extras/emacs/plugin-main-skel.el

   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
  18 (define-skeleton skel-plugin-main
  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))
  24 '(setq capital-oh-en "ON")
  25 '(setq main-p (concat (substring plugin-name 0 1) "mp"))
  26 "/*
  27  * " plugin-name ".c - skeleton vpp engine plug-in
  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>
  49 #include <vpp/app/version.h>
  50 #include <stdbool.h>
  51
  52 /* define message IDs */
  53 #include <" plugin-name "/" plugin-name "_msg_enum.h>
  54
  55 /* define message structures */
  56 #define vl_typedefs
  57 #include <" plugin-name "/" plugin-name "_all_api_h.h>
  58 #undef vl_typedefs
  59
  60 /* define generated endian-swappers */
  61 #define vl_endianfun
  62 #include <" plugin-name "/" plugin-name "_all_api_h.h>
  63 #undef vl_endianfun
  64
  65 /* instantiate all the print functions we know about */
  66 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  67 #define vl_printfun
  68 #include <" plugin-name "/" plugin-name "_all_api_h.h>
  69 #undef vl_printfun
  70
  71 /* Get the API version number */
  72 #define vl_api_version(n,v) static u32 api_version=(v);
  73 #include <" plugin-name "/" plugin-name "_all_api_h.h>
  74 #undef vl_api_version
  75
  76 #define REPLY_MSG_ID_BASE " main-p "->msg_id_base
  77 #include <vlibapi/api_helper_macros.h>
  78
  79 " plugin-name "_main_t " plugin-name "_main;
  80
  81 /* List of message types that this plugin understands */
  82
  83 #define foreach_" plugin-name "_plugin_api_msg                           \\
  84 _(" PLUGIN-NAME "_ENABLE_DISABLE, " plugin-name "_enable_disable)
  85
  86 /* Action function shared between message handler and debug CLI */
  87
  88 int " plugin-name "_enable_disable (" plugin-name "_main_t * " main-p ", u32 sw_if_index,
  89                                    int enable_disable)
  90 {
  91   vnet_sw_interface_t * sw;
  92   int rv = 0;
  93
  94   /* Utterly wrong? */
  95   if (pool_is_free_index (" main-p "->vnet_main->interface_main.sw_interfaces,
  96                           sw_if_index))
  97     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
  98
  99   /* Not a physical port? */
 100   sw = vnet_get_sw_interface (" main-p "->vnet_main, sw_if_index);
 101   if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
 102     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 103
 104   " plugin-name "_create_periodic_process (" main-p ");
 105
 106   vnet_feature_enable_disable (\"device-input\", \"" plugin-name "\",
 107                                sw_if_index, enable_disable, 0, 0);
 108
 109   /* Send an event to enable/disable the periodic scanner process */
 110   vlib_process_signal_event (" main-p "->vlib_main,
 111                              " main-p"->periodic_node_index,
 112                              " PLUGIN-NAME"_EVENT_PERIODIC_ENABLE_DISABLE,
 113                             (uword)enable_disable);
 114   return rv;
 115 }
 116
 117 static clib_error_t *
 118 " plugin-name "_enable_disable_command_fn (vlib_main_t * vm,
 119                                    unformat_input_t * input,
 120                                    vlib_cli_command_t * cmd)
 121 {
 122   " plugin-name "_main_t * " main-p " = &" plugin-name "_main;
 123   u32 sw_if_index = ~0;
 124   int enable_disable = 1;
 125
 126   int rv;
 127
 128   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 129     {
 130       if (unformat (input, \"disable\"))
 131         enable_disable = 0;
 132       else if (unformat (input, \"%U\", unformat_vnet_sw_interface,
 133                          " main-p "->vnet_main, &sw_if_index))
 134         ;
 135       else
 136         break;
 137   }
 138
 139   if (sw_if_index == ~0)
 140     return clib_error_return (0, \"Please specify an interface...\");
 141
 142   rv = " plugin-name "_enable_disable (" main-p ", sw_if_index, enable_disable);
 143
 144   switch(rv)
 145     {
 146   case 0:
 147     break;
 148
 149   case VNET_API_ERROR_INVALID_SW_IF_INDEX:
 150     return clib_error_return
 151       (0, \"Invalid interface, only works on physical ports\");
 152     break;
 153
 154   case VNET_API_ERROR_UNIMPLEMENTED:
 155     return clib_error_return (0, \"Device driver doesn't support redirection\");
 156     break;
 157
 158   default:
 159     return clib_error_return (0, \"" plugin-name "_enable_disable returned %d\",
 160                               rv);
 161     }
 162   return 0;
 163 }
 164
 165 /* *INDENT-OFF* */
 166 VLIB_CLI_COMMAND (" plugin-name "_enable_disable_command, static) =
 167 {
 168   .path = \"" plugin-name " enable-disable\",
 169   .short_help =
 170   \"" plugin-name " enable-disable <interface-name> [disable]\",
 171   .function = " plugin-name "_enable_disable_command_fn,
 172 };
 173 /* *INDENT-ON* */
 174
 175 /* API message handler */
 176 static void vl_api_" plugin-name "_enable_disable_t_handler
 177 (vl_api_" plugin-name "_enable_disable_t * mp)
 178 {
 179   vl_api_" plugin-name "_enable_disable_reply_t * rmp;
 180   " plugin-name "_main_t * " main-p " = &" plugin-name "_main;
 181   int rv;
 182
 183   rv = " plugin-name "_enable_disable (" main-p ", ntohl(mp->sw_if_index),
 184                                       (int) (mp->enable_disable));
 185
 186   REPLY_MACRO(VL_API_" PLUGIN-NAME "_ENABLE_DISABLE_REPLY);
 187 }
 188
 189 /* Set up the API message handling tables */
 190 static clib_error_t *
 191 " plugin-name "_plugin_api_hookup (vlib_main_t *vm)
 192 {
 193   " plugin-name "_main_t * " main-p " = &" plugin-name "_main;
 194 #define _(N,n)                                                  \\
 195     vl_msg_api_set_handlers((VL_API_##N + " main-p "->msg_id_base),     \\
 196                            #n,                                  \\
 197                            vl_api_##n##_t_handler,              \\
 198                            vl_noop_handler,                     \\
 199                            vl_api_##n##_t_endian,               \\
 200                            vl_api_##n##_t_print,                \\
 201                            sizeof(vl_api_##n##_t), 1);
 202     foreach_" plugin-name "_plugin_api_msg;
 203 #undef _
 204
 205     return 0;
 206 }
 207
 208 #define vl_msg_name_crc_list
 209 #include <" plugin-name "/" plugin-name "_all_api_h.h>
 210 #undef vl_msg_name_crc_list
 211
 212 static void
 213 setup_message_id_table (" plugin-name "_main_t * " main-p ", api_main_t * am)
 214 {
 215 #define _(id,n,crc) \
 216   vl_msg_api_add_msg_name_crc (am, #n \"_\" #crc, id + " main-p "->msg_id_base);
 217   foreach_vl_msg_name_crc_" plugin-name" ;
 218 #undef _
 219 }
 220
 221 static clib_error_t * " plugin-name "_init (vlib_main_t * vm)
 222 {
 223   " plugin-name "_main_t * " main-p " = &" plugin-name "_main;
 224   clib_error_t * error = 0;
 225   u8 * name;
 226
 227   " main-p "->vlib_main = vm;
 228   " main-p "->vnet_main = vnet_get_main();
 229
 230   name = format (0, \"" plugin-name "_%08x%c\", api_version, 0);
 231
 232   /* Ask for a correctly-sized block of API message decode slots */
 233   " main-p "->msg_id_base = vl_msg_api_get_msg_ids
 234       ((char *) name, VL_MSG_FIRST_AVAILABLE);
 235
 236   error = " plugin-name "_plugin_api_hookup (vm);
 237
 238   /* Add our API messages to the global name_crc hash table */
 239   setup_message_id_table (" main-p ", &api_main);
 240
 241   vec_free(name);
 242
 243   return error;
 244 }
 245
 246 VLIB_INIT_FUNCTION (" plugin-name "_init);
 247
 248 /* *INDENT-OFF* */
 249 VNET_FEATURE_INIT (" plugin-name ", static) =
 250 {
 251   .arc_name = \"device-input\",
 252   .node_name = \"" plugin-name "\",
 253   .runs_before = VNET_FEATURES (\"ethernet-input\"),
 254 };
 255 /* *INDENT-ON */
 256
 257 /* *INDENT-OFF* */
 258 VLIB_PLUGIN_REGISTER () =
 259 {
 260   .version = VPP_BUILD_VER,
 261   .description = \"" plugin-name " plugin description goes here\",
 262 };
 263 /* *INDENT-ON* */
 264
 265 /*
 266  * fd.io coding-style-patch-verification: " capital-oh-en "
 267  *
 268  * Local Variables:
 269  * eval: (c-set-style \"gnu\")
 270  * End:
 271  */
 272 ")