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")
25 '(setq main-p (concat (substring plugin-name 0 1) "mp"))
27 * " plugin-name ".c - skeleton vpp engine plug-in
29 * Copyright (c) <current-year> <your-organization>
30 * Licensed under the Apache License, Version 2.0 (the \"License\");
31 * you may not use this file except in compliance with the License.
32 * You may obtain a copy of the License at:
34 * http://www.apache.org/licenses/LICENSE-2.0
36 * Unless required by applicable law or agreed to in writing, software
37 * distributed under the License is distributed on an \"AS IS\" BASIS,
38 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
39 * See the License for the specific language governing permissions and
40 * limitations under the License.
43 #include <vnet/vnet.h>
44 #include <vnet/plugin/plugin.h>
45 #include <" plugin-name "/" plugin-name ".h>
47 #include <vlibapi/api.h>
48 #include <vlibmemory/api.h>
49 #include <vpp/app/version.h>
52 #include <" plugin-name "/" plugin-name ".api_enum.h>
53 #include <" plugin-name "/" plugin-name ".api_types.h>
55 #define REPLY_MSG_ID_BASE " main-p "->msg_id_base
56 #include <vlibapi/api_helper_macros.h>
58 " plugin-name "_main_t " plugin-name "_main;
60 /* Action function shared between message handler and debug CLI */
62 int " plugin-name "_enable_disable (" plugin-name "_main_t * " main-p ", u32 sw_if_index,
65 vnet_sw_interface_t * sw;
69 if (pool_is_free_index (" main-p "->vnet_main->interface_main.sw_interfaces,
71 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
73 /* Not a physical port? */
74 sw = vnet_get_sw_interface (" main-p "->vnet_main, sw_if_index);
75 if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
76 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
78 " plugin-name "_create_periodic_process (" main-p ");
80 vnet_feature_enable_disable (\"device-input\", \"" plugin-name "\",
81 sw_if_index, enable_disable, 0, 0);
83 /* Send an event to enable/disable the periodic scanner process */
84 vlib_process_signal_event (" main-p "->vlib_main,
85 " main-p"->periodic_node_index,
86 " PLUGIN-NAME"_EVENT_PERIODIC_ENABLE_DISABLE,
87 (uword)enable_disable);
92 " plugin-name "_enable_disable_command_fn (vlib_main_t * vm,
93 unformat_input_t * input,
94 vlib_cli_command_t * cmd)
96 " plugin-name "_main_t * " main-p " = &" plugin-name "_main;
98 int enable_disable = 1;
102 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
104 if (unformat (input, \"disable\"))
106 else if (unformat (input, \"%U\", unformat_vnet_sw_interface,
107 " main-p "->vnet_main, &sw_if_index))
113 if (sw_if_index == ~0)
114 return clib_error_return (0, \"Please specify an interface...\");
116 rv = " plugin-name "_enable_disable (" main-p ", sw_if_index, enable_disable);
123 case VNET_API_ERROR_INVALID_SW_IF_INDEX:
124 return clib_error_return
125 (0, \"Invalid interface, only works on physical ports\");
128 case VNET_API_ERROR_UNIMPLEMENTED:
129 return clib_error_return (0, \"Device driver doesn't support redirection\");
133 return clib_error_return (0, \"" plugin-name "_enable_disable returned %d\",
140 VLIB_CLI_COMMAND (" plugin-name "_enable_disable_command, static) =
142 .path = \"" plugin-name " enable-disable\",
144 \"" plugin-name " enable-disable <interface-name> [disable]\",
145 .function = " plugin-name "_enable_disable_command_fn,
149 /* API message handler */
150 static void vl_api_" plugin-name "_enable_disable_t_handler
151 (vl_api_" plugin-name "_enable_disable_t * mp)
153 vl_api_" plugin-name "_enable_disable_reply_t * rmp;
154 " plugin-name "_main_t * " main-p " = &" plugin-name "_main;
157 rv = " plugin-name "_enable_disable (" main-p ", ntohl(mp->sw_if_index),
158 (int) (mp->enable_disable));
160 REPLY_MACRO(VL_API_" PLUGIN-NAME "_ENABLE_DISABLE_REPLY);
163 /* API definitions */
164 #include <" plugin-name "/" plugin-name ".api.c>
166 static clib_error_t * " plugin-name "_init (vlib_main_t * vm)
168 " plugin-name "_main_t * " main-p " = &" plugin-name "_main;
169 clib_error_t * error = 0;
171 " main-p "->vlib_main = vm;
172 " main-p "->vnet_main = vnet_get_main();
174 /* Add our API messages to the global name_crc hash table */
175 " main-p "->msg_id_base = setup_message_id_table ();
180 VLIB_INIT_FUNCTION (" plugin-name "_init);
183 VNET_FEATURE_INIT (" plugin-name ", static) =
185 .arc_name = \"device-input\",
186 .node_name = \"" plugin-name "\",
187 .runs_before = VNET_FEATURES (\"ethernet-input\"),
192 VLIB_PLUGIN_REGISTER () =
194 .version = VPP_BUILD_VER,
195 .description = \"" plugin-name " plugin description goes here\",
200 * fd.io coding-style-patch-verification: " capital-oh-en "
203 * eval: (c-set-style \"gnu\")