2 *------------------------------------------------------------------
3 * api_helper_macros.h - message handler helper macros
5 * Copyright (c) 2016 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #ifndef __api_helper_macros_h__
21 #define __api_helper_macros_h__
24 #define f64_print(a,b)
26 #ifndef REPLY_MSG_ID_BASE
27 #define REPLY_MSG_ID_BASE 0
30 #define REPLY_MACRO(t) \
32 vl_api_registration_t *rp; \
33 rv = vl_msg_api_pd_handler (mp, rv); \
34 rp = vl_api_client_index_to_registration (mp->client_index); \
38 rmp = vl_msg_api_alloc (sizeof (*rmp)); \
39 rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
40 rmp->context = mp->context; \
41 rmp->retval = ntohl(rv); \
43 vl_msg_api_send (rp, (u8 *)rmp); \
46 #define REPLY_MACRO2(t, body) \
48 vl_api_registration_t *rp; \
49 rv = vl_msg_api_pd_handler (mp, rv); \
50 rp = vl_api_client_index_to_registration (mp->client_index); \
54 rmp = vl_msg_api_alloc (sizeof (*rmp)); \
55 rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
56 rmp->context = mp->context; \
57 rmp->retval = ntohl(rv); \
58 do {body;} while (0); \
59 vl_msg_api_send (rp, (u8 *)rmp); \
62 #define REPLY_MACRO3(t, n, body) \
64 vl_api_registration_t *rp; \
65 rv = vl_msg_api_pd_handler (mp, rv); \
66 rp = vl_api_client_index_to_registration (mp->client_index); \
70 rmp = vl_msg_api_alloc (sizeof (*rmp) + n); \
71 rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
72 rmp->context = mp->context; \
73 rmp->retval = ntohl(rv); \
74 do {body;} while (0); \
75 vl_msg_api_send (rp, (u8 *)rmp); \
78 #define REPLY_MACRO4(t, n, body) \
80 vl_api_registration_t *rp; \
82 rv = vl_msg_api_pd_handler (mp, rv); \
84 rp = vl_api_client_index_to_registration (mp->client_index); \
88 rmp = vl_msg_api_alloc_or_null (sizeof (*rmp) + n); \
91 /* if there isn't enough memory, try to allocate */ \
92 /* some at least for returning an error */ \
93 rmp = vl_msg_api_alloc (sizeof (*rmp)); \
97 memset (rmp, 0, sizeof (*rmp)); \
98 rv = VNET_API_ERROR_TABLE_TOO_BIG; \
101 rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
102 rmp->context = mp->context; \
103 rmp->retval = ntohl(rv); \
105 do {body;} while (0); \
106 vl_msg_api_send (rp, (u8 *)rmp); \
109 /* "trust, but verify" */
112 vnet_sw_if_index_is_api_valid (u32 sw_if_index)
114 return vnet_sw_interface_is_api_valid (vnet_get_main (), sw_if_index);
117 #define VALIDATE_SW_IF_INDEX(mp) \
118 do { u32 __sw_if_index = ntohl(mp->sw_if_index); \
119 if (!vnet_sw_if_index_is_api_valid(__sw_if_index)) { \
120 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; \
121 goto bad_sw_if_index; \
125 #define BAD_SW_IF_INDEX_LABEL \
131 #define VALIDATE_RX_SW_IF_INDEX(mp) \
132 do { u32 __rx_sw_if_index = ntohl(mp->rx_sw_if_index); \
133 if (!vnet_sw_if_index_is_api_valid(__rx_sw_if_index)) { \
134 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; \
135 goto bad_rx_sw_if_index; \
139 #define BAD_RX_SW_IF_INDEX_LABEL \
141 bad_rx_sw_if_index: \
145 #define VALIDATE_TX_SW_IF_INDEX(mp) \
146 do { u32 __tx_sw_if_index = ntohl(mp->tx_sw_if_index); \
147 if (!vnet_sw_if_index_is_api_valid(__tx_sw_if_index)) { \
148 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; \
149 goto bad_tx_sw_if_index; \
153 #define BAD_TX_SW_IF_INDEX_LABEL \
155 bad_tx_sw_if_index: \
159 #define VALIDATE_BD_ID(mp) \
160 do { u32 __rx_bd_id = ntohl(mp->bd_id); \
161 if (__rx_bd_id > L2_BD_ID_MAX) { \
162 rv = VNET_API_ERROR_BD_ID_EXCEED_MAX; \
167 #define BAD_BD_ID_LABEL \
173 #define pub_sub_handler(lca,UCA) \
174 static void vl_api_want_##lca##_t_handler ( \
175 vl_api_want_##lca##_t *mp) \
177 vpe_api_main_t *vam = &vpe_api_main; \
178 vpe_client_registration_t *rp; \
179 vl_api_want_##lca##_reply_t *rmp; \
183 p = hash_get (vam->lca##_registration_hash, mp->client_index); \
185 if (mp->enable_disable) { \
186 clib_warning ("pid %d: already enabled...", mp->pid); \
187 rv = VNET_API_ERROR_INVALID_REGISTRATION; \
190 rp = pool_elt_at_index (vam->lca##_registrations, p[0]); \
191 pool_put (vam->lca##_registrations, rp); \
192 hash_unset (vam->lca##_registration_hash, \
197 if (mp->enable_disable == 0) { \
198 clib_warning ("pid %d: already disabled...", mp->pid); \
199 rv = VNET_API_ERROR_INVALID_REGISTRATION; \
202 pool_get (vam->lca##_registrations, rp); \
203 rp->client_index = mp->client_index; \
204 rp->client_pid = mp->pid; \
205 hash_set (vam->lca##_registration_hash, rp->client_index, \
206 rp - vam->lca##_registrations); \
209 REPLY_MACRO (VL_API_WANT_##UCA##_REPLY); \
212 #define foreach_registration_hash \
213 _(interface_events) \
214 _(to_netconf_server) \
215 _(from_netconf_server) \
216 _(to_netconf_client) \
217 _(from_netconf_client) \
220 _(wc_ip6_nd_events) \
225 u32 client_index; /* in memclnt registration pool */
227 } vpe_client_registration_t;
229 struct _vl_api_ip4_arp_event;
230 struct _vl_api_ip6_nd_event;
234 #define _(a) uword *a##_registration_hash; \
235 vpe_client_registration_t * a##_registrations;
236 foreach_registration_hash
238 /* notifications happen really early in the game */
239 u8 link_state_process_up;
241 /* ip4 arp event registration pool */
242 struct _vl_api_ip4_arp_event *arp_events;
244 /* ip6 nd event registration pool */
245 struct _vl_api_ip6_nd_event *nd_events;
248 vlib_main_t *vlib_main;
249 vnet_main_t *vnet_main;
252 extern vpe_api_main_t vpe_api_main;
254 #endif /* __api_helper_macros_h__ */
257 * fd.io coding-style-patch-verification: ON
260 * eval: (c-set-style "gnu")