Macros
#define	__RD2(_x) (((_x) & 0x00000002) ? 0x2 : ((_x) & 0x1))

#define	__RD4(_x) (((_x) & 0x0000000c) ? __RD2((_x)>>2)<<2 : __RD2(_x))

#define	__RD8(_x) (((_x) & 0x000000f0) ? __RD4((_x)>>4)<<4 : __RD4(_x))

#define	__RD16(_x) (((_x) & 0x0000ff00) ? __RD8((_x)>>8)<<8 : __RD8(_x))

#define	__RD32(_x) (((_x) & 0xffff0000) ? __RD16((_x)>>16)<<16 : __RD16(_x))

#define	__CONST_RING_SIZE(_s, _sz)

#define	__RING_SIZE(_s, _sz) (__RD32(((_sz) - (long)&(_s)->ring + (long)(_s)) / sizeof((_s)->ring[0])))

#define	DEFINE_RING_TYPES(__name, __req_t, __rsp_t)

#define	SHARED_RING_INIT(_s)

#define	FRONT_RING_INIT(_r, _s, __size)

#define	BACK_RING_INIT(_r, _s, __size)

#define	FRONT_RING_ATTACH(_r, _s, __size)

#define	BACK_RING_ATTACH(_r, _s, __size)

#define	RING_SIZE(_r) ((_r)->nr_ents)

#define	RING_FREE_REQUESTS(_r) (RING_SIZE(_r) - ((_r)->req_prod_pvt - (_r)->rsp_cons))

#define	RING_FULL(_r) (RING_FREE_REQUESTS(_r) == 0)

#define	RING_HAS_UNCONSUMED_RESPONSES(_r) ((_r)->sring->rsp_prod - (_r)->rsp_cons)

#define	RING_HAS_UNCONSUMED_REQUESTS(_r)

#define	RING_GET_REQUEST(_r, _idx) (&((_r)->sring->ring[((_idx) & (RING_SIZE(_r) - 1))].req))

#define	RING_GET_RESPONSE(_r, _idx) (&((_r)->sring->ring[((_idx) & (RING_SIZE(_r) - 1))].rsp))

#define	RING_REQUEST_CONS_OVERFLOW(_r, _cons) (((_cons) - (_r)->rsp_prod_pvt) >= RING_SIZE(_r))

#define	RING_PUSH_REQUESTS(_r)

#define	RING_PUSH_RESPONSES(_r)

#define	RING_PUSH_REQUESTS_AND_CHECK_NOTIFY(_r, _notify)

#define	RING_PUSH_RESPONSES_AND_CHECK_NOTIFY(_r, _notify)

#define	RING_FINAL_CHECK_FOR_REQUESTS(_r, _work_to_do)

#define	RING_FINAL_CHECK_FOR_RESPONSES(_r, _work_to_do)

Typedefs
typedef unsigned int	RING_IDX

Macro Definition Documentation

#define __CONST_RING_SIZE	(	_s,
		_sz
	)

Value:

