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