doc: add jobstats sample guide

[dpdk.git] / doc / guides / sample_app_ug / test_pipeline.rst

diff --git a/doc/guides/sample_app_ug/test_pipeline.rst b/doc/guides/sample_app_ug/test_pipeline.rst
index 38b413a..0432942 100644 (file)
--- a/doc/guides/sample_app_ug/test_pipeline.rst
+++ b/doc/guides/sample_app_ug/test_pipeline.rst
@@ -31,8 +31,8 @@
 Test Pipeline Application
 =========================
 
-The Test Pipeline application illustrates the use of the Intel® DPDK Packet Framework tool suite.
-Its purpose is to demonstrate the performance of single-table Intel® DPDK pipelines.
+The Test Pipeline application illustrates the use of the DPDK Packet Framework tool suite.
+Its purpose is to demonstrate the performance of single-table DPDK pipelines.
 
 Overview
 --------
@@ -41,7 +41,7 @@ The application uses three CPU cores:
 
 *   Core A ("RX core") receives traffic from the NIC ports and feeds core B with traffic through SW queues.
 
-*   Core B ("Pipeline core") implements a single-table Intel® DPDK pipeline
+*   Core B ("Pipeline core") implements a single-table DPDK pipeline
     whose type is selectable through specific command line parameter.
     Core B receives traffic from core A through software queues,
     processes it according to the actions configured in the table entries that
@@ -122,14 +122,14 @@ For hash tables, the following parameters can be selected:
 | **#** | **TABLE_TYPE**         | **Description of Core B Table**                          | **Pre-added Table Entries**                           |
 |       |                        |                                                          |                                                       |
 +=======+========================+==========================================================+=======================================================+
-| 1     | none                   | Core B is not implementing an Intel® DPDK pipeline.      | N/A                                                   |
+| 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 Intel® DPDK Packet Framework by using one      |                                                       |
+|       |                        | using the DPDK Packet Framework by using one             |                                                       |
 |       |                        | stub table for each input NIC port.                      |                                                       |
 |       |                        |                                                          |                                                       |
 +-------+------------------------+----------------------------------------------------------+-------------------------------------------------------+
@@ -137,9 +137,9 @@ For hash tables, the following parameters can be selected:
 |       |                        | entries.                                                 | hash table with the following key format:             |
 |       |                        |                                                          |                                                       |
 |       |                        |                                                          | [4-byte index, 4 bytes of 0]                          |
-+-------+------------------------+----------------------------------------------------------+                                                       |
-| 4     | hash-[spec]-8-ext      |  Extendible bucket hash table with 8-byte key size       | The action configured for all table entries is        |
-|       |                        |  and 16 million entries.                                 | "Sendto output port", with the output port index      |
+|       |                        |                                                          |                                                       |
+|       |                        |                                                          | 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  |
@@ -152,13 +152,17 @@ For hash tables, the following parameters can be selected:
 |       |                        |                                                          | [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]                         |
-+-------+------------------------+----------------------------------------------------------+                                                       |
-| 6     | hash-[spec]-ash-16-ext | Extendible bucket hash table with 16-byte key size       | The action configured for all table entries is        |
-|       |                        | and 16 million entries.                                  | "Send to output port", with the output port index     |
+|       |                        |                                                          |                                                       |
+|       |                        |                                                          | 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  |
@@ -171,13 +175,17 @@ For hash tables, the following parameters can be selected:
 |       |                        |                                                          | [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:                 |
+|       |                        | entries.                                                 | table with the following key format:                  |
 |       |                        |                                                          |                                                       |
 |       |                        |                                                          | [4-byte index, 28 bytes of 0].                        |
-+-------+------------------------+----------------------------------------------------------+                                                       |
-| 8     | hash-[spec]-32-ext     | Extendible bucket hash table with 32-byte key size       | The action configured for all table entries is        |
-|       |                        | and 16 million entries.                                  | "Send to output port", with the output port index     |
+|       |                        |                                                          |                                                       |
+|       |                        |                                                          | 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  |
@@ -190,6 +198,10 @@ For hash tables, the following parameters can be selected:
 |       |                        |                                                          | [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:                               |
 |       |                        |                                                          |                                                       |
@@ -270,4 +282,4 @@ The profile for input traffic is TCP/IPv4 packets with:
 
 *   source TCP port fixed to 0
 
-.. |test_pipeline_app| image:: img/test_pipeline_app.png
+.. |test_pipeline_app| image:: img/test_pipeline_app.*