DPDK website maintenance
 help / color / Atom feed
From: "A.McLoughlin" <aideen.mcloughlin@intel.com>
To: web@dpdk.org
Cc: "A.McLoughlin" <aideen.mcloughlin@intel.com>
Subject: [dpdk-web] [PATCH v2] update quick start guide
Date: Fri, 30 Aug 2019 09:57:24 +0100
Message-ID: <20190830085724.20125-1-aideen.mcloughlin@intel.com> (raw)

The Quick Start Guide was unclear. This patch updates the Quick Start
Guide so that it can be more helpful to new users of DPDK. This patch
changes the use of physical ports to null ports as not all new users
will have easily usable ports.

These null ports simulate packets to avoid the process of setting up and
running a packet generator.

The previous version of the quick start guide  was only compatible with multi
socket platforms, this patch makes it compatible with single socket platforms.

Signed-off-by: Aideen McLoughlin <aideen.mcloughlin@intel.com>
---
v1 -> v2:
* fixed typo in 'hugetlbfs'
* Fixed Signed off message to show full name 
---
 content/doc/quick-start.md | 118 ++++++++++++++++++++++---------------
 1 file changed, 69 insertions(+), 49 deletions(-)

diff --git a/content/doc/quick-start.md b/content/doc/quick-start.md
index fdffa98..72e6e0e 100644
--- a/content/doc/quick-start.md
+++ b/content/doc/quick-start.md
@@ -4,74 +4,94 @@ title = "Quick Start Guide"
 
 {{% alert theme="info" %}}<center>A simple forwarding test with pcap PMD which works with any NIC (with performance penalties)</center>{{% /alert %}}
 
