Document update for debug options and information for PMD instances
like port, traffic manager, crypto, mempool and ring instances.
Signed-off-by: Vipin Varghese <vipin.vargh...@intel.com>
Acked-by: John McNamara <john.mcnam...@intel.com>
---
V6:
- add ack for v5 - John Mcnamara
- update entry for mempool iter - Vipin Varghese
V3:
- update document from dbg to show - Vipin Varghese
V2:
- update word style for content - Vipin Varghese
---
doc/guides/tools/proc_info.rst | 35 ++++++++++++++++++++++++++++++----
1 file changed, 31 insertions(+), 4 deletions(-)
diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst
index d5b5ed6a6..ee0bd99bb 100644
--- a/doc/guides/tools/proc_info.rst
+++ b/doc/guides/tools/proc_info.rst
@@ -6,9 +6,9 @@ dpdk-procinfo Application
The dpdk-procinfo application is a Data Plane Development Kit (DPDK)
application
that runs as a DPDK secondary process and is capable of retrieving port
-statistics, resetting port statistics and printing DPDK memory information.
-This application extends the original functionality that was supported by
-dump_cfg.
+statistics, resetting port statistics and printing DPDK memory information and
+debug information for port|tm|crypto|ring|mempool. This application extends the
+original functionality that was supported by dump_cfg.
Running the Application
-----------------------
@@ -17,7 +17,8 @@ The application has a number of command line options:
.. code-block:: console
./$(RTE_TARGET)/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats
|
- --stats-reset | --xstats-reset]
+ --stats-reset | --xstats-reset | --show-port | --show-tm | --show-crypto |
+ --show-mempool[=name] | --show-ring[=name] | --iter-mempool=name]
Parameters
~~~~~~~~~~
@@ -41,6 +42,32 @@ If no port mask is specified xstats are reset for all DPDK
ports.
**-m**: Print DPDK memory information.
+**--show-port**
+The show-port parameter displays port level various configuration and
+mbuf pool information associated to RX queues.
+
+**--show-tm**
+The show-tm parameter displays per port traffic manager settings and
+current configuration. It also display statistics too.
+
+**--show-crypto**
+The show-crypto parameter displays available cryptodev configurations,
+settings and stats per node.
+
+**--show-mempool[=name]**
+The show-mempool parameter display current allocation of all mempool
+with debug information. Specifying the name allows display details for
+specific mempool. For invalid or no mempool name, whole list is dump.
+
+**--show-ring[=name]**
+The show-ring pararmeter display current allocation of all ring with
+debug information. Specifying the name allows to display details for specific
+ring. For invalid or no ring name, whole list is dump.
+
+**--iter-mempool=name**
+The iter-mempool parameter iterates and displays mempool elements specified
+by name. For invalid or no mempool name no elements are displayed.
+
Limitations
-----------
--
2.17.1
