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   ap->num_rx_queues = 1;
  81
  82   if (mp->num_rx_queues > 1)
  83     ap->num_rx_queues = mp->num_rx_queues;
  84
  85   if (mp->host_if_name_set)
  86     ap->host_if_name = mp->host_if_name;
  87
  88   if (mp->host_mac_addr_set)
  89     {
  90       mac_address_decode (mp->host_mac_addr, &ap->host_mac_addr);
  91     }
  92
  93   if (mp->host_namespace_set)
  94     ap->host_namespace = mp->host_namespace;
  95
  96   if (mp->host_bridge_set)
  97     ap->host_bridge = mp->host_bridge;
  98
  99   if (mp->host_ip4_prefix_set)
 100     {
 101       ip4_address_decode (mp->host_ip4_prefix.address, &ap->host_ip4_addr);
 102       ap->host_ip4_prefix_len = mp->host_ip4_prefix.len;
 103     }
 104
 105   if (mp->host_ip6_prefix_set)
 106     {
 107       ip6_address_decode (mp->host_ip6_prefix.address, &ap->host_ip6_addr);
 108       ap->host_ip6_prefix_len = mp->host_ip6_prefix.len;
 109     }
 110
 111   if (mp->host_ip4_gw_set)
 112     {
 113       ip4_address_decode (mp->host_ip4_gw, &ap->host_ip4_gw);
 114       ap->host_ip4_gw_set = 1;
 115     }
 116
 117   if (mp->host_ip6_gw_set)
 118     {
 119       ip6_address_decode (mp->host_ip6_gw, &ap->host_ip6_gw);
 120       ap->host_ip6_gw_set = 1;
 121     }
 122
 123   if (mp->host_mtu_set)
 124     {
 125       ap->host_mtu_size = ntohl (mp->host_mtu_size);
 126       ap->host_mtu_set = 1;
 127     }
 128
 129   ap->tap_flags = ntohl (mp->tap_flags);
 130
 131   tap_create_if (vm, ap);
 132
 133
 134   /* If a tag was supplied... */
 135   if (vl_api_string_len (&mp->tag))
 136     {
 137       u8 *tag = vl_api_from_api_to_new_vec (&mp->tag);
 138       vnet_set_sw_interface_tag (vnm, tag, ap->sw_if_index);
 139     }
 140
 141   rmp = vl_msg_api_alloc (sizeof (*rmp));
 142   rmp->_vl_msg_id = ntohs (VL_API_TAP_CREATE_V2_REPLY);
 143   rmp->context = mp->context;
 144   rmp->retval = ntohl (ap->rv);
 145   rmp->sw_if_index = ntohl (ap->sw_if_index);
 146
 147   vl_api_send_msg (reg, (u8 *) rmp);
 148 }
 149
 150 static void
 151 vl_api_tap_delete_v2_t_handler (vl_api_tap_delete_v2_t * mp)
 152 {
 153   vl_api_registration_t *reg;
 154   reg = vl_api_client_index_to_registration (mp->client_index);
 155   if (!reg)
 156     return;
 157
 158   vnet_main_t *vnm = vnet_get_main ();
 159   vlib_main_t *vm = vlib_get_main ();
 160   int rv;
 161   vl_api_tap_delete_v2_reply_t *rmp;
 162
 163   u32 sw_if_index = ntohl (mp->sw_if_index);
 164
 165   rv = tap_delete_if (vm, sw_if_index);
 166
 167   rmp = vl_msg_api_alloc (sizeof (*rmp));
 168   rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_V2_REPLY);
 169   rmp->context = mp->context;
 170   rmp->retval = ntohl (rv);
 171
 172   vl_api_send_msg (reg, (u8 *) rmp);
 173
 174   if (!rv)
 175     vnet_clear_sw_interface_tag (vnm, sw_if_index);
 176 }
 177
 178 static void
 179 tap_send_sw_interface_details (vpe_api_main_t * am,
 180                                vl_api_registration_t * reg,
 181                                tap_interface_details_t * tap_if, u32 context)
 182 {
 183   vl_api_sw_interface_tap_v2_details_t *mp;
 184   mp = vl_msg_api_alloc (sizeof (*mp));
 185   clib_memset (mp, 0, sizeof (*mp));
 186   mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_TAP_V2_DETAILS);
 187   mp->id = htonl (tap_if->id);
 188   mp->sw_if_index = htonl (tap_if->sw_if_index);
 189   mp->tap_flags = htonl (tap_if->tap_flags);
 190   clib_memcpy (mp->dev_name, tap_if->dev_name,
 191                MIN (ARRAY_LEN (mp->dev_name) - 1,
 192                     strlen ((const char *) tap_if->dev_name)));
 193   mp->rx_ring_sz = htons (tap_if->rx_ring_sz);
 194   mp->tx_ring_sz = htons (tap_if->tx_ring_sz);
 195   mac_address_encode (&tap_if->host_mac_addr, mp->host_mac_addr);
 196   clib_memcpy (mp->host_if_name, tap_if->host_if_name,
 197                MIN (ARRAY_LEN (mp->host_if_name) - 1,
 198                     strlen ((const char *) tap_if->host_if_name)));
 199   clib_memcpy (mp->host_namespace, tap_if->host_namespace,
 200                MIN (ARRAY_LEN (mp->host_namespace) - 1,
 201                     strlen ((const char *) tap_if->host_namespace)));
 202   clib_memcpy (mp->host_bridge, tap_if->host_bridge,
 203                MIN (ARRAY_LEN (mp->host_bridge) - 1,
 204                     strlen ((const char *) tap_if->host_bridge)));
 205   mp->host_mtu_size = htonl (tap_if->host_mtu_size);
 206   mac_address_encode (&tap_if->host_mac_addr, mp->host_mac_addr);
 207
 208   if (tap_if->host_ip4_prefix_len)
 209     ip4_address_encode (&tap_if->host_ip4_addr, mp->host_ip4_prefix.address);
 210   mp->host_ip4_prefix.len = tap_if->host_ip4_prefix_len;
 211   if (tap_if->host_ip6_prefix_len)
 212     ip6_address_encode (&tap_if->host_ip6_addr, mp->host_ip6_prefix.address);
 213   mp->host_ip6_prefix.len = tap_if->host_ip6_prefix_len;
 214
 215   mp->context = context;
 216   vl_api_send_msg (reg, (u8 *) mp);
 217 }
 218
 219 static void
 220 vl_api_sw_interface_tap_v2_dump_t_handler (vl_api_sw_interface_tap_v2_dump_t *
 221                                            mp)
 222 {
 223   int rv;
 224   vpe_api_main_t *am = &vpe_api_main;
 225   vl_api_registration_t *reg;
 226   tap_interface_details_t *tapifs = NULL;
 227   tap_interface_details_t *tap_if = NULL;
 228   u32 filter_sw_if_index;
 229
 230   reg = vl_api_client_index_to_registration (mp->client_index);
 231   if (!reg)
 232     return;
 233
 234   filter_sw_if_index = htonl (mp->sw_if_index);
 235   if (filter_sw_if_index != ~0)
 236     return;                     /* UNIMPLEMENTED */
 237
 238   rv = tap_dump_ifs (&tapifs);
 239   if (rv)
 240     return;
 241
 242   vec_foreach (tap_if, tapifs)
 243   {
 244     tap_send_sw_interface_details (am, reg, tap_if, mp->context);
 245   }
 246
 247   vec_free (tapifs);
 248 }
 249
 250 #define vl_msg_name_crc_list
 251 #include <vnet/vnet_all_api_h.h>
 252 #undef vl_msg_name_crc_list
 253
 254 static void
 255 tap_setup_message_id_table (api_main_t * am)
 256 {
 257 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
 258   foreach_vl_msg_name_crc_tapv2;
 259 #undef _
 260 }
 261
 262 static clib_error_t *
 263 tapv2_api_hookup (vlib_main_t * vm)
 264 {
 265   api_main_t *am = vlibapi_get_main ();
 266
 267 #define _(N,n)                                                  \
 268     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
 269                            vl_api_##n##_t_handler,              \
 270                            vl_noop_handler,                     \
 271                            vl_api_##n##_t_endian,               \
 272                            vl_api_##n##_t_print,                \
 273                            sizeof(vl_api_##n##_t), 1);
 274   foreach_tapv2_api_msg;
 275 #undef _
 276
 277   /*
 278    * Set up the (msg_name, crc, message-id) table
 279    */
 280   tap_setup_message_id_table (am);
 281
 282   return 0;
 283 }
 284
 285 VLIB_API_INIT_FUNCTION (tapv2_api_hookup);
 286
 287 /*
 288  * fd.io coding-style-patch-verification: ON
 289  *
 290  * Local Variables:
 291  * eval: (c-set-style "gnu")
 292  * End:
 293  */