X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fsample_app_ug%2Fl3_forward_virtual.rst;h=21eab8da394d7310dd199d42520f09a889b5b6a4;hb=092a9de50b25c2b66eb79be83bee21c2db2f08e5;hp=fa04722ea186d6138fdc7abbe7c4140255519d7d;hpb=513b07238abf86c796c55d697bc40558583793ef;p=dpdk.git diff --git a/doc/guides/sample_app_ug/l3_forward_virtual.rst b/doc/guides/sample_app_ug/l3_forward_virtual.rst index fa04722ea1..21eab8da39 100644 --- a/doc/guides/sample_app_ug/l3_forward_virtual.rst +++ b/doc/guides/sample_app_ug/l3_forward_virtual.rst @@ -1,32 +1,5 @@ -.. BSD LICENSE - Copyright(c) 2010-2014 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-2014 Intel Corporation. L3 Forwarding in a Virtualization Environment Sample Application ================================================================ @@ -64,34 +37,9 @@ The set of LPM rules used by the application is statically configured and loaded Compiling the Application ------------------------- -To compile the application: +To compile the sample application see :doc:`compiling`. -#. Go to the sample application directory: - - .. code-block:: console - - export RTE_SDK=/path/to/rte_sdk - cd ${RTE_SDK}/examples/l3fwd-vf - -#. Set the target (a default target is used if not specified). For example: - - .. code-block:: console - - export RTE_TARGET=x86_64-native-linuxapp-gcc - - See the *DPDK Getting Started Guide* for possible RTE_TARGET values. - -#. Build the application: - - .. code-block:: console - - make - -.. note:: - - The compiled application is written to the build subdirectory. - To have the application written to a different location, - the O=/path/to/build/directory option may be specified in the make command. +The application is located in the ``l3fwd-vf`` sub-directory. Running the Application ----------------------- @@ -110,40 +58,33 @@ where, * --no-numa: optional, disables numa awareness -For example, consider a dual processor socket platform where cores 0,2,4,6, 8, and 10 appear on socket 0, -while cores 1,3,5,7,9, and 11 appear on socket 1. -Let's say that the programmer wants to use memory from both NUMA nodes, -the platform has only two ports and the programmer wants to use one core from each processor socket to do the packet processing -since only one Rx/Tx queue pair can be used in virtualization mode. +For example, consider a dual processor socket platform with 8 physical cores, where cores 0-7 and 16-23 appear on socket 0, +while cores 8-15 and 24-31 appear on socket 1. -To enable L3 forwarding between two ports, using one core from each processor, -while also taking advantage of local memory accesses by optimizing around NUMA, -the programmer can pin to the appropriate cores and allocate memory from the appropriate NUMA node. -This is achieved using the following command: +To enable L3 forwarding between two ports, assuming that both ports are in the same socket, using two cores, cores 1 and 2, +(which are in the same socket too), use the following command: .. code-block:: console - ./build/l3fwd-vf -c 0x03 -n 3 -- -p 0x3 --config="(0,0,0),(1,0,1)" + ./build/l3fwd-vf -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" In this command: -* The -c option enables cores 0 and 1 +* The -l option enables cores 1 and 2 * The -p option enables ports 0 and 1 * The --config option enables one queue on each port and maps each (port,queue) pair to a specific core. - Logic to enable multiple RX queues using RSS and to allocate memory from the correct NUMA nodes - is included in the application and is done transparently. The following table shows the mapping in this example: +----------+-----------+-----------+------------------------------------+ | **Port** | **Queue** | **lcore** | **Description** | | | | | | +==========+===========+===========+====================================+ - | 0 | 0 | 0 | Map queue 0 from port 0 to lcore 0 | + | 0 | 0 | 1 | Map queue 0 from port 0 to lcore 1 | | | | | | +----------+-----------+-----------+------------------------------------+ - | 1 | 1 | 1 | Map queue 0 from port 1 to lcore 1 | + | 1 | 0 | 2 | Map queue 0 from port 1 to lcore 2 | | | | | | +----------+-----------+-----------+------------------------------------+