2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 *------------------------------------------------------------------
17 * sample.c - simple MAC-swap API / debug CLI handling
18 *------------------------------------------------------------------
21 #include <vnet/vnet.h>
22 #include <vnet/plugin/plugin.h>
23 #include <sample/sample.h>
25 #include <vlibapi/api.h>
26 #include <vlibmemory/api.h>
27 #include <vlibsocket/api.h>
29 /* define message IDs */
30 #include <sample/sample_msg_enum.h>
32 /* define message structures */
34 #include <sample/sample_all_api_h.h>
37 /* define generated endian-swappers */
39 #include <sample/sample_all_api_h.h>
42 /* instantiate all the print functions we know about */
43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
45 #include <sample/sample_all_api_h.h>
48 /* Get the API version number */
49 #define vl_api_version(n,v) static u32 api_version=(v);
50 #include <sample/sample_all_api_h.h>
54 * A handy macro to set up a message reply.
55 * Assumes that the following variables are available:
56 * mp - pointer to request message
57 * rmp - pointer to reply message type
61 #define REPLY_MACRO(t) \
63 unix_shared_memory_queue_t * q = \
64 vl_api_client_index_to_input_queue (mp->client_index); \
68 rmp = vl_msg_api_alloc (sizeof (*rmp)); \
69 rmp->_vl_msg_id = ntohs((t)+sm->msg_id_base); \
70 rmp->context = mp->context; \
71 rmp->retval = ntohl(rv); \
73 vl_msg_api_send_shmem (q, (u8 *)&rmp); \
77 /* List of message types that this plugin understands */
79 #define foreach_sample_plugin_api_msg \
80 _(SAMPLE_MACSWAP_ENABLE_DISABLE, sample_macswap_enable_disable)
83 VLIB_PLUGIN_REGISTER () = {
84 .version = SAMPLE_PLUGIN_BUILD_VER,
88 /* Action function shared between message handler and debug CLI */
90 int sample_macswap_enable_disable (sample_main_t * sm, u32 sw_if_index,
93 vnet_sw_interface_t * sw;
97 if (pool_is_free_index (sm->vnet_main->interface_main.sw_interfaces,
99 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
101 /* Not a physical port? */
102 sw = vnet_get_sw_interface (sm->vnet_main, sw_if_index);
103 if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
104 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
106 vnet_feature_enable_disable ("device-input", "sample",
107 sw_if_index, enable_disable, 0, 0);
112 static clib_error_t *
113 macswap_enable_disable_command_fn (vlib_main_t * vm,
114 unformat_input_t * input,
115 vlib_cli_command_t * cmd)
117 sample_main_t * sm = &sample_main;
118 u32 sw_if_index = ~0;
119 int enable_disable = 1;
123 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) {
124 if (unformat (input, "disable"))
126 else if (unformat (input, "%U", unformat_vnet_sw_interface,
127 sm->vnet_main, &sw_if_index))
133 if (sw_if_index == ~0)
134 return clib_error_return (0, "Please specify an interface...");
136 rv = sample_macswap_enable_disable (sm, sw_if_index, enable_disable);
142 case VNET_API_ERROR_INVALID_SW_IF_INDEX:
143 return clib_error_return
144 (0, "Invalid interface, only works on physical ports");
147 case VNET_API_ERROR_UNIMPLEMENTED:
148 return clib_error_return (0, "Device driver doesn't support redirection");
152 return clib_error_return (0, "sample_macswap_enable_disable returned %d",
158 VLIB_CLI_COMMAND (sr_content_command, static) = {
159 .path = "sample macswap",
161 "sample macswap <interface-name> [disable]",
162 .function = macswap_enable_disable_command_fn,
165 /* API message handler */
166 static void vl_api_sample_macswap_enable_disable_t_handler
167 (vl_api_sample_macswap_enable_disable_t * mp)
169 vl_api_sample_macswap_enable_disable_reply_t * rmp;
170 sample_main_t * sm = &sample_main;
173 rv = sample_macswap_enable_disable (sm, ntohl(mp->sw_if_index),
174 (int) (mp->enable_disable));
176 REPLY_MACRO(VL_API_SAMPLE_MACSWAP_ENABLE_DISABLE_REPLY);
179 /* Set up the API message handling tables */
180 static clib_error_t *
181 sample_plugin_api_hookup (vlib_main_t *vm)
183 sample_main_t * sm = &sample_main;
185 vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base), \
187 vl_api_##n##_t_handler, \
189 vl_api_##n##_t_endian, \
190 vl_api_##n##_t_print, \
191 sizeof(vl_api_##n##_t), 1);
192 foreach_sample_plugin_api_msg;
198 #define vl_msg_name_crc_list
199 #include <sample/sample_all_api_h.h>
200 #undef vl_msg_name_crc_list
203 setup_message_id_table (sample_main_t * sm, api_main_t *am)
205 #define _(id,n,crc) \
206 vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + sm->msg_id_base);
207 foreach_vl_msg_name_crc_sample;
211 static clib_error_t * sample_init (vlib_main_t * vm)
213 sample_main_t * sm = &sample_main;
214 clib_error_t * error = 0;
217 sm->vnet_main = vnet_get_main ();
219 name = format (0, "sample_%08x%c", api_version, 0);
221 /* Ask for a correctly-sized block of API message decode slots */
222 sm->msg_id_base = vl_msg_api_get_msg_ids
223 ((char *) name, VL_MSG_FIRST_AVAILABLE);
225 error = sample_plugin_api_hookup (vm);
227 /* Add our API messages to the global name_crc hash table */
228 setup_message_id_table (sm, &api_main);
235 VLIB_INIT_FUNCTION (sample_init);
237 VNET_FEATURE_INIT (sample, static) =
239 .arc_name = "device-input",
240 .node_name = "sample",
241 .runs_before = VNET_FEATURES ("ethernet-input"),