Sample Applications User Guide - Intel

1 Sample Applications user GuideRelease 24, 2015 CONTENTS1 Roadmap ..22 Command Line Sample .. the Application .. the Application ..43 Exception Path Sample .. the Application .. the Application ..84 Hello World Sample the Application .. the Application .. 125 Basic Forwarding Sample the Application .. the Application .. 146 RX/TX Callbacks Sample the Application .. the Application .. 207 IP Fragmentation Sample .. the Application .. the Application .. 248 IPv4 Multicast Sample .. the Application .. the Application .. 27i9 IP Reassembly Sample .. Longest Prefix Match (LPM for IPv4, LPM6 for IPv6) table is used tostore/lookup an outgoing port number, associated with that IPv4 address.

2 Anyunmatched packets are forwarded to the originating the Appli-cation .. the Application .. 3410 Kernel NIC Interface Sample Overview .. Compiling the Application .. Loading the Kernel Module .. Running the Application .. KNI Operations .. Explanation .. 4011 L2 Forwarding Sample Application (in Real and Virtualized Environments) withcore load Overview .. Compiling the Application .. Running the Application .. Explanation .. 4912 L2 Forwarding Sample Application (in Real and Virtualized Environments) Overview .. Compiling the Application .. Running the Application.

3 Explanation .. 6013 L3 Forwarding Sample Overview .. Compiling the Application .. Running the Application .. Explanation .. 6914 L3 Forwarding with Power Management Sample Introduction .. Overview .. Compiling the Application .. Running the Application .. Explanation .. 7515 L3 Forwarding with Access Control Sample Overview .. Compiling the Application .. Running the Application .. Explanation .. 8516 L3 Forwarding in a Virtualization Environment Sample Overview .. Compiling the Application .. Running the Application .. Explanation .. 8917 Link Status Interrupt Sample Overview.

4 Compiling the Application .. Running the Application .. Explanation .. 9118 Load Balancer Sample Overview .. Compiling the Application .. Running the Application .. Explanation .. 10019 Multi-process Sample Example Applications .. 10320 QoS Metering Sample Overview .. Compiling the Application .. Running the Application .. Explanation .. 11921 QoS Scheduler Sample Overview .. Compiling the Application .. Running the Application .. Explanation .. 12522 Intel QuickAssist Technology Sample Overview .. Building the Application .. Running the Application .. 12923 Quota and Watermark Sample Overview.

5 Compiling the Application .. Running the Application .. Code Overview .. 13424 Timer Sample Compiling the Application .. Running the Application .. Explanation .. 14125 Packet Ordering Overview .. Compiling the Application .. Running the Application .. 14526 VMDQ and DCB Forwarding Sample Overview .. Compiling the Application .. Running the Application .. Explanation .. 14927 Vhost Sample Background .. Sample Code Overview .. Supported Distributions .. Prerequisites .. Compiling the Sample Code .. Running the Sample Code .. Running the Virtual Machine (QEMU).

6 Running DPDK in the Virtual Machine .. Passing Traffic to the Virtual Machine Device .. 16728 Netmap Compatibility Sample Introduction .. Available APIs .. Caveats .. Porting Netmap Applications .. Compiling the bridge Sample Application .. Running the bridge Sample Application .. 17029 Internet Protocol (IP) Pipeline Sample Overview .. Compiling the Application .. Running the Sample Code .. 17130 Test Pipeline Overview .. Compiling the Application .. Running the Application .. 17431 Distributor Sample Overview .. Compiling the Application .. Running the Application.

7 Explanation .. Debug Logging Support .. Statistics .. Application Initialization .. 18032 VM Power Management Introduction .. Overview .. Configuration .. Compiling and Running the Host Application .. Compiling and Running the Guest Applications .. 186ivSample Applications user Guide , Release 24, 2015 ContentsCONTENTS1 CHAPTERONEINTRODUCTIONThis document describes the Sample Applications that are included in the Data Plane Devel-opment Kit (DPDK). Each chapter describes a Sample application that showcases specificfunctionality and provides instructions on how to compile, run and use the Sample Documentation RoadmapThe following is a list of DPDK documents in suggested reading order: Release Notes: Provides release-specific information, including supported features,limitations, fixed issues, known issues and so on.

8 Also, provides the answers to frequentlyasked questions in FAQ format. Getting Started Guides: Describes how to install and configure the DPDK software foryour operating system; designed to get users up and running quickly with the software. Programmer s Guide :Describes: The software architecture and how to use it (through examples), specifically in aLinux* application (linuxapp) environment. The content of the DPDK, the build system (including the commands that can beused in the root DPDK Makefile to build the development kit and an application) andguidelines for porting an application. Optimizations used in the software and those that should be considered for newdevelopmentA glossary of terms is also provided.

9 API Reference: Provides detailed information about DPDK functions, data structuresand other programming constructs. Sample Applications user Guide : Describes a set of Sample Applications . Each chap-ter describes a Sample application that showcases specific functionality and providesinstructions on how to compile, run and use the Sample LINE Sample APPLICATIONThis chapter describes the Command Line Sample application that is part of the Data PlaneDevelopment Kit (DPDK). OverviewThe Command Line Sample application is a simple application that demonstrates the use ofthe command line interface in the DPDK. This application is a readline-like interface that canbe used to debug a DPDK application, in a Linux* application :The rte_cmdline library should not be used in production code since it is not validatedto the same standard as other Intel DPDK libraries.

10 See also the rte_cmdline library shouldnot be used in production code due to limited testing item in the Known Issues section of theRelease Command Line Sample application supports some of the features of the GNU readlinelibrary such as, completion, cut/paste and some other special bindings that make configurationand debug faster and application shows how the rte_cmdline application can be extended to handle a list ofobjects. There are three simple commands: add obj_name IP: Add a new object with an IP/IPv6 address associated to it. del obj_name: Delete the specified object. show obj_name: Show the IP associated with the specified :To terminate the application, Compiling the Application1.