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>
23 uword vat_unformat_sw_if_index (unformat_input_t * input, va_list * args);
25 /* Declare message IDs */
26 #include <mactime/mactime_msg_enum.h>
28 /* define message structures */
30 #include <mactime/mactime_all_api_h.h>
33 /* declare message handlers for each api */
35 #define vl_endianfun /* define message structures */
36 #include <mactime/mactime_all_api_h.h>
39 /* instantiate all the print functions we know about */
40 #define vl_print(handle, ...)
42 #include <mactime/mactime_all_api_h.h>
45 /* Get the API version number. */
46 #define vl_api_version(n,v) static u32 api_version=(v);
47 #include <mactime/mactime_all_api_h.h>
52 /* API message ID base */
55 } mactime_test_main_t;
57 mactime_test_main_t mactime_test_main;
59 #define __plugin_msg_base mactime_test_main.msg_id_base
60 #include <vlibapi/vat_helper_macros.h>
62 #define foreach_standard_reply_retval_handler \
63 _(mactime_enable_disable_reply) \
64 _(mactime_add_del_range_reply)
67 static void vl_api_##n##_t_handler \
68 (vl_api_##n##_t * mp) \
70 vat_main_t * vam = mactime_test_main.vat_main; \
71 i32 retval = ntohl(mp->retval); \
72 if (vam->async_mode) { \
73 vam->async_errors += (retval < 0); \
75 vam->retval = retval; \
76 vam->result_ready = 1; \
79 foreach_standard_reply_retval_handler;
83 format_mac_address (u8 * s, va_list * args)
85 u8 *a = va_arg (*args, u8 *);
86 return format (s, "%02x:%02x:%02x:%02x:%02x:%02x",
87 a[0], a[1], a[2], a[3], a[4], a[5]);
91 unformat_mac_address (unformat_input_t * input, va_list * args)
93 u8 *a = va_arg (*args, u8 *);
94 return unformat (input, "%x:%x:%x:%x:%x:%x", &a[0], &a[1], &a[2], &a[3],
99 * Table of message reply handlers, must include boilerplate handlers
102 #define foreach_vpe_api_reply_msg \
103 _(MACTIME_ENABLE_DISABLE_REPLY, mactime_enable_disable_reply) \
104 _(MACTIME_ADD_DEL_RANGE_REPLY, mactime_add_del_range_reply)
107 api_mactime_enable_disable (vat_main_t * vam)
109 unformat_input_t *i = vam->input;
110 int enable_disable = 1;
111 u32 sw_if_index = ~0;
112 vl_api_mactime_enable_disable_t *mp;
115 /* Parse args required to build the message */
116 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
118 if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
120 else if (unformat (i, "sw_if_index %d", &sw_if_index))
122 else if (unformat (i, "disable"))
128 if (sw_if_index == ~0)
130 errmsg ("missing interface name / explicit sw_if_index number \n");
134 /* Construct the API message */
135 M (MACTIME_ENABLE_DISABLE, mp);
136 mp->sw_if_index = ntohl (sw_if_index);
137 mp->enable_disable = enable_disable;
142 /* Wait for a reply... */
148 api_mactime_add_del_range (vat_main_t * vam)
150 unformat_input_t *i = vam->input;
151 vl_api_mactime_add_del_range_t *mp;
154 clib_timebase_range_t *rp = 0;
163 /* Parse args required to build the message */
164 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
166 if (unformat (i, "name %s", &device_name))
168 vec_add1 (device_name, 0);
171 else if (unformat (i, "allow-range %U",
172 unformat_clib_timebase_range_vector, &rp))
174 else if (unformat (i, "drop-range %U",
175 unformat_clib_timebase_range_vector, &rp))
177 else if (unformat (i, "allow-static"))
179 else if (unformat (i, "drop-static"))
181 else if (unformat (i, "mac %U", unformat_mac_address, mac_address))
183 else if (unformat (i, "del"))
193 vec_free (device_name);
194 errmsg ("mac address required, not set\n");
198 /* allow-range / drop-range parse errors cause this condition */
199 if (is_add && allow == 0 && drop == 0)
202 vec_free (device_name);
203 errmsg ("neither allow nor drop set, parse error...\n");
206 /* Unlikely, but check anyhow */
207 if (vec_len (device_name) > ARRAY_LEN (mp->device_name))
210 vec_free (device_name);
211 errmsg ("device name too long, max %d\n", ARRAY_LEN (mp->device_name));
215 /* Cough up a device name if none set */
218 device_name = format (0, "mac %U%c", format_mac_address,
222 /* Construct the API message */
223 M2 (MACTIME_ADD_DEL_RANGE, mp, sizeof (rp[0]) * vec_len (rp));
227 memcpy (mp->mac_address, mac_address, sizeof (mp->mac_address));
228 memcpy (mp->device_name, device_name, vec_len (device_name));
229 mp->count = clib_host_to_net_u32 (vec_len (rp));
231 for (ii = 0; ii < vec_len (rp); ii++)
233 mp->ranges[ii].start = rp[ii].start;
234 mp->ranges[ii].end = rp[ii].end;
238 vec_free (device_name);
243 /* Wait for a reply... */
249 * List of messages that the api test plugin sends,
250 * and that the data plane plugin processes
252 #define foreach_vpe_api_msg \
253 _(mactime_enable_disable, "<intfc> [disable]") \
254 _(mactime_add_del_range, \
255 "name <devname> mac <mac-addr> allow drop\n" \
256 "allow-range Mon - Fri 9:00 - 17:00")
259 mactime_api_hookup (vat_main_t * vam)
261 mactime_test_main_t *sm = &mactime_test_main;
262 /* Hook up handlers for replies from the data plane plug-in */
264 vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base), \
266 vl_api_##n##_t_handler, \
268 vl_api_##n##_t_endian, \
269 vl_api_##n##_t_print, \
270 sizeof(vl_api_##n##_t), 1);
271 foreach_vpe_api_reply_msg;
274 /* API messages we can send */
275 #define _(n,h) hash_set_mem (vam->function_by_name, #n, api_##n);
280 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
286 vat_plugin_register (vat_main_t * vam)
288 mactime_test_main_t *sm = &mactime_test_main;
293 /* Ask the vpp engine for the first assigned message-id */
294 name = format (0, "mactime_%08x%c", api_version, 0);
295 sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
297 if (sm->msg_id_base != (u16) ~ 0)
298 mactime_api_hookup (vam);
306 * fd.io coding-style-patch-verification: ON
309 * eval: (c-set-style "gnu")