From 0f08e825bdb63bd24f8f7e754ee2521889bf28f4 Mon Sep 17 00:00:00 2001 From: Jesper Dangaard Brouer Date: Tue, 16 Nov 2021 17:44:27 +0100 Subject: [PATCH] AF_XDP-interaction: README update AF_XDP documentation section Signed-off-by: Jesper Dangaard Brouer --- AF_XDP-interaction/README.org | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/AF_XDP-interaction/README.org b/AF_XDP-interaction/README.org index 3cae701..e6a1d6c 100644 --- a/AF_XDP-interaction/README.org +++ b/AF_XDP-interaction/README.org @@ -5,9 +5,13 @@ between XDP-prog (running kernel-side) and AF_XDP user-space process. * AF_XDP documentation -In kernel [[https://www.kernel.org/doc/html/latest/networking/af_xdp.html][documentation for AF_XDP]]. - -XDP-tools also contain documentation in [[https://github.com/xdp-project/xdp-tools/blob/master/lib/libxdp/README.org#using-af_xdp-sockets][libxdp for AF_XDP]], explaining -how to use the API, and the difference between the control-path and -data-path APIs. +When developing your AF_XDP application, we recommend familiarising +yourself with the core AF_XDP concepts, by reading the kernel +[[https://www.kernel.org/doc/html/latest/networking/af_xdp.html][documentation for AF_XDP]]. And XDP-tools also contain documentation in +[[https://github.com/xdp-project/xdp-tools/blob/master/lib/libxdp/README.org#using-af_xdp-sockets][libxdp for AF_XDP]], explaining how to use the API, and the difference +between the control-path and data-path APIs. +It is particularly important to understand the *four different +ring-queues* which are all Single-Producer Single-Consumer (SPSC) +ring-queues. A set of these four queues are needed *for each queue* +on the network device (netdev).