FD.io VPP  v20.05.1-6-gf53edbc3b
Vector Packet Processing
Macros
vat_helper_macros.h File Reference

Go to the source code of this file.

Macros

#define M(T, mp)
 
#define MPING(T, mp)
 
#define M2(T, mp, n)
 
#define S(mp)
 
#define W(ret)
 
#define W2(ret, body)
 
#define VAT_PLUGIN_REGISTER(plug)
 

Macro Definition Documentation

◆ M

#define M (   T,
  mp 
)
Value:
do { \
socket_client_main_t *scm = vam->socket_client_main; \
vam->result_ready = 0; \
if (scm && scm->socket_enable) \
mp = vl_socket_client_msg_alloc (sizeof(*mp)); \
else \
mp = vl_msg_api_alloc_as_if_client(sizeof(*mp)); \
clib_memset (mp, 0, sizeof (*mp)); \
mp->_vl_msg_id = ntohs (VL_API_##T+__plugin_msg_base); \
mp->client_index = vam->my_client_index; \
} while(0);
vl_socket_client_msg_alloc
void * vl_socket_client_msg_alloc(int nbytes)
Definition: socket_client.c:227
vl_msg_api_alloc_as_if_client
void * vl_msg_api_alloc_as_if_client(int nbytes)
Definition: memory_shared.c:236

Definition at line 23 of file vat_helper_macros.h.

◆ M2

#define M2 (   T,
  mp,
  n 
)
Value:
do { \
socket_client_main_t *scm = vam->socket_client_main; \
vam->result_ready = 0; \
if (scm && scm->socket_enable) \
mp = vl_socket_client_msg_alloc (sizeof(*mp) + n); \
else \
mp = vl_msg_api_alloc_as_if_client(sizeof(*mp) + n); \
clib_memset (mp, 0, sizeof (*mp)); \
mp->_vl_msg_id = ntohs (VL_API_##T+__plugin_msg_base); \
mp->client_index = vam->my_client_index; \
} while(0);
vl_socket_client_msg_alloc
void * vl_socket_client_msg_alloc(int nbytes)
Definition: socket_client.c:227
vl_msg_api_alloc_as_if_client
void * vl_msg_api_alloc_as_if_client(int nbytes)
Definition: memory_shared.c:236

Definition at line 52 of file vat_helper_macros.h.

◆ MPING

#define MPING (   T,
  mp 
)
Value:
do { \
socket_client_main_t *scm = vam->socket_client_main; \
vam->result_ready = 0; \
if (scm && scm->socket_enable) \
mp = vl_socket_client_msg_alloc (sizeof(*mp)); \
else \
mp = vl_msg_api_alloc_as_if_client(sizeof(*mp)); \
clib_memset (mp, 0, sizeof (*mp)); \
mp->_vl_msg_id = ntohs (VL_API_##T+__plugin_msg_base); \
mp->client_index = vam->my_client_index; \
if (scm) \
scm->control_pings_outstanding++; \
} while(0);
vl_socket_client_msg_alloc
void * vl_socket_client_msg_alloc(int nbytes)
Definition: socket_client.c:227
vl_msg_api_alloc_as_if_client
void * vl_msg_api_alloc_as_if_client(int nbytes)
Definition: memory_shared.c:236

Definition at line 37 of file vat_helper_macros.h.

◆ S

#define S (   mp)
Value:
do { \
socket_client_main_t *scm = vam->socket_client_main; \
if (scm && scm->socket_enable) \
vl_socket_client_write (); \
else \
vl_msg_api_send_shmem (vam->vl_input_queue, (u8 *)&mp); \
} while (0);
u8
unsigned char u8
Definition: types.h:56
vl_msg_api_send_shmem
void vl_msg_api_send_shmem(svm_queue_t *q, u8 *elem)
Definition: memory_shared.c:753

Definition at line 66 of file vat_helper_macros.h.

◆ VAT_PLUGIN_REGISTER

#define VAT_PLUGIN_REGISTER (   plug)
Value:
clib_error_t * vat_plugin_register (vat_main_t *vam) \
{ \
plug##_test_main_t * mp = &plug##_test_main; \
u8 * name; \
\
mp->vat_main = vam; \
\
/* Ask the vpp engine for the first assigned message-id */ \
name = format (0, #plug "_%08x%c", api_version, 0); \
mp->msg_id_base = \
vl_client_get_first_plugin_msg_id ((char *) name); \
vec_free(name); \
\
if (mp->msg_id_base != (u16) ~0) \
plug##_api_hookup (vam); \
else \
return clib_error_return (0, #plug " plugin not loaded...");\
return 0; \
}
format
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
clib_error_return
#define clib_error_return(e, args...)
Definition: error.h:99
u16
unsigned short u16
Definition: types.h:57
name
string name[64]
Definition: ip.api:44
clib_error_t
Definition: clib_error.h:21

Definition at line 112 of file vat_helper_macros.h.

◆ W

#define W (   ret)
Value:
do { \
f64 timeout = vat_time_now (vam) + 1.0; \
socket_client_main_t *scm = vam->socket_client_main; \
ret = -99; \
\
if (scm && scm->socket_enable) \
vl_socket_client_read (5); \
while (vat_time_now (vam) < timeout) { \
if (vam->result_ready == 1) { \
ret = vam->retval; \
break; \
} \
vat_suspend (vam->vlib_main, 1e-5); \
} \
} while(0);

Definition at line 76 of file vat_helper_macros.h.

◆ W2

#define W2 (   ret,
  body 
)
Value:
do { \
f64 timeout = vat_time_now (vam) + 1.0; \
socket_client_main_t *scm = vam->socket_client_main; \
ret = -99; \
\
if (scm && scm->socket_enable) \
vl_socket_client_read (5); \
while (vat_time_now (vam) < timeout) { \
if (vam->result_ready == 1) { \
(body); \
ret = vam->retval; \
break; \
} \
vat_suspend (vam->vlib_main, 1e-5); \
} \
} while(0);

Definition at line 94 of file vat_helper_macros.h.