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