src/vnet/devices/tap/tapv2_api.c

   1 /*
   2  *------------------------------------------------------------------
   3  * tap_api.c - vnet tap device driver API support
   4  *
   5  * Copyright (c) 2017 Cisco and/or its affiliates.
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *------------------------------------------------------------------
  18  */
  19
  20 #include <vnet/vnet.h>
  21 #include <vlibmemory/api.h>
  22
  23 #include <vnet/interface.h>
  24 #include <vnet/api_errno.h>
  25 #include <vnet/ethernet/ethernet.h>
  26 #include <vnet/ip/ip.h>
  27
  28 #include <vnet/ethernet/ethernet_types_api.h>
  29 #include <vnet/ip/ip_types_api.h>
  30
  31 #include <vnet/vnet_msg_enum.h>
  32
  33 #define vl_typedefs             /* define message structures */
  34 #include <vnet/vnet_all_api_h.h>
  35 #undef vl_typedefs
  36
  37 #define vl_endianfun            /* define message structures */
  38 #include <vnet/vnet_all_api_h.h>
  39 #undef vl_endianfun
  40
  41 /* instantiate all the print functions we know about */
  42 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  43 #define vl_printfun
  44 #include <vnet/vnet_all_api_h.h>
  45 #undef vl_printfun
  46
  47 #include <vlibapi/api_helper_macros.h>
  48 #include <vnet/devices/tap/tap.h>
  49
  50 #define foreach_tapv2_api_msg                     \
  51 _(TAP_CREATE_V2, tap_create_v2)                   \
  52 _(TAP_DELETE_V2, tap_delete_v2)                   \
  53 _(SW_INTERFACE_TAP_V2_DUMP, sw_interface_tap_v2_dump)
  54
  55 static void
  56 vl_api_tap_create_v2_t_handler (vl_api_tap_create_v2_t * mp)
  57 {
  58   vl_api_registration_t *reg;
  59   reg = vl_api_client_index_to_registration (mp->client_index);
  60   if (!reg)
  61     return;
  62
  63   vnet_main_t *vnm = vnet_get_main ();
  64   vlib_main_t *vm = vlib_get_main ();
  65   vl_api_tap_create_v2_reply_t *rmp;
  66
  67   tap_create_if_args_t _a, *ap = &_a;
  68
  69   clib_memset (ap, 0, sizeof (*ap));
  70
  71   ap->id = ntohl (mp->id);
  72   if (!mp->use_random_mac)
  73     {
  74       mac_address_decode (mp->mac_address, &ap->mac_addr);
  75       ap->mac_addr_set = 1;
  76     }
  77   ap->rx_ring_sz = ntohs (mp->rx_ring_sz);
  78   ap->tx_ring_sz = ntohs (mp->tx_ring_sz);
  79   ap->sw_if_index = (u32) ~ 0;
  80
  81   if (mp->num_rx_queues < 1)
  82     {
  83       ap->rv = VNET_API_ERROR_INVALID_ARGUMENT;
  84       ap->sw_if_index = ~0;
  85       goto done;
  86     }
  87
  88   ap->num_rx_queues = mp->num_rx_queues;
  89
  90   if (mp->host_if_name_set)
  91     ap->host_if_name = mp->host_if_name;
  92
  93   if (mp->host_mac_addr_set)
  94     {
  95       mac_address_decode (mp->host_mac_addr, &ap->host_mac_addr);
  96     }
  97
  98   if (mp->host_namespace_set)
  99     ap->host_namespace = mp->host_namespace;
 100
 101   if (mp->host_bridge_set)
 102     ap->host_bridge = mp->host_bridge;
 103
 104   if (mp->host_ip4_prefix_set)
 105     {
 106       ip4_address_decode (mp->host_ip4_prefix.address, &ap->host_ip4_addr);
 107       ap->host_ip4_prefix_len = mp->host_ip4_prefix.len;
 108     }
 109
 110   if (mp->host_ip6_prefix_set)
 111     {
 112       ip6_address_decode (mp->host_ip6_prefix.address, &ap->host_ip6_addr);
 113       ap->host_ip6_prefix_len = mp->host_ip6_prefix.len;
 114     }
 115
 116   if (mp->host_ip4_gw_set)
 117     {
 118       ip4_address_decode (mp->host_ip4_gw, &ap->host_ip4_gw);
 119       ap->host_ip4_gw_set = 1;
 120     }
 121
 122   if (mp->host_ip6_gw_set)
 123     {
 124       ip6_address_decode (mp->host_ip6_gw, &ap->host_ip6_gw);
 125       ap->host_ip6_gw_set = 1;
 126     }
 127
 128   if (mp->host_mtu_set)
 129     {
 130       ap->host_mtu_size = ntohl (mp->host_mtu_size);
 131       ap->host_mtu_set = 1;
 132     }
 133
 134   ap->tap_flags = ntohl (mp->tap_flags);
 135
 136   tap_create_if (vm, ap);
 137
 138
 139   /* If a tag was supplied... */
 140   if (vl_api_string_len (&mp->tag))
 141     {
 142       u8 *tag = format (0, "%s%c", vl_api_from_api_string (&mp->tag), 0);
 143       vnet_set_sw_interface_tag (vnm, tag, ap->sw_if_index);
 144     }
 145
 146 done:
 147   rmp = vl_msg_api_alloc (sizeof (*rmp));
 148   rmp->_vl_msg_id = ntohs (VL_API_TAP_CREATE_V2_REPLY);
 149   rmp->context = mp->context;
 150   rmp->retval = ntohl (ap->rv);
 151   rmp->sw_if_index = ntohl (ap->sw_if_index);
 152
 153   vl_api_send_msg (reg, (u8 *) rmp);
 154 }
 155
 156 static void
 157 vl_api_tap_delete_v2_t_handler (vl_api_tap_delete_v2_t * mp)
 158 {
 159   vl_api_registration_t *reg;
 160   reg = vl_api_client_index_to_registration (mp->client_index);
 161   if (!reg)
 162     return;
 163
 164   vnet_main_t *vnm = vnet_get_main ();
 165   vlib_main_t *vm = vlib_get_main ();
 166   int rv;
 167   vl_api_tap_delete_v2_reply_t *rmp;
 168
 169   u32 sw_if_index = ntohl (mp->sw_if_index);
 170
 171   rv = tap_delete_if (vm, sw_if_index);
 172
 173
 174
 175   rmp = vl_msg_api_alloc (sizeof (*rmp));
 176   rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_V2_REPLY);
 177   rmp->context = mp->context;
 178   rmp->retval = ntohl (rv);
 179
 180   vl_api_send_msg (reg, (u8 *) rmp);
 181
 182   if (!rv)
 183     vnet_clear_sw_interface_tag (vnm, sw_if_index);
 184 }
 185
 186 static void
 187 tap_send_sw_interface_details (vpe_api_main_t * am,
 188                                vl_api_registration_t * reg,
 189                                tap_interface_details_t * tap_if, u32 context)
 190 {
 191   vl_api_sw_interface_tap_v2_details_t *mp;
 192   mp = vl_msg_api_alloc (sizeof (*mp));
 193   clib_memset (mp, 0, sizeof (*mp));
 194   mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_TAP_V2_DETAILS);
 195   mp->id = htonl (tap_if->id);
 196   mp->sw_if_index = htonl (tap_if->sw_if_index);
 197   mp->tap_flags = htonl (tap_if->tap_flags);
 198   clib_memcpy (mp->dev_name, tap_if->dev_name,
 199                MIN (ARRAY_LEN (mp->dev_name) - 1,
 200                     strlen ((const char *) tap_if->dev_name)));
 201   mp->rx_ring_sz = htons (tap_if->rx_ring_sz);
 202   mp->tx_ring_sz = htons (tap_if->tx_ring_sz);
 203   mac_address_encode (&tap_if->host_mac_addr, mp->host_mac_addr);
 204   clib_memcpy (mp->host_if_name, tap_if->host_if_name,
 205                MIN (ARRAY_LEN (mp->host_if_name) - 1,
 206                     strlen ((const char *) tap_if->host_if_name)));
 207   clib_memcpy (mp->host_namespace, tap_if->host_namespace,
 208                MIN (ARRAY_LEN (mp->host_namespace) - 1,
 209                     strlen ((const char *) tap_if->host_namespace)));
 210   clib_memcpy (mp->host_bridge, tap_if->host_bridge,
 211                MIN (ARRAY_LEN (mp->host_bridge) - 1,
 212                     strlen ((const char *) tap_if->host_bridge)));
 213   mp->host_mtu_size = htonl (tap_if->host_mtu_size);
 214   mac_address_encode (&tap_if->host_mac_addr, mp->host_mac_addr);
 215
 216   if (tap_if->host_ip4_prefix_len)
 217     ip4_address_encode (&tap_if->host_ip4_addr, mp->host_ip4_prefix.address);
 218   mp->host_ip4_prefix.len = tap_if->host_ip4_prefix_len;
 219   if (tap_if->host_ip6_prefix_len)
 220     ip6_address_encode (&tap_if->host_ip6_addr, mp->host_ip6_prefix.address);
 221   mp->host_ip6_prefix.len = tap_if->host_ip6_prefix_len;
 222
 223   mp->context = context;
 224   vl_api_send_msg (reg, (u8 *) mp);
 225 }
 226
 227 static void
 228 vl_api_sw_interface_tap_v2_dump_t_handler (vl_api_sw_interface_tap_v2_dump_t *
 229                                            mp)
 230 {
 231   int rv;
 232   vpe_api_main_t *am = &vpe_api_main;
 233   vl_api_registration_t *reg;
 234   tap_interface_details_t *tapifs = NULL;
 235   tap_interface_details_t *tap_if = NULL;
 236   u32 filter_sw_if_index;
 237
 238   reg = vl_api_client_index_to_registration (mp->client_index);
 239   if (!reg)
 240     return;
 241
 242   filter_sw_if_index = htonl (mp->sw_if_index);
 243   if (filter_sw_if_index != ~0)
 244     return;                     /* UNIMPLEMENTED */
 245
 246   rv = tap_dump_ifs (&tapifs);
 247   if (rv)
 248     return;
 249
 250   vec_foreach (tap_if, tapifs)
 251   {
 252     tap_send_sw_interface_details (am, reg, tap_if, mp->context);
 253   }
 254
 255   vec_free (tapifs);
 256 }
 257
 258 #define vl_msg_name_crc_list
 259 #include <vnet/vnet_all_api_h.h>
 260 #undef vl_msg_name_crc_list
 261
 262 static void
 263 tap_setup_message_id_table (api_main_t * am)
 264 {
 265 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
 266   foreach_vl_msg_name_crc_tapv2;
 267 #undef _
 268 }
 269
 270 static clib_error_t *
 271 tapv2_api_hookup (vlib_main_t * vm)
 272 {
 273   api_main_t *am = vlibapi_get_main ();
 274
 275 #define _(N,n)                                                  \
 276     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
 277                            vl_api_##n##_t_handler,              \
 278                            vl_noop_handler,                     \
 279                            vl_api_##n##_t_endian,               \
 280                            vl_api_##n##_t_print,                \
 281                            sizeof(vl_api_##n##_t), 1);
 282   foreach_tapv2_api_msg;
 283 #undef _
 284
 285   /*
 286    * Set up the (msg_name, crc, message-id) table
 287    */
 288   tap_setup_message_id_table (am);
 289
 290   return 0;
 291 }
 292
 293 VLIB_API_INIT_FUNCTION (tapv2_api_hookup);
 294
 295 /*
 296  * fd.io coding-style-patch-verification: ON
 297  *
 298  * Local Variables:
 299  * eval: (c-set-style "gnu")
 300  * End:
 301  */