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