Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 1 | ;;; plugin-main-skel.el - vpp engine plug-in "main.c" skeleton |
| 2 | ;;; |
| 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: |
| 7 | ;;; |
| 8 | ;;; http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | ;;; |
| 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. |
| 15 | |
| 16 | (require 'skeleton) |
| 17 | |
Keith Burns (alagalah) | ca46d8c | 2016-03-18 07:22:15 -0700 | [diff] [blame] | 18 | (define-skeleton skel-plugin-main |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 19 | "Insert a plug-in 'main.c' skeleton " |
| 20 | nil |
| 21 | '(if (not (boundp 'plugin-name)) |
| 22 | (setq plugin-name (read-string "Plugin name: "))) |
| 23 | '(setq PLUGIN-NAME (upcase plugin-name)) |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 24 | '(setq capital-oh-en "ON") |
Dave Barach | 8284244 | 2018-10-31 09:54:34 -0400 | [diff] [blame] | 25 | '(setq main-p (concat (substring plugin-name 0 1) "mp")) |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 26 | "/* |
Dave Barach | 557d128 | 2016-11-10 14:22:49 -0500 | [diff] [blame] | 27 | * " plugin-name ".c - skeleton vpp engine plug-in |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 28 | * |
| 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: |
| 33 | * |
| 34 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 35 | * |
| 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. |
| 41 | */ |
| 42 | |
| 43 | #include <vnet/vnet.h> |
| 44 | #include <vnet/plugin/plugin.h> |
| 45 | #include <" plugin-name "/" plugin-name ".h> |
| 46 | |
| 47 | #include <vlibapi/api.h> |
| 48 | #include <vlibmemory/api.h> |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 49 | #include <vpp/app/version.h> |
Dave Barach | 913f4c9 | 2019-05-29 09:59:51 -0400 | [diff] [blame] | 50 | #include <stdbool.h> |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 51 | |
Dave Barach | 4ec6f6b | 2019-10-01 12:10:57 -0400 | [diff] [blame] | 52 | #include <" plugin-name "/" plugin-name ".api_enum.h> |
| 53 | #include <" plugin-name "/" plugin-name ".api_types.h> |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 54 | |
Dave Barach | 8284244 | 2018-10-31 09:54:34 -0400 | [diff] [blame] | 55 | #define REPLY_MSG_ID_BASE " main-p "->msg_id_base |
Dave Barach | 1044043 | 2018-04-03 14:58:14 -0400 | [diff] [blame] | 56 | #include <vlibapi/api_helper_macros.h> |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 57 | |
Dave Barach | 3f2e775 | 2018-10-03 16:10:04 -0400 | [diff] [blame] | 58 | " plugin-name "_main_t " plugin-name "_main; |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 59 | |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 60 | /* Action function shared between message handler and debug CLI */ |
| 61 | |
Dave Barach | 8284244 | 2018-10-31 09:54:34 -0400 | [diff] [blame] | 62 | int " plugin-name "_enable_disable (" plugin-name "_main_t * " main-p ", u32 sw_if_index, |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 63 | int enable_disable) |
| 64 | { |
| 65 | vnet_sw_interface_t * sw; |
Dave Barach | b7e2f3d | 2016-11-08 16:47:34 -0500 | [diff] [blame] | 66 | int rv = 0; |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 67 | |
| 68 | /* Utterly wrong? */ |
Dave Barach | 8284244 | 2018-10-31 09:54:34 -0400 | [diff] [blame] | 69 | if (pool_is_free_index (" main-p "->vnet_main->interface_main.sw_interfaces, |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 70 | sw_if_index)) |
| 71 | return VNET_API_ERROR_INVALID_SW_IF_INDEX; |
| 72 | |
| 73 | /* Not a physical port? */ |
Dave Barach | 8284244 | 2018-10-31 09:54:34 -0400 | [diff] [blame] | 74 | sw = vnet_get_sw_interface (" main-p "->vnet_main, sw_if_index); |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 75 | if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE) |
| 76 | return VNET_API_ERROR_INVALID_SW_IF_INDEX; |
Dave Barach | 557d128 | 2016-11-10 14:22:49 -0500 | [diff] [blame] | 77 | |
Dave Barach | 11965c7 | 2019-05-28 16:31:05 -0400 | [diff] [blame] | 78 | " plugin-name "_create_periodic_process (" main-p "); |
| 79 | |
Dave Barach | b7e2f3d | 2016-11-08 16:47:34 -0500 | [diff] [blame] | 80 | vnet_feature_enable_disable (\"device-input\", \"" plugin-name "\", |
| 81 | sw_if_index, enable_disable, 0, 0); |
| 82 | |
Dave Barach | f4addbd | 2018-04-30 13:03:46 -0400 | [diff] [blame] | 83 | /* Send an event to enable/disable the periodic scanner process */ |
Dave Barach | 11965c7 | 2019-05-28 16:31:05 -0400 | [diff] [blame] | 84 | vlib_process_signal_event (" main-p "->vlib_main, |
| 85 | " main-p"->periodic_node_index, |
| 86 | " PLUGIN-NAME"_EVENT_PERIODIC_ENABLE_DISABLE, |
Dave Barach | f4addbd | 2018-04-30 13:03:46 -0400 | [diff] [blame] | 87 | (uword)enable_disable); |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 88 | return rv; |
| 89 | } |
| 90 | |
| 91 | static clib_error_t * |
| 92 | " plugin-name "_enable_disable_command_fn (vlib_main_t * vm, |
| 93 | unformat_input_t * input, |
| 94 | vlib_cli_command_t * cmd) |
| 95 | { |
Dave Barach | 8284244 | 2018-10-31 09:54:34 -0400 | [diff] [blame] | 96 | " plugin-name "_main_t * " main-p " = &" plugin-name "_main; |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 97 | u32 sw_if_index = ~0; |
| 98 | int enable_disable = 1; |
Dave Barach | 557d128 | 2016-11-10 14:22:49 -0500 | [diff] [blame] | 99 | |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 100 | int rv; |
| 101 | |
Dave Barach | 35465dc | 2019-05-18 14:52:54 -0400 | [diff] [blame] | 102 | while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 103 | { |
| 104 | if (unformat (input, \"disable\")) |
| 105 | enable_disable = 0; |
| 106 | else if (unformat (input, \"%U\", unformat_vnet_sw_interface, |
Dave Barach | 8284244 | 2018-10-31 09:54:34 -0400 | [diff] [blame] | 107 | " main-p "->vnet_main, &sw_if_index)) |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 108 | ; |
| 109 | else |
| 110 | break; |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | if (sw_if_index == ~0) |
| 114 | return clib_error_return (0, \"Please specify an interface...\"); |
Dave Barach | 557d128 | 2016-11-10 14:22:49 -0500 | [diff] [blame] | 115 | |
Dave Barach | 8284244 | 2018-10-31 09:54:34 -0400 | [diff] [blame] | 116 | rv = " plugin-name "_enable_disable (" main-p ", sw_if_index, enable_disable); |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 117 | |
Dave Barach | 35465dc | 2019-05-18 14:52:54 -0400 | [diff] [blame] | 118 | switch(rv) |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 119 | { |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 120 | case 0: |
| 121 | break; |
| 122 | |
| 123 | case VNET_API_ERROR_INVALID_SW_IF_INDEX: |
Dave Barach | 557d128 | 2016-11-10 14:22:49 -0500 | [diff] [blame] | 124 | return clib_error_return |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 125 | (0, \"Invalid interface, only works on physical ports\"); |
| 126 | break; |
| 127 | |
| 128 | case VNET_API_ERROR_UNIMPLEMENTED: |
| 129 | return clib_error_return (0, \"Device driver doesn't support redirection\"); |
| 130 | break; |
| 131 | |
| 132 | default: |
| 133 | return clib_error_return (0, \"" plugin-name "_enable_disable returned %d\", |
| 134 | rv); |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 135 | } |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 136 | return 0; |
| 137 | } |
| 138 | |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 139 | /* *INDENT-OFF* */ |
Dave Barach | 35465dc | 2019-05-18 14:52:54 -0400 | [diff] [blame] | 140 | VLIB_CLI_COMMAND (" plugin-name "_enable_disable_command, static) = |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 141 | { |
| 142 | .path = \"" plugin-name " enable-disable\", |
| 143 | .short_help = |
| 144 | \"" plugin-name " enable-disable <interface-name> [disable]\", |
| 145 | .function = " plugin-name "_enable_disable_command_fn, |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 146 | }; |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 147 | /* *INDENT-ON* */ |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 148 | |
| 149 | /* API message handler */ |
| 150 | static void vl_api_" plugin-name "_enable_disable_t_handler |
| 151 | (vl_api_" plugin-name "_enable_disable_t * mp) |
| 152 | { |
| 153 | vl_api_" plugin-name "_enable_disable_reply_t * rmp; |
Dave Barach | 8284244 | 2018-10-31 09:54:34 -0400 | [diff] [blame] | 154 | " plugin-name "_main_t * " main-p " = &" plugin-name "_main; |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 155 | int rv; |
| 156 | |
Dave Barach | 8284244 | 2018-10-31 09:54:34 -0400 | [diff] [blame] | 157 | rv = " plugin-name "_enable_disable (" main-p ", ntohl(mp->sw_if_index), |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 158 | (int) (mp->enable_disable)); |
Dave Barach | 557d128 | 2016-11-10 14:22:49 -0500 | [diff] [blame] | 159 | |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 160 | REPLY_MACRO(VL_API_" PLUGIN-NAME "_ENABLE_DISABLE_REPLY); |
| 161 | } |
| 162 | |
Dave Barach | 4ec6f6b | 2019-10-01 12:10:57 -0400 | [diff] [blame] | 163 | /* API definitions */ |
| 164 | #include <" plugin-name "/" plugin-name ".api.c> |
Dave Barach | 557d128 | 2016-11-10 14:22:49 -0500 | [diff] [blame] | 165 | |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 166 | static clib_error_t * " plugin-name "_init (vlib_main_t * vm) |
| 167 | { |
Dave Barach | 8284244 | 2018-10-31 09:54:34 -0400 | [diff] [blame] | 168 | " plugin-name "_main_t * " main-p " = &" plugin-name "_main; |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 169 | clib_error_t * error = 0; |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 170 | |
Dave Barach | 8284244 | 2018-10-31 09:54:34 -0400 | [diff] [blame] | 171 | " main-p "->vlib_main = vm; |
| 172 | " main-p "->vnet_main = vnet_get_main(); |
Dave Barach | 1044043 | 2018-04-03 14:58:14 -0400 | [diff] [blame] | 173 | |
Dave Barach | 605c636 | 2017-01-02 12:22:48 -0500 | [diff] [blame] | 174 | /* Add our API messages to the global name_crc hash table */ |
Dave Barach | 4ec6f6b | 2019-10-01 12:10:57 -0400 | [diff] [blame] | 175 | " main-p "->msg_id_base = setup_message_id_table (); |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 176 | |
| 177 | return error; |
| 178 | } |
| 179 | |
| 180 | VLIB_INIT_FUNCTION (" plugin-name "_init); |
Dave Barach | b7e2f3d | 2016-11-08 16:47:34 -0500 | [diff] [blame] | 181 | |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 182 | /* *INDENT-OFF* */ |
Dave Barach | 557d128 | 2016-11-10 14:22:49 -0500 | [diff] [blame] | 183 | VNET_FEATURE_INIT (" plugin-name ", static) = |
Dave Barach | b7e2f3d | 2016-11-08 16:47:34 -0500 | [diff] [blame] | 184 | { |
| 185 | .arc_name = \"device-input\", |
| 186 | .node_name = \"" plugin-name "\", |
| 187 | .runs_before = VNET_FEATURES (\"ethernet-input\"), |
| 188 | }; |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 189 | /* *INDENT-ON */ |
| 190 | |
| 191 | /* *INDENT-OFF* */ |
Dave Barach | 35465dc | 2019-05-18 14:52:54 -0400 | [diff] [blame] | 192 | VLIB_PLUGIN_REGISTER () = |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 193 | { |
| 194 | .version = VPP_BUILD_VER, |
Dave Barach | 1044043 | 2018-04-03 14:58:14 -0400 | [diff] [blame] | 195 | .description = \"" plugin-name " plugin description goes here\", |
Dave Barach | fed79e8 | 2017-02-10 11:57:46 -0500 | [diff] [blame] | 196 | }; |
| 197 | /* *INDENT-ON* */ |
| 198 | |
| 199 | /* |
| 200 | * fd.io coding-style-patch-verification: " capital-oh-en " |
| 201 | * |
| 202 | * Local Variables: |
| 203 | * eval: (c-set-style \"gnu\") |
| 204 | * End: |
| 205 | */ |
Dave Barach | b852bfa | 2016-01-04 15:27:42 -0500 | [diff] [blame] | 206 | ") |