[dpdk-stable] patch 'doc: fix grammar' has been queued to LTS release 18.11.11

[dpdk-stable] patch 'doc: fix grammar' has been queued to LTS release 18.11.11

[Kevin Traynor]

Hi,

FYI, your patch has been queued to LTS release 18.11.11

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 12/16/20. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/aba244a62a53d7fb85c6462dad1e56d0e4633fe4

Thanks.

Kevin.

---
From aba244a62a53d7fb85c6462dad1e56d0e4633fe4 Mon Sep 17 00:00:00 2001
From: Sarosh Arif <sarosh.arif@emumba.com>
Date: Wed, 16 Sep 2020 16:14:38 +0500
Subject: [PATCH] doc: fix grammar

[ upstream commit c053d9e9629b2337093dfd344eb904f0aff703bd ]

This patch corrects a grammatical error by changing 'an DPDK' to 'a DPDK',
so that the sentences can become grammatically accurate.

Fixes: 2e486e26328c ("doc: remove Intel references from linux guide")
Fixes: 48624fd96e7c ("doc: remove Intel references from prog guide")
Fixes: e0c7c4731957 ("doc: remove Intel references from sample apps guide")

Signed-off-by: Sarosh Arif <sarosh.arif@emumba.com>
Reviewed-by: David Marchand <david.marchand@redhat.com>
---
 doc/guides/linux_gsg/build_sample_apps.rst        | 4 ++--
 doc/guides/linux_gsg/enable_func.rst              | 2 +-
 doc/guides/linux_gsg/linux_drivers.rst            | 2 +-
 doc/guides/linux_gsg/sys_reqs.rst                 | 2 +-
 doc/guides/prog_guide/multi_proc_support.rst      | 2 +-
 doc/guides/sample_app_ug/l3_forward_power_man.rst | 2 +-
 6 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/doc/guides/linux_gsg/build_sample_apps.rst b/doc/guides/linux_gsg/build_sample_apps.rst
index 332424e05c..34406ab3f0 100644
--- a/doc/guides/linux_gsg/build_sample_apps.rst
+++ b/doc/guides/linux_gsg/build_sample_apps.rst
@@ -5,5 +5,5 @@ Compiling and Running Sample Applications
 =========================================
 
-The chapter describes how to compile and run applications in an DPDK environment.
+The chapter describes how to compile and run applications in a DPDK environment.
 It also provides a pointer to where sample applications are stored.
 
@@ -186,5 +186,5 @@ Since these logical core numbers, and their mapping to specific cores on specifi
 it is recommended that the core layout for each platform be considered when choosing the coremask/corelist to use in each case.
 
-On initialization of the EAL layer by an DPDK application, the logical cores to be used and their socket location are displayed.
+On initialization of the EAL layer by a DPDK application, the logical cores to be used and their socket location are displayed.
 This information can also be determined for all cores on the system by examining the ``/proc/cpuinfo`` file, for example, by running cat ``/proc/cpuinfo``.
 The physical id attribute listed for each processor indicates the CPU socket to which it belongs.
diff --git a/doc/guides/linux_gsg/enable_func.rst b/doc/guides/linux_gsg/enable_func.rst
index b2bda80bb7..ad11bc9e4e 100644
--- a/doc/guides/linux_gsg/enable_func.rst
+++ b/doc/guides/linux_gsg/enable_func.rst
@@ -113,5 +113,5 @@ Using Linux Core Isolation to Reduce Context Switches
 -----------------------------------------------------
 
-While the threads used by an DPDK application are pinned to logical cores on the system,
+While the threads used by a DPDK application are pinned to logical cores on the system,
 it is possible for the Linux scheduler to run other tasks on those cores also.
 To help prevent additional workloads from running on those cores,
diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst
index 7be3c43e4f..f8c606ce3c 100644
--- a/doc/guides/linux_gsg/linux_drivers.rst
+++ b/doc/guides/linux_gsg/linux_drivers.rst
@@ -116,5 +116,5 @@ Binding and Unbinding Network Ports to/from the Kernel Modules
 
 As of release 1.4, DPDK applications no longer automatically unbind all supported network ports from the kernel driver in use.
