From: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v4 5/5] doc: new packet ordering app description
Date: Wed, 11 Feb 2015 13:07:35 +0000 [thread overview]
Message-ID: <1423660055-23920-6-git-send-email-sergio.gonzalez.monroy@intel.com> (raw)
In-Reply-To: <1423660055-23920-1-git-send-email-sergio.gonzalez.monroy@intel.com>
This patch describes how to build and run he new packet ordering sample
application that exercises the reorder library.
Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
---
doc/guides/sample_app_ug/index.rst | 1 +
doc/guides/sample_app_ug/packet_ordering.rst | 102 +++++++++++++++++++++++++++
2 files changed, 103 insertions(+)
create mode 100644 doc/guides/sample_app_ug/packet_ordering.rst
diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst
index d07dec3..5720181 100644
--- a/doc/guides/sample_app_ug/index.rst
+++ b/doc/guides/sample_app_ug/index.rst
@@ -60,6 +60,7 @@ Sample Applications User Guide
intel_quickassist
quota_watermark
timer
+ packet_ordering
vmdq_dcb_forwarding
vhost
netmap_compatibility
diff --git a/doc/guides/sample_app_ug/packet_ordering.rst b/doc/guides/sample_app_ug/packet_ordering.rst
new file mode 100644
index 0000000..481f1b7
--- /dev/null
+++ b/doc/guides/sample_app_ug/packet_ordering.rst
@@ -0,0 +1,102 @@
+.. BSD LICENSE
+ Copyright(c) 2015 Intel Corporation. All rights reserved.
+ All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
+ the documentation and/or other materials provided with the
+ distribution.
+ * Neither the name of Intel Corporation nor the names of its
+ contributors may be used to endorse or promote products derived
+ from this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Packet Ordering Application
+============================
+
+The Packet Ordering sample app simply shows the impact of reordering a stream.
+It's meant to stress the library with different configurations for performance.
+
+Overview
+--------
+
+The application uses at least three CPU cores:
+
+* RX core (maser core) receives traffic from the NIC ports and feeds Worker
+ cores with traffic through SW queues.
+
+* Worker core (slave core) basically do some light work on the packet.
+ Currently it modifies the output port of the packet for configurations with
+ more than one port enabled.
+
+* TX Core (slave core) receives traffic from Woker cores through software queues,
+ inserts out-of-order packets into reorder buffer, extracts ordered packets
+ from the reorder buffer and sends them to the NIC ports for transmission.
+
+Compiling the Application
+--------------------------
+
+#. Go to the example directory:
+
+ .. code-block:: console
+
+ export RTE_SDK=/path/to/rte_sdk
+ cd ${RTE_SDK}/examples/helloworld
+
+#. Set the target (a default target is used if not specified). For example:
+
+ .. code-block:: console
+
+ export RTE_TARGET=x86_64-native-linuxapp-gcc
+
+ See the *DPDK Getting Started* Guide for possible RTE_TARGET values.
+
+#. Build the application:
+
+ .. code-block:: console
+
+ make
+
+Running the Application
+-----------------------
+
+Refer to *DPDK Getting Started Guide* for general information on running applications
+and the Environment Abstraction Layer (EAL) options.
+
+Application Command Line
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The application execution command line is:
+
+.. code-block:: console
+
+ ./test-pipeline [EAL options] -- -p PORTMASK [--disable-reorder]
+
+The -c EAL CPU_COREMASK option has to contain at least 3 CPU cores.
+The first CPU core in the core mask is the master core and would be assigned to
+RX core, the last to TX core and the rest to Worker cores.
+
+The PORTMASK parameter must contain either 1 or even enabled port numbers.
+When setting more than 1 port, traffic would be forwarderd in pairs.
+For example, if we enable 4 ports, traffic from port 0 to 1 and from 1 to 0,
+then the other pair from 2 to 3 and from 3 to 2, having [0,1] and [2,3] pairs.
+
+The disable-reorder long option does, as its name implies, disable the reordering
+of traffic, which should help evaluate reordering performance impact.
--
1.9.3
next prev parent reply other threads:[~2015-02-11 13:08 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-01-07 16:39 [dpdk-dev] [PATCH 1/3] librte_reorder: New reorder library Reshma Pattan
2015-01-07 16:39 ` [dpdk-dev] [PATCH 2/3] librte_reorder: New unit test cases added Reshma Pattan
2015-01-07 16:39 ` [dpdk-dev] [PATCH 3/3] librte_reorder: New sample app for reorder library Reshma Pattan
2015-01-07 17:45 ` [dpdk-dev] [PATCH 1/3] librte_reorder: New " Neil Horman
2015-01-08 14:41 ` Pattan, Reshma
2015-01-07 21:09 ` Richard Sanger
2015-01-08 16:28 ` Pattan, Reshma
2015-01-20 8:00 ` Thomas Monjalon
2015-01-29 17:35 ` Gonzalez Monroy, Sergio
2015-01-29 20:39 ` Neil Horman
2015-01-30 9:35 ` Gonzalez Monroy, Sergio
2015-01-30 13:14 ` [dpdk-dev] [PATCH v2 0/4] New Reorder Library Sergio Gonzalez Monroy
2015-01-30 13:14 ` [dpdk-dev] [PATCH v2 1/4] reorder: new reorder library Sergio Gonzalez Monroy
2015-01-30 13:14 ` [dpdk-dev] [PATCH v2 2/4] app: New reorder unit test Sergio Gonzalez Monroy
2015-01-30 13:14 ` [dpdk-dev] [PATCH v2 3/4] examples: new sample app packet_ordering Sergio Gonzalez Monroy
2015-01-30 13:14 ` [dpdk-dev] [PATCH v2 4/4] doc: new reorder library description Sergio Gonzalez Monroy
2015-02-06 15:05 ` [dpdk-dev] [PATCH v3 0/5] New Reorder Library Sergio Gonzalez Monroy
2015-02-06 15:06 ` [dpdk-dev] [PATCH v3 1/5] reorder: new reorder library Sergio Gonzalez Monroy
2015-02-06 15:06 ` [dpdk-dev] [PATCH v3 2/5] app: New reorder unit test Sergio Gonzalez Monroy
2015-02-06 15:06 ` [dpdk-dev] [PATCH v3 3/5] examples: new sample app packet_ordering Sergio Gonzalez Monroy
2015-02-06 15:06 ` [dpdk-dev] [PATCH v3 4/5] doc: new reorder library description Sergio Gonzalez Monroy
2015-02-06 15:06 ` [dpdk-dev] [PATCH v3 5/5] doc: new packet ordering app description Sergio Gonzalez Monroy
2015-02-08 13:58 ` [dpdk-dev] [PATCH v3 0/5] New Reorder Library Neil Horman
2015-02-11 11:17 ` Gonzalez Monroy, Sergio
2015-02-11 13:07 ` [dpdk-dev] [PATCH v4 " Sergio Gonzalez Monroy
2015-02-11 13:07 ` [dpdk-dev] [PATCH v4 1/5] reorder: new reorder library Sergio Gonzalez Monroy
2015-02-11 13:07 ` [dpdk-dev] [PATCH v4 2/5] app: New reorder unit test Sergio Gonzalez Monroy
2015-02-11 13:07 ` [dpdk-dev] [PATCH v4 3/5] examples: new sample app packet_ordering Sergio Gonzalez Monroy
2015-02-11 13:07 ` [dpdk-dev] [PATCH v4 4/5] doc: new reorder library description Sergio Gonzalez Monroy
2015-02-11 13:07 ` Sergio Gonzalez Monroy [this message]
2015-02-12 5:33 ` [dpdk-dev] [PATCH v4 0/5] New Reorder Library Neil Horman
2015-02-12 12:00 ` Declan Doherty
2015-02-18 14:22 ` Thomas Monjalon
2015-02-18 14:36 ` Gonzalez Monroy, Sergio
2015-02-18 14:58 ` [dpdk-dev] [PATCH v5 0/6] " Sergio Gonzalez Monroy
2015-02-18 14:58 ` [dpdk-dev] [PATCH v5 1/6] reorder: new reorder library Sergio Gonzalez Monroy
2015-02-19 9:20 ` Olivier MATZ
2015-02-19 9:50 ` Olivier MATZ
2015-02-18 14:58 ` [dpdk-dev] [PATCH v5 2/6] app: New reorder unit test Sergio Gonzalez Monroy
2015-02-18 14:58 ` [dpdk-dev] [PATCH v5 3/6] examples: new sample app packet_ordering Sergio Gonzalez Monroy
2015-02-18 14:58 ` [dpdk-dev] [PATCH v5 4/6] doc: new reorder library description Sergio Gonzalez Monroy
2015-02-18 14:58 ` [dpdk-dev] [PATCH v5 5/6] doc: new packet ordering app description Sergio Gonzalez Monroy
2015-02-18 14:58 ` [dpdk-dev] [PATCH v5 6/6] MAINTAINERS: add and claim reorder Sergio Gonzalez Monroy
2015-02-18 15:52 ` [dpdk-dev] [PATCH v5 0/6] New Reorder Library Thomas Monjalon
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=1423660055-23920-6-git-send-email-sergio.gonzalez.monroy@intel.com \
--to=sergio.gonzalez.monroy@intel.com \
--cc=dev@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
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).