ossignal.h

/******************************************************************************
 
    @file    IntrOS: ossignal.h
    @author  Rajmund Szymanski
    @date    18.11.2025
    @brief   This file contains definitions for IntrOS.
 
 ******************************************************************************
 
   Copyright (c) 2018-2022 Rajmund Szymanski. All rights reserved.
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to
   deal in the Software without restriction, including without limitation the
   rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   sell copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:
 
   The above copyright notice and this permission notice shall be included
   in all copies or substantial portions of the Software.
 
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
   IN THE SOFTWARE.
 
 ******************************************************************************/
 
#ifndef __INTROS_SIG_H
#define __INTROS_SIG_H
 
#include "oskernel.h"
#include "osclock.h"

 
/* -------------------------------------------------------------------------- */
 
#define SIG_LIMIT     (sizeof(unsigned) * CHAR_BIT)
 
#define SIGSET(signo) (((signo) < (SIG_LIMIT)) ? 1U << (signo) : 0U) 
#define sigAny        ( 0U )                                         
#define sigAll        ( 0U-1 )                                       

 
typedef struct __sig sig_t;
 
struct __sig
{
    obj_t    obj;   
 
    unsigned sigset;
};
 
typedef struct __sig sig_id [];
 
/******************************************************************************
 *
 * Name              : _SIG_INIT
 *
 * Description       : create and initialize a signal object
 *
 * Parameters        : none
 *
 * Return            : signal object
 *
 * Note              : for internal use
 *
 ******************************************************************************/
 
#define               _SIG_INIT() { _OBJ_INIT(), 0 }

 
#define             OS_SIG( sig ) \
                       sig_t sig[] = { _SIG_INIT() }

/** static alias of OS_SIG() */
#define         static_SIG( sig ) \
                static sig_t sig[] = { _SIG_INIT() }

 
#ifndef __cplusplus
#define                SIG_INIT() \
                      _SIG_INIT()
#endif

 
#ifndef __cplusplus
#define                SIG_CREATE() \
                     { SIG_INIT  () }
/** alias of SIG_CREATE() */
#define                SIG_NEW \
                       SIG_CREATE
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

 
void sig_init( sig_t *sig );

 
void sig_reset( sig_t *sig );

__STATIC_INLINE
void sig_kill( sig_t *sig ) { sig_reset(sig); }

 
int sig_take( sig_t *sig, unsigned sigset, unsigned *signo );

__STATIC_INLINE
int sig_tryWait( sig_t *sig, unsigned sigset, unsigned *signo ) { return sig_take(sig, sigset, signo); }

 
int sig_waitFor( sig_t *sig, unsigned sigset, unsigned *signo, cnt_t delay );

 
int sig_waitUntil( sig_t *sig, unsigned sigset, unsigned *signo, cnt_t time );

 
__STATIC_INLINE
int sig_wait( sig_t *sig, unsigned sigset, unsigned *signo ) { return sig_waitFor(sig, sigset, signo, INFINITE); }

 
void sig_give( sig_t *sig, unsigned signo );

__STATIC_INLINE
void sig_set( sig_t *sig, unsigned signo ) { sig_give(sig, signo); }

 
void sig_clear( sig_t *sig, unsigned signo );
 
#ifdef __cplusplus
}
#endif
 
/* -------------------------------------------------------------------------- */
 
#if defined(__cplusplus)
namespace intros {

 
struct Signal : public __sig
{
    constexpr
    Signal(): __sig _SIG_INIT() {}
 
    ~Signal() { assert(__sig::obj.queue == nullptr); }

    /// move constructor
    Signal( Signal&& _src ): __sig(_src)
    {
        assert(_src.obj.queue == nullptr);
    }
 
    Signal( const Signal& ) = delete;
    Signal& operator=( Signal&& ) = delete;
    Signal& operator=( const Signal& ) = delete;
 
    void reset    ()                                                       {        sig_reset    (this); }                                        
    void kill     ()                                                       {        sig_kill     (this); }                                        
    int  take     ( unsigned _sigset, unsigned *_signo = nullptr )         { return sig_take     (this, _sigset, _signo); }                       
    int  tryWait  ( unsigned _sigset, unsigned *_signo = nullptr )         { return sig_tryWait  (this, _sigset, _signo); }                       
    template<typename T>
    int  waitFor  ( unsigned _sigset, unsigned *_signo,  const T& _delay ) { return sig_waitFor  (this, _sigset, _signo, Clock::count(_delay)); } 
    template<typename T>
    int  waitUntil( unsigned _sigset, unsigned *_signo,  const T& _time )  { return sig_waitUntil(this, _sigset, _signo, Clock::until(_time)); }  
    int  wait     ( unsigned _sigset, unsigned *_signo = nullptr )         { return sig_wait     (this, _sigset, _signo); }                       
    void give     ( unsigned _signo )                                      {        sig_give     (this, _signo); }                                
    void set      ( unsigned _signo )                                      {        sig_set      (this, _signo); }                                
    void clear    ( unsigned _signo )                                      {        sig_clear    (this, _signo); }                                
};
 
}     //  namespace
#endif//__cplusplus
 
/* -------------------------------------------------------------------------- */

 
#endif//__INTROS_SIG_H