1*d0dff9baSBernard Iremonger.. BSD LICENSE 2*d0dff9baSBernard Iremonger Copyright(c) 2010-2014 Intel Corporation. All rights reserved. 3*d0dff9baSBernard Iremonger All rights reserved. 4*d0dff9baSBernard Iremonger 5*d0dff9baSBernard Iremonger Redistribution and use in source and binary forms, with or without 6*d0dff9baSBernard Iremonger modification, are permitted provided that the following conditions 7*d0dff9baSBernard Iremonger are met: 8*d0dff9baSBernard Iremonger 9*d0dff9baSBernard Iremonger * Redistributions of source code must retain the above copyright 10*d0dff9baSBernard Iremonger notice, this list of conditions and the following disclaimer. 11*d0dff9baSBernard Iremonger * Redistributions in binary form must reproduce the above copyright 12*d0dff9baSBernard Iremonger notice, this list of conditions and the following disclaimer in 13*d0dff9baSBernard Iremonger the documentation and/or other materials provided with the 14*d0dff9baSBernard Iremonger distribution. 15*d0dff9baSBernard Iremonger * Neither the name of Intel Corporation nor the names of its 16*d0dff9baSBernard Iremonger contributors may be used to endorse or promote products derived 17*d0dff9baSBernard Iremonger from this software without specific prior written permission. 18*d0dff9baSBernard Iremonger 19*d0dff9baSBernard Iremonger THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20*d0dff9baSBernard Iremonger "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21*d0dff9baSBernard Iremonger LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22*d0dff9baSBernard Iremonger A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23*d0dff9baSBernard Iremonger OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24*d0dff9baSBernard Iremonger SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25*d0dff9baSBernard Iremonger LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26*d0dff9baSBernard Iremonger DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27*d0dff9baSBernard Iremonger THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28*d0dff9baSBernard Iremonger (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29*d0dff9baSBernard Iremonger OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30*d0dff9baSBernard Iremonger 31*d0dff9baSBernard IremongerIntroduction 32*d0dff9baSBernard Iremonger============ 33*d0dff9baSBernard Iremonger 34*d0dff9baSBernard IremongerThis document describes the sample applications that are included in the Intel® Data Plane Development Kit (Intel® DPDK). 35*d0dff9baSBernard IremongerEach chapter describes a sample application that showcases specific functionality and 36*d0dff9baSBernard Iremongerprovides instructions on how to compile, run and use the sample application. 37*d0dff9baSBernard Iremonger 38*d0dff9baSBernard IremongerDocumentation Roadmap 39*d0dff9baSBernard Iremonger--------------------- 40*d0dff9baSBernard Iremonger 41*d0dff9baSBernard IremongerThe following is a list of Intel® DPDK documents in suggested reading order: 42*d0dff9baSBernard Iremonger 43*d0dff9baSBernard Iremonger* **Release Notes** : Provides release-specific information, including supported features, 44*d0dff9baSBernard Iremonger limitations, fixed issues, known issues and so on. 45*d0dff9baSBernard Iremonger Also, provides the answers to frequently asked questions in FAQ format. 46*d0dff9baSBernard Iremonger 47*d0dff9baSBernard Iremonger* **Getting Started Guides** : Describes how to install and 48*d0dff9baSBernard Iremonger configure the Intel® DPDK software for your operating system; 49*d0dff9baSBernard Iremonger designed to get users up and running quickly with the software. 50*d0dff9baSBernard Iremonger 51*d0dff9baSBernard Iremonger* **Programmer's Guide:** Describes: 52*d0dff9baSBernard Iremonger 53*d0dff9baSBernard Iremonger * The software architecture and how to use it (through examples), 54*d0dff9baSBernard Iremonger specifically in a Linux* application (linuxapp) environment. 55*d0dff9baSBernard Iremonger 56*d0dff9baSBernard Iremonger * The content of the Intel® DPDK, the build system 57*d0dff9baSBernard Iremonger (including the commands that can be used in the root Intel® DPDK Makefile to build the development kit and an application) 58*d0dff9baSBernard Iremonger and guidelines for porting an application. 59*d0dff9baSBernard Iremonger 60*d0dff9baSBernard Iremonger * Optimizations used in the software and those that should be considered for new development 61*d0dff9baSBernard Iremonger 62*d0dff9baSBernard IremongerA glossary of terms is also provided. 63*d0dff9baSBernard Iremonger 64*d0dff9baSBernard Iremonger* **API Reference** : Provides detailed information about Intel® DPDK functions, 65*d0dff9baSBernard Iremonger data structures and other programming constructs. 66*d0dff9baSBernard Iremonger 67*d0dff9baSBernard Iremonger* **Sample Applications User Guide** : Describes a set of sample applications. 68*d0dff9baSBernard Iremonger Each chapter describes a sample application that showcases specific functionality and 69*d0dff9baSBernard Iremonger provides instructions on how to compile, run and use the sample application. 70