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