-Instead, in case the PMD being used use the UIO or VFIO drivers, all ports that are to be used by an DPDK application must be bound to the
+Instead, in case the PMD being used use the UIO or VFIO drivers, all ports that are to be used by a DPDK application must be bound to the
 ``uio_pci_generic``, ``igb_uio`` or ``vfio-pci`` module before the application is run.
 For such PMDs, any network ports under Linux* control will be ignored and cannot be used by the application.
diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst
index 735bc6ee5c..d390c89ac8 100644
--- a/doc/guides/linux_gsg/sys_reqs.rst
+++ b/doc/guides/linux_gsg/sys_reqs.rst
@@ -101,5 +101,5 @@ Running DPDK Applications
 -------------------------
 
-To run an DPDK application, some customization may be required on the target machine.
+To run a DPDK application, some customization may be required on the target machine.
 
 System Software
diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst
index a84083b96c..1a4a9e2d4d 100644
--- a/doc/guides/prog_guide/multi_proc_support.rst
+++ b/doc/guides/prog_guide/multi_proc_support.rst
@@ -76,5 +76,5 @@ and point to the same objects, in both processes.
 
 The EAL also supports an auto-detection mode (set by EAL ``--proc-type=auto`` flag ),
-whereby an DPDK process is started as a secondary instance if a primary instance is already running.
+whereby a DPDK process is started as a secondary instance if a primary instance is already running.
 
 Deployment Models
diff --git a/doc/guides/sample_app_ug/l3_forward_power_man.rst b/doc/guides/sample_app_ug/l3_forward_power_man.rst
index e44a11b2ce..eba8b7f147 100644
--- a/doc/guides/sample_app_ug/l3_forward_power_man.rst
+++ b/doc/guides/sample_app_ug/l3_forward_power_man.rst
@@ -50,5 +50,5 @@ to set the CPUFreq governor and set the frequency of specific cores.
 This application includes a P-state power management algorithm to generate a frequency hint to be sent to CPUFreq.
 The algorithm uses the number of received and available Rx packets on recent polls to make a heuristic decision to scale frequency up/down.
-Specifically, some thresholds are checked to see whether a specific core running an DPDK polling thread needs to increase frequency
+Specifically, some thresholds are checked to see whether a specific core running a DPDK polling thread needs to increase frequency
 a step up based on the near to full trend of polled Rx queues.
 Also, it decreases frequency a step if packet processed per loop is far less than the expected threshold
-- 
2.26.2

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-12-15 12:52:21.982195341 +0000
+++ 0001-doc-fix-grammar.patch	2020-12-15 12:52:21.947978677 +0000
@@ -1 +1 @@
-From c053d9e9629b2337093dfd344eb904f0aff703bd Mon Sep 17 00:00:00 2001
+From aba244a62a53d7fb85c6462dad1e56d0e4633fe4 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit c053d9e9629b2337093dfd344eb904f0aff703bd ]
+
@@ -12 +13,0 @@
-Cc: stable@dpdk.org
@@ -26 +27 @@
-index 043a1dcee1..994db4b6a0 100644
+index 332424e05c..34406ab3f0 100644
@@ -29,2 +30,2 @@
-@@ -5,5 +5,5 @@ Running Sample Applications
- ===========================
+@@ -5,5 +5,5 @@ Compiling and Running Sample Applications
+ =========================================
@@ -36 +37 @@
-@@ -137,5 +137,5 @@ Since these logical core numbers, and their mapping to specific cores on specifi
+@@ -186,5 +186,5 @@ Since these logical core numbers, and their mapping to specific cores on specifi
@@ -44 +45 @@
-index aab32252ea..a2339a877b 100644
+index b2bda80bb7..ad11bc9e4e 100644
@@ -47 +48 @@
-@@ -115,5 +115,5 @@ Using Linux Core Isolation to Reduce Context Switches
+@@ -113,5 +113,5 @@ Using Linux Core Isolation to Reduce Context Switches
@@ -55 +56 @@
-index ef8798569a..2d750b4c33 100644
+index 7be3c43e4f..f8c606ce3c 100644
@@ -58 +59 @@
-@@ -149,5 +149,5 @@ Binding and Unbinding Network Ports to/from the Kernel Modules
+@@ -116,5 +116,5 @@ Binding and Unbinding Network Ports to/from the Kernel Modules
@@ -66 +67 @@
-index 6ecdc04aa9..dadb23fc89 100644
+index 735bc6ee5c..d390c89ac8 100644
@@ -69 +70 @@
-@@ -98,5 +98,5 @@ Running DPDK Applications
+@@ -101,5 +101,5 @@ Running DPDK Applications
@@ -77 +78 @@
-index 57fd7425a1..6b0ac30c5b 100644
+index a84083b96c..1a4a9e2d4d 100644
@@ -88 +89 @@
-index 831f2bf58f..85a78a5c1e 100644
+index e44a11b2ce..eba8b7f147 100644

