1.. BSD LICENSE 2 Copyright(c) 2015 Intel Corporation. All rights reserved. 3 All rights reserved. 4 5 Redistribution and use in source and binary forms, with or without 6 modification, are permitted provided that the following conditions 7 are met: 8 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 14 distribution. 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. 18 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. 30 31Packet Ordering Application 32============================ 33 34The Packet Ordering sample app simply shows the impact of reordering a stream. 35It's meant to stress the library with different configurations for performance. 36 37Overview 38-------- 39 40The application uses at least three CPU cores: 41 42* RX core (maser core) receives traffic from the NIC ports and feeds Worker 43 cores with traffic through SW queues. 44 45* Worker core (slave core) basically do some light work on the packet. 46 Currently it modifies the output port of the packet for configurations with 47 more than one port enabled. 48 49* TX Core (slave core) receives traffic from Worker cores through software queues, 50 inserts out-of-order packets into reorder buffer, extracts ordered packets 51 from the reorder buffer and sends them to the NIC ports for transmission. 52 53Compiling the Application 54------------------------- 55 56To compile the sample application see :doc:`compiling`. 57 58The application is located in the ``packet_ordering`` sub-directory. 59 60Running the Application 61----------------------- 62 63Refer to *DPDK Getting Started Guide* for general information on running applications 64and the Environment Abstraction Layer (EAL) options. 65 66Application Command Line 67~~~~~~~~~~~~~~~~~~~~~~~~ 68 69The application execution command line is: 70 71.. code-block:: console 72 73 ./test-pipeline [EAL options] -- -p PORTMASK [--disable-reorder] 74 75The -c EAL CPU_COREMASK option has to contain at least 3 CPU cores. 76The first CPU core in the core mask is the master core and would be assigned to 77RX core, the last to TX core and the rest to Worker cores. 78 79The PORTMASK parameter must contain either 1 or even enabled port numbers. 80When setting more than 1 port, traffic would be forwarded in pairs. 81For example, if we enable 4 ports, traffic from port 0 to 1 and from 1 to 0, 82then the other pair from 2 to 3 and from 3 to 2, having [0,1] and [2,3] pairs. 83 84The disable-reorder long option does, as its name implies, disable the reordering 85of traffic, which should help evaluate reordering performance impact. 86