summaryrefslogtreecommitdiffstats
path: root/src/plugins/af_xdp
diff options
context:
space:
mode:
authorMohammed Hawari <mohammed@hawari.fr>2020-09-10 15:10:45 +0200
committerAndrew Yourtchenko <ayourtch@gmail.com>2020-09-15 08:34:05 +0000
commit758e6776a8f58782a8603fb9b5cc8d120dbe6ba2 (patch)
tree4bf2dc82a3f926465f8e3af6c1003f6b1f46ca10 /src/plugins/af_xdp
parentf1b7953449b5ec5a21b359c35ad4d587d02da788 (diff)
af_xdp: documents incompatibility with 1GB hugepages and high buffers-per-numa.
Type: docs Change-Id: If8602d4b73cc1f04e42d19b8df60a05f67aa90c9 Signed-off-by: Mohammed Hawari <mohammed@hawari.fr> (cherry picked from commit 5d2091da2a96cb1092b0744cdee8bb481788a6dc)
Diffstat (limited to 'src/plugins/af_xdp')
-rw-r--r--src/plugins/af_xdp/af_xdp_doc.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/plugins/af_xdp/af_xdp_doc.md b/src/plugins/af_xdp/af_xdp_doc.md
index 6d2dae55055..40a3596be7c 100644
--- a/src/plugins/af_xdp/af_xdp_doc.md
+++ b/src/plugins/af_xdp/af_xdp_doc.md
@@ -17,6 +17,8 @@ Because of AF_XDP restrictions, the MTU is limited to below PAGE_SIZE
(4096-bytes on most systems) minus 256-bytes, and they are additional
limitations depending upon specific Linux device drivers.
As a rule of thumb, a MTU of 3000-bytes or less should be safe.
+Furthermore, upon UMEM creation, the kernel allocates a physically-contiguous structure, whose size is proportional to the number of 4KB pages contained in the UMEM. That allocation might fail when the number of buffers allocated by VPP is too high. That number can be controlled with the `buffers { buffers-per-numa }` configuration option.
+Finally, note that because of this limitation, this plugin is unlikely to be compatible with the use of 1GB hugepages.
## Requirements
The Linux kernel interface must be up and have enough queues before