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_MACRO_DETAILS2(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 (sizeof (*rmp)); \
71 rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
72 rmp->context = mp->context; \
73 do {body;} while (0); \
74 vl_api_send_msg (rp, (u8 *)rmp); \
77 #define REPLY_MACRO3(t, n, body) \
79 vl_api_registration_t *rp; \
80 rv = vl_msg_api_pd_handler (mp, rv); \
81 rp = vl_api_client_index_to_registration (mp->client_index); \
85 rmp = vl_msg_api_alloc (sizeof (*rmp) + n); \
86 rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
87 rmp->context = mp->context; \
88 rmp->retval = ntohl(rv); \
89 do {body;} while (0); \
90 vl_api_send_msg (rp, (u8 *)rmp); \
93 #define REPLY_MACRO4(t, n, body) \
95 vl_api_registration_t *rp; \
97 rv = vl_msg_api_pd_handler (mp, rv); \
99 rp = vl_api_client_index_to_registration (mp->client_index); \
103 rmp = vl_msg_api_alloc_or_null (sizeof (*rmp) + n); \
106 /* if there isn't enough memory, try to allocate */ \
107 /* some at least for returning an error */ \
108 rmp = vl_msg_api_alloc (sizeof (*rmp)); \
112 clib_memset (rmp, 0, sizeof (*rmp)); \
113 rv = VNET_API_ERROR_TABLE_TOO_BIG; \
116 rmp->_vl_msg_id = htons((t)+(REPLY_MSG_ID_BASE)); \
117 rmp->context = mp->context; \
118 rmp->retval = ntohl(rv); \
120 do {body;} while (0); \
121 vl_api_send_msg (rp, (u8 *)rmp); \
124 /* "trust, but verify" */
127 vnet_sw_if_index_is_api_valid (u32 sw_if_index)
129 return vnet_sw_interface_is_api_valid (vnet_get_main (), sw_if_index);
132 #define VALIDATE_SW_IF_INDEX(mp) \
133 do { u32 __sw_if_index = ntohl((mp)->sw_if_index); \
134 if (!vnet_sw_if_index_is_api_valid(__sw_if_index)) { \
135 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; \
136 goto bad_sw_if_index; \
140 #define BAD_SW_IF_INDEX_LABEL \
146 #define VALIDATE_RX_SW_IF_INDEX(mp) \
147 do { u32 __rx_sw_if_index = ntohl((mp)->rx_sw_if_index); \
148 if (!vnet_sw_if_index_is_api_valid(__rx_sw_if_index)) { \
149 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; \
150 goto bad_rx_sw_if_index; \
154 #define BAD_RX_SW_IF_INDEX_LABEL \
156 bad_rx_sw_if_index: \
160 #define VALIDATE_TX_SW_IF_INDEX(mp) \
161 do { u32 __tx_sw_if_index = ntohl(mp->tx_sw_if_index); \
162 if (!vnet_sw_if_index_is_api_valid(__tx_sw_if_index)) { \
163 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX; \
164 goto bad_tx_sw_if_index; \
168 #define BAD_TX_SW_IF_INDEX_LABEL \
170 bad_tx_sw_if_index: \
174 #define VALIDATE_BD_ID(mp) \
175 do { u32 __rx_bd_id = ntohl(mp->bd_id); \
176 if (__rx_bd_id > L2_BD_ID_MAX) { \
177 rv = VNET_API_ERROR_BD_ID_EXCEED_MAX; \
182 #define BAD_BD_ID_LABEL \
188 #define pub_sub_handler(lca,UCA) \
189 static void vl_api_want_##lca##_t_handler ( \
190 vl_api_want_##lca##_t *mp) \
192 vpe_api_main_t *vam = &vpe_api_main; \
193 vpe_client_registration_t *rp; \
194 vl_api_want_##lca##_reply_t *rmp; \
198 p = hash_get (vam->lca##_registration_hash, mp->client_index); \
200 if (mp->enable_disable) { \
201 clib_warning ("pid %d: already enabled...", ntohl(mp->pid)); \
202 rv = VNET_API_ERROR_INVALID_REGISTRATION; \
205 rp = pool_elt_at_index (vam->lca##_registrations, p[0]); \
206 pool_put (vam->lca##_registrations, rp); \
207 hash_unset (vam->lca##_registration_hash, \
212 if (mp->enable_disable == 0) { \
213 clib_warning ("pid %d: already disabled...", mp->pid); \
214 rv = VNET_API_ERROR_INVALID_REGISTRATION; \
217 pool_get (vam->lca##_registrations, rp); \
218 rp->client_index = mp->client_index; \
219 rp->client_pid = mp->pid; \
220 hash_set (vam->lca##_registration_hash, rp->client_index, \
221 rp - vam->lca##_registrations); \
224 REPLY_MACRO (VL_API_WANT_##UCA##_REPLY); \
227 static clib_error_t * vl_api_want_##lca##_t_reaper (u32 client_index) \
229 vpe_api_main_t *vam = &vpe_api_main; \
230 vpe_client_registration_t *rp; \
233 p = hash_get (vam->lca##_registration_hash, client_index); \
236 rp = pool_elt_at_index (vam->lca##_registrations, p[0]); \
237 pool_put (vam->lca##_registrations, rp); \
238 hash_unset (vam->lca##_registration_hash, client_index); \
243 VL_MSG_API_REAPER_FUNCTION (vl_api_want_##lca##_t_reaper); \
245 #define foreach_registration_hash \
246 _(interface_events) \
247 _(to_netconf_server) \
248 _(from_netconf_server) \
249 _(to_netconf_client) \
250 _(from_netconf_client) \
253 _(l2_arp_term_events) \
255 _(dhcp6_pd_reply_events) \
256 _(dhcp6_reply_events)
260 u32 client_index; /* in memclnt registration pool */
262 } vpe_client_registration_t;
267 uword *a##_registration_hash; \
268 vpe_client_registration_t * a##_registrations;
269 foreach_registration_hash
271 /* notifications happen really early in the game */
272 u8 link_state_process_up;
275 vlib_main_t *vlib_main;
276 vnet_main_t *vnet_main;
279 extern vpe_api_main_t vpe_api_main;
281 #endif /* __api_helper_macros_h__ */
284 * fd.io coding-style-patch-verification: ON
287 * eval: (c-set-style "gnu")