plugins/sample-plugin/sample/sample.c

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16  *------------------------------------------------------------------
  17  * sample.c - simple MAC-swap API / debug CLI handling
  18  *------------------------------------------------------------------
  19  */
  20
  21 #include <vnet/vnet.h>
  22 #include <vnet/plugin/plugin.h>
  23 #include <sample/sample.h>
  24
  25 #include <vlibapi/api.h>
  26 #include <vlibmemory/api.h>
  27 #include <vlibsocket/api.h>
  28
  29 /* define message IDs */
  30 #include <sample/sample_msg_enum.h>
  31
  32 /* define message structures */
  33 #define vl_typedefs
  34 #include <sample/sample_all_api_h.h>
  35 #undef vl_typedefs
  36
  37 /* define generated endian-swappers */
  38 #define vl_endianfun
  39 #include <sample/sample_all_api_h.h>
  40 #undef vl_endianfun
  41
  42 /* instantiate all the print functions we know about */
  43 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  44 #define vl_printfun
  45 #include <sample/sample_all_api_h.h>
  46 #undef vl_printfun
  47
  48 /* Get the API version number */
  49 #define vl_api_version(n,v) static u32 api_version=(v);
  50 #include <sample/sample_all_api_h.h>
  51 #undef vl_api_version
  52
  53 /*
  54  * A handy macro to set up a message reply.
  55  * Assumes that the following variables are available:
  56  * mp - pointer to request message
  57  * rmp - pointer to reply message type
  58  * rv - return value
  59  */
  60
  61 #define REPLY_MACRO(t)                                          \
  62 do {                                                            \
  63     unix_shared_memory_queue_t * q =                            \
  64     vl_api_client_index_to_input_queue (mp->client_index);      \
  65     if (!q)                                                     \
  66         return;                                                 \
  67                                                                 \
  68     rmp = vl_msg_api_alloc (sizeof (*rmp));                     \
  69     rmp->_vl_msg_id = ntohs((t)+sm->msg_id_base);               \
  70     rmp->context = mp->context;                                 \
  71     rmp->retval = ntohl(rv);                                    \
  72                                                                 \
  73     vl_msg_api_send_shmem (q, (u8 *)&rmp);                      \
  74 } while(0);
  75
  76
  77 /* List of message types that this plugin understands */
  78
  79 #define foreach_sample_plugin_api_msg                           \
  80 _(SAMPLE_MACSWAP_ENABLE_DISABLE, sample_macswap_enable_disable)
  81
  82 /*
  83  * This routine exists to convince the vlib plugin framework that
  84  * we haven't accidentally copied a random .dll into the plugin directory.
  85  *
  86  * Also collects global variable pointers passed from the vpp engine
  87  */
  88
  89 clib_error_t *
  90 vlib_plugin_register (vlib_main_t * vm, vnet_plugin_handoff_t * h,
  91                       int from_early_init)
  92 {
  93   sample_main_t * sm = &sample_main;
  94   clib_error_t * error = 0;
  95
  96   sm->vlib_main = vm;
  97   sm->vnet_main = h->vnet_main;
  98   sm->ethernet_main = h->ethernet_main;
  99
 100   return error;
 101 }
 102
 103 /* Action function shared between message handler and debug CLI */
 104
 105 int sample_macswap_enable_disable (sample_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", "sample",
 122                                sw_if_index, enable_disable, 0, 0);
 123
 124   return rv;
 125 }
 126
 127 static clib_error_t *
 128 macswap_enable_disable_command_fn (vlib_main_t * vm,
 129                                    unformat_input_t * input,
 130                                    vlib_cli_command_t * cmd)
 131 {
 132   sample_main_t * sm = &sample_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     if (unformat (input, "disable"))
 140       enable_disable = 0;
 141     else if (unformat (input, "%U", unformat_vnet_sw_interface,
 142                        sm->vnet_main, &sw_if_index))
 143       ;
 144     else
 145       break;
 146   }
 147
 148   if (sw_if_index == ~0)
 149     return clib_error_return (0, "Please specify an interface...");
 150
 151   rv = sample_macswap_enable_disable (sm, sw_if_index, enable_disable);
 152
 153   switch(rv) {
 154   case 0:
 155     break;
 156
 157   case VNET_API_ERROR_INVALID_SW_IF_INDEX:
 158     return clib_error_return
 159       (0, "Invalid interface, only works on physical ports");
 160     break;
 161
 162   case VNET_API_ERROR_UNIMPLEMENTED:
 163     return clib_error_return (0, "Device driver doesn't support redirection");
 164     break;
 165
 166   default:
 167     return clib_error_return (0, "sample_macswap_enable_disable returned %d",
 168                               rv);
 169   }
 170   return 0;
 171 }
 172
 173 VLIB_CLI_COMMAND (sr_content_command, static) = {
 174     .path = "sample macswap",
 175     .short_help =
 176     "sample macswap <interface-name> [disable]",
 177     .function = macswap_enable_disable_command_fn,
 178 };
 179
 180 /* API message handler */
 181 static void vl_api_sample_macswap_enable_disable_t_handler
 182 (vl_api_sample_macswap_enable_disable_t * mp)
 183 {
 184   vl_api_sample_macswap_enable_disable_reply_t * rmp;
 185   sample_main_t * sm = &sample_main;
 186   int rv;
 187
 188   rv = sample_macswap_enable_disable (sm, ntohl(mp->sw_if_index),
 189                                       (int) (mp->enable_disable));
 190
 191   REPLY_MACRO(VL_API_SAMPLE_MACSWAP_ENABLE_DISABLE_REPLY);
 192 }
 193
 194 /* Set up the API message handling tables */
 195 static clib_error_t *
 196 sample_plugin_api_hookup (vlib_main_t *vm)
 197 {
 198   sample_main_t * sm = &sample_main;
 199 #define _(N,n)                                                  \
 200     vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base),     \
 201                            #n,                                  \
 202                            vl_api_##n##_t_handler,              \
 203                            vl_noop_handler,                     \
 204                            vl_api_##n##_t_endian,               \
 205                            vl_api_##n##_t_print,                \
 206                            sizeof(vl_api_##n##_t), 1);
 207     foreach_sample_plugin_api_msg;
 208 #undef _
 209
 210     return 0;
 211 }
 212
 213 #define vl_msg_name_crc_list
 214 #include <sample/sample_all_api_h.h>
 215 #undef vl_msg_name_crc_list
 216
 217 static void
 218 setup_message_id_table (sample_main_t * sm, api_main_t *am)
 219 {
 220 #define _(id,n,crc) \
 221   vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + sm->msg_id_base);
 222   foreach_vl_msg_name_crc_sample;
 223 #undef _
 224 }
 225
 226 static clib_error_t * sample_init (vlib_main_t * vm)
 227 {
 228   sample_main_t * sm = &sample_main;
 229   clib_error_t * error = 0;
 230   u8 * name;
 231
 232   name = format (0, "sample_%08x%c", api_version, 0);
 233
 234   /* Ask for a correctly-sized block of API message decode slots */
 235   sm->msg_id_base = vl_msg_api_get_msg_ids
 236       ((char *) name, VL_MSG_FIRST_AVAILABLE);
 237
 238   error = sample_plugin_api_hookup (vm);
 239
 240   /* Add our API messages to the global name_crc hash table */
 241   setup_message_id_table (sm, &api_main);
 242
 243   vec_free(name);
 244
 245   return error;
 246 }
 247
 248 VLIB_INIT_FUNCTION (sample_init);
 249
 250 VNET_FEATURE_INIT (sample, static) =
 251 {
 252   .arc_name = "device-input",
 253   .node_name = "sample",
 254   .runs_before = VNET_FEATURES ("ethernet-input"),
 255 };