api_helper_macros.h File Reference

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	VALIDATE_BD_ID(mp)
#define	BAD_BD_ID_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

BAD_BD_ID_LABEL

#define BAD_BD_ID_LABEL

Value:

do {                                            \
bad_bd_id:                                      \
    ;                                           \
} while (0);

Definition at line 167 of file api_helper_macros.h.

BAD_RX_SW_IF_INDEX_LABEL

#define BAD_RX_SW_IF_INDEX_LABEL

Value:

do {                                            \
bad_rx_sw_if_index:                             \
    ;                                           \
} while (0);

Definition at line 139 of file api_helper_macros.h.

BAD_SW_IF_INDEX_LABEL

#define BAD_SW_IF_INDEX_LABEL

Value:

do {                                            \
bad_sw_if_index:                                \
    ;                                           \
} while (0);

Definition at line 125 of file api_helper_macros.h.

BAD_TX_SW_IF_INDEX_LABEL

#define BAD_TX_SW_IF_INDEX_LABEL

Value:

do {                                            \
bad_tx_sw_if_index:                             \
    ;                                           \
} while (0);

Definition at line 153 of file api_helper_macros.h.

f64_endian

#define f64_endian

(

a

)

Definition at line 23 of file api_helper_macros.h.

f64_print

#define f64_print	(		a,
			b
	)

Definition at line 24 of file api_helper_macros.h.

foreach_registration_hash

#define foreach_registration_hash

Value:

_(interface_events)                             \
_(to_netconf_server)                            \
_(from_netconf_server)                          \
_(to_netconf_client)                            \
_(from_netconf_client)                          \
_(oam_events)                                   \
_(bfd_events)                                   \
_(wc_ip6_nd_events)                             \
_(wc_ip4_arp_events)                            \
_(ip6_ra_events)                                \
_(dhcp6_pd_reply_events)                        \
_(dhcp6_reply_events)

Definition at line 230 of file api_helper_macros.h.

pub_sub_handler

#define pub_sub_handler	(		lca,
			UCA
	)

Definition at line 173 of file api_helper_macros.h.

REPLY_MACRO

#define REPLY_MACRO

(

t

)

Value:

do {                                                                    \
    vl_api_registration_t *rp;                                          \
    rv = vl_msg_api_pd_handler (mp, rv);                                \
    rp = vl_api_client_index_to_registration (mp->client_index);        \
    if (rp == 0)                                                        \
      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_api_send_msg (rp, (u8 *)rmp);                                    \
} while(0);

Definition at line 30 of file api_helper_macros.h.

REPLY_MACRO2

#define REPLY_MACRO2	(		t,
			body
	)

Value:

do {                                                                    \
    vl_api_registration_t *rp;                                          \
    rv = vl_msg_api_pd_handler (mp, rv);                                \
    rp = vl_api_client_index_to_registration (mp->client_index);        \
    if (rp == 0)                                                        \
      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_api_send_msg (rp, (u8 *)rmp);                                    \
} while(0);

Definition at line 46 of file api_helper_macros.h.

REPLY_MACRO3

#define REPLY_MACRO3	(		t,
			n,
			body
	)

Value:

do {                                                                    \
    vl_api_registration_t *rp;                                          \
    rv = vl_msg_api_pd_handler (mp, rv);                                \
    rp = vl_api_client_index_to_registration (mp->client_index);        \
    if (rp == 0)                                                        \
      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_api_send_msg (rp, (u8 *)rmp);                                    \
} while(0);

Definition at line 62 of file api_helper_macros.h.

REPLY_MACRO4

#define REPLY_MACRO4	(		t,
			n,
			body
	)

Value:

do {                                                                    \
    vl_api_registration_t *rp;                                          \
    u8 is_error = 0;                                                    \
    rv = vl_msg_api_pd_handler (mp, rv);                                \
                                                                        \
    rp = vl_api_client_index_to_registration (mp->client_index);        \
    if (rp == 0)                                                        \
      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;                                                       \
                                                                        \
        clib_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_api_send_msg (rp, (u8 *)rmp);                                    \
} while(0);

Definition at line 78 of file api_helper_macros.h.

REPLY_MSG_ID_BASE

#define REPLY_MSG_ID_BASE   0

Definition at line 27 of file api_helper_macros.h.

VALIDATE_BD_ID

#define VALIDATE_BD_ID

(

mp

)

Value:

do { u32 __rx_bd_id = ntohl(mp->bd_id); \
    if (__rx_bd_id > L2_BD_ID_MAX) {            \
        rv = VNET_API_ERROR_BD_ID_EXCEED_MAX;   \
        goto bad_bd_id;                         \
    }                                           \
} while(0);

Definition at line 159 of file api_helper_macros.h.

VALIDATE_RX_SW_IF_INDEX

#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);

Definition at line 131 of file api_helper_macros.h.

VALIDATE_SW_IF_INDEX

#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);

Definition at line 117 of file api_helper_macros.h.

VALIDATE_TX_SW_IF_INDEX

#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);

Definition at line 145 of file api_helper_macros.h.

Function Documentation

vnet_sw_if_index_is_api_valid()

static uword vnet_sw_if_index_is_api_valid ( u32  sw_if_index )

inlinestatic

Definition at line 112 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

vpe_api_main_t vpe_api_main

Definition at line 49 of file interface_api.c.