-Extract sources
-
+## Download DPDK {#download}
+---
+Download a DPDK package from [this page](/download/). It is best to download the latest stable version.
+If you want to have DPDK on a remote server or board, you must transfer the downloaded file to the board/server. You can do this with programs such as [WinSCP](https://winscp.net/eng/index.php) or [MobaXterm](https://mobaxterm.mobatek.net/download.html)
+
+## Extract source files from downloaded file {#extract}
+---
+Ensure the downloaded file is in the directory in which you want DPDK, and that you are in that same directory.
+To extract the DPDK files from the downloaded file into a new directory, run the command below
+(if you downloaded dpdk-19.05.tar.xz , the commands should reflect that eg. tar xf dpdk-19.05.tar.xz)
 ```
   tar xf dpdk.tar.gz
+```
+Enter the newly created directory with the cd command as below
+```
   cd dpdk
 ```
-
-Enable pcap (libpcap headers are required).
-
+## Build DPDK {#build}
+---
+To make any necessary config changes to the environment before DPDK is built, run the command below
 ```
-  make config T=x86_64-native-linuxapp-gcc
-  sed -ri 's,(PMD_PCAP=).*,\1y,' build/.config
+  make defconfig
 ```
-
-Build libraries and test application (Linux headers may be needed with default config).
-
+The command below builds a usable version of DPDK from the DPDK folder. You must be within the new DPDK folder for this command to run.
+It may take a while for the command to fully run as there are a lot of elements to build in DPDK.
 ```
-  make
+  make -j
 ```
+'make' is the standard command to build an application, and '-j' tells the make command to use all the cores when building, which should speed up the building process
 
-Reserve huge pages memory.
-
+## Reserve memory for Hugepages {#hugepages}
+---
+Hugepages increase application performance as the performance cost of swapping between pages is much less than if only small pages were used.
+First make subdirectory huge in directory mnt
 ```
   mkdir -p /mnt/huge
+```
+Then make the filesystem 'hugetlbfs nodev' accessible to directory structure /mnt/huge for the proper storage of the hugepages which will be created.
+```
   mount -t hugetlbfs nodev /mnt/huge
-  echo 64 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages
 ```
-
-Run poll-mode driver test (with a cable between ports).
-
+Then allocate 2048 hugepages with the command below
+```
+  sysctl -w vm.nr_hugepages=2048
 ```
-  build/app/testpmd -c7 -n3 --vdev=net_pcap0,iface=eth0     --vdev=net_pcap1,iface=eth1 --
-                  -i --nb-cores=2 --nb-ports=2 --total-num-mbufs=2048
-
-  testpmd> show port stats all
-
-  ######################## NIC statistics for port 0  ########################
-  RX-packets: 0          RX-errors: 0         RX-bytes: 0
-  TX-packets: 0          TX-errors: 0         TX-bytes: 0
-  ############################################################################
-
-  ######################## NIC statistics for port 1  ########################
-  RX-packets: 0          RX-errors: 0         RX-bytes: 0
-  TX-packets: 0          TX-errors: 0         TX-bytes: 0
-  ############################################################################
 
-  testpmd> start tx_first
+## Run poll-mode packet forwarding test {#run}
+---
+Run the command below to start a packet sending and receiving program
+```
+  build/app/testpmd --vdev=net_null0 --vdev=net_null1 -- -i
+```
 
+You may have a lot of errors like the one shown below. This is because we do not give specific device addresses to use, and so the system checks every available device to use before running. In this case, you can ignore those error messages
+```
+  EAL: PCI device 0000:83:00.1 on NUMA socket -1
+  EAL:   Invalid NUMA socket, default to 0
+  EAL:   probe driver: 8086:10fb net_ixgbe
+```
+Within the program, type 'start' to start transmission of packets. That will print out information on how the packets are being transmitted, and will keep transmitting until you stop transmission.
+```
+  testpmd> start
+```
+Type 'stop' to both stop transmission and display stats on the transmission, as shown below
+```
   testpmd> stop
-
+  Telling cores to stop...
+  Waiting for lcores to finish...
   ---------------------- Forward statistics for port 0  ----------------------
-  RX-packets: 2377688        RX-dropped: 0             RX-total: 2377688
-  TX-packets: 2007009        TX-dropped: 0             TX-total: 2007009
-  ----------------------------------------------------------------------------
-
+    RX-packets: 105326272      RX-dropped: 0             RX-total: 105326272
+    TX-packets: 105326272      TX-dropped: 0             TX-total: 105326272
+    ----------------------------------------------------------------------------
   ---------------------- Forward statistics for port 1  ----------------------
-  RX-packets: 2006977        RX-dropped: 0             RX-total: 2006977
-  TX-packets: 2377720        TX-dropped: 0             TX-total: 2377720
-  ----------------------------------------------------------------------------
-
-  +++++++++++++++ Accumulated forward statistics for all ports+++++++++++++++
-  RX-packets: 4384665        RX-dropped: 0             RX-total: 4384665
-  TX-packets: 4384729        TX-dropped: 0             TX-total: 4384729
-  ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+    RX-packets: 105326272      RX-dropped: 0             RX-total: 105326272
+    TX-packets: 105326272      TX-dropped: 0             TX-total: 105326272
+    ----------------------------------------------------------------------------
+  +++++++++++++++ Accumulated forward statistics for all ports+++++++++
+    RX-packets: 210652544      RX-dropped: 0             RX-total: 210652544
+    TX-packets: 210652544      TX-dropped: 0             TX-total: 210652544
+    +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+  Done.
 ```
+To exit the program, type 'quit'
 
-Some sample applications can be tested after building them.
+You have now run testpmd, a DPDK packet forwarding application. To continue learning about how to use DPDK, go to the [DPDK guide website](https://doc.dpdk.org/guides/index.html).
+
+Testpmd is a forwarding application and not a packet generator. We can see packets being sent and received in this example as the null devices (net_null0, net_null1) simulate packets.
+
+The next step in understanding and setting up DPDK is binding ports. This will allow you to send actual packets, instead of simulated packets
+For an explanation on how to bind ports to DPDK follow [these instructions](https://doc.dpdk.org/guides/linux_gsg/linux_drivers.html) from the DPDK guide website.
 
-```
-  make -C examples RTE_SDK=$(pwd) RTE_TARGET=build O=$(pwd)/build/examples
-```
-- 
2.17.1


                 reply index

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publically 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=20190830085724.20125-1-aideen.mcloughlin@intel.com \
    --to=aideen.mcloughlin@intel.com \
    --cc=web@dpdk.org \
    /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

DPDK website maintenance

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/web/0 web/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 web web/ http://inbox.dpdk.org/web \
		web@dpdk.org
	public-inbox-index web


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.web


AGPL code for this site: git clone https://public-inbox.org/ public-inbox