FD.io VPP  v17.04.2-2-ga8f93f8
Vector Packet Processing
Data Structures | Macros | Functions | Variables
api_helper_macros.h File Reference
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  vpe_client_registration_t
 
struct  vpe_api_main_t
 

Macros

#define f64_endian(a)
 
#define f64_print(a, b)
 
#define REPLY_MSG_ID_BASE   0
 
#define REPLY_MACRO(t)
 
#define REPLY_MACRO2(t, body)
 
#define REPLY_MACRO3(t, n, body)
 
#define REPLY_MACRO4(t, n, body)
 
#define VALIDATE_SW_IF_INDEX(mp)
 
#define BAD_SW_IF_INDEX_LABEL
 
#define VALIDATE_RX_SW_IF_INDEX(mp)
 
#define BAD_RX_SW_IF_INDEX_LABEL
 
#define VALIDATE_TX_SW_IF_INDEX(mp)
 
#define BAD_TX_SW_IF_INDEX_LABEL
 
#define pub_sub_handler(lca, UCA)
 
#define foreach_registration_hash
 

Functions

static uword vnet_sw_if_index_is_api_valid (u32 sw_if_index)
 

Variables

vpe_api_main_t vpe_api_main
 

Macro Definition Documentation

#define BAD_RX_SW_IF_INDEX_LABEL
Value:
do { \
bad_rx_sw_if_index: \
; \
} while (0);

Definition at line 138 of file api_helper_macros.h.

#define BAD_SW_IF_INDEX_LABEL
Value:
do { \
bad_sw_if_index: \
; \
} while (0);

Definition at line 124 of file api_helper_macros.h.

#define BAD_TX_SW_IF_INDEX_LABEL
Value:
do { \
bad_tx_sw_if_index: \
; \
} while (0);

Definition at line 152 of file api_helper_macros.h.

#define f64_endian (   a)

Definition at line 23 of file api_helper_macros.h.

#define f64_print (   a,
  b 
)

Definition at line 24 of file api_helper_macros.h.

#define foreach_registration_hash
Value:
_(interface_events) \
_(to_netconf_server) \
_(from_netconf_server) \
_(to_netconf_client) \
_(from_netconf_client) \
_(oam_events) \
_(bfd_events)

Definition at line 197 of file api_helper_macros.h.

