src/plugins/af_xdp/device.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2018 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #include <stdio.h>
  19 #include <net/if.h>
  20 #include <linux/if_link.h>
  21 #include <bpf/libbpf.h>
  22 #include <vlib/vlib.h>
  23 #include <vlib/unix/unix.h>
  24 #include <vlib/pci/pci.h>
  25 #include <vppinfra/linux/sysfs.h>
  26 #include <vppinfra/unix.h>
  27 #include <vnet/ethernet/ethernet.h>
  28 #include "af_xdp.h"
  29
  30 af_xdp_main_t af_xdp_main;
  31
  32 typedef struct
  33 {
  34   u32 prod;
  35   u32 cons;
  36 } gdb_af_xdp_pair_t;
  37
  38 gdb_af_xdp_pair_t
  39 gdb_af_xdp_get_prod (const struct xsk_ring_prod *prod)
  40 {
  41   gdb_af_xdp_pair_t pair = { *prod->producer, *prod->consumer };
  42   return pair;
  43 }
  44
  45 gdb_af_xdp_pair_t
  46 gdb_af_xdp_get_cons (const struct xsk_ring_cons * cons)
  47 {
  48   gdb_af_xdp_pair_t pair = { *cons->producer, *cons->consumer };
  49   return pair;
  50 }
  51
  52 static clib_error_t *
  53 af_xdp_mac_change (vnet_hw_interface_t * hw, const u8 * old, const u8 * new)
  54 {
  55   af_xdp_main_t *am = &af_xdp_main;
  56   af_xdp_device_t *ad = vec_elt_at_index (am->devices, hw->dev_instance);
  57   errno_t err = memcpy_s (ad->hwaddr, sizeof (ad->hwaddr), new, 6);
  58   if (err)
  59     return clib_error_return_code (0, -err, CLIB_ERROR_ERRNO_VALID,
  60                                    "mac change failed");
  61   return 0;
  62 }
  63
  64 static u32
  65 af_xdp_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hw, u32 flags)
  66 {
  67   af_xdp_main_t *am = &af_xdp_main;
  68   af_xdp_device_t *ad = vec_elt_at_index (am->devices, hw->dev_instance);
  69
  70   switch (flags)
  71     {
  72     case 0:
  73       af_xdp_log (VLIB_LOG_LEVEL_ERR, ad, "set unicast not supported yet");
  74       return ~0;
  75     case ETHERNET_INTERFACE_FLAG_ACCEPT_ALL:
  76       af_xdp_log (VLIB_LOG_LEVEL_ERR, ad,
  77                   "set promiscuous not supported yet");
  78       return ~0;
  79     case ETHERNET_INTERFACE_FLAG_MTU:
  80       af_xdp_log (VLIB_LOG_LEVEL_ERR, ad, "set mtu not supported yet");
  81       return ~0;
  82     }
  83
  84   af_xdp_log (VLIB_LOG_LEVEL_ERR, ad, "unknown flag %x requested", flags);
  85   return ~0;
  86 }
  87
  88 void
  89 af_xdp_delete_if (vlib_main_t * vm, af_xdp_device_t * ad)
  90 {
  91   vnet_main_t *vnm = vnet_get_main ();
  92   af_xdp_main_t *axm = &af_xdp_main;
  93   struct xsk_socket **xsk;
  94   struct xsk_umem **umem;
  95   af_xdp_rxq_t *rxq;
  96   af_xdp_txq_t *txq;
  97
  98   if (ad->hw_if_index)
  99     {
 100       vnet_hw_interface_set_flags (vnm, ad->hw_if_index, 0);
 101       vnet_hw_interface_unassign_rx_thread (vnm, ad->hw_if_index, 0);
 102       ethernet_delete_interface (vnm, ad->hw_if_index);
 103     }
 104
 105   vec_foreach (rxq, ad->rxqs) clib_file_del_by_index (&file_main,
 106                                                       rxq->file_index);
 107   vec_foreach (txq, ad->txqs) clib_spinlock_free (&txq->lock);
 108   vec_foreach (xsk, ad->xsk) xsk_socket__delete (*xsk);
 109   vec_foreach (umem, ad->umem) xsk_umem__delete (*umem);
 110
 111   if (ad->bpf_obj)
 112     {
 113       bpf_set_link_xdp_fd (ad->linux_ifindex, -1, 0);
 114       bpf_object__unload (ad->bpf_obj);
 115     }
 116
 117   vec_free (ad->xsk);
 118   vec_free (ad->umem);
 119   vec_free (ad->buffer_template);
 120   vec_free (ad->rxqs);
 121   vec_free (ad->txqs);
 122   clib_error_free (ad->error);
 123   pool_put (axm->devices, ad);
 124 }
 125
 126 static int
 127 af_xdp_load_program (af_xdp_create_if_args_t * args, af_xdp_device_t * ad)
 128 {
 129   int fd;
 130
 131   ad->linux_ifindex = if_nametoindex (ad->linux_ifname);
 132   if (!ad->linux_ifindex)
 133     {
 134       args->rv = VNET_API_ERROR_INVALID_VALUE;
 135       args->error =
 136         clib_error_return_unix (0, "if_nametoindex(%s) failed",
 137                                 ad->linux_ifname);
 138       goto err0;
 139     }
 140
 141   if (bpf_prog_load (args->prog, BPF_PROG_TYPE_XDP, &ad->bpf_obj, &fd))
 142     {
 143       args->rv = VNET_API_ERROR_SYSCALL_ERROR_5;
 144       args->error =
 145         clib_error_return_unix (0, "bpf_prog_load(%s) failed", args->prog);
 146       goto err0;
 147     }
 148
 149 #ifndef XDP_FLAGS_REPLACE
 150 #define XDP_FLAGS_REPLACE 0
 151 #endif
 152   if (bpf_set_link_xdp_fd (ad->linux_ifindex, fd, XDP_FLAGS_REPLACE))
 153     {
 154       args->rv = VNET_API_ERROR_SYSCALL_ERROR_6;
 155       args->error =
 156         clib_error_return_unix (0, "bpf_set_link_xdp_fd(%s) failed",
 157                                 ad->linux_ifname);
 158       goto err1;
 159     }
 160
 161   return 0;
 162
 163 err1:
 164   bpf_object__unload (ad->bpf_obj);
 165   ad->bpf_obj = 0;
 166 err0:
 167   ad->linux_ifindex = ~0;
 168   return -1;
 169 }
 170
 171 static int
 172 af_xdp_create_queue (vlib_main_t * vm, af_xdp_create_if_args_t * args,
 173                      af_xdp_device_t * ad, int qid, int rxq_num, int txq_num)
 174 {
 175   struct xsk_umem **umem;
 176   struct xsk_socket **xsk;
 177   af_xdp_rxq_t *rxq;
 178   af_xdp_txq_t *txq;
 179   struct xsk_umem_config umem_config;
 180   struct xsk_socket_config sock_config;
 181   struct xdp_options opt;
 182   socklen_t optlen;
 183
 184   vec_validate_aligned (ad->umem, qid, CLIB_CACHE_LINE_BYTES);
 185   umem = vec_elt_at_index (ad->umem, qid);
 186
 187   vec_validate_aligned (ad->xsk, qid, CLIB_CACHE_LINE_BYTES);
 188   xsk = vec_elt_at_index (ad->xsk, qid);
 189
 190   vec_validate_aligned (ad->rxqs, qid, CLIB_CACHE_LINE_BYTES);
 191   rxq = vec_elt_at_index (ad->rxqs, qid);
 192
 193   vec_validate_aligned (ad->txqs, qid, CLIB_CACHE_LINE_BYTES);
 194   txq = vec_elt_at_index (ad->txqs, qid);
 195
 196   /*
 197    * fq and cq must always be allocated even if unused
 198    * whereas rx and tx indicates whether we want rxq, txq, or both
 199    */
 200   struct xsk_ring_cons *rx = qid < rxq_num ? &rxq->rx : 0;
 201   struct xsk_ring_prod *fq = &rxq->fq;
 202   struct xsk_ring_prod *tx = qid < txq_num ? &txq->tx : 0;
 203   struct xsk_ring_cons *cq = &txq->cq;
 204   int fd;
 205
 206   memset (&umem_config, 0, sizeof (umem_config));
 207   umem_config.fill_size = args->rxq_size;
 208   umem_config.comp_size = args->txq_size;
 209   umem_config.frame_size =
 210     sizeof (vlib_buffer_t) + vlib_buffer_get_default_data_size (vm);
 211   umem_config.flags = XDP_UMEM_UNALIGNED_CHUNK_FLAG;
 212   if (xsk_umem__create
 213       (umem, uword_to_pointer (vm->buffer_main->buffer_mem_start, void *),
 214        vm->buffer_main->buffer_mem_size, fq, cq, &umem_config))
 215     {
 216       args->rv = VNET_API_ERROR_SYSCALL_ERROR_1;
 217       args->error = clib_error_return_unix (0, "xsk_umem__create() failed");
 218       goto err0;
 219     }
 220
 221   memset (&sock_config, 0, sizeof (sock_config));
 222   sock_config.rx_size = args->rxq_size;
 223   sock_config.tx_size = args->txq_size;
 224   sock_config.bind_flags = XDP_USE_NEED_WAKEUP;
 225   switch (args->mode)
 226     {
 227     case AF_XDP_MODE_AUTO:
 228       break;
 229     case AF_XDP_MODE_COPY:
 230       sock_config.bind_flags |= XDP_COPY;
 231       break;
 232     case AF_XDP_MODE_ZERO_COPY:
 233       sock_config.bind_flags |= XDP_ZEROCOPY;
 234       break;
 235     }
 236   if (xsk_socket__create
 237       (xsk, ad->linux_ifname, qid, *umem, rx, tx, &sock_config))
 238     {
 239       args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
 240       args->error =
 241         clib_error_return_unix (0,
 242                                 "xsk_socket__create() failed (is linux netdev %s up?)",
 243                                 ad->linux_ifname);
 244       goto err1;
 245     }
 246
 247   fd = xsk_socket__fd (*xsk);
 248   optlen = sizeof (opt);
 249   if (getsockopt (fd, SOL_XDP, XDP_OPTIONS, &opt, &optlen))
 250     {
 251       args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
 252       args->error =
 253         clib_error_return_unix (0, "getsockopt(XDP_OPTIONS) failed");
 254       goto err2;
 255     }
 256   if (opt.flags & XDP_OPTIONS_ZEROCOPY)
 257     ad->flags |= AF_XDP_DEVICE_F_ZEROCOPY;
 258
 259   rxq->xsk_fd = qid < rxq_num ? fd : -1;
 260   txq->xsk_fd = qid < txq_num ? fd : -1;
 261
 262   return 0;
 263
 264 err2:
 265   xsk_socket__delete (*xsk);
 266 err1:
 267   xsk_umem__delete (*umem);
 268 err0:
 269   *umem = 0;
 270   *xsk = 0;
 271   return -1;
 272 }
 273
 274 static int
 275 af_xdp_get_numa (const char *ifname)
 276 {
 277   char *path;
 278   clib_error_t *err;
 279   int numa;
 280
 281   path =
 282     (char *) format (0, "/sys/class/net/%s/device/numa_node%c", ifname, 0);
 283   err = clib_sysfs_read (path, "%d", &numa);
 284   if (err || numa < 0)
 285     numa = 0;
 286
 287   clib_error_free (err);
 288   vec_free (path);
 289   return numa;
 290 }
 291
 292 static clib_error_t *
 293 af_xdp_device_rxq_read_ready (clib_file_t * f)
 294 {
 295   vnet_main_t *vnm = vnet_get_main ();
 296   const af_xdp_main_t *am = &af_xdp_main;
 297   const u32 dev_instance = f->private_data >> 16;
 298   const u16 qid = f->private_data & 0xffff;
 299   const af_xdp_device_t *ad = vec_elt_at_index (am->devices, dev_instance);
 300   vnet_device_input_set_interrupt_pending (vnm, ad->hw_if_index, qid);
 301   return 0;
 302 }
 303
 304 void
 305 af_xdp_create_if (vlib_main_t * vm, af_xdp_create_if_args_t * args)
 306 {
 307   vnet_main_t *vnm = vnet_get_main ();
 308   vlib_thread_main_t *tm = vlib_get_thread_main ();
 309   af_xdp_main_t *am = &af_xdp_main;
 310   af_xdp_device_t *ad;
 311   vnet_sw_interface_t *sw;
 312   vnet_hw_interface_t *hw;
 313   int rxq_num, txq_num, q_num;
 314   int i;
 315
 316   args->rxq_size = args->rxq_size ? args->rxq_size : 2 * VLIB_FRAME_SIZE;
 317   args->txq_size = args->txq_size ? args->txq_size : 2 * VLIB_FRAME_SIZE;
 318   rxq_num = args->rxq_num ? args->rxq_num : 1;
 319   txq_num = tm->n_vlib_mains;
 320
 321   if (!args->linux_ifname)
 322     {
 323       args->rv = VNET_API_ERROR_INVALID_VALUE;
 324       args->error = clib_error_return (0, "missing host interface");
 325       goto err0;
 326     }
 327
 328   if (args->rxq_size < VLIB_FRAME_SIZE || args->txq_size < VLIB_FRAME_SIZE ||
 329       args->rxq_size > 65535 || args->txq_size > 65535 ||
 330       !is_pow2 (args->rxq_size) || !is_pow2 (args->txq_size))
 331     {
 332       args->rv = VNET_API_ERROR_INVALID_VALUE;
 333       args->error =
 334         clib_error_return (0,
 335                            "queue size must be a power of two between %i and 65535",
 336                            VLIB_FRAME_SIZE);
 337       goto err0;
 338     }
 339
 340   pool_get_zero (am->devices, ad);
 341
 342   ad->linux_ifname = (char *) format (0, "%s", args->linux_ifname);
 343   vec_validate (ad->linux_ifname, IFNAMSIZ - 1);        /* libbpf expects ifname to be at least IFNAMSIZ */
 344
 345   if (args->prog && af_xdp_load_program (args, ad))
 346     goto err1;
 347
 348   q_num = clib_max (rxq_num, txq_num);
 349   ad->txq_num = txq_num;
 350   for (i = 0; i < q_num; i++)
 351     {
 352       if (af_xdp_create_queue (vm, args, ad, i, rxq_num, txq_num))
 353         {
 354           /*
 355            * queue creation failed
 356            * it is only a fatal error if we could not create the number of rx
 357            * queues requested explicitely by the user and the user did not
 358            * requested 'max'
 359            * we might create less tx queues than workers but this is ok
 360            */
 361
 362           /* fixup vectors length */
 363           vec_set_len (ad->umem, i);
 364           vec_set_len (ad->xsk, i);
 365           vec_set_len (ad->rxqs, i);
 366           vec_set_len (ad->txqs, i);
 367
 368           if (i < rxq_num && AF_XDP_NUM_RX_QUEUES_ALL != rxq_num)
 369             goto err1;          /* failed creating requested rxq: fatal error, bailing out */
 370
 371           if (i < txq_num)
 372             {
 373               /* we created less txq than threads not an error but initialize lock for shared txq */
 374               af_xdp_txq_t *txq;
 375               ad->txq_num = i;
 376               vec_foreach (txq, ad->txqs) clib_spinlock_init (&txq->lock);
 377             }
 378
 379           args->rv = 0;
 380           clib_error_free (args->error);
 381           break;
 382         }
 383     }
 384
 385   ad->dev_instance = ad - am->devices;
 386   ad->per_interface_next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
 387   ad->pool =
 388     vlib_buffer_pool_get_default_for_numa (vm,
 389                                            af_xdp_get_numa
 390                                            (ad->linux_ifname));
 391   if (!args->name)
 392     ad->name =
 393       (char *) format (0, "%s/%d", ad->linux_ifname, ad->dev_instance);
 394   else
 395     ad->name = (char *) format (0, "%s", args->name);
 396
 397   ethernet_mac_address_generate (ad->hwaddr);
 398
 399   /* create interface */
 400   if (ethernet_register_interface (vnm, af_xdp_device_class.index,
 401                                    ad->dev_instance, ad->hwaddr,
 402                                    &ad->hw_if_index, af_xdp_flag_change))
 403     {
 404       args->rv = VNET_API_ERROR_INVALID_INTERFACE;
 405       args->error =
 406         clib_error_return (0, "ethernet_register_interface() failed");
 407       goto err1;
 408     }
 409
 410   sw = vnet_get_hw_sw_interface (vnm, ad->hw_if_index);
 411   hw = vnet_get_hw_interface (vnm, ad->hw_if_index);
 412   args->sw_if_index = ad->sw_if_index = sw->sw_if_index;
 413   hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
 414
 415   vnet_hw_interface_set_input_node (vnm, ad->hw_if_index,
 416                                     af_xdp_input_node.index);
 417
 418   for (i = 0; i < vec_len (ad->rxqs); i++)
 419     {
 420       af_xdp_rxq_t *rxq = vec_elt_at_index (ad->rxqs, i);
 421       clib_file_t f = {
 422         .file_descriptor = rxq->xsk_fd,
 423         .flags = UNIX_FILE_EVENT_EDGE_TRIGGERED,
 424         .private_data = (uword) ad->dev_instance << 16 | (uword) i,
 425         .read_function = af_xdp_device_rxq_read_ready,
 426         .description =
 427           format (0, "%U rxq %d", format_af_xdp_device_name, ad->dev_instance,
 428                   i),
 429       };
 430       rxq->file_index = clib_file_add (&file_main, &f);
 431       vnet_hw_interface_assign_rx_thread (vnm, ad->hw_if_index, i, ~0);
 432     }
 433
 434   /* buffer template */
 435   vec_validate_aligned (ad->buffer_template, 1, CLIB_CACHE_LINE_BYTES);
 436   ad->buffer_template->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
 437   ad->buffer_template->ref_count = 1;
 438   vnet_buffer (ad->buffer_template)->sw_if_index[VLIB_RX] = ad->sw_if_index;
 439   vnet_buffer (ad->buffer_template)->sw_if_index[VLIB_TX] = (u32) ~ 0;
 440   ad->buffer_template->buffer_pool_index = ad->pool;
 441
 442   return;
 443
 444 err1:
 445   af_xdp_delete_if (vm, ad);
 446 err0:
 447   vlib_log_err (am->log_class, "%U", format_clib_error, args->error);
 448 }
 449
 450 static clib_error_t *
 451 af_xdp_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 452 {
 453   vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
 454   af_xdp_main_t *am = &af_xdp_main;
 455   af_xdp_device_t *ad = vec_elt_at_index (am->devices, hi->dev_instance);
 456   uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
 457
 458   if (ad->flags & AF_XDP_DEVICE_F_ERROR)
 459     return clib_error_return (0, "device is in error state");
 460
 461   if (is_up)
 462     {
 463       vnet_hw_interface_set_flags (vnm, ad->hw_if_index,
 464                                    VNET_HW_INTERFACE_FLAG_LINK_UP);
 465       ad->flags |= AF_XDP_DEVICE_F_ADMIN_UP;
 466     }
 467   else
 468     {
 469       vnet_hw_interface_set_flags (vnm, ad->hw_if_index, 0);
 470       ad->flags &= ~AF_XDP_DEVICE_F_ADMIN_UP;
 471     }
 472   return 0;
 473 }
 474
 475 static void
 476 af_xdp_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
 477                                 u32 node_index)
 478 {
 479   af_xdp_main_t *am = &af_xdp_main;
 480   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 481   af_xdp_device_t *ad = pool_elt_at_index (am->devices, hw->dev_instance);
 482
 483   /* Shut off redirection */
 484   if (node_index == ~0)
 485     {
 486       ad->per_interface_next_index = node_index;
 487       return;
 488     }
 489
 490   ad->per_interface_next_index =
 491     vlib_node_add_next (vlib_get_main (), af_xdp_input_node.index,
 492                         node_index);
 493 }
 494
 495 static char *af_xdp_tx_func_error_strings[] = {
 496 #define _(n,s) s,
 497   foreach_af_xdp_tx_func_error
 498 #undef _
 499 };
 500
 501 static void
 502 af_xdp_clear (u32 dev_instance)
 503 {
 504   af_xdp_main_t *am = &af_xdp_main;
 505   af_xdp_device_t *ad = pool_elt_at_index (am->devices, dev_instance);
 506   clib_error_free (ad->error);
 507 }
 508
 509 /* *INDENT-OFF* */
 510 VNET_DEVICE_CLASS (af_xdp_device_class) =
 511 {
 512   .name = "AF_XDP interface",
 513   .format_device = format_af_xdp_device,
 514   .format_device_name = format_af_xdp_device_name,
 515   .admin_up_down_function = af_xdp_interface_admin_up_down,
 516   .rx_redirect_to_node = af_xdp_set_interface_next_node,
 517   .tx_function_n_errors = AF_XDP_TX_N_ERROR,
 518   .tx_function_error_strings = af_xdp_tx_func_error_strings,
 519   .mac_addr_change_function = af_xdp_mac_change,
 520   .clear_counters = af_xdp_clear,
 521 };
 522 /* *INDENT-ON* */
 523
 524 clib_error_t *
 525 af_xdp_init (vlib_main_t * vm)
 526 {
 527   af_xdp_main_t *am = &af_xdp_main;
 528
 529   am->log_class = vlib_log_register_class ("af_xdp", 0);
 530
 531   return 0;
 532 }
 533
 534 VLIB_INIT_FUNCTION (af_xdp_init);
 535
 536 /*
 537  * fd.io coding-style-patch-verification: ON
 538  *
 539  * Local Variables:
 540  * eval: (c-set-style "gnu")
 541  * End:
 542  */