net/af_xdp: forbid umem sharing for xsks with same context

[dpdk.git] / doc / guides / nics / af_xdp.rst

diff --git a/doc/guides/nics/af_xdp.rst b/doc/guides/nics/af_xdp.rst
index b434b25..052e59a 100644 (file)
--- a/doc/guides/nics/af_xdp.rst
+++ b/doc/guides/nics/af_xdp.rst
@@ -1,5 +1,5 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
-    Copyright(c) 2019 Intel Corporation.
+    Copyright(c) 2019-2020 Intel Corporation.
 
 AF_XDP Poll Mode Driver
 ==========================
@@ -18,9 +18,6 @@ packets through the socket which would bypass the kernel network stack.
 Current implementation only supports single queue, multi-queues feature will
 be added later.
 
-Note that MTU of AF_XDP PMD is limited due to XDP lacks support for
-fragmentation.
-
 AF_XDP PMD enables need_wakeup flag by default if it is supported. This
 need_wakeup feature is used to support executing application and driver on the
 same core efficiently. This feature not only has a large positive performance
@@ -35,6 +32,9 @@ The following options can be provided to set up an af_xdp port in DPDK.
 *   ``iface`` - name of the Kernel interface to attach to (required);
 *   ``start_queue`` - starting netdev queue id (optional, default 0);
 *   ``queue_count`` - total netdev queue number (optional, default 1);
+*   ``shared_umem`` - PMD will attempt to share UMEM with others (optional,
+    default 0);
+*   ``xdp_prog`` - path to custom xdp program (optional, default none);
 
 Prerequisites
 -------------
@@ -48,6 +48,8 @@ This is a Linux-specific PMD, thus the following prerequisites apply:
 *  A Kernel bound interface to attach to;
 *  For need_wakeup feature, it requires kernel version later than v5.3-rc1;
 *  For PMD zero copy, it requires kernel version later than v5.4-rc1;
+*  For shared_umem, it requires kernel version v5.10 or later and libbpf version
+   v0.2.0 or later.
 
 Set up an af_xdp interface
 -----------------------------
@@ -57,3 +59,51 @@ The following example will set up an af_xdp interface in DPDK:
 .. code-block:: console
 
     --vdev net_af_xdp,iface=ens786f1
+
+Limitations
+-----------
+
+- **MTU**
+
+  The MTU of the AF_XDP PMD is limited due to the XDP requirement of one packet
+  per page. In the PMD we report the maximum MTU for zero copy to be equal
+  to the page size less the frame overhead introduced by AF_XDP (XDP HR = 256)
+  and DPDK (frame headroom = 320). With a 4K page size this works out at 3520.
+  However in practice this value may be even smaller, due to differences between
+  the supported RX buffer sizes of the underlying kernel netdev driver.
+
+  For example, the largest RX buffer size supported by the underlying kernel driver
+  which is less than the page size (4096B) may be 3072B. In this case, the maximum
+  MTU value will be at most 3072, but likely even smaller than this, once relevant
+  headers are accounted for eg. Ethernet and VLAN.
+
+  To determine the actual maximum MTU value of the interface you are using with the
+  AF_XDP PMD, consult the documentation for the kernel driver.
+
+  Note: The AF_XDP PMD will fail to initialise if an MTU which violates the driver's
+  conditions as above is set prior to launching the application.
+
+- **Shared UMEM**
+
+  The sharing of UMEM is only supported for AF_XDP sockets with unique contexts.
+  The context refers to the netdev,qid tuple.
+
+  The following combination will fail:
+
+  .. code-block:: console
+
+    --vdev net_af_xdp0,iface=ens786f1,shared_umem=1 \
+    --vdev net_af_xdp1,iface=ens786f1,shared_umem=1 \
+
+  Either of the following however is permitted since either the netdev or qid differs
+  between the two vdevs:
+
+  .. code-block:: console
+
+    --vdev net_af_xdp0,iface=ens786f1,shared_umem=1 \
+    --vdev net_af_xdp1,iface=ens786f1,start_queue=1,shared_umem=1 \
+
+  .. code-block:: console
+
+    --vdev net_af_xdp0,iface=ens786f1,shared_umem=1 \
+    --vdev net_af_xdp1,iface=ens786f2,shared_umem=1 \
\ No newline at end of file