(__RD32(((_sz) - offsetof(struct _s##_sring, ring)) / \

sizeof(((struct _s##_sring *)0)->ring[0])))

Definition at line 27 of file ring.h.

#define __RD16 ( _x ) (((_x) & 0x0000ff00) ? __RD8((_x)>>8)<<8 : __RD8(_x))

Definition at line 18 of file ring.h.

#define __RD2 ( _x ) (((_x) & 0x00000002) ? 0x2 : ((_x) & 0x1))

Definition at line 15 of file ring.h.

#define __RD32 ( _x ) (((_x) & 0xffff0000) ? __RD16((_x)>>16)<<16 : __RD16(_x))

Definition at line 19 of file ring.h.

#define __RD4 ( _x ) (((_x) & 0x0000000c) ? __RD2((_x)>>2)<<2 : __RD2(_x))

Definition at line 16 of file ring.h.

#define __RD8 ( _x ) (((_x) & 0x000000f0) ? __RD4((_x)>>4)<<4 : __RD4(_x))

Definition at line 17 of file ring.h.

#define __RING_SIZE	(	_s,
		_sz
	)	(__RD32(((_sz) - (long)&(_s)->ring + (long)(_s)) / sizeof((_s)->ring[0])))

Definition at line 34 of file ring.h.

#define BACK_RING_ATTACH	(	_r,
		_s,
		__size
	)

Value:

do {                \
    (_r)->sring = (_s);                         \
    (_r)->rsp_prod_pvt = (_s)->rsp_prod;                \
    (_r)->req_cons = (_s)->req_prod;                    \
    (_r)->nr_ents = __RING_SIZE(_s, __size);                \
} while (0)

Definition at line 147 of file ring.h.

#define BACK_RING_INIT	(	_r,
		_s,
		__size
	)

Value:

do {                \
    (_r)->rsp_prod_pvt = 0;                     \
    (_r)->req_cons = 0;                         \
    (_r)->nr_ents = __RING_SIZE(_s, __size);                \
    (_r)->sring = (_s);                         \
} while (0)

Definition at line 132 of file ring.h.

#define DEFINE_RING_TYPES	(	__name,
		__req_t,
		__rsp_t
	)

Value:

\
/* Shared ring entry */                         \
union __name##_sring_entry {                        \
    __req_t req;                            \
    __rsp_t rsp;                            \
};                                  \
                                    \
/* Shared ring page */                          \
struct __name##_sring {                         \
    RING_IDX req_prod, req_event;                   \
    RING_IDX rsp_prod, rsp_event;                   \
    uint8_t  pad[48];                           \
    union __name##_sring_entry ring[1]; /* variable-length */       \
};                                  \
                                    \
/* "Front" end's private variables */                   \
struct __name##_front_ring {                        \
    RING_IDX req_prod_pvt;                      \
    RING_IDX rsp_cons;                          \
    unsigned int nr_ents;                       \
    struct __name##_sring *sring;                   \
};                                  \
                                    \
/* "Back" end's private variables */                    \
struct __name##_back_ring {                     \
    RING_IDX rsp_prod_pvt;                      \
    RING_IDX req_cons;                          \
    unsigned int nr_ents;                       \
    struct __name##_sring *sring;                   \
};

Definition at line 71 of file ring.h.

#define FRONT_RING_ATTACH	(	_r,
		_s,
		__size
	)

Value:

do {                \
    (_r)->sring = (_s);                         \
    (_r)->req_prod_pvt = (_s)->req_prod;                \
    (_r)->rsp_cons = (_s)->rsp_prod;                    \
    (_r)->nr_ents = __RING_SIZE(_s, __size);                \
} while (0)

Definition at line 140 of file ring.h.

#define FRONT_RING_INIT	(	_r,
		_s,
		__size
	)

Value:

do {                \
    (_r)->req_prod_pvt = 0;                     \
    (_r)->rsp_cons = 0;                         \
    (_r)->nr_ents = __RING_SIZE(_s, __size);                \
    (_r)->sring = (_s);                         \
} while (0)

Definition at line 125 of file ring.h.

#define RING_FINAL_CHECK_FOR_REQUESTS	(	_r,
		_work_to_do
	)

Value:

do {        \
    (_work_to_do) = RING_HAS_UNCONSUMED_REQUESTS(_r);           \
    if (_work_to_do) break;                     \
    (_r)->sring->req_event = (_r)->req_cons + 1;            \
    mb();                               \
    (_work_to_do) = RING_HAS_UNCONSUMED_REQUESTS(_r);           \
} while (0)

Definition at line 251 of file ring.h.

#define RING_FINAL_CHECK_FOR_RESPONSES	(	_r,
		_work_to_do
	)

Value:

do {        \
    (_work_to_do) = RING_HAS_UNCONSUMED_RESPONSES(_r);          \
    if (_work_to_do) break;                     \
    (_r)->sring->rsp_event = (_r)->rsp_cons + 1;            \
    mb();                               \
    (_work_to_do) = RING_HAS_UNCONSUMED_RESPONSES(_r);          \
} while (0)

Definition at line 259 of file ring.h.

