src/vnet/devices/af_packet/af_packet.c

   1 /*
   2  *------------------------------------------------------------------
   3  * af_packet.c - linux kernel packet interface
   4  *
   5  * Copyright (c) 2016 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 <linux/if_ether.h>
  21 #include <linux/if_packet.h>
  22 #include <dirent.h>
  23
  24 #include <vlib/vlib.h>
  25 #include <vlib/unix/unix.h>
  26 #include <vnet/ip/ip.h>
  27 #include <vnet/ethernet/ethernet.h>
  28
  29 #include <vnet/devices/af_packet/af_packet.h>
  30
  31 #define AF_PACKET_DEBUG_SOCKET          0
  32
  33 #define AF_PACKET_TX_FRAMES_PER_BLOCK   1024
  34 #define AF_PACKET_TX_FRAME_SIZE         (2048 * 5)
  35 #define AF_PACKET_TX_BLOCK_NR           1
  36 #define AF_PACKET_TX_FRAME_NR           (AF_PACKET_TX_BLOCK_NR * \
  37                                          AF_PACKET_TX_FRAMES_PER_BLOCK)
  38 #define AF_PACKET_TX_BLOCK_SIZE         (AF_PACKET_TX_FRAME_SIZE * \
  39                                          AF_PACKET_TX_FRAMES_PER_BLOCK)
  40
  41 #define AF_PACKET_RX_FRAMES_PER_BLOCK   1024
  42 #define AF_PACKET_RX_FRAME_SIZE         (2048 * 5)
  43 #define AF_PACKET_RX_BLOCK_NR           1
  44 #define AF_PACKET_RX_FRAME_NR           (AF_PACKET_RX_BLOCK_NR * \
  45                                          AF_PACKET_RX_FRAMES_PER_BLOCK)
  46 #define AF_PACKET_RX_BLOCK_SIZE         (AF_PACKET_RX_FRAME_SIZE * \
  47                                          AF_PACKET_RX_FRAMES_PER_BLOCK)
  48
  49 #if AF_PACKET_DEBUG_SOCKET == 1
  50 #define DBG_SOCK(args...) clib_warning(args);
  51 #else
  52 #define DBG_SOCK(args...)
  53 #endif
  54
  55 /*defined in net/if.h but clashes with dpdk headers */
  56 unsigned int if_nametoindex (const char *ifname);
  57
  58 typedef struct tpacket_req tpacket_req_t;
  59
  60 static u32
  61 af_packet_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
  62                            u32 flags)
  63 {
  64   /* nothing for now */
  65   return 0;
  66 }
  67
  68 static clib_error_t *
  69 af_packet_fd_read_ready (unix_file_t * uf)
  70 {
  71   af_packet_main_t *apm = &af_packet_main;
  72   vnet_main_t *vnm = vnet_get_main ();
  73   u32 idx = uf->private_data;
  74   af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, idx);
  75
  76   apm->pending_input_bitmap =
  77     clib_bitmap_set (apm->pending_input_bitmap, idx, 1);
  78
  79   /* Schedule the rx node */
  80   vnet_device_input_set_interrupt_pending (vnm, apif->hw_if_index, 0);
  81
  82   return 0;
  83 }
  84
  85 static int
  86 is_bridge (const u8 * host_if_name)
  87 {
  88   u8 *s;
  89   DIR *dir = NULL;
  90
  91   s = format (0, "/sys/class/net/%s/bridge%c", host_if_name, 0);
  92   dir = opendir ((char *) s);
  93   vec_free (s);
  94
  95   if (dir)
  96     {
  97       closedir (dir);
  98       return 0;
  99     }
 100
 101   return -1;
 102 }
 103
 104 static int
 105 create_packet_v2_sock (int host_if_index, tpacket_req_t * rx_req,
 106                        tpacket_req_t * tx_req, int *fd, u8 ** ring)
 107 {
 108   int ret, err;
 109   struct sockaddr_ll sll;
 110   int ver = TPACKET_V2;
 111   socklen_t req_sz = sizeof (struct tpacket_req);
 112   u32 ring_sz = rx_req->tp_block_size * rx_req->tp_block_nr +
 113     tx_req->tp_block_size * tx_req->tp_block_nr;
 114
 115   if ((*fd = socket (AF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
 116     {
 117       DBG_SOCK ("Failed to create socket");
 118       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 119       goto error;
 120     }
 121
 122   if ((err =
 123        setsockopt (*fd, SOL_PACKET, PACKET_VERSION, &ver, sizeof (ver))) < 0)
 124     {
 125       DBG_SOCK ("Failed to set rx packet interface version");
 126       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 127       goto error;
 128     }
 129
 130   int opt = 1;
 131   if ((err =
 132        setsockopt (*fd, SOL_PACKET, PACKET_LOSS, &opt, sizeof (opt))) < 0)
 133     {
 134       DBG_SOCK ("Failed to set packet tx ring error handling option");
 135       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 136       goto error;
 137     }
 138
 139   if ((err =
 140        setsockopt (*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz)) < 0)
 141     {
 142       DBG_SOCK ("Failed to set packet rx ring options");
 143       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 144       goto error;
 145     }
 146
 147   if ((err =
 148        setsockopt (*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz)) < 0)
 149     {
 150       DBG_SOCK ("Failed to set packet rx ring options");
 151       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 152       goto error;
 153     }
 154
 155   *ring =
 156     mmap (NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED, *fd,
 157           0);
 158   if (*ring == MAP_FAILED)
 159     {
 160       DBG_SOCK ("mmap failure");
 161       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 162       goto error;
 163     }
 164
 165   memset (&sll, 0, sizeof (sll));
 166   sll.sll_family = PF_PACKET;
 167   sll.sll_protocol = htons (ETH_P_ALL);
 168   sll.sll_ifindex = host_if_index;
 169
 170   if ((err = bind (*fd, (struct sockaddr *) &sll, sizeof (sll))) < 0)
 171     {
 172       DBG_SOCK ("Failed to bind rx packet socket (error %d)", err);
 173       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 174       goto error;
 175     }
 176
 177   return 0;
 178 error:
 179   if (*fd >= 0)
 180     close (*fd);
 181   *fd = -1;
 182   return ret;
 183 }
 184
 185 int
 186 af_packet_create_if (vlib_main_t * vm, u8 * host_if_name, u8 * hw_addr_set,
 187                      u32 * sw_if_index)
 188 {
 189   af_packet_main_t *apm = &af_packet_main;
 190   int ret, fd = -1;
 191   struct tpacket_req *rx_req = 0;
 192   struct tpacket_req *tx_req = 0;
 193   u8 *ring = 0;
 194   af_packet_if_t *apif = 0;
 195   u8 hw_addr[6];
 196   clib_error_t *error;
 197   vnet_sw_interface_t *sw;
 198   vnet_hw_interface_t *hw;
 199   vlib_thread_main_t *tm = vlib_get_thread_main ();
 200   vnet_main_t *vnm = vnet_get_main ();
 201   uword *p;
 202   uword if_index;
 203   u8 *host_if_name_dup = vec_dup (host_if_name);
 204   int host_if_index = -1;
 205
 206   p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
 207   if (p)
 208     {
 209       return VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
 210     }
 211
 212   vec_validate (rx_req, 0);
 213   rx_req->tp_block_size = AF_PACKET_RX_BLOCK_SIZE;
 214   rx_req->tp_frame_size = AF_PACKET_RX_FRAME_SIZE;
 215   rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
 216   rx_req->tp_frame_nr = AF_PACKET_RX_FRAME_NR;
 217
 218   vec_validate (tx_req, 0);
 219   tx_req->tp_block_size = AF_PACKET_TX_BLOCK_SIZE;
 220   tx_req->tp_frame_size = AF_PACKET_TX_FRAME_SIZE;
 221   tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
 222   tx_req->tp_frame_nr = AF_PACKET_TX_FRAME_NR;
 223
 224   host_if_index = if_nametoindex ((const char *) host_if_name);
 225
 226   if (!host_if_index)
 227     {
 228       DBG_SOCK ("Wrong host interface name");
 229       return VNET_API_ERROR_INVALID_INTERFACE;
 230     }
 231
 232   ret = create_packet_v2_sock (host_if_index, rx_req, tx_req, &fd, &ring);
 233
 234   if (ret != 0)
 235     goto error;
 236
 237   ret = is_bridge (host_if_name);
 238
 239   if (ret == 0)                 /* is a bridge, ignore state */
 240     host_if_index = -1;
 241
 242   /* So far everything looks good, let's create interface */
 243   pool_get (apm->interfaces, apif);
 244   if_index = apif - apm->interfaces;
 245
 246   apif->host_if_index = host_if_index;
 247   apif->fd = fd;
 248   apif->rx_ring = ring;
 249   apif->tx_ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
 250   apif->rx_req = rx_req;
 251   apif->tx_req = tx_req;
 252   apif->host_if_name = host_if_name_dup;
 253   apif->per_interface_next_index = ~0;
 254   apif->next_tx_frame = 0;
 255   apif->next_rx_frame = 0;
 256
 257   if (tm->n_vlib_mains > 1)
 258     clib_spinlock_init (&apif->lockp);
 259
 260   {
 261     unix_file_t template = { 0 };
 262     template.read_function = af_packet_fd_read_ready;
 263     template.file_descriptor = fd;
 264     template.private_data = if_index;
 265     template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
 266     apif->unix_file_index = unix_file_add (&unix_main, &template);
 267   }
 268
 269   /*use configured or generate random MAC address */
 270   if (hw_addr_set)
 271     clib_memcpy (hw_addr, hw_addr_set, 6);
 272   else
 273     {
 274       f64 now = vlib_time_now (vm);
 275       u32 rnd;
 276       rnd = (u32) (now * 1e6);
 277       rnd = random_u32 (&rnd);
 278
 279       clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
 280       hw_addr[0] = 2;
 281       hw_addr[1] = 0xfe;
 282     }
 283
 284   error = ethernet_register_interface (vnm, af_packet_device_class.index,
 285                                        if_index, hw_addr, &apif->hw_if_index,
 286                                        af_packet_eth_flag_change);
 287
 288   if (error)
 289     {
 290       memset (apif, 0, sizeof (*apif));
 291       pool_put (apm->interfaces, apif);
 292       clib_error_report (error);
 293       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 294       goto error;
 295     }
 296
 297   sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
 298   hw = vnet_get_hw_interface (vnm, apif->hw_if_index);
 299   apif->sw_if_index = sw->sw_if_index;
 300   vnet_hw_interface_set_input_node (vnm, apif->hw_if_index,
 301                                     af_packet_input_node.index);
 302
 303   vnet_hw_interface_assign_rx_thread (vnm, apif->hw_if_index, 0,        /* queue */
 304                                       ~0 /* any cpu */ );
 305
 306   hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
 307   vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
 308                                VNET_HW_INTERFACE_FLAG_LINK_UP);
 309
 310   vnet_hw_interface_set_rx_mode (vnm, apif->hw_if_index, 0,
 311                                  VNET_HW_INTERFACE_RX_MODE_INTERRUPT);
 312
 313   mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name_dup, &if_index,
 314                  0);
 315   if (sw_if_index)
 316     *sw_if_index = apif->sw_if_index;
 317
 318   return 0;
 319
 320 error:
 321   vec_free (host_if_name_dup);
 322   vec_free (rx_req);
 323   vec_free (tx_req);
 324   return ret;
 325 }
 326
 327 int
 328 af_packet_delete_if (vlib_main_t * vm, u8 * host_if_name)
 329 {
 330   vnet_main_t *vnm = vnet_get_main ();
 331   af_packet_main_t *apm = &af_packet_main;
 332   af_packet_if_t *apif;
 333   uword *p;
 334   uword if_index;
 335   u32 ring_sz;
 336
 337   p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
 338   if (p == NULL)
 339     {
 340       clib_warning ("Host interface %s does not exist", host_if_name);
 341       return VNET_API_ERROR_SYSCALL_ERROR_1;
 342     }
 343   apif = pool_elt_at_index (apm->interfaces, p[0]);
 344   if_index = apif - apm->interfaces;
 345
 346   /* bring down the interface */
 347   vnet_hw_interface_set_flags (vnm, apif->hw_if_index, 0);
 348   vnet_hw_interface_unassign_rx_thread (vnm, apif->hw_if_index, 0);
 349
 350   /* clean up */
 351   if (apif->unix_file_index != ~0)
 352     {
 353       unix_file_del (&unix_main, unix_main.file_pool + apif->unix_file_index);
 354       apif->unix_file_index = ~0;
 355     }
 356   else
 357     close (apif->fd);
 358
 359   ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
 360     apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
 361   if (munmap (apif->rx_ring, ring_sz))
 362     clib_warning ("Host interface %s could not free rx/tx ring",
 363                   host_if_name);
 364   apif->rx_ring = NULL;
 365   apif->tx_ring = NULL;
 366   apif->fd = -1;
 367
 368   vec_free (apif->rx_req);
 369   apif->rx_req = NULL;
 370   vec_free (apif->tx_req);
 371   apif->tx_req = NULL;
 372
 373   vec_free (apif->host_if_name);
 374   apif->host_if_name = NULL;
 375   apif->host_if_index = -1;
 376
 377   mhash_unset (&apm->if_index_by_host_if_name, host_if_name, &if_index);
 378
 379   ethernet_delete_interface (vnm, apif->hw_if_index);
 380
 381   pool_put (apm->interfaces, apif);
 382
 383   return 0;
 384 }
 385
 386 static clib_error_t *
 387 af_packet_init (vlib_main_t * vm)
 388 {
 389   af_packet_main_t *apm = &af_packet_main;
 390   vlib_thread_main_t *tm = vlib_get_thread_main ();
 391
 392   memset (apm, 0, sizeof (af_packet_main_t));
 393
 394   mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
 395
 396   vec_validate_aligned (apm->rx_buffers, tm->n_vlib_mains - 1,
 397                         CLIB_CACHE_LINE_BYTES);
 398
 399   return 0;
 400 }
 401
 402 VLIB_INIT_FUNCTION (af_packet_init);
 403
 404 /*
 405  * fd.io coding-style-patch-verification: ON
 406  *
 407  * Local Variables:
 408  * eval: (c-set-style "gnu")
 409  * End:
 410  */