From: "xu,gang" <gangx.xu@intel.com>
To: dts@dpdk.org
Cc: Lijuan Tu <lijuanx.a.tu@intel.com>
Subject: [dts] [PATCH V2 4/6] add netmap_compat test plan
Date: Tue, 3 May 2016 11:18:59 +0800 [thread overview]
Message-ID: <1462245541-2886-5-git-send-email-gangx.xu@intel.com> (raw)
In-Reply-To: <1462245541-2886-1-git-send-email-gangx.xu@intel.com>
From: Lijuan Tu <lijuanx.a.tu@intel.com>
Signed-off-by: Lijuan Tu <lijuanx.a.tu@intel.com>
---
test_plans/netmap_compat_test_plan.rst | 100 +++++++++++++++++++++++++++++++++
1 file changed, 100 insertions(+)
create mode 100644 test_plans/netmap_compat_test_plan.rst
diff --git a/test_plans/netmap_compat_test_plan.rst b/test_plans/netmap_compat_test_plan.rst
new file mode 100644
index 0000000..910773b
--- /dev/null
+++ b/test_plans/netmap_compat_test_plan.rst
@@ -0,0 +1,100 @@
+.. BSD LICENSE
+ Copyright(c) 2010-2016 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.
+
+
+Netmap Compatibility Sample Application
+=======================================
+
+Introduction
+------------
+
+The Netmap compatibility library provides a minimal set of APIs to give programs written against the Netmap APIs
+the ability to be run, with minimal changes to their source code, using the DPDK to perform the actual packet I/O.
+
+Since Netmap applications use regular system calls, like ``open()``, ``ioctl()`` and
+``mmap()`` to communicate with the Netmap kernel module performing the packet I/O,
+the ``compat_netmap`` library provides a set of similar APIs to use in place of those system calls,
+effectively turning a Netmap application into a DPDK application.
+
+The provided library is currently minimal and doesn't support all the features that Netmap supports,
+but is enough to run simple applications, such as the bridge example detailed below.
+
+Knowledge of Netmap is required to understand the rest of this section.
+Please refer to the Netmap distribution for details about Netmap.
+
+Running the "bridge" Sample Application
+---------------------------------------
+
+The application requires a single command line option:
+
+.. code-block:: console
+
+ ./build/bridge [EAL options] -- -i INTERFACE_A [-i INTERFACE_B]
+
+where,
+
+* ``-i INTERFACE``: Interface (DPDK port number) to use.
+
+ If a single ``-i`` parameter is given, the interface will send back all the traffic it receives.
+ If two ``-i`` parameters are given, the two interfaces form a bridge,
+ where traffic received on one interface is replicated and sent to the other interface.
+
+For example, to run the application in a linuxapp environment using port 0 and 2:
+
+.. code-block:: console
+
+ ./build/bridge [EAL options] -- -i 0 -i 2
+
+Refer to the *DPDK Getting Started Guide for Linux* for general information on running applications and
+the Environment Abstraction Layer (EAL) options.
+
+Test Case1: netmap compat with one port
+=======================================
+Run bridge with one port::
+ ./examples/netmap_compat/build/bridge -c 0x1e -n 4 -- -i 0
+waked up :
+ Port 0 now in Netmap mode
+ Bridge up and running!
+
+Send one packet on Port0,check this port receive packet.
+It receive one packet that it send.
+
+Test Case2: netmap compat with two port
+=======================================
+Run bridge with one port::
+ ./examples/netmap_compat/build/bridge -c 0x1e -n 4 -- -i 0 -i 1
+waked up :
+ Port 0 now in Netmap mode
+ Port 1 now in Netmap mode
+ Bridge up and running!
+
+Send one packet on Port0,check the port1 receive packet.
+It receive one packet that the port0 send.
+
--
1.9.3
next prev parent reply other threads:[~2016-05-03 3:23 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-03 3:18 [dts] [PATCH V2 1/6] add netmap compat code xu,gang
2016-05-03 3:18 ` [dts] [PATCH V1] add sample executable config file xu,gang
2016-05-03 3:18 ` [dts] [PATCH V2 2/6] add rxtx callbacks code xu,gang
2016-05-03 3:18 ` [dts] [PATCH V2 3/6] add skeleton code xu,gang
2016-05-03 3:18 ` xu,gang [this message]
2016-05-03 3:19 ` [dts] [PATCH V2 5/6] add rxtx_callbacks test plan xu,gang
2016-05-03 3:19 ` [dts] [PATCH V2 6/6] add skeleton test plan.rst xu,gang
2016-05-04 2:15 ` [dts] [PATCH V2 1/6] add netmap compat code Tu, LijuanX A
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=1462245541-2886-5-git-send-email-gangx.xu@intel.com \
--to=gangx.xu@intel.com \
--cc=dts@dpdk.org \
--cc=lijuanx.a.tu@intel.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).