From: Dave Young <dave@youngcopy.com>
To: Bruce Richardson <bruce.richardson@intel.com>
Cc: Ferruh Yigit <ferruh.yigit@amd.com>, dev@dpdk.org
Subject: Re: [PATCH 3/6] Section 3: Setting up a System to Run DPDK Applications
Date: Thu, 12 Oct 2023 13:32:58 -0400 [thread overview]
Message-ID: <CAMXm8ETKr9O4wLvY00qodGuepom+SuEOwRiE5O=S58_vJ=vhzQ@mail.gmail.com> (raw)
In-Reply-To: <ZRF7cdVL2q2O5p8V@bricha3-MOBL.ger.corp.intel.com>
[-- Attachment #1: Type: text/plain, Size: 4612 bytes --]
I asked the following in the Slack channel, responding to Stephen and
Thomas so asking in this thread as well to confirm:
To confirm, the three steps in 3.1.1 Memory Setup: Reservering Hugepages at
http://170.249.220.94/getting_started_guide/system_setup.html#system-setup-for-linux
can be replaced with the following:
Memory Setup: Reserving Hugepages
To simplify the hugepages setup, use the `dpdk-hugepages` script:
sudo dpdk-hugepages --setup
To confirm, the instructions in 3.1.2 Device Setup: VFIO at
http://170.249.220.94/getting_started_guide/system_setup.html#device-setup-vfio
can be replaced with the following:
Device Setup: VFIO
For VFIO setup, please refer to the `Kernel Documentation for VFIO <
https://www.kernel.org/doc/html/latest/driver-api/vfio.html>`_.
Thanks!
David Young
Professional Copywriter/Technical Writer
Young Copy
+1 (678) 500-9550
https://www.youngcopy.com
On Mon, Sep 25, 2023 at 8:22 AM Bruce Richardson <bruce.richardson@intel.com>
wrote:
> On Mon, Sep 25, 2023 at 12:31:34PM +0100, Ferruh Yigit wrote:
> > On 9/20/2023 4:48 PM, David Young wrote:
> > > ---
> > > .../getting_started_guide/system_setup.rst | 195 ++++++++++++++++++
> > > 1 file changed, 195 insertions(+)
> > > create mode 100644 doc/guides/getting_started_guide/system_setup.rst
> > >
> > > diff --git a/doc/guides/getting_started_guide/system_setup.rst
> b/doc/guides/getting_started_guide/system_setup.rst
> > > new file mode 100644
> > > index 0000000000..fa9d249ec7
> > > --- /dev/null
> > > +++ b/doc/guides/getting_started_guide/system_setup.rst
> > > @@ -0,0 +1,195 @@
> > > +.. SPDX-License-Identifier: BSD-3-Clause
> > > + Copyright(c) 2010-2025 Intel Corporation.
> > > +
> > > +.. _memory_setup:
> > > +
> > > +.. |reg| unicode:: U+000AE
> > > +
> > > +Setting up a System to Run DPDK Applications
> > > +============================================
> > > +
> > > +This section provides step-by-step instructions for setting up your
> system to run DPDK applications. It covers system configurations for Linux,
> FreeBSD, and Windows. Each section details the necessary memory and device
> setups for these operating systems.
> > > +
> > > +Navigate to the section that corresponds to your operating system to
> begin the setup process.
> > > +
> >
> > Not sure above sentences adds value.
> >
> >
> >
> > > +.. contents:: Table of Contents
> > > + :local:
> > > +
> > > +System Setup for Linux
> > > +----------------------
> > > +
> > > +Memory Setup: Reserving Hugepages
> > > +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> > > +
> > > +For Linux, DPDK requires hugepages be reserved for its use on the
> system. To check if hugepages are are on your system, you can run the
> following command::
> > > +
> > > + grep HugePages_Total /proc/meminfo
> > > +
> > > +If hugepages are not reserved, you will need to reserve them by
> following these steps:
> > > +
> > > +1. Determine the number of hugepages you want to allocate. For
> example, to allocate 1024 hugepages of 2MB each, you can use the following
> command::
> > > +
> > > + echo 1024 | sudo tee
> /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages
> > > +
> > > +2. To make the hugepages configuration persistent across reboots, add
> the following line to your `/etc/sysctl.conf` file, adjusting the number of
> hugepages as needed::
> > > +
> > > + vm.nr_hugepages = 1024
> > > +
> > > +3. Most distributions make hugepages available via `/dev/hugepages`,
> so this step may not be necessary. If you need to manually mount the
> hugepages filesystem, add the following line to your `/etc/fstab` file::
> > > +
> > > + nodev /mnt/huge hugetlbfs defaults 0 0
> > > +
> > > + Then, create the mount directory and mount the filesystem::
> > > +
> > > + mkdir -p /mnt/huge
> > > + mount -a
> > > +
> > >
> >
> >
> > We have './usertools/dpdk-hugepages.py' script for this, which I am
> > using regularly.
> >
> > Script is wrapper to what described above, so I think good to explain
> > basics, but also may worth mentioning from script, it is more user
> > friendly than above instructions.
> >
> Actually, if script can do all the basics - something I believe Stephen and
> Thomas also pointed out on a slack review earlier - then we should just
> drop the manual steps from here. If we think the script is sufficiently
> robust, we can drop them from the doc entirely, or if not, move them to an
> appendix which we reference here.
>
> /Bruce
>
[-- Attachment #2: Type: text/html, Size: 6490 bytes --]
next prev parent reply other threads:[~2023-10-12 17:33 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-20 15:48 [PATCH 0/6] docs: Unify Getting Started Guides David Young
2023-09-20 15:48 ` [PATCH 1/6] Section 1: Introduction David Young
2023-09-25 11:30 ` Ferruh Yigit
2023-10-11 18:26 ` Dave Young
2023-09-20 15:48 ` [PATCH 2/6] Section 2: Install and Build DPDK David Young
2023-09-25 11:30 ` Ferruh Yigit
2023-09-25 12:20 ` Bruce Richardson
2023-09-25 16:05 ` Tyler Retzlaff
2023-10-12 18:08 ` Dave Young
2023-10-17 13:37 ` Tyler Retzlaff
2023-09-20 15:48 ` [PATCH 3/6] Section 3: Setting up a System to Run DPDK Applications David Young
2023-09-25 11:31 ` Ferruh Yigit
2023-09-25 12:22 ` Bruce Richardson
2023-10-12 17:32 ` Dave Young [this message]
2023-09-20 15:48 ` [PATCH 4/6] Section 4: Running Applications David Young
2023-09-25 11:32 ` Ferruh Yigit
2023-09-20 15:48 ` [PATCH 5/6] Section 5: Appendix David Young
2023-09-25 11:33 ` Ferruh Yigit
2023-09-25 11:52 ` Ferruh Yigit
2023-09-25 12:24 ` Bruce Richardson
2023-09-20 15:48 ` [PATCH 6/6] Section 6: Glossary David Young
2023-09-25 11:43 ` Ferruh Yigit
2023-09-22 4:15 ` [PATCH 0/6] docs: Unify Getting Started Guides Tyler Retzlaff
2023-09-22 14:47 ` David Marchand
2023-09-22 15:54 ` Bruce Richardson
2023-09-25 11:54 ` Ferruh Yigit
2023-10-11 18:34 ` Dave Young
2023-10-13 16:28 ` Bruce Richardson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAMXm8ETKr9O4wLvY00qodGuepom+SuEOwRiE5O=S58_vJ=vhzQ@mail.gmail.com' \
--to=dave@youngcopy.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@amd.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).