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