[dpdk-stable] patch 'doc: add SPDX license tag header to Intel performance guide' has been queued to LTS release 18.11.11

[Kevin Traynor]

Hi,

FYI, your patch has been queued to LTS release 18.11.11

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 12/16/20. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/d7e5526e03afbd114c1da98a498746d50eb08455

Thanks.

Kevin.

---
From d7e5526e03afbd114c1da98a498746d50eb08455 Mon Sep 17 00:00:00 2001
From: Stephen Hemminger <stephen@networkplumber.org>
Date: Sun, 15 Nov 2020 18:22:02 -0800
Subject: [PATCH] doc: add SPDX license tag header to Intel performance guide

[ upstream commit a0abf7052257ee21b1b9c6066f721e3b954aa181 ]

This document never had any license or copyright on this file, add one.

Fixes: b932ebcb2664 ("doc: add NIC performance guide on Linux IA")

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/linux_gsg/nic_perf_intel_platform.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/guides/linux_gsg/nic_perf_intel_platform.rst b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
index 5fa6e3899d..0f6550898a 100644
--- a/doc/guides/linux_gsg/nic_perf_intel_platform.rst
+++ b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
@@ -1,2 +1,5 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2015 Intel Corporation.
+
 How to get best performance with NICs on Intel platforms
 ========================================================
-- 
2.26.2

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-12-15 12:52:22.011210661 +0000
+++ 0002-doc-add-SPDX-license-tag-header-to-Intel-performance.patch	2020-12-15 12:52:21.948978688 +0000
@@ -1 +1 @@
-From a0abf7052257ee21b1b9c6066f721e3b954aa181 Mon Sep 17 00:00:00 2001
+From d7e5526e03afbd114c1da98a498746d50eb08455 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit a0abf7052257ee21b1b9c6066f721e3b954aa181 ]
+
@@ -9 +10,0 @@
-Cc: stable@dpdk.org
@@ -19 +20 @@
-index 08be5d58b9..dbfaf4e350 100644
+index 5fa6e3899d..0f6550898a 100644

[dpdk-stable] patch 'kni: fix build on RHEL 8.3' has been queued to LTS release 18.11.11

[Kevin Traynor]

Hi,

FYI, your patch has been queued to LTS release 18.11.11

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 12/16/20. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/dcd493e5059e4a2818e2df5b36179056184a7aae

Thanks.

Kevin.

---
From dcd493e5059e4a2818e2df5b36179056184a7aae Mon Sep 17 00:00:00 2001
From: Olivier Matz <olivier.matz@6wind.com>
Date: Thu, 26 Nov 2020 15:23:45 +0100
Subject: [PATCH] kni: fix build on RHEL 8.3

[ upstream commit 95e0871929bfd9891545c9cbfe97119cb72390ba ]

Like what was done for mainline kernel in commit 38ad54f3bc76 ("kni: fix
build with Linux 5.6"), a new parameter 'txqueue' has to be added to
'ndo_tx_timeout' ndo on RHEL 8.3 kernel.

Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
Tested-by: Christophe Grosse <christophe.grosse@6wind.com>
Tested-by: David Marchand <david.marchand@redhat.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
 kernel/linux/kni/compat.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/kernel/linux/kni/compat.h b/kernel/linux/kni/compat.h
index bf5e6e2b17..953b2cb614 100644
--- a/kernel/linux/kni/compat.h
+++ b/kernel/linux/kni/compat.h
@@ -122,5 +122,7 @@
 #endif
 
-#if KERNEL_VERSION(5, 6, 0) <= LINUX_VERSION_CODE
+#if KERNEL_VERSION(5, 6, 0) <= LINUX_VERSION_CODE || \
+	(defined(RHEL_RELEASE_CODE) && \
+	 RHEL_RELEASE_VERSION(8, 3) <= RHEL_RELEASE_CODE)
 #define HAVE_TX_TIMEOUT_TXQUEUE
 #endif
-- 
2.26.2

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-12-15 12:52:22.038740663 +0000
+++ 0003-kni-fix-build-on-RHEL-8.3.patch	2020-12-15 12:52:21.951978719 +0000
@@ -1 +1 @@
-From 95e0871929bfd9891545c9cbfe97119cb72390ba Mon Sep 17 00:00:00 2001
+From dcd493e5059e4a2818e2df5b36179056184a7aae Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 95e0871929bfd9891545c9cbfe97119cb72390ba ]
+
@@ -10,2 +11,0 @@
-Cc: stable@dpdk.org
-
@@ -21 +21 @@
-index d515b27669..5f65640d5e 100644
+index bf5e6e2b17..953b2cb614 100644
@@ -24 +24 @@
-@@ -132,5 +132,7 @@
+@@ -122,5 +122,7 @@

