summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnatoly Burakov <anatoly.burakov@intel.com>2019-01-31 17:05:51 +0000
committerThomas Monjalon <thomas@monjalon.net>2019-02-01 11:50:33 +0100
commite39d9b63664ae44af6214fa236cd989850a50833 (patch)
tree153b18b42de43852ec17999884f48432e20e564b
parent0763ec43db788fc42597341041e7186fc843df72 (diff)
downloaddpdk-e39d9b63664ae44af6214fa236cd989850a50833.zip
dpdk-e39d9b63664ae44af6214fa236cd989850a50833.tar.gz
dpdk-e39d9b63664ae44af6214fa236cd989850a50833.tar.xz
doc: clarify libnuma requirement for NUMA systems
Since 18.05, libnuma is pretty much required on Linux when using non-legacy mode, because without it, we cannot know where our hugepages are located [1]. In legacy mode, libnuma is not required because we can still sort pages by sockets, as we use pagemap lookup method to figure out socket ID's for pages. So, document libnuma as required for NUMA systems and non-legacy mode. [1] https://mails.dpdk.org/archives/dev/2018-December/120490.html Fixes: 6b42f75632f0 ("eal: enable non-legacy memory mode") Cc: stable@dpdk.org Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com> Acked-by: Kevin Traynor <ktraynor@redhat.com>
-rw-r--r--doc/guides/linux_gsg/sys_reqs.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst
index 8ec3af4..d0cb66f 100644
--- a/doc/guides/linux_gsg/sys_reqs.rst
+++ b/doc/guides/linux_gsg/sys_reqs.rst
@@ -70,6 +70,15 @@ Compilation of the DPDK
* libnuma-dev in Debian/Ubuntu;
+ .. note::
+
+ On systems with NUMA support, `libnuma-dev` (aka `numactl-devel`)
+ is a recommended dependency when `--legacy-mem` switch is used,
+ and a *required* dependency if default memory mode is used.
+ While DPDK will compile and run without `libnuma`
+ even on NUMA-enabled systems,
+ both usability and performance will be degraded.
+
* Python, version 2.7+ or 3.2+, to use various helper scripts included in the DPDK package.