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_api_send_msg (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_api_send_msg (rp, (u8 *)rmp); \
62 #define REPLY_MACRO2_ZERO(t, 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_zero (sizeof (*rmp)); \
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_api_send_msg (rp, (u8 *)rmp); \
78 #define REPLY_MACRO_DETAILS2(t, body) \
80 vl_api_registration_t *rp; \
81 rv = vl_msg_api_pd_handler (mp, rv); \
82 rp = vl_api_client_index_to_registration (mp->client_index); \
86 rmp = vl_msg_api_alloc (sizeof (*rmp)); \
87 rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
88 rmp->context = mp->context; \
89 do {body;} while (0); \
90 vl_api_send_msg (rp, (u8 *)rmp); \
93 #define REPLY_MACRO_DETAILS4(t, rp, context, body) \
95 rmp = vl_msg_api_alloc (sizeof (*rmp)); \
96 rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
97 rmp->context = context; \
98 do {body;} while (0); \
99 vl_api_send_msg (rp, (u8 *)rmp); \
102 #define REPLY_MACRO3(t, n, body) \
104 vl_api_registration_t *rp; \
105 rv = vl_msg_api_pd_handler (mp, rv); \
106 rp = vl_api_client_index_to_registration (mp->client_index); \
110 rmp = vl_msg_api_alloc (sizeof (*rmp) + n); \
111 rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
112 rmp->context = mp->context; \
113 rmp->retval = ntohl(rv); \
114 do {body;} while (0); \
115 vl_api_send_msg (rp, (u8 *)rmp); \
118 #define REPLY_MACRO3_ZERO(t, n, body) \
120 vl_api_registration_t *rp; \
121 rv = vl_msg_api_pd_handler (mp, rv); \
122 rp = vl_api_client_index_to_registration (mp->client_index); \
126 rmp = vl_msg_api_alloc_zero (sizeof (*rmp) + n); \
127 rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
128 rmp->context = mp->context; \
129 rmp->retval = ntohl(rv); \
130 do {body;} while (0); \
131 vl_api_send_msg (rp, (u8 *)rmp); \
134 #define REPLY_MACRO4(t, n, body) \
136 vl_api_registration_t *rp; \
138 rv = vl_msg_api_pd_handler (mp, rv); \
140 rp = vl_api_client_index_to_registration (mp->client_index); \
144 rmp = vl_msg_api_alloc_or_null (sizeof (*rmp) + n); \
147 /* if there isn't enough memory, try to allocate */ \
148 /* some at least for returning an error */ \
149 rmp = vl_msg_api_alloc (sizeof (*rmp)); \
153 clib_memset (rmp, 0, sizeof (*rmp)); \
154 rv = VNET_API_ERROR_TABLE_TOO_BIG; \
157 rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
158 rmp->context = mp->context; \
159 rmp->retval = ntohl(rv); \
161 do {body;} while (0); \
162 vl_api_send_msg (rp, (u8 *)rmp); \
165 #define REPLY_AND_DETAILS_MACRO(t, p, body) \
167 vl_api_registration_t *rp; \
168 rp = vl_api_client_index_to_registration (mp->client_index); \
171 u32 cursor = clib_net_to_host_u32 (mp->cursor); \
172 vlib_main_t *vm = vlib_get_main (); \
173 f64 start = vlib_time_now (vm); \
174 if (pool_is_free_index (p, cursor)) { \
175 cursor = pool_next_index (p, cursor); \
177 rv = VNET_API_ERROR_INVALID_VALUE; \
179 while (cursor != ~0) { \
180 do {body;} while (0); \
181 cursor = pool_next_index (p, cursor); \
182 if (vl_api_process_may_suspend (vm, rp, start)) { \
184 rv = VNET_API_ERROR_EAGAIN; \
188 REPLY_MACRO2 (t, ({ \
189 rmp->cursor = clib_host_to_net_u32 (cursor); \
193 /* "trust, but verify" */
196 vnet_sw_if_index_is_api_valid (u32 sw_if_index)
198 return vnet_sw_interface_is_api_valid (vnet_get_main (), sw_if_index);
201 #define VALIDATE_SW_IF_INDEX(mp) \
202 do { u32 __sw_if_index = ntohl((mp)->sw_if_index); \
203 if (!vnet_sw_if_index_is_api_valid(__sw_if_index)) { \
204 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; \
205 goto bad_sw_if_index; \
209 #define BAD_SW_IF_INDEX_LABEL \
215 #define VALIDATE_RX_SW_IF_INDEX(mp) \
216 do { u32 __rx_sw_if_index = ntohl((mp)->rx_sw_if_index); \
217 if (!vnet_sw_if_index_is_api_valid(__rx_sw_if_index)) { \
218 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; \
219 goto bad_rx_sw_if_index; \
223 #define BAD_RX_SW_IF_INDEX_LABEL \
225 bad_rx_sw_if_index: \
229 #define VALIDATE_TX_SW_IF_INDEX(mp) \
230 do { u32 __tx_sw_if_index = ntohl(mp->tx_sw_if_index); \
231 if (!vnet_sw_if_index_is_api_valid(__tx_sw_if_index)) { \
232 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; \
233 goto bad_tx_sw_if_index; \
237 #define BAD_TX_SW_IF_INDEX_LABEL \
239 bad_tx_sw_if_index: \
243 #define VALIDATE_BD_ID(mp) \
244 do { u32 __rx_bd_id = ntohl(mp->bd_id); \
245 if (__rx_bd_id > L2_BD_ID_MAX) { \
246 rv = VNET_API_ERROR_BD_ID_EXCEED_MAX; \
251 #define BAD_BD_ID_LABEL \
257 #define pub_sub_handler(lca,UCA) \
258 static void vl_api_want_##lca##_t_handler ( \
259 vl_api_want_##lca##_t *mp) \
261 vpe_api_main_t *vam = &vpe_api_main; \
262 vpe_client_registration_t *rp; \
263 vl_api_want_##lca##_reply_t *rmp; \
267 p = hash_get (vam->lca##_registration_hash, mp->client_index); \
269 if (mp->enable_disable) { \
270 clib_warning ("pid %d: already enabled...", ntohl(mp->pid)); \
271 rv = VNET_API_ERROR_INVALID_REGISTRATION; \
274 rp = pool_elt_at_index (vam->lca##_registrations, p[0]); \
275 pool_put (vam->lca##_registrations, rp); \
276 hash_unset (vam->lca##_registration_hash, \
281 if (mp->enable_disable == 0) { \
282 clib_warning ("pid %d: already disabled...", mp->pid); \
283 rv = VNET_API_ERROR_INVALID_REGISTRATION; \
286 pool_get (vam->lca##_registrations, rp); \
287 rp->client_index = mp->client_index; \
288 rp->client_pid = mp->pid; \
289 hash_set (vam->lca##_registration_hash, rp->client_index, \
290 rp - vam->lca##_registrations); \
293 REPLY_MACRO (VL_API_WANT_##UCA##_REPLY); \
296 static clib_error_t * vl_api_want_##lca##_t_reaper (u32 client_index) \
298 vpe_api_main_t *vam = &vpe_api_main; \
299 vpe_client_registration_t *rp; \
302 p = hash_get (vam->lca##_registration_hash, client_index); \
305 rp = pool_elt_at_index (vam->lca##_registrations, p[0]); \
306 pool_put (vam->lca##_registrations, rp); \
307 hash_unset (vam->lca##_registration_hash, client_index); \
312 VL_MSG_API_REAPER_FUNCTION (vl_api_want_##lca##_t_reaper); \
314 #define foreach_registration_hash \
315 _(interface_events) \
316 _(to_netconf_server) \
317 _(from_netconf_server) \
318 _(to_netconf_client) \
319 _(from_netconf_client) \
322 _(l2_arp_term_events) \
324 _(dhcp6_pd_reply_events) \
325 _(dhcp6_reply_events)
329 u32 client_index; /* in memclnt registration pool */
331 } vpe_client_registration_t;
336 uword *a##_registration_hash; \
337 vpe_client_registration_t * a##_registrations;
338 foreach_registration_hash
340 /* notifications happen really early in the game */
341 u8 link_state_process_up;
344 vlib_main_t *vlib_main;
345 vnet_main_t *vnet_main;
348 extern vpe_api_main_t vpe_api_main;
350 #endif /* __api_helper_macros_h__ */
353 * fd.io coding-style-patch-verification: ON
356 * eval: (c-set-style "gnu")