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 <dirent.h>
  23 #include <sys/stat.h>
  24 #include <sys/types.h>
  25 #include <fcntl.h>
  26
  27 #include <vlib/vlib.h>
  28 #include <vlib/unix/unix.h>
  29 #include <vnet/ip/ip.h>
  30 #include <vnet/ethernet/ethernet.h>
  31
  32 #include <vnet/devices/af_packet/af_packet.h>
  33
  34 #define AF_PACKET_DEBUG_SOCKET          0
  35
  36 #define AF_PACKET_TX_FRAMES_PER_BLOCK   1024
  37 #define AF_PACKET_TX_FRAME_SIZE         (2048 * 5)
  38 #define AF_PACKET_TX_BLOCK_NR           1
  39 #define AF_PACKET_TX_FRAME_NR           (AF_PACKET_TX_BLOCK_NR * \
  40                                          AF_PACKET_TX_FRAMES_PER_BLOCK)
  41 #define AF_PACKET_TX_BLOCK_SIZE         (AF_PACKET_TX_FRAME_SIZE * \
  42                                          AF_PACKET_TX_FRAMES_PER_BLOCK)
  43
  44 #define AF_PACKET_RX_FRAMES_PER_BLOCK   1024
  45 #define AF_PACKET_RX_FRAME_SIZE         (2048 * 5)
  46 #define AF_PACKET_RX_BLOCK_NR           1
  47 #define AF_PACKET_RX_FRAME_NR           (AF_PACKET_RX_BLOCK_NR * \
  48                                          AF_PACKET_RX_FRAMES_PER_BLOCK)
  49 #define AF_PACKET_RX_BLOCK_SIZE         (AF_PACKET_RX_FRAME_SIZE * \
  50                                          AF_PACKET_RX_FRAMES_PER_BLOCK)
  51
  52 #if AF_PACKET_DEBUG_SOCKET == 1
  53 #define DBG_SOCK(args...) clib_warning(args);
  54 #else
  55 #define DBG_SOCK(args...)
  56 #endif
  57
  58 /*defined in net/if.h but clashes with dpdk headers */
  59 unsigned int if_nametoindex (const char *ifname);
  60
  61 typedef struct tpacket_req tpacket_req_t;
  62
  63 static u32
  64 af_packet_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi,
  65                            u32 flags)
  66 {
  67   clib_error_t *error;
  68   u8 *s;
  69   af_packet_main_t *apm = &af_packet_main;
  70   af_packet_if_t *apif =
  71     pool_elt_at_index (apm->interfaces, hi->dev_instance);
  72
  73   if (ETHERNET_INTERFACE_FLAG_MTU == (flags & ETHERNET_INTERFACE_FLAG_MTU))
  74     {
  75       s = format (0, "/sys/class/net/%s/mtu%c", apif->host_if_name, 0);
  76
  77       error = vlib_sysfs_write ((char *) s, "%d", hi->max_packet_bytes);
  78       vec_free (s);
  79
  80       if (error)
  81         {
  82           clib_error_report (error);
  83           return VNET_API_ERROR_SYSCALL_ERROR_1;
  84         }
  85     }
  86
  87   return 0;
  88 }
  89
  90 static clib_error_t *
  91 af_packet_fd_read_ready (unix_file_t * uf)
  92 {
  93   af_packet_main_t *apm = &af_packet_main;
  94   vnet_main_t *vnm = vnet_get_main ();
  95   u32 idx = uf->private_data;
  96   af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, idx);
  97
  98   apm->pending_input_bitmap =
  99     clib_bitmap_set (apm->pending_input_bitmap, idx, 1);
 100
 101   /* Schedule the rx node */
 102   vnet_device_input_set_interrupt_pending (vnm, apif->hw_if_index, 0);
 103
 104   return 0;
 105 }
 106
 107 static int
 108 is_bridge (const u8 * host_if_name)
 109 {
 110   u8 *s;
 111   DIR *dir = NULL;
 112
 113   s = format (0, "/sys/class/net/%s/bridge%c", host_if_name, 0);
 114   dir = opendir ((char *) s);
 115   vec_free (s);
 116
 117   if (dir)
 118     {
 119       closedir (dir);
 120       return 0;
 121     }
 122
 123   return -1;
 124 }
 125
 126 static int
 127 create_packet_v2_sock (int host_if_index, tpacket_req_t * rx_req,
 128                        tpacket_req_t * tx_req, int *fd, u8 ** ring)
 129 {
 130   int ret, err;
 131   struct sockaddr_ll sll;
 132   int ver = TPACKET_V2;
 133   socklen_t req_sz = sizeof (struct tpacket_req);
 134   u32 ring_sz = rx_req->tp_block_size * rx_req->tp_block_nr +
 135     tx_req->tp_block_size * tx_req->tp_block_nr;
 136
 137   if ((*fd = socket (AF_PACKET, SOCK_RAW, htons (ETH_P_ALL))) < 0)
 138     {
 139       DBG_SOCK ("Failed to create socket");
 140       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 141       goto error;
 142     }
 143
 144   if ((err =
 145        setsockopt (*fd, SOL_PACKET, PACKET_VERSION, &ver, sizeof (ver))) < 0)
 146     {
 147       DBG_SOCK ("Failed to set rx packet interface version");
 148       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 149       goto error;
 150     }
 151
 152   int opt = 1;
 153   if ((err =
 154        setsockopt (*fd, SOL_PACKET, PACKET_LOSS, &opt, sizeof (opt))) < 0)
 155     {
 156       DBG_SOCK ("Failed to set packet tx ring error handling option");
 157       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 158       goto error;
 159     }
 160
 161   if ((err =
 162        setsockopt (*fd, SOL_PACKET, PACKET_RX_RING, rx_req, req_sz)) < 0)
 163     {
 164       DBG_SOCK ("Failed to set packet rx ring options");
 165       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 166       goto error;
 167     }
 168
 169   if ((err =
 170        setsockopt (*fd, SOL_PACKET, PACKET_TX_RING, tx_req, req_sz)) < 0)
 171     {
 172       DBG_SOCK ("Failed to set packet rx ring options");
 173       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 174       goto error;
 175     }
 176
 177   *ring =
 178     mmap (NULL, ring_sz, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_LOCKED, *fd,
 179           0);
 180   if (*ring == MAP_FAILED)
 181     {
 182       DBG_SOCK ("mmap failure");
 183       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 184       goto error;
 185     }
 186
 187   memset (&sll, 0, sizeof (sll));
 188   sll.sll_family = PF_PACKET;
 189   sll.sll_protocol = htons (ETH_P_ALL);
 190   sll.sll_ifindex = host_if_index;
 191
 192   if ((err = bind (*fd, (struct sockaddr *) &sll, sizeof (sll))) < 0)
 193     {
 194       DBG_SOCK ("Failed to bind rx packet socket (error %d)", err);
 195       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 196       goto error;
 197     }
 198
 199   return 0;
 200 error:
 201   if (*fd >= 0)
 202     close (*fd);
 203   *fd = -1;
 204   return ret;
 205 }
 206
 207 int
 208 af_packet_create_if (vlib_main_t * vm, u8 * host_if_name, u8 * hw_addr_set,
 209                      u32 * sw_if_index)
 210 {
 211   af_packet_main_t *apm = &af_packet_main;
 212   int ret, fd = -1;
 213   struct tpacket_req *rx_req = 0;
 214   struct tpacket_req *tx_req = 0;
 215   u8 *ring = 0;
 216   af_packet_if_t *apif = 0;
 217   u8 hw_addr[6];
 218   clib_error_t *error;
 219   vnet_sw_interface_t *sw;
 220   vnet_hw_interface_t *hw;
 221   vlib_thread_main_t *tm = vlib_get_thread_main ();
 222   vnet_main_t *vnm = vnet_get_main ();
 223   uword *p;
 224   uword if_index;
 225   u8 *host_if_name_dup = vec_dup (host_if_name);
 226   int host_if_index = -1;
 227
 228   p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
 229   if (p)
 230     {
 231       return VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
 232     }
 233
 234   vec_validate (rx_req, 0);
 235   rx_req->tp_block_size = AF_PACKET_RX_BLOCK_SIZE;
 236   rx_req->tp_frame_size = AF_PACKET_RX_FRAME_SIZE;
 237   rx_req->tp_block_nr = AF_PACKET_RX_BLOCK_NR;
 238   rx_req->tp_frame_nr = AF_PACKET_RX_FRAME_NR;
 239
 240   vec_validate (tx_req, 0);
 241   tx_req->tp_block_size = AF_PACKET_TX_BLOCK_SIZE;
 242   tx_req->tp_frame_size = AF_PACKET_TX_FRAME_SIZE;
 243   tx_req->tp_block_nr = AF_PACKET_TX_BLOCK_NR;
 244   tx_req->tp_frame_nr = AF_PACKET_TX_FRAME_NR;
 245
 246   host_if_index = if_nametoindex ((const char *) host_if_name);
 247
 248   if (!host_if_index)
 249     {
 250       DBG_SOCK ("Wrong host interface name");
 251       return VNET_API_ERROR_INVALID_INTERFACE;
 252     }
 253
 254   ret = create_packet_v2_sock (host_if_index, rx_req, tx_req, &fd, &ring);
 255
 256   if (ret != 0)
 257     goto error;
 258
 259   ret = is_bridge (host_if_name);
 260
 261   if (ret == 0)                 /* is a bridge, ignore state */
 262     host_if_index = -1;
 263
 264   /* So far everything looks good, let's create interface */
 265   pool_get (apm->interfaces, apif);
 266   if_index = apif - apm->interfaces;
 267
 268   apif->host_if_index = host_if_index;
 269   apif->fd = fd;
 270   apif->rx_ring = ring;
 271   apif->tx_ring = ring + rx_req->tp_block_size * rx_req->tp_block_nr;
 272   apif->rx_req = rx_req;
 273   apif->tx_req = tx_req;
 274   apif->host_if_name = host_if_name_dup;
 275   apif->per_interface_next_index = ~0;
 276   apif->next_tx_frame = 0;
 277   apif->next_rx_frame = 0;
 278
 279   if (tm->n_vlib_mains > 1)
 280     clib_spinlock_init (&apif->lockp);
 281
 282   {
 283     unix_file_t template = { 0 };
 284     template.read_function = af_packet_fd_read_ready;
 285     template.file_descriptor = fd;
 286     template.private_data = if_index;
 287     template.flags = UNIX_FILE_EVENT_EDGE_TRIGGERED;
 288     apif->unix_file_index = unix_file_add (&unix_main, &template);
 289   }
 290
 291   /*use configured or generate random MAC address */
 292   if (hw_addr_set)
 293     clib_memcpy (hw_addr, hw_addr_set, 6);
 294   else
 295     {
 296       f64 now = vlib_time_now (vm);
 297       u32 rnd;
 298       rnd = (u32) (now * 1e6);
 299       rnd = random_u32 (&rnd);
 300
 301       clib_memcpy (hw_addr + 2, &rnd, sizeof (rnd));
 302       hw_addr[0] = 2;
 303       hw_addr[1] = 0xfe;
 304     }
 305
 306   error = ethernet_register_interface (vnm, af_packet_device_class.index,
 307                                        if_index, hw_addr, &apif->hw_if_index,
 308                                        af_packet_eth_flag_change);
 309
 310   if (error)
 311     {
 312       memset (apif, 0, sizeof (*apif));
 313       pool_put (apm->interfaces, apif);
 314       clib_error_report (error);
 315       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 316       goto error;
 317     }
 318
 319   sw = vnet_get_hw_sw_interface (vnm, apif->hw_if_index);
 320   hw = vnet_get_hw_interface (vnm, apif->hw_if_index);
 321   apif->sw_if_index = sw->sw_if_index;
 322   vnet_hw_interface_set_input_node (vnm, apif->hw_if_index,
 323                                     af_packet_input_node.index);
 324
 325   vnet_hw_interface_assign_rx_thread (vnm, apif->hw_if_index, 0,        /* queue */
 326                                       ~0 /* any cpu */ );
 327
 328   hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
 329   vnet_hw_interface_set_flags (vnm, apif->hw_if_index,
 330                                VNET_HW_INTERFACE_FLAG_LINK_UP);
 331
 332   vnet_hw_interface_set_rx_mode (vnm, apif->hw_if_index, 0,
 333                                  VNET_HW_INTERFACE_RX_MODE_INTERRUPT);
 334
 335   mhash_set_mem (&apm->if_index_by_host_if_name, host_if_name_dup, &if_index,
 336                  0);
 337   if (sw_if_index)
 338     *sw_if_index = apif->sw_if_index;
 339
 340   return 0;
 341
 342 error:
 343   vec_free (host_if_name_dup);
 344   vec_free (rx_req);
 345   vec_free (tx_req);
 346   return ret;
 347 }
 348
 349 int
 350 af_packet_delete_if (vlib_main_t * vm, u8 * host_if_name)
 351 {
 352   vnet_main_t *vnm = vnet_get_main ();
 353   af_packet_main_t *apm = &af_packet_main;
 354   af_packet_if_t *apif;
 355   uword *p;
 356   uword if_index;
 357   u32 ring_sz;
 358
 359   p = mhash_get (&apm->if_index_by_host_if_name, host_if_name);
 360   if (p == NULL)
 361     {
 362       clib_warning ("Host interface %s does not exist", host_if_name);
 363       return VNET_API_ERROR_SYSCALL_ERROR_1;
 364     }
 365   apif = pool_elt_at_index (apm->interfaces, p[0]);
 366   if_index = apif - apm->interfaces;
 367
 368   /* bring down the interface */
 369   vnet_hw_interface_set_flags (vnm, apif->hw_if_index, 0);
 370   vnet_hw_interface_unassign_rx_thread (vnm, apif->hw_if_index, 0);
 371
 372   /* clean up */
 373   if (apif->unix_file_index != ~0)
 374     {
 375       unix_file_del (&unix_main, unix_main.file_pool + apif->unix_file_index);
 376       apif->unix_file_index = ~0;
 377     }
 378   else
 379     close (apif->fd);
 380
 381   ring_sz = apif->rx_req->tp_block_size * apif->rx_req->tp_block_nr +
 382     apif->tx_req->tp_block_size * apif->tx_req->tp_block_nr;
 383   if (munmap (apif->rx_ring, ring_sz))
 384     clib_warning ("Host interface %s could not free rx/tx ring",
 385                   host_if_name);
 386   apif->rx_ring = NULL;
 387   apif->tx_ring = NULL;
 388   apif->fd = -1;
 389
 390   vec_free (apif->rx_req);
 391   apif->rx_req = NULL;
 392   vec_free (apif->tx_req);
 393   apif->tx_req = NULL;
 394
 395   vec_free (apif->host_if_name);
 396   apif->host_if_name = NULL;
 397   apif->host_if_index = -1;
 398
 399   mhash_unset (&apm->if_index_by_host_if_name, host_if_name, &if_index);
 400
 401   ethernet_delete_interface (vnm, apif->hw_if_index);
 402
 403   pool_put (apm->interfaces, apif);
 404
 405   return 0;
 406 }
 407
 408 static clib_error_t *
 409 af_packet_init (vlib_main_t * vm)
 410 {
 411   af_packet_main_t *apm = &af_packet_main;
 412   vlib_thread_main_t *tm = vlib_get_thread_main ();
 413
 414   memset (apm, 0, sizeof (af_packet_main_t));
 415
 416   mhash_init_vec_string (&apm->if_index_by_host_if_name, sizeof (uword));
 417
 418   vec_validate_aligned (apm->rx_buffers, tm->n_vlib_mains - 1,
 419                         CLIB_CACHE_LINE_BYTES);
 420
 421   return 0;
 422 }
 423
 424 VLIB_INIT_FUNCTION (af_packet_init);
 425
 426 /*
 427  * fd.io coding-style-patch-verification: ON
 428  *
 429  * Local Variables:
 430  * eval: (c-set-style "gnu")
 431  * End:
 432  */