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