X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fsample_app_ug%2Ftest_pipeline.rst;h=a9370c80beaf132c00c95044d5b1ca3981376189;hb=00b94c1c21d4e8300c51acdd5a0e43bed4552bae;hp=0432942b741ee5f702a376497f226801f9d58b62;hpb=ba9e05cb6b002016b01adf4e8700f206f3d04fd6;p=dpdk.git diff --git a/doc/guides/sample_app_ug/test_pipeline.rst b/doc/guides/sample_app_ug/test_pipeline.rst index 0432942b74..a9370c80be 100644 --- a/doc/guides/sample_app_ug/test_pipeline.rst +++ b/doc/guides/sample_app_ug/test_pipeline.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. Test Pipeline Application ========================= @@ -49,35 +22,18 @@ The application uses three CPU cores: * Core C ("TX core") receives traffic from core B through software queues and sends it to the NIC ports for transmission. -.. _figure_21: +.. _figure_test_pipeline_app: -**Figure 21.Test Pipeline Application** +.. figure:: img/test_pipeline_app.* -.. image24_png has been renamed - -|test_pipeline_app| + Test Pipeline Application Compiling the Application ------------------------- +To compile the sample application see :doc:`compiling` -#. Go to the app/test directory: - - .. code-block:: console - - export RTE_SDK=/path/to/rte_sdk - cd ${RTE_SDK}/app/test/test-pipeline - -#. Set the target (a default target is used if not specified): - - .. code-block:: console +The application is located in the ``$RTE_SDK/test/test-pipline`` directory. - export RTE_TARGET=x86_64-native-linuxapp-gcc - -#. Build the application: - - .. code-block:: console - - make Running the Application ----------------------- @@ -91,7 +47,7 @@ The application execution command line is: ./test-pipeline [EAL options] -- -p PORTMASK --TABLE_TYPE -The -c EAL CPU core mask option has to contain exactly 3 CPU cores. +The -c or -l EAL CPU coremask/corelist option has to contain exactly 3 CPU cores. The first CPU core in the core mask is assigned for core A, the second for core B and the third for core C. The PORTMASK parameter must contain 2 or 4 ports. @@ -99,7 +55,7 @@ The PORTMASK parameter must contain 2 or 4 ports. Table Types and Behavior ~~~~~~~~~~~~~~~~~~~~~~~~ -Table 3 describes the table types used and how they are populated. +:numref:`table_test_pipeline_1` describes the table types used and how they are populated. The hash tables are pre-populated with 16 million keys. For hash tables, the following parameters can be selected: @@ -112,159 +68,159 @@ For hash tables, the following parameters can be selected: The available options are 8, 16 and 32 bytes; * **Table type (e.g. hash-spec-16-ext or hash-spec-16-lru).** - The available options are ext (extendible bucket) or lru (least recently used). - -.. _table_3: - -**Table 3. Table Types** - -+-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ -| **#** | **TABLE_TYPE** | **Description of Core B Table** | **Pre-added Table Entries** | -| | | | | -+=======+========================+==========================================================+=======================================================+ -| 1 | none | Core B is not implementing a DPDK pipeline. | N/A | -| | | Core B is implementing a pass-through from its input set | | -| | | of software queues to its output set of software queues. | | -| | | | | -+-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ -| 2 | stub | Stub table. Core B is implementing the same pass-through | N/A | -| | | functionality as described for the "none" option by | | -| | | using the DPDK Packet Framework by using one | | -| | | stub table for each input NIC port. | | -| | | | | -+-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ -| 3 | hash-[spec]-8-lru | LRU hash table with 8-byte key size and 16 million | 16 million entries are successfully added to the | -| | | entries. | hash table with the following key format: | -| | | | | -| | | | [4-byte index, 4 bytes of 0] | -| | | | | -| | | | The action configured for all table entries is | -| | | | "Sendto output port", with the output port index | -| | | | uniformly distributed for the range of output ports. | -| | | | | -| | | | The default table rule (used in the case of a lookup | -| | | | miss) is to drop the packet. | -| | | | | -| | | | At run time, core A is creating the following lookup | -| | | | key and storing it into the packet meta data for | -| | | | core B to use for table lookup: | -| | | | | -| | | | [destination IPv4 address, 4 bytes of 0] | -| | | | | -+-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ -| 4 | hash-[spec]-8-ext | Extendible bucket hash table with 8-byte key size | Same as hash-[spec]-8-lru table entries, above. | -| | | and 16 million entries. | | -| | | | | -+-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ -| 5 | hash-[spec]-16-lru | LRU hash table with 16-byte key size and 16 million | 16 million entries are successfully added to the hash | -| | | entries. | table with the following key format: | -| | | | | -| | | | [4-byte index, 12 bytes of 0] | -| | | | | -| | | | The action configured for all table entries is | -| | | | "Send to output port", with the output port index | -| | | | uniformly distributed for the range of output ports. | -| | | | | -| | | | The default table rule (used in the case of a lookup | -| | | | miss) is to drop the packet. | -| | | | | -| | | | At run time, core A is creating the following lookup | -| | | | key and storing it into the packet meta data for core | -| | | | B to use for table lookup: | -| | | | | -| | | | [destination IPv4 address, 12 bytes of 0] | -| | | | | -+-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ -| 6 | hash-[spec]-16-ext | Extendible bucket hash table with 16-byte key size | Same as hash-[spec]-16-lru table entries, above. | -| | | and 16 million entries. | | -| | | | | -+-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ -| 7 | hash-[spec]-32-lru | LRU hash table with 32-byte key size and 16 million | 16 million entries are successfully added to the hash | -| | | entries. | table with the following key format: | -| | | | | -| | | | [4-byte index, 28 bytes of 0]. | -| | | | | -| | | | The action configured for all table entries is | -| | | | "Send to output port", with the output port index | -| | | | uniformly distributed for the range of output ports. | -| | | | | -| | | | The default table rule (used in the case of a lookup | -| | | | miss) is to drop the packet. | -| | | | | -| | | | At run time, core A is creating the following lookup | -| | | | key and storing it into the packet meta data for | -| | | | Lpmcore B to use for table lookup: | -| | | | | -| | | | [destination IPv4 address, 28 bytes of 0] | -| | | | | -+-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ -| 8 | hash-[spec]-32-ext | Extendible bucket hash table with 32-byte key size | Same as hash-[spec]-32-lru table entries, above. | -| | | and 16 million entries. | | -| | | | | -+-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ -| 9 | lpm | Longest Prefix Match (LPM) IPv4 table. | In the case of two ports, two routes | -| | | | are added to the table: | -| | | | | -| | | | [0.0.0.0/9 => send to output port 0] | -| | | | | -| | | | [0.128.0.0/9 => send to output port 1] | -| | | | | -| | | | In case of four ports, four entries are added to the | -| | | | table: | -| | | | | -| | | | [0.0.0.0/10 => send to output port 0] | -| | | | | -| | | | [0.64.0.0/10 => send to output port 1] | -| | | | | -| | | | [0.128.0.0/10 => send to output port 2] | -| | | | | -| | | | [0.192.0.0/10 => send to output port 3] | -| | | | | -| | | | The default table rule (used in the case of a lookup | -| | | | miss) is to drop the packet. | -| | | | | -| | | | At run time, core A is storing the IPv4 destination | -| | | | within the packet meta data to be later used by core | -| | | | B as the lookup key. | -| | | | | -+-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ -| 10 | acl | Access Control List (ACL) table | In the case of two ports, two ACL rules are added to | -| | | | the table: | -| | | | | -| | | | [priority = 0 (highest), | -| | | | | -| | | | IPv4 source = ANY, | -| | | | | -| | | | IPv4 destination = 0.0.0.0/9, | -| | | | | -| | | | L4 protocol = ANY, | -| | | | | -| | | | TCP source port = ANY, | -| | | | | -| | | | TCP destination port = ANY | -| | | | | -| | | | => send to output port 0] | -| | | | | -| | | | | -| | | | [priority = 0 (highest), | -| | | | | -| | | | IPv4 source = ANY, | -| | | | | -| | | | IPv4 destination = 0.128.0.0/9, | -| | | | | -| | | | L4 protocol = ANY, | -| | | | | -| | | | TCP source port = ANY, | -| | | | | -| | | | TCP destination port = ANY | -| | | | | -| | | | => send to output port 0]. | -| | | | | -| | | | | -| | | | The default table rule (used in the case of a lookup | -| | | | miss) is to drop the packet. | -| | | | | -+-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ + The available options are ext (extendable bucket) or lru (least recently used). + +.. _table_test_pipeline_1: + +.. table:: Table Types + + +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ + | **#** | **TABLE_TYPE** | **Description of Core B Table** | **Pre-added Table Entries** | + | | | | | + +=======+========================+==========================================================+=======================================================+ + | 1 | none | Core B is not implementing a DPDK pipeline. | N/A | + | | | Core B is implementing a pass-through from its input set | | + | | | of software queues to its output set of software queues. | | + | | | | | + +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ + | 2 | stub | Stub table. Core B is implementing the same pass-through | N/A | + | | | functionality as described for the "none" option by | | + | | | using the DPDK Packet Framework by using one | | + | | | stub table for each input NIC port. | | + | | | | | + +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ + | 3 | hash-[spec]-8-lru | LRU hash table with 8-byte key size and 16 million | 16 million entries are successfully added to the | + | | | entries. | hash table with the following key format: | + | | | | | + | | | | [4-byte index, 4 bytes of 0] | + | | | | | + | | | | The action configured for all table entries is | + | | | | "Sendto output port", with the output port index | + | | | | uniformly distributed for the range of output ports. | + | | | | | + | | | | The default table rule (used in the case of a lookup | + | | | | miss) is to drop the packet. | + | | | | | + | | | | At run time, core A is creating the following lookup | + | | | | key and storing it into the packet meta data for | + | | | | core B to use for table lookup: | + | | | | | + | | | | [destination IPv4 address, 4 bytes of 0] | + | | | | | + +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ + | 4 | hash-[spec]-8-ext | Extendable bucket hash table with 8-byte key size | Same as hash-[spec]-8-lru table entries, above. | + | | | and 16 million entries. | | + | | | | | + +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ + | 5 | hash-[spec]-16-lru | LRU hash table with 16-byte key size and 16 million | 16 million entries are successfully added to the hash | + | | | entries. | table with the following key format: | + | | | | | + | | | | [4-byte index, 12 bytes of 0] | + | | | | | + | | | | The action configured for all table entries is | + | | | | "Send to output port", with the output port index | + | | | | uniformly distributed for the range of output ports. | + | | | | | + | | | | The default table rule (used in the case of a lookup | + | | | | miss) is to drop the packet. | + | | | | | + | | | | At run time, core A is creating the following lookup | + | | | | key and storing it into the packet meta data for core | + | | | | B to use for table lookup: | + | | | | | + | | | | [destination IPv4 address, 12 bytes of 0] | + | | | | | + +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ + | 6 | hash-[spec]-16-ext | Extendable bucket hash table with 16-byte key size | Same as hash-[spec]-16-lru table entries, above. | + | | | and 16 million entries. | | + | | | | | + +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ + | 7 | hash-[spec]-32-lru | LRU hash table with 32-byte key size and 16 million | 16 million entries are successfully added to the hash | + | | | entries. | table with the following key format: | + | | | | | + | | | | [4-byte index, 28 bytes of 0]. | + | | | | | + | | | | The action configured for all table entries is | + | | | | "Send to output port", with the output port index | + | | | | uniformly distributed for the range of output ports. | + | | | | | + | | | | The default table rule (used in the case of a lookup | + | | | | miss) is to drop the packet. | + | | | | | + | | | | At run time, core A is creating the following lookup | + | | | | key and storing it into the packet meta data for | + | | | | Lpmcore B to use for table lookup: | + | | | | | + | | | | [destination IPv4 address, 28 bytes of 0] | + | | | | | + +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ + | 8 | hash-[spec]-32-ext | Extendable bucket hash table with 32-byte key size | Same as hash-[spec]-32-lru table entries, above. | + | | | and 16 million entries. | | + | | | | | + +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ + | 9 | lpm | Longest Prefix Match (LPM) IPv4 table. | In the case of two ports, two routes | + | | | | are added to the table: | + | | | | | + | | | | [0.0.0.0/9 => send to output port 0] | + | | | | | + | | | | [0.128.0.0/9 => send to output port 1] | + | | | | | + | | | | In case of four ports, four entries are added to the | + | | | | table: | + | | | | | + | | | | [0.0.0.0/10 => send to output port 0] | + | | | | | + | | | | [0.64.0.0/10 => send to output port 1] | + | | | | | + | | | | [0.128.0.0/10 => send to output port 2] | + | | | | | + | | | | [0.192.0.0/10 => send to output port 3] | + | | | | | + | | | | The default table rule (used in the case of a lookup | + | | | | miss) is to drop the packet. | + | | | | | + | | | | At run time, core A is storing the IPv4 destination | + | | | | within the packet meta data to be later used by core | + | | | | B as the lookup key. | + | | | | | + +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ + | 10 | acl | Access Control List (ACL) table | In the case of two ports, two ACL rules are added to | + | | | | the table: | + | | | | | + | | | | [priority = 0 (highest), | + | | | | | + | | | | IPv4 source = ANY, | + | | | | | + | | | | IPv4 destination = 0.0.0.0/9, | + | | | | | + | | | | L4 protocol = ANY, | + | | | | | + | | | | TCP source port = ANY, | + | | | | | + | | | | TCP destination port = ANY | + | | | | | + | | | | => send to output port 0] | + | | | | | + | | | | | + | | | | [priority = 0 (highest), | + | | | | | + | | | | IPv4 source = ANY, | + | | | | | + | | | | IPv4 destination = 0.128.0.0/9, | + | | | | | + | | | | L4 protocol = ANY, | + | | | | | + | | | | TCP source port = ANY, | + | | | | | + | | | | TCP destination port = ANY | + | | | | | + | | | | => send to output port 0]. | + | | | | | + | | | | | + | | | | The default table rule (used in the case of a lookup | + | | | | miss) is to drop the packet. | + | | | | | + +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+ Input Traffic ~~~~~~~~~~~~~ @@ -281,5 +237,3 @@ The profile for input traffic is TCP/IPv4 packets with: * destination TCP port fixed to 0 * source TCP port fixed to 0 - -.. |test_pipeline_app| image:: img/test_pipeline_app.*