2 Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in
13 the documentation and/or other materials provided with the
15 * Neither the name of Intel Corporation nor the names of its
16 contributors may be used to endorse or promote products derived
17 from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 Description of Release
32 ======================
34 These release notes cover the new features,
35 fixed bugs and known issues for Data Plane Development Kit (DPDK) release version 1.7.0.
37 For instructions on compiling and running the release, see the *DPDK Getting Started Guide*.
39 Using DPDK Upgrade Patches
40 --------------------------
42 For minor updates to the main DPDK releases, the software may be made available both as a new full package and as a patch file to be applied to the previously released package.
43 In the latter case, the following commands should be used to apply the patch on top of the already-installed package for the previous release:
45 .. code-block:: console
48 # patch –p1 < /path/to/patch/file
50 Once the patch has been applied cleanly, the DPDK can be recompiled and used as before (described in the *DPDK Getting Started Guide*).
54 If the patch does not apply cleanly, perhaps because of modifications made locally to the software,
55 it is recommended to use the full release package for the minor update, instead of using the patch.
60 The following is a list of DPDK documents in the suggested reading order:
63 (this document): Provides release-specific information, including supported features, limitations, fixed issues, known issues and so on.
64 Also, provides the answers to frequently asked questions in FAQ format.
66 * **Getting Started Guide**
67 : Describes how to install and configure the DPDK software; designed to get users up and running quickly with the software.
69 * **FreeBSD* Getting Started Guide**
70 : A document describing the use of the DPDK with FreeBSD* has been added in DPDK Release 1.6.0.
71 Refer to this guide for installation and configuration instructions to get started using the DPDK with FreeBSD*.
73 * **Programmer's Guide**
76 * The software architecture and how to use it (through examples), specifically in a Linux* application (linuxapp) environment
78 * The content of the DPDK, the build system (including the commands that can be used in the root DPDK Makefile to build the development kit and an application)
79 and guidelines for porting an application
81 * Optimizations used in the software and those that should be considered for new development
83 A glossary of terms is also provided.
86 : Provides detailed information about DPDK functions, data structures and other programming constructs.
88 * **Sample Applications User Guide**
89 : Describes a set of sample applications. Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile,
90 run and use the sample application.
92 The following sample applications are included:
96 * Exception Path (into Linux* for packets using the Linux TUN/TAP driver)
100 * Integration with Intel® QuickAssist Technology
102 * Link Status Interrupt (Ethernet* Link Status Detection)
112 * L2 Forwarding (supports virtualized and non-virtualized environments)
114 * L2 Forwarding IVSHMEM
116 * L2 Forwarding Jobstats
120 * L3 Forwarding with Access Control
122 * L3 Forwarding with Power Management
124 * L3 Forwarding in a Virtualized Environment
128 * Link Status Interrupt
134 * QoS Scheduler + Dropper
142 * VMDQ and DCB L2 Forwarding
148 * Userspace vhost switch
152 * Kernel NIC Interface (KNI)
154 * VM Power Management
162 In addition, there are some other applications that are built when the libraries are created.
163 The source for these applications is in the DPDK/app directory and are called:
169 Once the libraries are created, they can be found in the build/app directory.
171 * The test application provides a variety of specific tests for the various functions in the DPDK.
173 * The testpmd application provides a number of different packet throughput tests and examples of features such as
174 how to use the Flow Director found in the Intel® 82599 10 Gigabit Ethernet Controller.
176 The testpmd application is documented in the *DPDK Testpmd Application Note*.
177 The test application is not currently documented.
178 However, you should be able to run and use test application with the command line help that is provided in the application.