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