oseventqueue.h

/******************************************************************************
 
    @file    IntrOS: oseventqueue.h
    @author  Rajmund Szymanski
    @date    17.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_EVQ_H
#define __INTROS_EVQ_H
 
#include "oskernel.h"
#include "osclock.h"


 
typedef struct __evq evq_t;
 
struct __evq
{
    obj_t    obj;   
 
    unsigned count; 
    unsigned limit; 
 
    unsigned head;  
    unsigned tail;  
    unsigned*data;  
};
 
typedef struct __evq evq_id [];
 
/******************************************************************************
 *
 * Name              : _EVQ_INIT
 *
 * Description       : create and initialize an event queue object
 *
 * Parameters
 *   limit           : size of a queue (max number of stored events)
 *   data            : event queue data buffer
 *
 * Return            : event queue object
 *
 * Note              : for internal use
 *
 ******************************************************************************/
 
#define               _EVQ_INIT( _limit, _data ) { _OBJ_INIT(), 0, _limit, 0, 0, _data }
 
/******************************************************************************
 *
 * Name              : _EVQ_DATA
 *
 * Description       : create an event queue data buffer
 *
 * Parameters
 *   limit           : size of a queue (max number of stored events)
 *
 * Return            : event queue data buffer
 *
 * Note              : for internal use
 *
 ******************************************************************************/
 
#ifndef __cplusplus
#define               _EVQ_DATA( _limit ) (unsigned[_limit]){ 0 }
#endif

 
#define             OS_EVQ_BUFFER( buf, limit ) \
                       unsigned buf[limit]

 
#define             OS_EVQ( evq, limit )          \
                static unsigned evq##__buf[limit]; \
                       evq_t evq[] = { _EVQ_INIT( limit, evq##__buf ) }

/** static alias of OS_EVQ() */
#define         static_EVQ( evq, limit )          \
                static unsigned evq##__buf[limit]; \
                static evq_t evq[] = { _EVQ_INIT( limit, evq##__buf ) }

 
#ifndef __cplusplus
#define                EVQ_INIT( limit ) \
                      _EVQ_INIT( limit, _EVQ_DATA( limit ) )
#endif

 
#ifndef __cplusplus
#define                EVQ_CREATE( limit ) \
                     { EVQ_INIT  ( limit ) }
/** alias of EVQ_CREATE() */
#define                EVQ_NEW \
                       EVQ_CREATE
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

 
void evq_init( evq_t *evq, unsigned *data, size_t bufsize );

 
void evq_reset( evq_t *evq );

__STATIC_INLINE
void evq_kill( evq_t *evq ) { evq_reset(evq); }

 
int evq_take( evq_t *evq, unsigned *event );

__STATIC_INLINE
int evq_tryWait( evq_t *evq, unsigned *event ) { return evq_take(evq, event); }
 
#if OS_ATOMICS
int evq_takeAsync( evq_t *evq, unsigned *event );
#endif

 
int evq_waitFor( evq_t *evq, unsigned *event, cnt_t delay );

 
int evq_waitUntil( evq_t *evq, unsigned *event, cnt_t time );

 
__STATIC_INLINE
int evq_wait( evq_t *evq, unsigned *event ) { return evq_waitFor(evq, event, INFINITE); }
 
#if OS_ATOMICS
int evq_waitAsync( evq_t *evq, unsigned *event );
#endif

 
int evq_give( evq_t *evq, unsigned event );
 
#if OS_ATOMICS
int evq_giveAsync( evq_t *evq, unsigned event );
#endif

 
int evq_sendFor( evq_t *evq, unsigned event, cnt_t delay );

 
int evq_sendUntil( evq_t *evq, unsigned event, cnt_t time );

 
__STATIC_INLINE
int evq_send( evq_t *evq, unsigned event ) { return evq_sendFor(evq, event, INFINITE); }
 
#if OS_ATOMICS
int evq_sendAsync( evq_t *evq, unsigned event );
#endif

 
void evq_push( evq_t *evq, unsigned event );

 
unsigned evq_count( evq_t *evq );

 
unsigned evq_space( evq_t *evq );

 
unsigned evq_limit( evq_t *evq );
 
#ifdef __cplusplus
}
#endif
 
/* -------------------------------------------------------------------------- */
 
#if defined(__cplusplus)
namespace intros {

 
template<unsigned limit_>
struct EventQueueT : public __evq
{
    constexpr
    EventQueueT(): __evq _EVQ_INIT(limit_, data_) {}
 
    ~EventQueueT() { assert(__evq::obj.queue == nullptr); }

    /// move constructor
    EventQueueT( EventQueueT&& _src ): __evq _EVQ_INIT(limit_, data_)
    {
        assert(_src.__evq::count == 0 && _src.obj.queue == nullptr);
        (void) _src;
    }
 
    EventQueueT( const EventQueueT& ) = delete;
    EventQueueT& operator=( EventQueueT&& ) = delete;
    EventQueueT& operator=( const EventQueueT& ) = delete;
 
    void     reset    ()                                    {        evq_reset    (this); }                                
    void     kill     ()                                    {        evq_kill     (this); }                                
    int      take     ( unsigned *_event = nullptr )        { return evq_take     (this,  _event); }                       
    int      take     ( unsigned &_event )                  { return evq_take     (this, &_event); }                       
    int      tryWait  ( unsigned *_event = nullptr )        { return evq_tryWait  (this,  _event); }                       
    int      tryWait  ( unsigned &_event )                  { return evq_tryWait  (this, &_event); }                       
    template<typename T>
    int      waitFor  ( unsigned *_event, const T& _delay ) { return evq_waitFor  (this,  _event, Clock::count(_delay)); } 
    template<typename T>
    int      waitUntil( unsigned *_event, const T& _time )  { return evq_waitUntil(this,  _event, Clock::until(_time)); }  
    int      wait     ( unsigned *_event = nullptr )        { return evq_wait     (this,  _event); }                       
    int      wait     ( unsigned &_event )                  { return evq_wait     (this, &_event); }                       
    int      give     ( unsigned  _event )                  { return evq_give     (this,  _event); }                       
    template<typename T>
    int      sendFor  ( unsigned  _event, const T& _delay ) { return evq_sendFor  (this,  _event, Clock::count(_delay)); } 
    template<typename T>
    int      sendUntil( unsigned  _event, const T& _time )  { return evq_sendUntil(this,  _event, Clock::until(_time)); }  
    int      send     ( unsigned  _event )                  { return evq_send     (this,  _event); }                       
    void     push     ( unsigned  _event )                  {        evq_push     (this,  _event); }                       
    unsigned count    ()                                    { return evq_count    (this); }                                
    unsigned space    ()                                    { return evq_space    (this); }                                
    unsigned limit    ()                                    { return evq_limit    (this); }                                
#if OS_ATOMICS
    int      takeAsync( unsigned *_event = nullptr )        { return evq_takeAsync(this,  _event); }                       
    int      takeAsync( unsigned &_event )                  { return evq_takeAsync(this, &_event); }                       
    int      waitAsync( unsigned *_event = nullptr )        { return evq_waitAsync(this,  _event); }                       
    int      waitAsync( unsigned &_event )                  { return evq_waitAsync(this, &_event); }                       
    int      giveAsync( unsigned  _event )                  { return evq_giveAsync(this,  _event); }                       
    int      sendAsync( unsigned  _event )                  { return evq_sendAsync(this,  _event); }                       
#endif
 
    private:
    unsigned data_[limit_];
};
 
}     //  namespace
#endif//__cplusplus
 
/* -------------------------------------------------------------------------- */

 
#endif//__INTROS_EVQ_H