[dpdk-stable] patch 'doc: clarify instructions on running as non-root' has been queued to LTS release 18.11.11

[Kevin Traynor]

Hi,

FYI, your patch has been queued to LTS release 18.11.11

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 12/16/20. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/05a0668483cbdf5ef15ee65078cc8fb9c83eabff

Thanks.

Kevin.

---
From 05a0668483cbdf5ef15ee65078cc8fb9c83eabff Mon Sep 17 00:00:00 2001
From: Anatoly Burakov <anatoly.burakov@intel.com>
Date: Thu, 19 Nov 2020 10:52:44 +0000
Subject: [PATCH] doc: clarify instructions on running as non-root

[ upstream commit 3c3a861ce07e507dadda56091bc39cb92c3ae928 ]

The current instructions are slightly out of date when it comes to
providing information about setting up the system for using DPDK as
non-root, so update them.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/linux_gsg/enable_func.rst | 58 ++++++++++++++++++++--------
 1 file changed, 41 insertions(+), 17 deletions(-)

diff --git a/doc/guides/linux_gsg/enable_func.rst b/doc/guides/linux_gsg/enable_func.rst
index ad11bc9e4e..459a952ce3 100644
--- a/doc/guides/linux_gsg/enable_func.rst
+++ b/doc/guides/linux_gsg/enable_func.rst
@@ -59,20 +59,49 @@ The application can then determine what action to take, if any, if the HPET is n
 
 Running DPDK Applications Without Root Privileges
---------------------------------------------------------
+-------------------------------------------------
+
+In order to run DPDK as non-root, the following Linux filesystem objects'
+permissions should be adjusted to ensure that the Linux account being used to
+run the DPDK application has access to them:
+
+*   All directories which serve as hugepage mount points, for example, ``/dev/hugepages``
+
+*   If the HPET is to be used,  ``/dev/hpet``
+
+When running as non-root user, there may be some additional resource limits
+that are imposed by the system. Specifically, the following resource limits may
+need to be adjusted in order to ensure normal DPDK operation:
+
+* RLIMIT_LOCKS (number of file locks that can be held by a process)
+
+* RLIMIT_NOFILE (number of open file descriptors that can be held open by a process)
+
+* RLIMIT_MEMLOCK (amount of pinned pages the process is allowed to have)
+
+The above limits can usually be adjusted by editing
+``/etc/security/limits.conf`` file, and rebooting.
+
+Additionally, depending on which kernel driver is in use, the relevant
+resources also should be accessible by the user running the DPDK application.
+
+For ``vfio-pci`` kernel driver, the following Linux file system objects'
+permissions should be adjusted:
+
+* The VFIO device file, ``/dev/vfio/vfio``
+
+* The directories under ``/dev/vfio`` that correspond to IOMMU group numbers of
+  devices intended to be used by DPDK, for example, ``/dev/vfio/50``
 
 .. note::
 
-    The instructions below will allow running DPDK as non-root with older
-    Linux kernel versions. However, since version 4.0, the kernel does not allow
-    unprivileged processes to read the physical address information from
-    the pagemaps file, making it impossible for those processes to use HW
-    devices which require physical addresses
+    The instructions below will allow running DPDK with ``igb_uio`` or
+    ``uio_pci_generic`` drivers as non-root with older Linux kernel versions.
+    However, since version 4.0, the kernel does not allow unprivileged processes
+    to read the physical address information from the pagemaps file, making it
+    impossible for those processes to be used by non-privileged users. In such
+    cases, using the VFIO driver is recommended.
 
