queue.h

Go to the documentation of this file.

#ifndef _XENO_QUEUE_H
#define _XENO_QUEUE_H

#include <nucleus/synch.h>
#include <nucleus/heap.h>
#include <native/types.h>

/* Creation flags. */
#define Q_PRIO   XNSYNCH_PRIO   /* Pend by task priority order. */
#define Q_FIFO   XNSYNCH_FIFO   /* Pend by FIFO order. */
#define Q_DMA    0x100          /* Use memory suitable for DMA. */
#define Q_SHARED 0x200          /* Use mappable shared memory. */

#define Q_UNLIMITED 0           /* No size limit. */

/* Operation flags. */
#define Q_NORMAL     0x0
#define Q_URGENT     0x1
#define Q_BROADCAST  0x2

typedef struct rt_queue_info {

    int nwaiters;               /* !< Number of pending tasks. */

    int nmessages;              /* !< Number of queued messages. */

    int mode;                   /* !< Creation mode. */

    size_t qlimit;              /* !< Queue limit. */

    size_t poolsize;            /* !< Size of pool memory (in bytes). */

    size_t usedmem;             /* !< Amount of pool memory used (in bytes). */

    char name[XNOBJECT_NAME_LEN]; /* !< Symbolic name. */

} RT_QUEUE_INFO;

typedef struct rt_queue_placeholder {
        xnhandle_t opaque;
        void *opaque2;
        caddr_t mapbase;
        size_t mapsize;
        unsigned long area;
} RT_QUEUE_PLACEHOLDER;

#if defined(__KERNEL__) || defined(__XENO_SIM__)

#include <native/ppd.h>

#define XENO_QUEUE_MAGIC 0x55550707

typedef struct rt_queue {

    unsigned magic;   /* !< Magic code - must be first */

    xnsynch_t synch_base; /* !< Base synchronization object. */

    xnqueue_t pendq;    /* !< Pending message queue. */

    xnheap_t bufpool;   /* !< Message buffer pool. */

    int mode;           /* !< Creation mode. */

    xnhandle_t handle;  /* !< Handle in registry -- zero if unregistered. */

    int qlimit;         /* !< Maximum queued elements. */

    char name[XNOBJECT_NAME_LEN]; /* !< Symbolic name. */

#ifdef CONFIG_XENO_OPT_PERVASIVE
    pid_t cpid;                 /* !< Creator's pid. */
#endif /* CONFIG_XENO_OPT_PERVASIVE */

    xnholder_t rlink;           /* !< Link in resource queue. */

#define rlink2queue(ln) container_of(ln, RT_QUEUE, rlink)

    xnqueue_t *rqueue;          /* !< Backpointer to resource queue. */

} RT_QUEUE;

typedef struct rt_queue_msg {

    size_t size;

    volatile unsigned refcount;

    xnholder_t link;

#define link2rtmsg(ln)          container_of(ln, rt_queue_msg_t, link)

} rt_queue_msg_t;

#ifdef __cplusplus
extern "C" {
#endif

#ifdef CONFIG_XENO_OPT_NATIVE_QUEUE

int __native_queue_pkg_init(void);

void __native_queue_pkg_cleanup(void);

static inline void __native_queue_flush_rq(xnqueue_t *rq)
{
        xeno_flush_rq_norelease(RT_QUEUE, rq, queue);
}

ssize_t rt_queue_receive_inner(RT_QUEUE *q, void **bufp,
                               xntmode_t timeout_mode, RTIME timeout);

int rt_queue_delete_inner(RT_QUEUE *q,
                          void __user *mapaddr);

#else /* !CONFIG_XENO_OPT_NATIVE_QUEUE */

#define __native_queue_pkg_init()               ({ 0; })
#define __native_queue_pkg_cleanup()            do { } while(0)
#define __native_queue_flush_rq(rq)             do { } while(0)

#endif /* !CONFIG_XENO_OPT_NATIVE_QUEUE */

#ifdef __cplusplus
}
#endif

#else /* !(__KERNEL__ || __XENO_SIM__) */

typedef RT_QUEUE_PLACEHOLDER RT_QUEUE;

#ifdef __cplusplus
extern "C" {
#endif

int rt_queue_bind(RT_QUEUE *q,
                  const char *name,
                  RTIME timeout);

int rt_queue_unbind(RT_QUEUE *q);

#ifdef __cplusplus
}
#endif

#endif /* __KERNEL__ || __XENO_SIM__ */

#ifdef __cplusplus
extern "C" {
#endif

/* Public interface. */

int rt_queue_create(RT_QUEUE *q,
                    const char *name,
                    size_t poolsize,
                    size_t qlimit,
                    int mode);

int rt_queue_delete(RT_QUEUE *q);

void *rt_queue_alloc(RT_QUEUE *q,
                     size_t size);

int rt_queue_free(RT_QUEUE *q,
                  void *buf);

int rt_queue_send(RT_QUEUE *q,
                  void *buf,
                  size_t size,
                  int mode);

int rt_queue_write(RT_QUEUE *q,
                   const void *buf,
                   size_t size,
                   int mode);

ssize_t rt_queue_receive(RT_QUEUE *q,
                         void **bufp,
                         RTIME timeout);

ssize_t rt_queue_receive_until(RT_QUEUE *q,
                               void **bufp,
                               RTIME timeout);

ssize_t rt_queue_read(RT_QUEUE *q,
                      void *bufp,
                      size_t size,
                      RTIME timeout);

ssize_t rt_queue_read_until(RT_QUEUE *q,
                            void *bufp,
                            size_t size,
                            RTIME timeout);

int rt_queue_flush(RT_QUEUE *q);

int rt_queue_inquire(RT_QUEUE *q,
                     RT_QUEUE_INFO *info);

#ifdef __cplusplus
}
#endif

#endif /* !_XENO_QUEUE_H */