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