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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
20 #include <sys/ioctl.h>
21 #include <linux/ethtool.h>
22 #include <linux/if_link.h>
23 #include <linux/sockios.h>
24 #include <bpf/libbpf.h>
25 #include <vlib/vlib.h>
26 #include <vlib/unix/unix.h>
27 #include <vlib/pci/pci.h>
28 #include <vppinfra/linux/sysfs.h>
29 #include <vppinfra/unix.h>
30 #include <vnet/ethernet/ethernet.h>
31 #include <vnet/interface/rx_queue_funcs.h>
34 af_xdp_main_t af_xdp_main;
43 gdb_af_xdp_get_prod (const struct xsk_ring_prod *prod)
45 gdb_af_xdp_pair_t pair = { *prod->producer, *prod->consumer };
50 gdb_af_xdp_get_cons (const struct xsk_ring_cons * cons)
52 gdb_af_xdp_pair_t pair = { *cons->producer, *cons->consumer };
57 af_xdp_mac_change (vnet_hw_interface_t * hw, const u8 * old, const u8 * new)
59 af_xdp_main_t *am = &af_xdp_main;
60 af_xdp_device_t *ad = vec_elt_at_index (am->devices, hw->dev_instance);
61 errno_t err = memcpy_s (ad->hwaddr, sizeof (ad->hwaddr), new, 6);
63 return clib_error_return_code (0, -err, CLIB_ERROR_ERRNO_VALID,
69 af_xdp_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hw, u32 flags)
71 af_xdp_main_t *am = &af_xdp_main;
72 af_xdp_device_t *ad = vec_elt_at_index (am->devices, hw->dev_instance);
77 af_xdp_log (VLIB_LOG_LEVEL_ERR, ad, "set unicast not supported yet");
79 case ETHERNET_INTERFACE_FLAG_ACCEPT_ALL:
80 af_xdp_log (VLIB_LOG_LEVEL_ERR, ad,
81 "set promiscuous not supported yet");
83 case ETHERNET_INTERFACE_FLAG_MTU:
84 af_xdp_log (VLIB_LOG_LEVEL_ERR, ad, "set mtu not supported yet");
88 af_xdp_log (VLIB_LOG_LEVEL_ERR, ad, "unknown flag %x requested", flags);
93 af_xdp_delete_if (vlib_main_t * vm, af_xdp_device_t * ad)
95 vnet_main_t *vnm = vnet_get_main ();
96 af_xdp_main_t *axm = &af_xdp_main;
97 struct xsk_socket **xsk;
98 struct xsk_umem **umem;
103 vnet_hw_interface_set_flags (vnm, ad->hw_if_index, 0);
104 ethernet_delete_interface (vnm, ad->hw_if_index);
107 for (i = 0; i < ad->txq_num; i++)
108 clib_spinlock_free (&vec_elt (ad->txqs, i).lock);
110 vec_foreach (xsk, ad->xsk)
111 xsk_socket__delete (*xsk);
113 vec_foreach (umem, ad->umem)
114 xsk_umem__delete (*umem);
116 for (i = 0; i < ad->rxq_num; i++)
117 clib_file_del_by_index (&file_main, vec_elt (ad->rxqs, i).file_index);
121 bpf_set_link_xdp_fd (ad->linux_ifindex, -1, 0);
122 bpf_object__unload (ad->bpf_obj);
127 vec_free (ad->buffer_template);
130 clib_error_free (ad->error);
131 pool_put (axm->devices, ad);
135 af_xdp_load_program (af_xdp_create_if_args_t * args, af_xdp_device_t * ad)
139 ad->linux_ifindex = if_nametoindex (ad->linux_ifname);
140 if (!ad->linux_ifindex)
142 args->rv = VNET_API_ERROR_INVALID_VALUE;
144 clib_error_return_unix (0, "if_nametoindex(%s) failed",
149 if (bpf_prog_load (args->prog, BPF_PROG_TYPE_XDP, &ad->bpf_obj, &fd))
151 args->rv = VNET_API_ERROR_SYSCALL_ERROR_5;
153 clib_error_return_unix (0, "bpf_prog_load(%s) failed", args->prog);
157 #ifndef XDP_FLAGS_REPLACE
158 #define XDP_FLAGS_REPLACE 0
160 if (bpf_set_link_xdp_fd (ad->linux_ifindex, fd, XDP_FLAGS_REPLACE))
162 args->rv = VNET_API_ERROR_SYSCALL_ERROR_6;
164 clib_error_return_unix (0, "bpf_set_link_xdp_fd(%s) failed",
172 bpf_object__unload (ad->bpf_obj);
175 ad->linux_ifindex = ~0;
180 af_xdp_create_queue (vlib_main_t *vm, af_xdp_create_if_args_t *args,
181 af_xdp_device_t *ad, int qid)
183 struct xsk_umem **umem;
184 struct xsk_socket **xsk;
187 struct xsk_umem_config umem_config;
188 struct xsk_socket_config sock_config;
189 struct xdp_options opt;
191 const int is_rx = qid < ad->rxq_num;
192 const int is_tx = qid < ad->txq_num;
194 umem = vec_elt_at_index (ad->umem, qid);
195 xsk = vec_elt_at_index (ad->xsk, qid);
196 rxq = vec_elt_at_index (ad->rxqs, qid);
197 txq = vec_elt_at_index (ad->txqs, qid);
200 * fq and cq must always be allocated even if unused
201 * whereas rx and tx indicates whether we want rxq, txq, or both
203 struct xsk_ring_cons *rx = is_rx ? &rxq->rx : 0;
204 struct xsk_ring_prod *fq = &rxq->fq;
205 struct xsk_ring_prod *tx = is_tx ? &txq->tx : 0;
206 struct xsk_ring_cons *cq = &txq->cq;
209 memset (&umem_config, 0, sizeof (umem_config));
210 umem_config.fill_size = args->rxq_size;
211 umem_config.comp_size = args->txq_size;
212 umem_config.frame_size =
213 sizeof (vlib_buffer_t) + vlib_buffer_get_default_data_size (vm);
214 umem_config.frame_headroom = sizeof (vlib_buffer_t);
215 umem_config.flags = XDP_UMEM_UNALIGNED_CHUNK_FLAG;
217 (umem, uword_to_pointer (vm->buffer_main->buffer_mem_start, void *),
218 vm->buffer_main->buffer_mem_size, fq, cq, &umem_config))
220 args->rv = VNET_API_ERROR_SYSCALL_ERROR_1;
221 args->error = clib_error_return_unix (0, "xsk_umem__create() failed");
225 memset (&sock_config, 0, sizeof (sock_config));
226 sock_config.rx_size = args->rxq_size;
227 sock_config.tx_size = args->txq_size;
228 sock_config.bind_flags = XDP_USE_NEED_WAKEUP;
231 case AF_XDP_MODE_AUTO:
233 case AF_XDP_MODE_COPY:
234 sock_config.bind_flags |= XDP_COPY;
236 case AF_XDP_MODE_ZERO_COPY:
237 sock_config.bind_flags |= XDP_ZEROCOPY;
240 if (xsk_socket__create
241 (xsk, ad->linux_ifname, qid, *umem, rx, tx, &sock_config))
243 args->rv = VNET_API_ERROR_SYSCALL_ERROR_2;
245 clib_error_return_unix (0,
246 "xsk_socket__create() failed (is linux netdev %s up?)",
251 fd = xsk_socket__fd (*xsk);
252 optlen = sizeof (opt);
253 if (getsockopt (fd, SOL_XDP, XDP_OPTIONS, &opt, &optlen))
255 args->rv = VNET_API_ERROR_SYSCALL_ERROR_3;
257 clib_error_return_unix (0, "getsockopt(XDP_OPTIONS) failed");
260 if (opt.flags & XDP_OPTIONS_ZEROCOPY)
261 ad->flags |= AF_XDP_DEVICE_F_ZEROCOPY;
263 rxq->xsk_fd = is_rx ? fd : -1;
268 if (is_rx && (ad->flags & AF_XDP_DEVICE_F_SYSCALL_LOCK))
270 /* This is a shared rx+tx queue and we need to lock before syscalls.
271 * Prior to Linux 5.6 there is a race condition preventing to call
272 * poll() and sendto() concurrently on AF_XDP sockets. This was
273 * fixed with commit 11cc2d21499cabe7e7964389634ed1de3ee91d33
274 * to workaround this issue, we protect the syscalls with a
275 * spinlock. Note that it also prevents to use interrupt mode in
276 * multi workers setup, because in this case the poll() is done in
277 * the framework w/o any possibility to protect it.
279 * https://lore.kernel.org/bpf/BYAPR11MB365382C5DB1E5FCC53242609C1549@BYAPR11MB3653.namprd11.prod.outlook.com/
281 clib_spinlock_init (&rxq->syscall_lock);
282 txq->syscall_lock = rxq->syscall_lock;
293 xsk_socket__delete (*xsk);
295 xsk_umem__delete (*umem);
303 af_xdp_get_numa (const char *ifname)
310 (char *) format (0, "/sys/class/net/%s/device/numa_node%c", ifname, 0);
311 err = clib_sysfs_read (path, "%d", &numa);
315 clib_error_free (err);
321 af_xdp_get_q_count (const char *ifname, int *rxq_num, int *txq_num)
323 struct ethtool_channels ec = { .cmd = ETHTOOL_GCHANNELS };
324 struct ifreq ifr = { .ifr_data = (void *) &ec };
327 *rxq_num = *txq_num = 1;
329 fd = socket (AF_INET, SOCK_DGRAM, 0);
333 snprintf (ifr.ifr_name, sizeof (ifr.ifr_name), "%s", ifname);
334 err = ioctl (fd, SIOCETHTOOL, &ifr);
341 *rxq_num = clib_max (ec.combined_count, ec.rx_count);
342 *txq_num = clib_max (ec.combined_count, ec.tx_count);
345 static clib_error_t *
346 af_xdp_device_rxq_read_ready (clib_file_t * f)
348 vnet_hw_if_rx_queue_set_int_pending (vnet_get_main (), f->private_data);
352 static clib_error_t *
353 af_xdp_device_set_rxq_mode (const af_xdp_device_t *ad, af_xdp_rxq_t *rxq,
354 const af_xdp_rxq_mode_t mode)
356 clib_file_main_t *fm = &file_main;
357 clib_file_update_type_t update;
360 if (rxq->mode == mode)
365 case AF_XDP_RXQ_MODE_POLLING:
366 update = UNIX_FILE_UPDATE_DELETE;
368 case AF_XDP_RXQ_MODE_INTERRUPT:
369 if (ad->flags & AF_XDP_DEVICE_F_SYSCALL_LOCK)
370 return clib_error_create (
371 "kernel workaround incompatible with interrupt mode");
372 update = UNIX_FILE_UPDATE_ADD;
376 return clib_error_create ("unknown rxq mode %i", mode);
379 f = clib_file_get (fm, rxq->file_index);
380 fm->file_update (f, update);
386 af_xdp_create_if (vlib_main_t * vm, af_xdp_create_if_args_t * args)
388 vnet_main_t *vnm = vnet_get_main ();
389 vlib_thread_main_t *tm = vlib_get_thread_main ();
390 af_xdp_main_t *am = &af_xdp_main;
392 vnet_sw_interface_t *sw;
393 vnet_hw_interface_t *hw;
394 int rxq_num, txq_num, q_num;
397 args->rxq_size = args->rxq_size ? args->rxq_size : 2 * VLIB_FRAME_SIZE;
398 args->txq_size = args->txq_size ? args->txq_size : 2 * VLIB_FRAME_SIZE;
399 args->rxq_num = args->rxq_num ? args->rxq_num : 1;
401 if (!args->linux_ifname)
403 args->rv = VNET_API_ERROR_INVALID_VALUE;
404 args->error = clib_error_return (0, "missing host interface");
408 if (args->rxq_size < VLIB_FRAME_SIZE || args->txq_size < VLIB_FRAME_SIZE ||
409 args->rxq_size > 65535 || args->txq_size > 65535 ||
410 !is_pow2 (args->rxq_size) || !is_pow2 (args->txq_size))
412 args->rv = VNET_API_ERROR_INVALID_VALUE;
414 clib_error_return (0,
415 "queue size must be a power of two between %i and 65535",
420 af_xdp_get_q_count (args->linux_ifname, &rxq_num, &txq_num);
421 if (args->rxq_num > rxq_num && AF_XDP_NUM_RX_QUEUES_ALL != args->rxq_num)
423 args->rv = VNET_API_ERROR_INVALID_VALUE;
424 args->error = clib_error_create ("too many rxq requested (%d > %d)",
425 args->rxq_num, rxq_num);
428 rxq_num = clib_min (rxq_num, args->rxq_num);
429 txq_num = clib_min (txq_num, tm->n_vlib_mains);
431 pool_get_zero (am->devices, ad);
433 if (tm->n_vlib_mains > 1 &&
434 0 == (args->flags & AF_XDP_CREATE_FLAGS_NO_SYSCALL_LOCK))
435 ad->flags |= AF_XDP_DEVICE_F_SYSCALL_LOCK;
437 ad->linux_ifname = (char *) format (0, "%s", args->linux_ifname);
438 vec_validate (ad->linux_ifname, IFNAMSIZ - 1); /* libbpf expects ifname to be at least IFNAMSIZ */
440 if (args->prog && af_xdp_load_program (args, ad))
443 q_num = clib_max (rxq_num, txq_num);
444 ad->rxq_num = rxq_num;
445 ad->txq_num = txq_num;
447 vec_validate_aligned (ad->umem, q_num - 1, CLIB_CACHE_LINE_BYTES);
448 vec_validate_aligned (ad->xsk, q_num - 1, CLIB_CACHE_LINE_BYTES);
449 vec_validate_aligned (ad->rxqs, q_num - 1, CLIB_CACHE_LINE_BYTES);
450 vec_validate_aligned (ad->txqs, q_num - 1, CLIB_CACHE_LINE_BYTES);
452 for (i = 0; i < q_num; i++)
454 if (af_xdp_create_queue (vm, args, ad, i))
457 * queue creation failed
458 * it is only a fatal error if we could not create the number of rx
459 * queues requested explicitely by the user and the user did not
461 * we might create less tx queues than workers but this is ok
464 /* fixup vectors length */
465 vec_set_len (ad->umem, i);
466 vec_set_len (ad->xsk, i);
467 vec_set_len (ad->rxqs, i);
468 vec_set_len (ad->txqs, i);
470 ad->rxq_num = clib_min (i, rxq_num);
471 ad->txq_num = clib_min (i, txq_num);
473 if (i < rxq_num && AF_XDP_NUM_RX_QUEUES_ALL != args->rxq_num)
475 ad->rxq_num = ad->txq_num = 0;
476 goto err1; /* failed creating requested rxq: fatal error, bailing
482 /* we created less txq than threads not an error but initialize lock for shared txq */
483 for (i = 0; i < ad->txq_num; i++)
484 clib_spinlock_init (&vec_elt (ad->txqs, i).lock);
488 clib_error_free (args->error);
493 ad->dev_instance = ad - am->devices;
494 ad->per_interface_next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
496 vlib_buffer_pool_get_default_for_numa (vm,
501 (char *) format (0, "%s/%d", ad->linux_ifname, ad->dev_instance);
503 ad->name = (char *) format (0, "%s", args->name);
505 ethernet_mac_address_generate (ad->hwaddr);
507 /* create interface */
508 if (ethernet_register_interface (vnm, af_xdp_device_class.index,
509 ad->dev_instance, ad->hwaddr,
510 &ad->hw_if_index, af_xdp_flag_change))
512 args->rv = VNET_API_ERROR_INVALID_INTERFACE;
514 clib_error_return (0, "ethernet_register_interface() failed");
518 sw = vnet_get_hw_sw_interface (vnm, ad->hw_if_index);
519 hw = vnet_get_hw_interface (vnm, ad->hw_if_index);
520 args->sw_if_index = ad->sw_if_index = sw->sw_if_index;
521 hw->caps |= VNET_HW_INTERFACE_CAP_SUPPORTS_INT_MODE;
523 vnet_hw_if_set_input_node (vnm, ad->hw_if_index, af_xdp_input_node.index);
525 for (i = 0; i < ad->rxq_num; i++)
527 af_xdp_rxq_t *rxq = vec_elt_at_index (ad->rxqs, i);
528 rxq->queue_index = vnet_hw_if_register_rx_queue (
529 vnm, ad->hw_if_index, i, VNET_HW_IF_RXQ_THREAD_ANY);
530 u8 *desc = format (0, "%U rxq %d", format_af_xdp_device_name,
531 ad->dev_instance, i);
533 .file_descriptor = rxq->xsk_fd,
534 .private_data = rxq->queue_index,
535 .read_function = af_xdp_device_rxq_read_ready,
538 rxq->file_index = clib_file_add (&file_main, &f);
539 vnet_hw_if_set_rx_queue_file_index (vnm, rxq->queue_index,
541 if (af_xdp_device_set_rxq_mode (ad, rxq, AF_XDP_RXQ_MODE_POLLING))
545 vnet_hw_if_update_runtime_data (vnm, ad->hw_if_index);
547 /* buffer template */
548 vec_validate_aligned (ad->buffer_template, 1, CLIB_CACHE_LINE_BYTES);
549 ad->buffer_template->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
550 ad->buffer_template->ref_count = 1;
551 vnet_buffer (ad->buffer_template)->sw_if_index[VLIB_RX] = ad->sw_if_index;
552 vnet_buffer (ad->buffer_template)->sw_if_index[VLIB_TX] = (u32) ~ 0;
553 ad->buffer_template->buffer_pool_index = ad->pool;
558 af_xdp_delete_if (vm, ad);
560 vlib_log_err (am->log_class, "%U", format_clib_error, args->error);
563 static clib_error_t *
564 af_xdp_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
566 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
567 af_xdp_main_t *am = &af_xdp_main;
568 af_xdp_device_t *ad = vec_elt_at_index (am->devices, hi->dev_instance);
569 uword is_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
571 if (ad->flags & AF_XDP_DEVICE_F_ERROR)
572 return clib_error_return (0, "device is in error state");
576 vnet_hw_interface_set_flags (vnm, ad->hw_if_index,
577 VNET_HW_INTERFACE_FLAG_LINK_UP);
578 ad->flags |= AF_XDP_DEVICE_F_ADMIN_UP;
579 af_xdp_device_input_refill (ad);
583 vnet_hw_interface_set_flags (vnm, ad->hw_if_index, 0);
584 ad->flags &= ~AF_XDP_DEVICE_F_ADMIN_UP;
589 static clib_error_t *
590 af_xdp_interface_rx_mode_change (vnet_main_t *vnm, u32 hw_if_index, u32 qid,
591 vnet_hw_if_rx_mode mode)
593 af_xdp_main_t *am = &af_xdp_main;
594 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
595 af_xdp_device_t *ad = pool_elt_at_index (am->devices, hw->dev_instance);
596 af_xdp_rxq_t *rxq = vec_elt_at_index (ad->rxqs, qid);
600 default: /* fallthrough */
601 case VNET_HW_IF_RX_MODE_UNKNOWN: /* fallthrough */
602 case VNET_HW_IF_NUM_RX_MODES:
603 return clib_error_create ("uknown rx mode - doing nothing");
604 case VNET_HW_IF_RX_MODE_DEFAULT: /* fallthrough */
605 case VNET_HW_IF_RX_MODE_POLLING:
606 return af_xdp_device_set_rxq_mode (ad, rxq, AF_XDP_RXQ_MODE_POLLING);
607 case VNET_HW_IF_RX_MODE_INTERRUPT: /* fallthrough */
608 case VNET_HW_IF_RX_MODE_ADAPTIVE:
609 return af_xdp_device_set_rxq_mode (ad, rxq, AF_XDP_RXQ_MODE_INTERRUPT);
612 ASSERT (0 && "unreachable");
613 return clib_error_create ("unreachable");
617 af_xdp_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
620 af_xdp_main_t *am = &af_xdp_main;
621 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
622 af_xdp_device_t *ad = pool_elt_at_index (am->devices, hw->dev_instance);
624 /* Shut off redirection */
625 if (node_index == ~0)
627 ad->per_interface_next_index = node_index;
631 ad->per_interface_next_index =
632 vlib_node_add_next (vlib_get_main (), af_xdp_input_node.index,
636 static char *af_xdp_tx_func_error_strings[] = {
638 foreach_af_xdp_tx_func_error
643 af_xdp_clear (u32 dev_instance)
645 af_xdp_main_t *am = &af_xdp_main;
646 af_xdp_device_t *ad = pool_elt_at_index (am->devices, dev_instance);
647 clib_error_free (ad->error);
651 VNET_DEVICE_CLASS (af_xdp_device_class) = {
652 .name = "AF_XDP interface",
653 .format_device = format_af_xdp_device,
654 .format_device_name = format_af_xdp_device_name,
655 .admin_up_down_function = af_xdp_interface_admin_up_down,
656 .rx_mode_change_function = af_xdp_interface_rx_mode_change,
657 .rx_redirect_to_node = af_xdp_set_interface_next_node,
658 .tx_function_n_errors = AF_XDP_TX_N_ERROR,
659 .tx_function_error_strings = af_xdp_tx_func_error_strings,
660 .mac_addr_change_function = af_xdp_mac_change,
661 .clear_counters = af_xdp_clear,
666 af_xdp_init (vlib_main_t * vm)
668 af_xdp_main_t *am = &af_xdp_main;
670 am->log_class = vlib_log_register_class ("af_xdp", 0);
675 VLIB_INIT_FUNCTION (af_xdp_init);
678 * fd.io coding-style-patch-verification: ON
681 * eval: (c-set-style "gnu")