#define pub_sub_handler (   lca,
  UCA 
)
Value:
static void vl_api_want_##lca##_t_handler ( \
vl_api_want_##lca##_t *mp) \
{ \
vpe_api_main_t *vam = &vpe_api_main; \
vpe_client_registration_t *rp; \
vl_api_want_##lca##_reply_t *rmp; \
uword *p; \
i32 rv = 0; \
\
p = hash_get (vam->lca##_registration_hash, mp->client_index); \
if (p) { \
if (mp->enable_disable) { \
clib_warning ("pid %d: already enabled...", mp->pid); \
rv = VNET_API_ERROR_INVALID_REGISTRATION; \
goto reply; \
} else { \
rp = pool_elt_at_index (vam->lca##_registrations, p[0]); \
pool_put (vam->lca##_registrations, rp); \
hash_unset (vam->lca##_registration_hash, \
mp->client_index); \
goto reply; \
} \
} \
if (mp->enable_disable == 0) { \
clib_warning ("pid %d: already disabled...", mp->pid); \
rv = VNET_API_ERROR_INVALID_REGISTRATION; \
goto reply; \
} \
pool_get (vam->lca##_registrations, rp); \
rp->client_index = mp->client_index; \
rp->client_pid = mp->pid; \
hash_set (vam->lca##_registration_hash, rp->client_index, \
rp - vam->lca##_registrations); \
\
reply: \
REPLY_MACRO (VL_API_WANT_##UCA##_REPLY); \
}
hash_set
#define hash_set(h, key, value)
Definition: hash.h:254
hash_unset
#define hash_unset(h, key)
Definition: hash.h:260
pool_get
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:200
i32
int i32
Definition: types.h:81
hash_get
#define hash_get(h, key)
Definition: hash.h:248
pool_elt_at_index
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:397
pool_put
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:241
REPLY_MACRO
#define REPLY_MACRO(t)
Definition: api_helper_macros.h:30
clib_warning
#define clib_warning(format, args...)
Definition: error.h:59
uword
u64 uword
Definition: types.h:112
vpe_api_main
vpe_api_main_t vpe_api_main
Definition: api.c:161

Definition at line 158 of file api_helper_macros.h.

#define REPLY_MACRO (   t)
Value:
do { \
unix_shared_memory_queue_t * q; \
rv = vl_msg_api_pd_handler (mp, rv); \
q = vl_api_client_index_to_input_queue (mp->client_index); \
if (!q) \
return; \
\
rmp = vl_msg_api_alloc (sizeof (*rmp)); \
rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
rmp->context = mp->context; \
rmp->retval = ntohl(rv); \
\
vl_msg_api_send_shmem (q, (u8 *)&rmp); \
} while(0);
vl_msg_api_send_shmem
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
Definition: memory_shared.c:539
REPLY_MSG_ID_BASE
#define REPLY_MSG_ID_BASE
Definition: api_helper_macros.h:27
vl_api_client_index_to_input_queue
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
Definition: memory_shared.c:822
vl_msg_api_alloc
void * vl_msg_api_alloc(int nbytes)
Definition: memory_shared.c:171
vl_msg_api_pd_handler
int vl_msg_api_pd_handler(void *mp, int rv)
Definition: api_shared.c:802
u8
unsigned char u8
Definition: types.h:56
unix_shared_memory_queue_t
struct _unix_shared_memory_queue unix_shared_memory_queue_t

Definition at line 30 of file api_helper_macros.h.

#define REPLY_MACRO2 (   t,
  body 
)
Value:
do { \
unix_shared_memory_queue_t * q; \
rv = vl_msg_api_pd_handler (mp, rv); \
q = vl_api_client_index_to_input_queue (mp->client_index); \
if (!q) \
return; \
\
rmp = vl_msg_api_alloc (sizeof (*rmp)); \
rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
rmp->context = mp->context; \
rmp->retval = ntohl(rv); \
do {body;} while (0); \
vl_msg_api_send_shmem (q, (u8 *)&rmp); \
} while(0);
vl_msg_api_send_shmem
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
Definition: memory_shared.c:539
REPLY_MSG_ID_BASE
#define REPLY_MSG_ID_BASE
Definition: api_helper_macros.h:27
vl_api_client_index_to_input_queue
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
Definition: memory_shared.c:822
vl_msg_api_alloc
void * vl_msg_api_alloc(int nbytes)
Definition: memory_shared.c:171
vl_msg_api_pd_handler
int vl_msg_api_pd_handler(void *mp, int rv)
Definition: api_shared.c:802
u8
unsigned char u8
Definition: types.h:56
unix_shared_memory_queue_t
struct _unix_shared_memory_queue unix_shared_memory_queue_t

Definition at line 46 of file api_helper_macros.h.

#define REPLY_MACRO3 (   t,
  n,
  body 
)
Value:
do { \
unix_shared_memory_queue_t * q; \
rv = vl_msg_api_pd_handler (mp, rv); \
q = vl_api_client_index_to_input_queue (mp->client_index); \
if (!q) \
return; \
\
rmp = vl_msg_api_alloc (sizeof (*rmp) + n); \
rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
rmp->context = mp->context; \
rmp->retval = ntohl(rv); \
do {body;} while (0); \
vl_msg_api_send_shmem (q, (u8 *)&rmp); \
} while(0);
vl_msg_api_send_shmem
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
Definition: memory_shared.c:539
REPLY_MSG_ID_BASE
#define REPLY_MSG_ID_BASE
Definition: api_helper_macros.h:27
vl_api_client_index_to_input_queue
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
Definition: memory_shared.c:822
vl_msg_api_alloc
void * vl_msg_api_alloc(int nbytes)
Definition: memory_shared.c:171
vl_msg_api_pd_handler
int vl_msg_api_pd_handler(void *mp, int rv)
Definition: api_shared.c:802
u8
unsigned char u8
Definition: types.h:56
unix_shared_memory_queue_t
struct _unix_shared_memory_queue unix_shared_memory_queue_t

Definition at line 62 of file api_helper_macros.h.

#define REPLY_MACRO4 (   t,
  n,
  body 
)
Value:
do { \
unix_shared_memory_queue_t * q; \
u8 is_error = 0; \
rv = vl_msg_api_pd_handler (mp, rv); \
q = vl_api_client_index_to_input_queue (mp->client_index); \
if (!q) \
return; \
\
rmp = vl_msg_api_alloc_or_null (sizeof (*rmp) + n); \
if (!rmp) \
{ \
/* if there isn't enough memory, try to allocate */ \
/* some at least for returning an error */ \
rmp = vl_msg_api_alloc (sizeof (*rmp)); \
if (!rmp) \
return; \
\
memset (rmp, 0, sizeof (*rmp)); \
rv = VNET_API_ERROR_TABLE_TOO_BIG; \
is_error = 1; \
} \
rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
rmp->context = mp->context; \
rmp->retval = ntohl(rv); \
if (!is_error) \
do {body;} while (0); \
vl_msg_api_send_shmem (q, (u8 *)&rmp); \
} while(0);
vl_msg_api_send_shmem
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
Definition: memory_shared.c:539
REPLY_MSG_ID_BASE
#define REPLY_MSG_ID_BASE
Definition: api_helper_macros.h:27
vl_api_client_index_to_input_queue
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
Definition: memory_shared.c:822
vl_msg_api_alloc
void * vl_msg_api_alloc(int nbytes)
Definition: memory_shared.c:171
vl_msg_api_pd_handler
int vl_msg_api_pd_handler(void *mp, int rv)
Definition: api_shared.c:802
u8
unsigned char u8
Definition: types.h:56
vl_msg_api_alloc_or_null
void * vl_msg_api_alloc_or_null(int nbytes)
Definition: memory_shared.c:185
unix_shared_memory_queue_t
struct _unix_shared_memory_queue unix_shared_memory_queue_t

Definition at line 78 of file api_helper_macros.h.

#define REPLY_MSG_ID_BASE   0

Definition at line 27 of file api_helper_macros.h.

#define VALIDATE_RX_SW_IF_INDEX (   mp)
Value:
do { u32 __rx_sw_if_index = ntohl(mp->rx_sw_if_index); \
if (!vnet_sw_if_index_is_api_valid(__rx_sw_if_index)) { \
rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; \
goto bad_rx_sw_if_index; \
} \
} while(0);
vnet_sw_if_index_is_api_valid
static uword vnet_sw_if_index_is_api_valid(u32 sw_if_index)
Definition: api_helper_macros.h:111
u32
unsigned int u32
Definition: types.h:88

Definition at line 130 of file api_helper_macros.h.

#define VALIDATE_SW_IF_INDEX (   mp)
Value:
do { u32 __sw_if_index = ntohl(mp->sw_if_index); \
if (!vnet_sw_if_index_is_api_valid(__sw_if_index)) { \
rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; \
goto bad_sw_if_index; \
} \
} while(0);
vnet_sw_if_index_is_api_valid
static uword vnet_sw_if_index_is_api_valid(u32 sw_if_index)
Definition: api_helper_macros.h:111
u32
unsigned int u32
Definition: types.h:88

Definition at line 116 of file api_helper_macros.h.

#define VALIDATE_TX_SW_IF_INDEX (   mp)
Value:
do { u32 __tx_sw_if_index = ntohl(mp->tx_sw_if_index); \
if (!vnet_sw_if_index_is_api_valid(__tx_sw_if_index)) { \
rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; \
goto bad_tx_sw_if_index; \
} \
} while(0);
vnet_sw_if_index_is_api_valid
static uword vnet_sw_if_index_is_api_valid(u32 sw_if_index)
Definition: api_helper_macros.h:111
u32
unsigned int u32
Definition: types.h:88

Definition at line 144 of file api_helper_macros.h.

Function Documentation

static uword vnet_sw_if_index_is_api_valid ( u32  sw_if_index)
inlinestatic

Definition at line 111 of file api_helper_macros.h.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Variable Documentation

vpe_api_main_t vpe_api_main

Definition at line 161 of file api.c.