mbox.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 Kaspar Schleiser <kaspar@schleiser.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include "cib.h"
#include "compiler_hints.h"
#include "list.h"
#include "msg.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define MBOX_INIT(queue, queue_size) { \
        { 0 }, { 0 }, CIB_INIT(queue_size), queue \
}

typedef struct {
    list_node_t readers;    
    list_node_t writers;    
    cib_t cib;              
    msg_t *msg_array;       
} mbox_t;
 
enum {
    NON_BLOCKING = 0,       
    BLOCKING,               
};

ACCESS(write_only, 2, 3)
static inline void mbox_init(mbox_t *mbox, msg_t *queue,
                             unsigned int queue_size)
{
    mbox_t m = MBOX_INIT(queue, queue_size);
 
    *mbox = m;
}

int _mbox_put(mbox_t *mbox, msg_t *msg, int blocking);

int _mbox_get(mbox_t *mbox, msg_t *msg, int blocking);

static inline void mbox_put(mbox_t *mbox, msg_t *msg)
{
    _mbox_put(mbox, msg, BLOCKING);
}

static inline int mbox_try_put(mbox_t *mbox, msg_t *msg)
{
    return _mbox_put(mbox, msg, NON_BLOCKING);
}

static inline void mbox_get(mbox_t *mbox, msg_t *msg)
{
    _mbox_get(mbox, msg, BLOCKING);
}

static inline int mbox_try_get(mbox_t *mbox, msg_t *msg)
{
    return _mbox_get(mbox, msg, NON_BLOCKING);
}

static inline size_t mbox_size(mbox_t *mbox)
{
    return mbox->cib.mask ? mbox->cib.mask + 1 : 0;
}

static inline size_t mbox_avail(mbox_t *mbox)
{
    return cib_avail(&mbox->cib);
}

static inline void mbox_unset(mbox_t *mbox)
{
    mbox->msg_array = NULL;
    mbox->cib.mask = 0;
}
 
#ifdef __cplusplus
}
#endif