iPXE
Macros | Typedefs | Functions
ring.h File Reference
#include "../xen-compat.h"

Go to the source code of this file.

Macros

#define xen_mb()   mb()
 
#define xen_rmb()   rmb()
 
#define xen_wmb()   wmb()
 
#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 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_REQUEST_PROD_OVERFLOW(_r, _prod)   (((_prod) - (_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
 

Functions

 FILE_LICENCE (MIT)
 

Macro Definition Documentation

◆ xen_mb

#define xen_mb ( )    mb()

Definition at line 35 of file ring.h.

◆ xen_rmb

#define xen_rmb ( )    rmb()

Definition at line 36 of file ring.h.

◆ xen_wmb

#define xen_wmb ( )    wmb()

Definition at line 37 of file ring.h.

◆ __RD2

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

Definition at line 43 of file ring.h.

◆ __RD4

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

Definition at line 44 of file ring.h.

◆ __RD8

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

Definition at line 45 of file ring.h.

◆ __RD16

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

Definition at line 46 of file ring.h.

◆ __RD32

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

Definition at line 47 of file ring.h.

◆ __CONST_RING_SIZE

#define __CONST_RING_SIZE (   _s,
  _sz 
)
Value:
(__RD32(((_sz) - offsetof(struct _s##_sring, ring)) / \
sizeof(((struct _s##_sring *)0)->ring[0])))
#define offsetof(type, field)
Get offset of a field within a structure.
Definition: stddef.h:24
#define __RD32(_x)
Definition: ring.h:47

Definition at line 55 of file ring.h.

◆ __RING_SIZE

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

Definition at line 61 of file ring.h.

◆ DEFINE_RING_TYPES

#define DEFINE_RING_TYPES (   __name,
  __req_t,
  __rsp_t 
)

Definition at line 96 of file ring.h.

◆ SHARED_RING_INIT

#define SHARED_RING_INIT (   _s)
Value:
do { \
(_s)->req_prod = (_s)->rsp_prod = 0; \
(_s)->req_event = (_s)->rsp_event = 1; \
(void)memset((_s)->private.pvt_pad, 0, sizeof((_s)->private.pvt_pad)); \
(void)memset((_s)->__pad, 0, sizeof((_s)->__pad)); \
} while(0)
void * memset(void *dest, int character, size_t len) __nonnull

Definition at line 158 of file ring.h.

◆ FRONT_RING_INIT

#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)
#define __RING_SIZE(_s, _sz)
Definition: ring.h:61

Definition at line 165 of file ring.h.

◆ BACK_RING_INIT

#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)
#define __RING_SIZE(_s, _sz)
Definition: ring.h:61

Definition at line 172 of file ring.h.

◆ RING_SIZE

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

Definition at line 180 of file ring.h.

◆ RING_FREE_REQUESTS

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

Definition at line 184 of file ring.h.

◆ RING_FULL

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

Definition at line 190 of file ring.h.

◆ RING_HAS_UNCONSUMED_RESPONSES

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

Definition at line 194 of file ring.h.

◆ RING_HAS_UNCONSUMED_REQUESTS

#define RING_HAS_UNCONSUMED_REQUESTS (   _r)
Value:
((((_r)->sring->req_prod - (_r)->req_cons) < \
(RING_SIZE(_r) - ((_r)->req_cons - (_r)->rsp_prod_pvt))) ? \
((_r)->sring->req_prod - (_r)->req_cons) : \
(RING_SIZE(_r) - ((_r)->req_cons - (_r)->rsp_prod_pvt)))
#define RING_SIZE(_r)
Definition: ring.h:180

Definition at line 206 of file ring.h.

◆ RING_GET_REQUEST

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

Definition at line 214 of file ring.h.

◆ RING_GET_RESPONSE

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

Definition at line 217 of file ring.h.

◆ RING_REQUEST_CONS_OVERFLOW

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

Definition at line 221 of file ring.h.

◆ RING_REQUEST_PROD_OVERFLOW

#define RING_REQUEST_PROD_OVERFLOW (   _r,
  _prod 
)    (((_prod) - (_r)->rsp_prod_pvt) > RING_SIZE(_r))

Definition at line 225 of file ring.h.

◆ RING_PUSH_REQUESTS

#define RING_PUSH_REQUESTS (   _r)
Value:
do { \
xen_wmb(); /* back sees requests /before/ updated producer index */ \
(_r)->sring->req_prod = (_r)->req_prod_pvt; \
} while (0)

Definition at line 228 of file ring.h.

◆ RING_PUSH_RESPONSES

#define RING_PUSH_RESPONSES (   _r)
Value:
do { \
xen_wmb(); /* front sees resps /before/ updated producer index */ \
(_r)->sring->rsp_prod = (_r)->rsp_prod_pvt; \
} while (0)

Definition at line 233 of file ring.h.

◆ RING_PUSH_REQUESTS_AND_CHECK_NOTIFY

#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; \
xen_wmb(); /* back sees requests /before/ updated producer index */ \
(_r)->sring->req_prod = __new; \
xen_mb(); /* back sees new requests /before/ we check req_event */ \
(_notify) = ((RING_IDX)(__new - (_r)->sring->req_event) < \
(RING_IDX)(__new - __old)); \
} while (0)
unsigned int RING_IDX
Definition: ring.h:40
#define xen_mb()
Definition: ring.h:35

Definition at line 268 of file ring.h.

◆ RING_PUSH_RESPONSES_AND_CHECK_NOTIFY

#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; \
xen_wmb(); /* front sees resps /before/ updated producer index */ \
(_r)->sring->rsp_prod = __new; \
xen_mb(); /* front sees new resps /before/ we check rsp_event */ \
(_notify) = ((RING_IDX)(__new - (_r)->sring->rsp_event) < \
(RING_IDX)(__new - __old)); \
} while (0)
unsigned int RING_IDX
Definition: ring.h:40
#define xen_mb()
Definition: ring.h:35

Definition at line 278 of file ring.h.

◆ RING_FINAL_CHECK_FOR_REQUESTS

#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; \
xen_mb(); \
(_work_to_do) = RING_HAS_UNCONSUMED_REQUESTS(_r); \
} while (0)
#define RING_HAS_UNCONSUMED_REQUESTS(_r)
Definition: ring.h:206

Definition at line 288 of file ring.h.

◆ RING_FINAL_CHECK_FOR_RESPONSES

#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; \
xen_mb(); \
(_work_to_do) = RING_HAS_UNCONSUMED_RESPONSES(_r); \
} while (0)
#define RING_HAS_UNCONSUMED_RESPONSES(_r)
Definition: ring.h:194

Definition at line 296 of file ring.h.

Typedef Documentation

◆ RING_IDX

typedef unsigned int RING_IDX

Definition at line 40 of file ring.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( MIT  )