#define RING_FREE_REQUESTS ( _r ) (RING_SIZE(_r) - ((_r)->req_prod_pvt - (_r)->rsp_cons))

Definition at line 159 of file ring.h.

#define RING_FULL ( _r ) (RING_FREE_REQUESTS(_r) == 0)

Definition at line 165 of file ring.h.

#define RING_GET_REQUEST	(	_r,
		_idx
	)	(&((_r)->sring->ring[((_idx) & (RING_SIZE(_r) - 1))].req))

Definition at line 181 of file ring.h.

#define RING_GET_RESPONSE	(	_r,
		_idx
	)	(&((_r)->sring->ring[((_idx) & (RING_SIZE(_r) - 1))].rsp))

Definition at line 184 of file ring.h.

#define RING_HAS_UNCONSUMED_REQUESTS ( _r )

Value:

({                                  \
    unsigned int req = (_r)->sring->req_prod - (_r)->req_cons;  \
    unsigned int rsp = RING_SIZE(_r) -              \
               ((_r)->req_cons - (_r)->rsp_prod_pvt);   \
    req < rsp ? req : rsp;                      \
    })

Definition at line 172 of file ring.h.

#define RING_HAS_UNCONSUMED_RESPONSES ( _r ) ((_r)->sring->rsp_prod - (_r)->rsp_cons)

Definition at line 169 of file ring.h.

#define RING_PUSH_REQUESTS ( _r )

Value:

do {                    \
    wmb(); /* back sees requests /before/ updated producer index */ \
    (_r)->sring->req_prod = (_r)->req_prod_pvt;             \
} while (0)

Definition at line 191 of file ring.h.

#define RING_PUSH_REQUESTS_AND_CHECK_NOTIFY	(	_r,
		_notify
	)

Value:

do {        \
    RING_IDX __old = (_r)->sring->req_prod;             \
    RING_IDX __new = (_r)->req_prod_pvt;                \
    wmb(); /* back sees requests /before/ updated producer index */ \
    (_r)->sring->req_prod = __new;                  \
    mb(); /* back sees new requests /before/ we check req_event */  \
    (_notify) = ((RING_IDX)(__new - (_r)->sring->req_event) <       \
         (RING_IDX)(__new - __old));                \
} while (0)

Definition at line 231 of file ring.h.

#define RING_PUSH_RESPONSES ( _r )

Value:

do {                    \
    wmb(); /* front sees responses /before/ updated producer index */   \
    (_r)->sring->rsp_prod = (_r)->rsp_prod_pvt;             \
} while (0)

Definition at line 196 of file ring.h.

#define RING_PUSH_RESPONSES_AND_CHECK_NOTIFY	(	_r,
		_notify
	)

Value:

do {        \
    RING_IDX __old = (_r)->sring->rsp_prod;             \
    RING_IDX __new = (_r)->rsp_prod_pvt;                \
    wmb(); /* front sees responses /before/ updated producer index */   \
    (_r)->sring->rsp_prod = __new;                  \
    mb(); /* front sees new responses /before/ we check rsp_event */    \
    (_notify) = ((RING_IDX)(__new - (_r)->sring->rsp_event) <       \
         (RING_IDX)(__new - __old));                \
} while (0)

Definition at line 241 of file ring.h.

#define RING_REQUEST_CONS_OVERFLOW	(	_r,
		_cons
	)	(((_cons) - (_r)->rsp_prod_pvt) >= RING_SIZE(_r))

Definition at line 188 of file ring.h.

#define RING_SIZE ( _r ) ((_r)->nr_ents)

Definition at line 155 of file ring.h.

#define SHARED_RING_INIT ( _s )

Value:

do {                    \
    (_s)->req_prod  = (_s)->rsp_prod  = 0;              \
    (_s)->req_event = (_s)->rsp_event = 1;              \
    memset((_s)->pad, 0, sizeof((_s)->pad));                \
} while(0)

Definition at line 119 of file ring.h.

Typedef Documentation

typedef unsigned int RING_IDX

Definition at line 12 of file ring.h.

Macros

Typedefs

Macro Definition Documentation

Typedef Documentation