2 * mactime.c - skeleton vpp-api-test plug-in
4 * Copyright (c) <current-year> <your-organization>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vlibapi/api.h>
19 #include <vlibmemory/api.h>
20 #include <vppinfra/error.h>
21 #include <vppinfra/time_range.h>
22 #include <vnet/ethernet/ethernet.h>
24 uword vat_unformat_sw_if_index (unformat_input_t * input, va_list * args);
26 /* Declare message IDs */
27 #include <mactime/mactime_msg_enum.h>
29 /* define message structures */
31 #include <mactime/mactime_all_api_h.h>
34 /* declare message handlers for each api */
36 #define vl_endianfun /* define message structures */
37 #include <mactime/mactime_all_api_h.h>
40 /* instantiate all the print functions we know about */
41 #define vl_print(handle, ...)
43 #include <mactime/mactime_all_api_h.h>
46 /* Get the API version number. */
47 #define vl_api_version(n,v) static u32 api_version=(v);
48 #include <mactime/mactime_all_api_h.h>
53 /* API message ID base */
56 } mactime_test_main_t;
58 mactime_test_main_t mactime_test_main;
60 #define __plugin_msg_base mactime_test_main.msg_id_base
61 #include <vlibapi/vat_helper_macros.h>
63 #define foreach_standard_reply_retval_handler \
64 _(mactime_enable_disable_reply) \
65 _(mactime_add_del_range_reply)
68 static void vl_api_##n##_t_handler \
69 (vl_api_##n##_t * mp) \
71 vat_main_t * vam = mactime_test_main.vat_main; \
72 i32 retval = ntohl(mp->retval); \
73 if (vam->async_mode) { \
74 vam->async_errors += (retval < 0); \
76 vam->retval = retval; \
77 vam->result_ready = 1; \
80 foreach_standard_reply_retval_handler;
84 * Table of message reply handlers, must include boilerplate handlers
87 #define foreach_vpe_api_reply_msg \
88 _(MACTIME_ENABLE_DISABLE_REPLY, mactime_enable_disable_reply) \
89 _(MACTIME_ADD_DEL_RANGE_REPLY, mactime_add_del_range_reply)
92 api_mactime_enable_disable (vat_main_t * vam)
94 unformat_input_t *i = vam->input;
95 int enable_disable = 1;
97 vl_api_mactime_enable_disable_t *mp;
100 /* Parse args required to build the message */
101 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
103 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
105 else if (unformat (i, "sw_if_index %d", &sw_if_index))
107 else if (unformat (i, "disable"))
113 if (sw_if_index == ~0)
115 errmsg ("missing interface name / explicit sw_if_index number \n");
119 /* Construct the API message */
120 M (MACTIME_ENABLE_DISABLE, mp);
121 mp->sw_if_index = ntohl (sw_if_index);
122 mp->enable_disable = enable_disable;
127 /* Wait for a reply... */
132 /* These two ought to be in a library somewhere but they aren't */
134 my_unformat_mac_address (unformat_input_t * input, va_list * args)
136 u8 *a = va_arg (*args, u8 *);
137 return unformat (input, "%x:%x:%x:%x:%x:%x", &a[0], &a[1], &a[2], &a[3],
142 my_format_mac_address (u8 * s, va_list * args)
144 u8 *a = va_arg (*args, u8 *);
145 return format (s, "%02x:%02x:%02x:%02x:%02x:%02x",
146 a[0], a[1], a[2], a[3], a[4], a[5]);
150 api_mactime_add_del_range (vat_main_t * vam)
152 unformat_input_t *i = vam->input;
153 vl_api_mactime_add_del_range_t *mp;
156 clib_timebase_range_t *rp = 0;
165 /* Parse args required to build the message */
166 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
168 if (unformat (i, "name %s", &device_name))
170 vec_add1 (device_name, 0);
173 else if (unformat (i, "allow-range %U",
174 unformat_clib_timebase_range_vector, &rp))
176 else if (unformat (i, "drop-range %U",
177 unformat_clib_timebase_range_vector, &rp))
179 else if (unformat (i, "allow-static"))
181 else if (unformat (i, "drop-static"))
183 else if (unformat (i, "mac %U", my_unformat_mac_address, mac_address))
185 else if (unformat (i, "del"))
195 vec_free (device_name);
196 errmsg ("mac address required, not set\n");
200 /* allow-range / drop-range parse errors cause this condition */
201 if (is_add && allow == 0 && drop == 0)
204 vec_free (device_name);
205 errmsg ("neither allow nor drop set, parse error...\n");
208 /* Unlikely, but check anyhow */
209 if (vec_len (device_name) > ARRAY_LEN (mp->device_name))
212 vec_free (device_name);
213 errmsg ("device name too long, max %d\n", ARRAY_LEN (mp->device_name));
217 /* Cough up a device name if none set */
220 device_name = format (0, "mac %U%c", my_format_mac_address,
224 /* Construct the API message */
225 M2 (MACTIME_ADD_DEL_RANGE, mp, sizeof (rp[0]) * vec_len (rp));
229 memcpy (mp->mac_address, mac_address, sizeof (mp->mac_address));
230 memcpy (mp->device_name, device_name, vec_len (device_name));
231 mp->count = clib_host_to_net_u32 (vec_len (rp));
233 for (ii = 0; ii < vec_len (rp); ii++)
235 mp->ranges[ii].start = rp[ii].start;
236 mp->ranges[ii].end = rp[ii].end;
240 vec_free (device_name);
245 /* Wait for a reply... */
251 * List of messages that the api test plugin sends,
252 * and that the data plane plugin processes
254 #define foreach_vpe_api_msg \
255 _(mactime_enable_disable, "<intfc> [disable]") \
256 _(mactime_add_del_range, \
257 "name <devname> mac <mac-addr> allow drop\n" \
258 "allow-range Mon - Fri 9:00 - 17:00")
261 mactime_api_hookup (vat_main_t * vam)
263 mactime_test_main_t *sm = &mactime_test_main;
264 /* Hook up handlers for replies from the data plane plug-in */
266 vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base), \
268 vl_api_##n##_t_handler, \
270 vl_api_##n##_t_endian, \
271 vl_api_##n##_t_print, \
272 sizeof(vl_api_##n##_t), 1);
273 foreach_vpe_api_reply_msg;
276 /* API messages we can send */
277 #define _(n,h) hash_set_mem (vam->function_by_name, #n, api_##n);
282 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
288 vat_plugin_register (vat_main_t * vam)
290 mactime_test_main_t *sm = &mactime_test_main;
295 /* Ask the vpp engine for the first assigned message-id */
296 name = format (0, "mactime_%08x%c", api_version, 0);
297 sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
299 if (sm->msg_id_base != (u16) ~ 0)
300 mactime_api_hookup (vam);
308 * fd.io coding-style-patch-verification: ON
311 * eval: (c-set-style "gnu")