X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fsample_app_ug%2Fip_pipeline.rst;h=b521d3b8be201d18461c696461e102d0a760ffe7;hb=34fd4373ce76efd0236e59397c495762c2ec9e64;hp=447a544d57292fffe3c03d326f7afecbdde641ad;hpb=1edccebcccdbe600dc0a3a418fae68336648a87e;p=dpdk.git diff --git a/doc/guides/sample_app_ug/ip_pipeline.rst b/doc/guides/sample_app_ug/ip_pipeline.rst index 447a544d57..b521d3b8be 100644 --- a/doc/guides/sample_app_ug/ip_pipeline.rst +++ b/doc/guides/sample_app_ug/ip_pipeline.rst @@ -34,7 +34,7 @@ Running the application The application startup command line is:: - ip_pipeline [EAL_ARGS] -- [-s SCRIPT_FILE] [-h HOST] [-p PORT] + dpdk-ip_pipeline [EAL_ARGS] -- [-s SCRIPT_FILE] [-h HOST] [-p PORT] The application startup arguments are: @@ -71,7 +71,7 @@ The following is an example command to run ip pipeline application configured fo .. code-block:: console - $ ./build/ip_pipeline -c 0x3 -- -s examples/route_ecmp.cli + $ .//examples/dpdk-ip_pipeline -c 0x3 -- -s examples/route_ecmp.cli The application should start successfully and display as follows: @@ -113,7 +113,7 @@ Application stages Initialization ~~~~~~~~~~~~~~ -During this stage, EAL layer is initialised and application specific arguments are parsed. Furthermore, the data strcutures +During this stage, EAL layer is initialised and application specific arguments are parsed. Furthermore, the data structures (i.e. linked lists) for application objects are initialized. In case of any initialization error, an error message is displayed and the application is terminated. @@ -122,7 +122,7 @@ is displayed and the application is terminated. Run-time ~~~~~~~~ -The master thread is creating and managing all the application objects based on CLI input. +The main thread is creating and managing all the application objects based on CLI input. Each data plane thread runs one or several pipelines previously assigned to it in round-robin order. Each data plane thread executes two tasks in time-sharing mode: @@ -130,7 +130,7 @@ executes two tasks in time-sharing mode: 1. *Packet processing task*: Process bursts of input packets read from the pipeline input ports. 2. *Message handling task*: Periodically, the data plane thread pauses the packet processing task and polls for request - messages send by the master thread. Examples: add/remove pipeline to/from current data plane thread, add/delete rules + messages send by the main thread. Examples: add/remove pipeline to/from current data plane thread, add/delete rules to/from given table of a specific pipeline owned by the current data plane thread, read statistics, etc. Examples @@ -185,7 +185,7 @@ Examples +-----------------------+----------------------+----------------+------------------------------------+ | IP routing | LPM (IPv4) | Forward | 1. Mempool Create | | | | | 2. Link create | - | | * Key = IP dest addr | | 3. Pipeline creat | + | | * Key = IP dest addr | | 3. Pipeline create | | | * Offset = 286 | | 4. Pipeline port in/out | | | * Table size = 4K | | 5. Pipeline table | | | | | 6. Pipeline port in table | @@ -249,17 +249,21 @@ Traffic manager tmgr subport profile - + + + - Add traffic manager pipe profile :: tmgr pipe profile - + + + - + + Create traffic manager port :: @@ -267,9 +271,9 @@ Traffic manager rate spp pps - qsize - - fo mtu cpu + fo + mtu + cpu Configure traffic manager subport ::