-Although applications using the DPDK use network ports and other hardware resources directly,
-with a number of small permission adjustments it is possible to run these applications as a user other than "root".
-To do so, the ownership, or permissions, on the following Linux file system objects should be adjusted to ensure that
-the Linux user account being used to run the DPDK application has access to them:
-
-*   All directories which serve as hugepage mount points, for example,   ``/mnt/huge``
+For ``igb_uio`` or ``uio_pci_generic`` kernel drivers, the following Linux file
+system objects' permissions should be adjusted:
 
 *   The userspace-io device files in  ``/dev``, for example,  ``/dev/uio0``, ``/dev/uio1``, and so on
@@ -83,9 +112,4 @@ the Linux user account being used to run the DPDK application has access to them
        /sys/class/uio/uio0/device/resource*
 
-*   If the HPET is to be used,  ``/dev/hpet``
-
-.. note::
-
-    On some Linux installations, ``/dev/hugepages``  is also a hugepage mount point created by default.
 
 Power Management and Power Saving Functionality
-- 
2.26.2

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-12-15 12:52:22.066581852 +0000
+++ 0004-doc-clarify-instructions-on-running-as-non-root.patch	2020-12-15 12:52:21.952978730 +0000
@@ -1 +1 @@
-From 3c3a861ce07e507dadda56091bc39cb92c3ae928 Mon Sep 17 00:00:00 2001
+From 05a0668483cbdf5ef15ee65078cc8fb9c83eabff Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 3c3a861ce07e507dadda56091bc39cb92c3ae928 ]
+
@@ -10,2 +11,0 @@
-Cc: stable@dpdk.org
-
@@ -20 +20 @@
-index a2339a877b..45fd53ba36 100644
+index ad11bc9e4e..459a952ce3 100644
@@ -23 +23 @@
-@@ -61,20 +61,49 @@ The application can then determine what action to take, if any, if the HPET is n
+@@ -59,20 +59,49 @@ The application can then determine what action to take, if any, if the HPET is n
@@ -85 +85 @@
-@@ -85,9 +114,4 @@ the Linux user account being used to run the DPDK application has access to them
+@@ -83,9 +112,4 @@ the Linux user account being used to run the DPDK application has access to them

[dpdk-stable] patch 'doc: update information on using hugepages' has been queued to LTS release 18.11.11

[Kevin Traynor]

Hi,

FYI, your patch has been queued to LTS release 18.11.11

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 12/16/20. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable-queue/commit/1c361d28db15504cb92d6de53b32edacecd3a579

Thanks.

Kevin.

---
From 1c361d28db15504cb92d6de53b32edacecd3a579 Mon Sep 17 00:00:00 2001
From: Anatoly Burakov <anatoly.burakov@intel.com>
Date: Thu, 19 Nov 2020 10:52:45 +0000
Subject: [PATCH] doc: update information on using hugepages

[ upstream commit 8397cac725e43562df3ce7d230aa3b4390b64b10 ]

Current information regarding hugepage usage is a little out of date.
Update it to include information on in-memory mode, as well as on
default mountpoints provided by systemd.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/linux_gsg/sys_reqs.rst | 74 ++++++++++++++++++++-----------
 1 file changed, 48 insertions(+), 26 deletions(-)

diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst
index d390c89ac8..a57ccf4eb0 100644
--- a/doc/guides/linux_gsg/sys_reqs.rst
+++ b/doc/guides/linux_gsg/sys_reqs.rst
@@ -157,6 +157,34 @@ Reserving Hugepages for DPDK Use
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-The allocation of hugepages should be done at boot time or as soon as possible after system boot
-to prevent memory from being fragmented in physical memory.
+The reservation of hugepages can be performed at run time.
+This is done by echoing the number of hugepages required
+to a ``nr_hugepages`` file in the ``/sys/kernel/`` directory
+corresponding to a specific page size (in Kilobytes).
+For a single-node system, the command to use is as follows
+(assuming that 1024 of 2MB pages are required)::
+
+    echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
+
+On a NUMA machine, the above command will usually divide the number of hugepages
+equally across all NUMA nodes (assuming there is enough memory on all NUMA nodes).
+However, pages can also be reserved explicitly on individual NUMA nodes
+using a ``nr_hugepages`` file in the ``/sys/devices/`` directory::
+
+    echo 1024 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages
+    echo 1024 > /sys/devices/system/node/node1/hugepages/hugepages-2048kB/nr_hugepages
+
+.. note::
+
+    Some kernel versions may not allow reserving 1 GB hugepages at run time,
+    so reserving them at boot time may be the only option.
+    Please see below for instructions.
+
+**Alternative:**
+
+In the general case, reserving hugepages at run time is perfectly fine,
+but in use cases where having lots of physically contiguous memory is required,
+it is preferable to reserve hugepages at boot time,
+as that will help in preventing physical memory from becoming heavily fragmented.
+
 To reserve hugepages at boot time, a parameter is passed to the Linux kernel on the kernel command line.
 
@@ -187,34 +215,28 @@ the number of hugepages reserved at boot time is generally divided equally betwe
 See the Documentation/admin-guide/kernel-parameters.txt file in your Linux source tree for further details of these and other kernel options.
 
-**Alternative:**
-
-For 2 MB pages, there is also the option of allocating hugepages after the system has booted.
-This is done by echoing the number of hugepages required to a nr_hugepages file in the ``/sys/devices/`` directory.
-For a single-node system, the command to use is as follows (assuming that 1024 pages are required)::
-
-    echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
-
-On a NUMA machine, pages should be allocated explicitly on separate nodes::
-
-    echo 1024 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages
-    echo 1024 > /sys/devices/system/node/node1/hugepages/hugepages-2048kB/nr_hugepages
-
-.. note::
-
-    For 1G pages, it is not possible to reserve the hugepage memory after the system has booted.
-
 Using Hugepages with the DPDK
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Once the hugepage memory is reserved, to make the memory available for DPDK use, perform the following steps::
+If secondary process support is not required, DPDK is able to use hugepages
+without any configuration by using "in-memory" mode.
+Please see :doc:`linux_eal_parameters` for more details.
+
+If secondary process support is required,
+mount points for hugepages need to be created.
+On modern Linux distributions, a default mount point for hugepages
+is provided by the system and is located at ``/dev/hugepages``.
+This mount point will use the default hugepage size
+set by the kernel parameters as described above.
+
+However, in order to use hugepage sizes other than the default, it is necessary
+to manually create mount points for those hugepage sizes (e.g. 1GB pages).
+
+To make the hugepages of size 1GB available for DPDK use,
+following steps must be performed::
 
     mkdir /mnt/huge
-    mount -t hugetlbfs nodev /mnt/huge
+    mount -t hugetlbfs pagesize=1GB /mnt/huge
 
 The mount point can be made permanent across reboots, by adding the following line to the ``/etc/fstab`` file::
 
-    nodev /mnt/huge hugetlbfs defaults 0 0
-
-For 1GB pages, the page size must be specified as a mount option::
-
-    nodev /mnt/huge_1GB hugetlbfs pagesize=1GB 0 0
+    nodev /mnt/huge hugetlbfs pagesize=1GB 0 0
-- 
2.26.2

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-12-15 12:52:22.093651684 +0000
+++ 0005-doc-update-information-on-using-hugepages.patch	2020-12-15 12:52:21.953978740 +0000
@@ -1 +1 @@
-From 8397cac725e43562df3ce7d230aa3b4390b64b10 Mon Sep 17 00:00:00 2001
+From 1c361d28db15504cb92d6de53b32edacecd3a579 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 8397cac725e43562df3ce7d230aa3b4390b64b10 ]
+
@@ -10,2 +11,0 @@
-Cc: stable@dpdk.org
-
@@ -19 +19 @@
-index e074faf514..be714adf22 100644
+index d390c89ac8..a57ccf4eb0 100644
@@ -22 +22 @@
-@@ -159,6 +159,34 @@ Reserving Hugepages for DPDK Use
+@@ -157,6 +157,34 @@ Reserving Hugepages for DPDK Use
@@ -59 +59 @@
-@@ -189,34 +217,28 @@ the number of hugepages reserved at boot time is generally divided equally betwe
+@@ -187,34 +215,28 @@ the number of hugepages reserved at boot time is generally divided equally betwe