-.. BSD LICENSE
- Copyright(c) 2010-2017 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.
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2010-2017 Intel Corporation.
Introduction to the DPDK Sample Applications
============================================
applications, try out the features, and then extend them to fit their needs.
+Running Sample Applications
+---------------------------
+
+Some sample applications may have their own command-line parameters described in
+their respective guides, however all of them also share the same EAL parameters.
+Please refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>`
+or :doc:`EAL parameters (FreeBSD) <../freebsd_gsg/freebsd_eal_parameters>` for
+a list of available EAL command-line options.
+
+
The DPDK Sample Applications
----------------------------
-Table :numref:`table_sample_apps` shows a list of some of the main sample
-applications that are available in the examples directory of DPDK:
-
- .. _table_sample_apps:
-
- .. table:: **Some of the DPDK Sample applications**
-
- +---------------------------------------+--------------------------------------+
- | Bonding | Netmap Compatibility |
- +---------------------------------------+--------------------------------------+
- | Command Line | Packet Ordering |
- +---------------------------------------+--------------------------------------+
- | Distributor | Performance Thread |
- +---------------------------------------+--------------------------------------+
- | Ethtool | Precision Time Protocol (PTP) Client |
- +---------------------------------------+--------------------------------------+
- | Exception Path | Quality of Service (QoS) Metering |
- +---------------------------------------+--------------------------------------+
- | Hello World | QoS Scheduler |
- +---------------------------------------+--------------------------------------+
- | Internet Protocol (IP) Fragmentation | Quota and Watermark |
- +---------------------------------------+--------------------------------------+
- | IP Pipeline | RX/TX Callbacks |
- +---------------------------------------+--------------------------------------+
- | IP Reassembly | Server node EFD |
- +---------------------------------------+--------------------------------------+
- | IPsec Security Gateway | Basic Forwarding/Skeleton App |
- +---------------------------------------+--------------------------------------+
- | IPv4 multicast | Tunnel End Point (TEP) termination |
- +---------------------------------------+--------------------------------------+
- | Kernel NIC Interface | Timer |
- +---------------------------------------+--------------------------------------+
- | Network Layer 2 Forwarding + variants | Vhost |
- +---------------------------------------+--------------------------------------+
- | Network Layer 3 Forwarding + variants | Vhost Xen |
- +---------------------------------------+--------------------------------------+
- | Link Status Interrupt | VMDQ Forwarding |
- +---------------------------------------+--------------------------------------+
- | Load Balancer | VMDQ and DCB Forwarding |
- +---------------------------------------+--------------------------------------+
- | Multi-process | VM Power Management |
- +---------------------------------------+--------------------------------------+
-
+There are many sample applications available in the examples directory of DPDK.
These examples range from simple to reasonably complex but most are designed
to demonstrate one particular feature of DPDK. Some of the more interesting
examples are highlighted below.
forwarding, or ``l2fwd`` application does forwarding based on Ethernet MAC
addresses like a simple switch.
+* :doc:`Network Layer 2 forwarding<l2_forward_event>`: The Network Layer 2
+ forwarding, or ``l2fwd-event`` application does forwarding based on Ethernet MAC
+ addresses like a simple switch. It demonstrates usage of poll and event mode
+ IO mechanism under a single application.
+
* :doc:`Network Layer 3 forwarding<l3_forward>`: The Network Layer3
forwarding, or ``l3fwd`` application does forwarding based on Internet
Protocol, IPv4 or IPv6 like a simple router.
+* :doc:`Hardware packet copying<ioat>`: The Hardware packet copying,
+ or ``ioatfwd`` application demonstrates how to use IOAT rawdev driver for
+ copying packets between two threads.
+
* :doc:`Packet Distributor<dist_app>`: The Packet Distributor
demonstrates how to distribute packets arriving on an Rx port to different
cores for processing and transmission.
(packet arrival) and TX (packet transmission) by adding callbacks to the RX
and TX packet processing functions.
-* :doc:`IPSec Security Gateway<ipsec_secgw>`: The IPSec Security
+* :doc:`IPsec Security Gateway<ipsec_secgw>`: The IPsec Security
Gateway application is minimal example of something closer to a real world
example. This is also a good example of an application using the DPDK
Cryptodev framework.
git.droids-corp.org / dpdk.git / blobdiff