build-root/emacs-lisp/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 "
  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 <vlibsocket/api.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 /*
 104  * This routine exists to convince the vlib plugin framework that
 105  * we haven't accidentally copied a random .dll into the plugin directory.
 106  *
 107  * Also collects global variable pointers passed from the vpp engine
 108  */
 109
 110 clib_error_t *
 111 vlib_plugin_register (vlib_main_t * vm, vnet_plugin_handoff_t * h,
 112                       int from_early_init)
 113 {
 114   " plugin-name "_main_t * sm = &" plugin-name "_main;
 115   clib_error_t * error = 0;
 116
 117   sm->vlib_main = vm;
 118   sm->vnet_main = h->vnet_main;
 119   sm->ethernet_main = h->ethernet_main;
 120
 121   return error;
 122 }
 123
 124 /* Action function shared between message handler and debug CLI */
 125
 126 int " plugin-name "_enable_disable (" plugin-name "_main_t * sm, u32 sw_if_index,
 127                                    int enable_disable)
 128 {
 129   vnet_sw_interface_t * sw;
 130   int rv;
 131   u32 node_index = enable_disable ? " plugin-name "_node.index : ~0;
 132
 133   /* Utterly wrong? */
 134   if (pool_is_free_index (sm->vnet_main->interface_main.sw_interfaces,
 135                           sw_if_index))
 136     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 137
 138   /* Not a physical port? */
 139   sw = vnet_get_sw_interface (sm->vnet_main, sw_if_index);
 140   if (sw->type != VNET_SW_INTERFACE_TYPE_HARDWARE)
 141     return VNET_API_ERROR_INVALID_SW_IF_INDEX;
 142
 143   /*
 144    * Redirect pkts from the driver to the macswap node.
 145    * Returns VNET_API_ERROR_UNIMPLEMENTED if the h/w driver
 146    * doesn't implement the API.
 147    *
 148    * Node_index = ~0 => shut off redirection
 149    */
 150   rv = vnet_hw_interface_rx_redirect_to_node (sm->vnet_main, sw_if_index,
 151                                               node_index);
 152   return rv;
 153 }
 154
 155 static clib_error_t *
 156 " plugin-name "_enable_disable_command_fn (vlib_main_t * vm,
 157                                    unformat_input_t * input,
 158                                    vlib_cli_command_t * cmd)
 159 {
 160   " plugin-name "_main_t * sm = &" plugin-name "_main;
 161   u32 sw_if_index = ~0;
 162   int enable_disable = 1;
 163
 164   int rv;
 165
 166   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) {
 167     if (unformat (input, \"disable\"))
 168       enable_disable = 0;
 169     else if (unformat (input, \"%U\", unformat_vnet_sw_interface,
 170                        sm->vnet_main, &sw_if_index))
 171       ;
 172     else
 173       break;
 174   }
 175
 176   if (sw_if_index == ~0)
 177     return clib_error_return (0, \"Please specify an interface...\");
 178
 179   rv = " plugin-name "_enable_disable (sm, sw_if_index, enable_disable);
 180
 181   switch(rv) {
 182   case 0:
 183     break;
 184
 185   case VNET_API_ERROR_INVALID_SW_IF_INDEX:
 186     return clib_error_return
 187       (0, \"Invalid interface, only works on physical ports\");
 188     break;
 189
 190   case VNET_API_ERROR_UNIMPLEMENTED:
 191     return clib_error_return (0, \"Device driver doesn't support redirection\");
 192     break;
 193
 194   default:
 195     return clib_error_return (0, \"" plugin-name "_enable_disable returned %d\",
 196                               rv);
 197   }
 198   return 0;
 199 }
 200
 201 VLIB_CLI_COMMAND (" plugin-name "_enable_disable_command, static) = {
 202     .path = \"" plugin-name " enable-disable\",
 203     .short_help =
 204     \"" plugin-name " enable-disable <interface-name> [disable]\",
 205     .function = " plugin-name "_enable_disable_command_fn,
 206 };
 207
 208 /* API message handler */
 209 static void vl_api_" plugin-name "_enable_disable_t_handler
 210 (vl_api_" plugin-name "_enable_disable_t * mp)
 211 {
 212   vl_api_" plugin-name "_enable_disable_reply_t * rmp;
 213   " plugin-name "_main_t * sm = &" plugin-name "_main;
 214   int rv;
 215
 216   rv = " plugin-name "_enable_disable (sm, ntohl(mp->sw_if_index),
 217                                       (int) (mp->enable_disable));
 218
 219   REPLY_MACRO(VL_API_" PLUGIN-NAME "_ENABLE_DISABLE_REPLY);
 220 }
 221
 222 /* Set up the API message handling tables */
 223 static clib_error_t *
 224 " plugin-name "_plugin_api_hookup (vlib_main_t *vm)
 225 {
 226   " plugin-name "_main_t * sm = &" plugin-name "_main;
 227 #define _(N,n)                                                  \\
 228     vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base),     \\
 229                            #n,                                  \\
 230                            vl_api_##n##_t_handler,              \\
 231                            vl_noop_handler,                     \\
 232                            vl_api_##n##_t_endian,               \\
 233                            vl_api_##n##_t_print,                \\
 234                            sizeof(vl_api_##n##_t), 1);
 235     foreach_" plugin-name "_plugin_api_msg;
 236 #undef _
 237
 238     return 0;
 239 }
 240
 241 static clib_error_t * " plugin-name "_init (vlib_main_t * vm)
 242 {
 243   " plugin-name "_main_t * sm = &" plugin-name "_main;
 244   clib_error_t * error = 0;
 245   u8 * name;
 246
 247   name = format (0, \"" plugin-name "_%08x%c\", api_version, 0);
 248
 249   /* Ask for a correctly-sized block of API message decode slots */
 250   sm->msg_id_base = vl_msg_api_get_msg_ids
 251       ((char *) name, VL_MSG_FIRST_AVAILABLE);
 252
 253   error = " plugin-name "_plugin_api_hookup (vm);
 254
 255   vec_free(name);
 256
 257   return error;
 258 }
 259
 260 VLIB_INIT_FUNCTION (" plugin-name "_init);
 261 ")
 262