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))
24 '(setq capital-oh-en "ON")
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>
49 #include <vpp/app/version.h>
51 /* define message IDs */
52 #include <" plugin-name "/" plugin-name "_msg_enum.h>
54 /* define message structures */
56 #include <" plugin-name "/" plugin-name "_all_api_h.h>
59 /* define generated endian-swappers */
61 #include <" plugin-name "/" plugin-name "_all_api_h.h>
64 /* instantiate all the print functions we know about */
65 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
67 #include <" plugin-name "/" plugin-name "_all_api_h.h>
70 /* Get the API version number */
71 #define vl_api_version(n,v) static u32 api_version=(v);
72 #include <" plugin-name "/" plugin-name "_all_api_h.h>
76 * A handy macro to set up a message reply.
77 * Assumes that the following variables are available:
78 * mp - pointer to request message
79 * rmp - pointer to reply message type
83 #define REPLY_MACRO(t) \\
85 unix_shared_memory_queue_t * q = \\
86 vl_api_client_index_to_input_queue (mp->client_index); \\
90 rmp = vl_msg_api_alloc (sizeof (*rmp)); \\
91 rmp->_vl_msg_id = ntohs((t)+sm->msg_id_base); \\
92 rmp->context = mp->context; \\
93 rmp->retval = ntohl(rv); \\
95 vl_msg_api_send_shmem (q, (u8 *)&rmp); \\
99 /* List of message types that this plugin understands */
101 #define foreach_" plugin-name "_plugin_api_msg \\
102 _(" PLUGIN-NAME "_ENABLE_DISABLE, " plugin-name "_enable_disable)
104 /* Action function shared between message handler and debug CLI */
106 int " plugin-name "_enable_disable (" plugin-name "_main_t * sm, u32 sw_if_index,
109 vnet_sw_interface_t * sw;
113 if (pool_is_free_index (sm->vnet_main->interface_main.sw_interfaces,
115 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
117 /* Not a physical port? */
118 sw = vnet_get_sw_interface (sm->vnet_main, sw_if_index);
119 if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
120 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
122 vnet_feature_enable_disable (\"device-input\", \"" plugin-name "\",
123 sw_if_index, enable_disable, 0, 0);
128 static clib_error_t *
129 " plugin-name "_enable_disable_command_fn (vlib_main_t * vm,
130 unformat_input_t * input,
131 vlib_cli_command_t * cmd)
133 " plugin-name "_main_t * sm = &" plugin-name "_main;
134 u32 sw_if_index = ~0;
135 int enable_disable = 1;
139 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
141 if (unformat (input, \"disable\"))
143 else if (unformat (input, \"%U\", unformat_vnet_sw_interface,
144 sm->vnet_main, &sw_if_index))
150 if (sw_if_index == ~0)
151 return clib_error_return (0, \"Please specify an interface...\");
153 rv = " plugin-name "_enable_disable (sm, sw_if_index, enable_disable);
160 case VNET_API_ERROR_INVALID_SW_IF_INDEX:
161 return clib_error_return
162 (0, \"Invalid interface, only works on physical ports\");
165 case VNET_API_ERROR_UNIMPLEMENTED:
166 return clib_error_return (0, \"Device driver doesn't support redirection\");
170 return clib_error_return (0, \"" plugin-name "_enable_disable returned %d\",
177 VLIB_CLI_COMMAND (" plugin-name "_enable_disable_command, static) =
179 .path = \"" plugin-name " enable-disable\",
181 \"" plugin-name " enable-disable <interface-name> [disable]\",
182 .function = " plugin-name "_enable_disable_command_fn,
186 /* API message handler */
187 static void vl_api_" plugin-name "_enable_disable_t_handler
188 (vl_api_" plugin-name "_enable_disable_t * mp)
190 vl_api_" plugin-name "_enable_disable_reply_t * rmp;
191 " plugin-name "_main_t * sm = &" plugin-name "_main;
194 rv = " plugin-name "_enable_disable (sm, ntohl(mp->sw_if_index),
195 (int) (mp->enable_disable));
197 REPLY_MACRO(VL_API_" PLUGIN-NAME "_ENABLE_DISABLE_REPLY);
200 /* Set up the API message handling tables */
201 static clib_error_t *
202 " plugin-name "_plugin_api_hookup (vlib_main_t *vm)
204 " plugin-name "_main_t * sm = &" plugin-name "_main;
206 vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base), \\
208 vl_api_##n##_t_handler, \\
210 vl_api_##n##_t_endian, \\
211 vl_api_##n##_t_print, \\
212 sizeof(vl_api_##n##_t), 1);
213 foreach_" plugin-name "_plugin_api_msg;
219 #define vl_msg_name_crc_list
220 #include <" plugin-name "/" plugin-name "_all_api_h.h>
221 #undef vl_msg_name_crc_list
224 setup_message_id_table (" plugin-name "_main_t * sm, api_main_t * am)
226 #define _(id,n,crc) \
227 vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + sm->msg_id_base);
228 foreach_vl_msg_name_crc_" plugin-name" ;
232 static clib_error_t * " plugin-name "_init (vlib_main_t * vm)
234 " plugin-name "_main_t * sm = &" plugin-name "_main;
235 clib_error_t * error = 0;
238 name = format (0, \"" plugin-name "_%08x%c\", api_version, 0);
240 /* Ask for a correctly-sized block of API message decode slots */
241 sm->msg_id_base = vl_msg_api_get_msg_ids
242 ((char *) name, VL_MSG_FIRST_AVAILABLE);
244 error = " plugin-name "_plugin_api_hookup (vm);
246 /* Add our API messages to the global name_crc hash table */
247 setup_message_id_table (sm, &api_main);
254 VLIB_INIT_FUNCTION (" plugin-name "_init);
257 VNET_FEATURE_INIT (" plugin-name ", static) =
259 .arc_name = \"device-input\",
260 .node_name = \"" plugin-name "\",
261 .runs_before = VNET_FEATURES (\"ethernet-input\"),
266 VLIB_PLUGIN_REGISTER () =
268 .version = VPP_BUILD_VER,
273 * fd.io coding-style-patch-verification: " capital-oh-en "
276 * eval: (c-set-style \"gnu\")