d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: replace hugepages commands with dedicated tool

Browse Source 
The tool dpdk-hugepages.py, added in DPDK 20.11,
is referenced in the guides instead of more complicate commands.

The original Linux commands are kept in linux_gsg/sys_reqs.rst
and nics/build_and_test.rst.

Suggested-by: Stephen Hemminger <stephen@networkplumber.org>
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Stephen Hemminger <stephen@networkplumber.org>
This commit is contained in:
Thomas Monjalon 2021-02-11 19:16:59 +01:00
parent 7a016af4aa
commit de34aaa96b
10 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/guides/cryptodevs/octeontx.rst
View File

@ -107,9 +107,7 @@ applications.
.. code-block:: console
echo 8 > /sys/kernel/mm/hugepages/hugepages-524288kB/nr_hugepages
mkdir /mnt/huge
mount -t hugetlbfs nodev /mnt/huge
dpdk-hugepages.py --setup 4G --pagesize 512M
Example applications can now be executed with crypto operations offloaded to
OCTEON TX crypto PMD.

2
doc/guides/cryptodevs/octeontx2.rst
View File

@ -123,7 +123,7 @@ Another way to bind the VF would be to use the ``dpdk-devbind.py`` script:
* Ensure that sufficient huge pages are available for your application::
echo 8 > /sys/kernel/mm/hugepages/hugepages-524288kB/nr_hugepages
dpdk-hugepages.py --setup 4G --pagesize 512M
Refer to :ref:`linux_gsg_hugepages` for more details.

6
doc/guides/howto/lm_bond_virtio_sriov.rst
View File

@ -581,9 +581,9 @@ Set up DPDK in the Virtual Machine
# virtio port is 03
# vf port is 04
cat /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
cat /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
/root/dpdk/usertools/dpdk-hugepages.py --show
/root/dpdk/usertools/dpdk-hugepages.py --setup 2G
/root/dpdk/usertools/dpdk-hugepages.py --show
ifconfig -a
/root/dpdk/usertools/dpdk-devbind.py --status

6
doc/guides/howto/lm_virtio_vhost_user.rst
View File

@ -411,9 +411,9 @@ setup_dpdk_virtio_in_vm.sh
# virtio port is 03
# virtio port is 04
cat /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
cat /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
/root/dpdk/usertools/dpdk-hugepages.py --show
/root/dpdk/usertools/dpdk-hugepages.py --setup 2G
/root/dpdk/usertools/dpdk-hugepages.py --show
ifconfig -a
/root/dpdk/usertools/dpdk-devbind.py --status

2
doc/guides/linux_gsg/sys_reqs.rst
View File

@ -181,6 +181,8 @@ 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
The tool ``dpdk-hugepages.py`` can be used to manage hugepages.
.. note::
Some kernel versions may not allow reserving 1 GB hugepages at run time,

6
doc/guides/nics/build_and_test.rst
View File

@ -64,6 +64,12 @@ This section demonstrates how to setup and run ``testpmd`` in Linux.
Hugepagesize: 2048 kB
Mount and request above can be achieved simply with this tool:
.. code-block:: console
dpdk-hugepages.py --setup 2G
#. Load ``igb_uio`` or ``vfio-pci`` driver:
.. code-block:: console

2
doc/guides/nics/mlx4.rst
View File

@ -405,7 +405,7 @@ devices managed by librte_net_mlx4.
#. Request huge pages::
echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
dpdk-hugepages.py --setup 2G
#. Start testpmd with basic parameters::

2
doc/guides/nics/mlx5.rst
View File

@ -1712,7 +1712,7 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5.
#. Request huge pages::
echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
dpdk-hugepages.py --setup 2G
#. Start testpmd with basic parameters::

2
doc/guides/nics/virtio.rst
View File

@ -152,7 +152,7 @@ Host2VM communication example
.. code-block:: console
modprobe uio
echo 512 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages
dpdk-hugepages.py --setup 1G
modprobe uio_pci_generic
./usertools/dpdk-devbind.py -b uio_pci_generic 00:03.0

2
doc/guides/sample_app_ug/vhost.rst
View File

@ -188,7 +188,7 @@ Common Issues
.. code-block:: console
cat /sys/kernel/mm/hugepages/hugepages-<pagesize>/nr_hugepages
dpdk-hugepages.py --show
The command above indicates how many hugepages are free to support QEMU's
allocation request.