1 ;;; plugin-main-skel.el - vpp engine plug-in "main.c" skeleton
3 ;;; Copyright (c) 2016 Cisco and/or its affiliates.
4 ;;; Licensed under the Apache License, Version 2.0 (the "License");
5 ;;; you may not use this file except in compliance with the License.
6 ;;; You may obtain a copy of the License at:
8 ;;; http://www.apache.org/licenses/LICENSE-2.0
10 ;;; Unless required by applicable law or agreed to in writing, software
11 ;;; distributed under the License is distributed on an "AS IS" BASIS,
12 ;;; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 ;;; See the License for the specific language governing permissions and
14 ;;; limitations under the License.
18 (define-skeleton skel-plugin-main
19 "Insert a plug-in 'main.c' skeleton "
21 '(if (not (boundp 'plugin-name))
22 (setq plugin-name (read-string "Plugin name: ")))
23 '(setq PLUGIN-NAME (upcase plugin-name))
26 * " plugin-name ".c - skeleton vpp engine plug-in
28 * Copyright (c) <current-year> <your-organization>
29 * Licensed under the Apache License, Version 2.0 (the \"License\");
30 * you may not use this file except in compliance with the License.
31 * You may obtain a copy of the License at:
33 * http://www.apache.org/licenses/LICENSE-2.0
35 * Unless required by applicable law or agreed to in writing, software
36 * distributed under the License is distributed on an \"AS IS\" BASIS,
37 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
38 * See the License for the specific language governing permissions and
39 * limitations under the License.
42 #include <vnet/vnet.h>
43 #include <vnet/plugin/plugin.h>
44 #include <" plugin-name "/" plugin-name ".h>
46 #include <vlibapi/api.h>
47 #include <vlibmemory/api.h>
48 #include <vlibsocket/api.h>
50 /* define message IDs */
51 #include <" plugin-name "/" plugin-name "_msg_enum.h>
53 /* define message structures */
55 #include <" plugin-name "/" plugin-name "_all_api_h.h>
58 /* define generated endian-swappers */
60 #include <" plugin-name "/" plugin-name "_all_api_h.h>
63 /* instantiate all the print functions we know about */
64 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
66 #include <" plugin-name "/" plugin-name "_all_api_h.h>
69 /* Get the API version number */
70 #define vl_api_version(n,v) static u32 api_version=(v);
71 #include <" plugin-name "/" plugin-name "_all_api_h.h>
75 * A handy macro to set up a message reply.
76 * Assumes that the following variables are available:
77 * mp - pointer to request message
78 * rmp - pointer to reply message type
82 #define REPLY_MACRO(t) \\
84 unix_shared_memory_queue_t * q = \\
85 vl_api_client_index_to_input_queue (mp->client_index); \\
89 rmp = vl_msg_api_alloc (sizeof (*rmp)); \\
90 rmp->_vl_msg_id = ntohs((t)+sm->msg_id_base); \\
91 rmp->context = mp->context; \\
92 rmp->retval = ntohl(rv); \\
94 vl_msg_api_send_shmem (q, (u8 *)&rmp); \\
98 /* List of message types that this plugin understands */
100 #define foreach_" plugin-name "_plugin_api_msg \\
101 _(" PLUGIN-NAME "_ENABLE_DISABLE, " plugin-name "_enable_disable)
104 * This routine exists to convince the vlib plugin framework that
105 * we haven't accidentally copied a random .dll into the plugin directory.
107 * Also collects global variable pointers passed from the vpp engine
111 vlib_plugin_register (vlib_main_t * vm, vnet_plugin_handoff_t * h,
114 " plugin-name "_main_t * sm = &" plugin-name "_main;
115 clib_error_t * error = 0;
118 sm->vnet_main = h->vnet_main;
119 sm->ethernet_main = h->ethernet_main;
124 /* Action function shared between message handler and debug CLI */
126 int " plugin-name "_enable_disable (" plugin-name "_main_t * sm, u32 sw_if_index,
129 vnet_sw_interface_t * sw;
133 if (pool_is_free_index (sm->vnet_main->interface_main.sw_interfaces,
135 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
137 /* Not a physical port? */
138 sw = vnet_get_sw_interface (sm->vnet_main, sw_if_index);
139 if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
140 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
142 vnet_feature_enable_disable (\"device-input\", \"" plugin-name "\",
143 sw_if_index, enable_disable, 0, 0);
148 static clib_error_t *
149 " plugin-name "_enable_disable_command_fn (vlib_main_t * vm,
150 unformat_input_t * input,
151 vlib_cli_command_t * cmd)
153 " plugin-name "_main_t * sm = &" plugin-name "_main;
154 u32 sw_if_index = ~0;
155 int enable_disable = 1;
159 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) {
160 if (unformat (input, \"disable\"))
162 else if (unformat (input, \"%U\", unformat_vnet_sw_interface,
163 sm->vnet_main, &sw_if_index))
169 if (sw_if_index == ~0)
170 return clib_error_return (0, \"Please specify an interface...\");
172 rv = " plugin-name "_enable_disable (sm, sw_if_index, enable_disable);
178 case VNET_API_ERROR_INVALID_SW_IF_INDEX:
179 return clib_error_return
180 (0, \"Invalid interface, only works on physical ports\");
183 case VNET_API_ERROR_UNIMPLEMENTED:
184 return clib_error_return (0, \"Device driver doesn't support redirection\");
188 return clib_error_return (0, \"" plugin-name "_enable_disable returned %d\",
194 VLIB_CLI_COMMAND (" plugin-name "_enable_disable_command, static) = {
195 .path = \"" plugin-name " enable-disable\",
197 \"" plugin-name " enable-disable <interface-name> [disable]\",
198 .function = " plugin-name "_enable_disable_command_fn,
201 /* API message handler */
202 static void vl_api_" plugin-name "_enable_disable_t_handler
203 (vl_api_" plugin-name "_enable_disable_t * mp)
205 vl_api_" plugin-name "_enable_disable_reply_t * rmp;
206 " plugin-name "_main_t * sm = &" plugin-name "_main;
209 rv = " plugin-name "_enable_disable (sm, ntohl(mp->sw_if_index),
210 (int) (mp->enable_disable));
212 REPLY_MACRO(VL_API_" PLUGIN-NAME "_ENABLE_DISABLE_REPLY);
215 /* Set up the API message handling tables */
216 static clib_error_t *
217 " plugin-name "_plugin_api_hookup (vlib_main_t *vm)
219 " plugin-name "_main_t * sm = &" plugin-name "_main;
221 vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base), \\
223 vl_api_##n##_t_handler, \\
225 vl_api_##n##_t_endian, \\
226 vl_api_##n##_t_print, \\
227 sizeof(vl_api_##n##_t), 1);
228 foreach_" plugin-name "_plugin_api_msg;
234 #define vl_msg_name_crc_list
235 #include <" plugin-name "/" plugin-name "_all_api_h.h>
236 #undef vl_msg_name_crc_list
239 setup_message_id_table (" plugin-name "_main_t * sm, api_main_t * am)
241 #define _(id,n,crc) \
242 vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + sm->msg_id_base);
243 foreach_vl_msg_name_crc_" plugin-name" ;
247 static clib_error_t * " plugin-name "_init (vlib_main_t * vm)
249 " plugin-name "_main_t * sm = &" plugin-name "_main;
250 clib_error_t * error = 0;
253 name = format (0, \"" plugin-name "_%08x%c\", api_version, 0);
255 /* Ask for a correctly-sized block of API message decode slots */
256 sm->msg_id_base = vl_msg_api_get_msg_ids
257 ((char *) name, VL_MSG_FIRST_AVAILABLE);
259 error = " plugin-name "_plugin_api_hookup (vm);
261 /* Add our API messages to the global name_crc hash table */
262 setup_message_id_table (sm, &api_main);
269 VLIB_INIT_FUNCTION (" plugin-name "_init);
271 VNET_FEATURE_INIT (" plugin-name ", static) =
273 .arc_name = \"device-input\",
274 .node_name = \"" plugin-name "\",
275 .runs_before = VNET_FEATURES (\"ethernet-input\"),