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/vnet_msg_enum.h>
  29
  30 #define vl_typedefs             /* define message structures */
  31 #include <vnet/vnet_all_api_h.h>
  32 #undef vl_typedefs
  33
  34 #define vl_endianfun            /* define message structures */
  35 #include <vnet/vnet_all_api_h.h>
  36 #undef vl_endianfun
  37
  38 /* instantiate all the print functions we know about */
  39 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
  40 #define vl_printfun
  41 #include <vnet/vnet_all_api_h.h>
  42 #undef vl_printfun
  43
  44 #include <vlibapi/api_helper_macros.h>
  45 #include <vnet/devices/tap/tap.h>
  46
  47 #define foreach_tapv2_api_msg                     \
  48 _(TAP_CREATE_V2, tap_create_v2)                   \
  49 _(TAP_DELETE_V2, tap_delete_v2)                   \
  50 _(SW_INTERFACE_TAP_V2_DUMP, sw_interface_tap_v2_dump)
  51
  52 static void
  53 vl_api_tap_create_v2_t_handler (vl_api_tap_create_v2_t * mp)
  54 {
  55   vnet_main_t *vnm = vnet_get_main ();
  56   vlib_main_t *vm = vlib_get_main ();
  57   vl_api_tap_create_v2_reply_t *rmp;
  58   vl_api_registration_t *reg;
  59   tap_create_if_args_t _a, *ap = &_a;
  60
  61   clib_memset (ap, 0, sizeof (*ap));
  62
  63   ap->id = ntohl (mp->id);
  64   if (!mp->use_random_mac)
  65     {
  66       clib_memcpy (ap->mac_addr, mp->mac_address, 6);
  67       ap->mac_addr_set = 1;
  68     }
  69   ap->rx_ring_sz = ntohs (mp->rx_ring_sz);
  70   ap->tx_ring_sz = ntohs (mp->tx_ring_sz);
  71   ap->sw_if_index = (u32) ~ 0;
  72
  73   if (mp->host_if_name_set)
  74     ap->host_if_name = mp->host_if_name;
  75
  76   if (mp->host_mac_addr_set)
  77     {
  78       clib_memcpy (ap->host_mac_addr, mp->host_mac_addr, 6);
  79       ap->mac_addr_set = 1;
  80     }
  81
  82   if (mp->host_namespace_set)
  83     ap->host_namespace = mp->host_namespace;
  84
  85   if (mp->host_bridge_set)
  86     ap->host_bridge = mp->host_bridge;
  87
  88   if (mp->host_ip4_addr_set)
  89     {
  90       clib_memcpy (&ap->host_ip4_addr.as_u8, mp->host_ip4_addr, 4);
  91       ap->host_ip4_prefix_len = mp->host_ip4_prefix_len;
  92     }
  93
  94   if (mp->host_ip6_addr_set)
  95     {
  96       clib_memcpy (&ap->host_ip6_addr, mp->host_ip6_addr, 16);
  97       ap->host_ip6_prefix_len = mp->host_ip6_prefix_len;
  98     }
  99
 100   if (mp->host_ip4_gw_set)
 101     {
 102       clib_memcpy (&ap->host_ip4_gw, mp->host_ip4_gw, 4);
 103       ap->host_ip4_gw_set = 1;
 104     }
 105
 106   if (mp->host_ip6_gw_set)
 107     {
 108       clib_memcpy (&ap->host_ip6_gw, mp->host_ip6_gw, 16);
 109       ap->host_ip6_gw_set = 1;
 110     }
 111
 112   ap->tap_flags = ntohl (mp->tap_flags);
 113
 114   tap_create_if (vm, ap);
 115
 116   reg = vl_api_client_index_to_registration (mp->client_index);
 117   if (!reg)
 118     return;;
 119
 120   /* If a tag was supplied... */
 121   if (mp->tag[0])
 122     {
 123       /* Make sure it's a proper C-string */
 124       mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
 125       u8 *tag = format (0, "%s%c", mp->tag, 0);
 126       vnet_set_sw_interface_tag (vnm, tag, ap->sw_if_index);
 127     }
 128
 129
 130   rmp = vl_msg_api_alloc (sizeof (*rmp));
 131   rmp->_vl_msg_id = ntohs (VL_API_TAP_CREATE_V2_REPLY);
 132   rmp->context = mp->context;
 133   rmp->retval = ntohl (ap->rv);
 134   rmp->sw_if_index = ntohl (ap->sw_if_index);
 135
 136   vl_api_send_msg (reg, (u8 *) rmp);
 137 }
 138
 139 static void
 140 tap_send_sw_interface_event_deleted (vpe_api_main_t * am,
 141                                      vl_api_registration_t * reg,
 142                                      u32 sw_if_index)
 143 {
 144   vl_api_sw_interface_event_t *mp;
 145
 146   mp = vl_msg_api_alloc (sizeof (*mp));
 147   clib_memset (mp, 0, sizeof (*mp));
 148   mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
 149   mp->sw_if_index = ntohl (sw_if_index);
 150
 151   mp->admin_up_down = 0;
 152   mp->link_up_down = 0;
 153   mp->deleted = 1;
 154   vl_api_send_msg (reg, (u8 *) mp);
 155 }
 156
 157 static void
 158 vl_api_tap_delete_v2_t_handler (vl_api_tap_delete_v2_t * mp)
 159 {
 160   vnet_main_t *vnm = vnet_get_main ();
 161   vlib_main_t *vm = vlib_get_main ();
 162   int rv;
 163   vpe_api_main_t *vam = &vpe_api_main;
 164   vl_api_tap_delete_v2_reply_t *rmp;
 165   vl_api_registration_t *reg;
 166   u32 sw_if_index = ntohl (mp->sw_if_index);
 167
 168   rv = tap_delete_if (vm, sw_if_index);
 169
 170   reg = vl_api_client_index_to_registration (mp->client_index);
 171   if (!reg)
 172     return;
 173
 174   rmp = vl_msg_api_alloc (sizeof (*rmp));
 175   rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_V2_REPLY);
 176   rmp->context = mp->context;
 177   rmp->retval = ntohl (rv);
 178
 179   vl_api_send_msg (reg, (u8 *) rmp);
 180
 181   if (!rv)
 182     {
 183       vnet_clear_sw_interface_tag (vnm, sw_if_index);
 184       tap_send_sw_interface_event_deleted (vam, reg, sw_if_index);
 185     }
 186 }
 187
 188 static void
 189 tap_send_sw_interface_details (vpe_api_main_t * am,
 190                                vl_api_registration_t * reg,
 191                                tap_interface_details_t * tap_if, u32 context)
 192 {
 193   vl_api_sw_interface_tap_v2_details_t *mp;
 194   mp = vl_msg_api_alloc (sizeof (*mp));
 195   clib_memset (mp, 0, sizeof (*mp));
 196   mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_TAP_V2_DETAILS);
 197   mp->id = htonl (tap_if->id);
 198   mp->sw_if_index = htonl (tap_if->sw_if_index);
 199   mp->tap_flags = htonl (tap_if->tap_flags);
 200   clib_memcpy (mp->dev_name, tap_if->dev_name,
 201                MIN (ARRAY_LEN (mp->dev_name) - 1,
 202                     strlen ((const char *) tap_if->dev_name)));
 203   mp->rx_ring_sz = htons (tap_if->rx_ring_sz);
 204   mp->tx_ring_sz = htons (tap_if->tx_ring_sz);
 205   clib_memcpy (mp->host_mac_addr, tap_if->host_mac_addr, 6);
 206   clib_memcpy (mp->host_if_name, tap_if->host_if_name,
 207                MIN (ARRAY_LEN (mp->host_if_name) - 1,
 208                     strlen ((const char *) tap_if->host_if_name)));
 209   clib_memcpy (mp->host_namespace, tap_if->host_namespace,
 210                MIN (ARRAY_LEN (mp->host_namespace) - 1,
 211                     strlen ((const char *) tap_if->host_namespace)));
 212   clib_memcpy (mp->host_bridge, tap_if->host_bridge,
 213                MIN (ARRAY_LEN (mp->host_bridge) - 1,
 214                     strlen ((const char *) tap_if->host_bridge)));
 215   if (tap_if->host_ip4_prefix_len)
 216     clib_memcpy (&mp->host_ip4_addr, &tap_if->host_ip4_addr, 4);
 217   mp->host_ip4_prefix_len = tap_if->host_ip4_prefix_len;
 218   if (tap_if->host_ip6_prefix_len)
 219     clib_memcpy (&mp->host_ip6_addr, &tap_if->host_ip6_addr, 16);
 220   mp->host_ip6_prefix_len = tap_if->host_ip6_prefix_len;
 221
 222   mp->context = context;
 223   vl_api_send_msg (reg, (u8 *) mp);
 224 }
 225
 226 static void
 227 vl_api_sw_interface_tap_v2_dump_t_handler (vl_api_sw_interface_tap_v2_dump_t *
 228                                            mp)
 229 {
 230   int rv;
 231   vpe_api_main_t *am = &vpe_api_main;
 232   vl_api_registration_t *reg;
 233   tap_interface_details_t *tapifs = NULL;
 234   tap_interface_details_t *tap_if = NULL;
 235
 236   reg = vl_api_client_index_to_registration (mp->client_index);
 237   if (!reg)
 238     return;
 239
 240   rv = tap_dump_ifs (&tapifs);
 241   if (rv)
 242     return;
 243
 244   vec_foreach (tap_if, tapifs)
 245   {
 246     tap_send_sw_interface_details (am, reg, tap_if, mp->context);
 247   }
 248
 249   vec_free (tapifs);
 250 }
 251
 252 #define vl_msg_name_crc_list
 253 #include <vnet/vnet_all_api_h.h>
 254 #undef vl_msg_name_crc_list
 255
 256 static void
 257 tap_setup_message_id_table (api_main_t * am)
 258 {
 259 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
 260   foreach_vl_msg_name_crc_tapv2;
 261 #undef _
 262 }
 263
 264 static clib_error_t *
 265 tapv2_api_hookup (vlib_main_t * vm)
 266 {
 267   api_main_t *am = &api_main;
 268
 269 #define _(N,n)                                                  \
 270     vl_msg_api_set_handlers(VL_API_##N, #n,                     \
 271                            vl_api_##n##_t_handler,              \
 272                            vl_noop_handler,                     \
 273                            vl_api_##n##_t_endian,               \
 274                            vl_api_##n##_t_print,                \
 275                            sizeof(vl_api_##n##_t), 1);
 276   foreach_tapv2_api_msg;
 277 #undef _
 278
 279   /*
 280    * Set up the (msg_name, crc, message-id) table
 281    */
 282   tap_setup_message_id_table (am);
 283
 284   return 0;
 285 }
 286
 287 VLIB_API_INIT_FUNCTION (tapv2_api_hookup);
 288
 289 /*
 290  * fd.io coding-style-patch-verification: ON
 291  *
 292  * Local Variables:
 293  * eval: (c-set-style "gnu")
 294  * End:
 295  */