All of lore.kernel.org
 help / color / mirror / Atom feed
From: Vipin Varghese <vipin.varghese@intel.com>
To: dev@dpdk.org, reshma.pattan@intel.com, thomas@monjalon.net,
	stephen@networkplumber.org, john.mcnamara@intel.com
Cc: amol.patel@intel.com, Vipin Varghese <vipin.varghese@intel.com>
Subject: [PATCH v5 9/9] doc/procinfo: add information for debug options
Date: Thu, 22 Nov 2018 19:45:43 +0530	[thread overview]
Message-ID: <20181122141543.37067-9-vipin.varghese@intel.com> (raw)
In-Reply-To: <20181122141543.37067-1-vipin.varghese@intel.com>

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.varghese@intel.com>
---

V3:
 - update document from dbg to show - Vipin Varghese

V2:
 - update word style for content - Vipin Varghese
---
 doc/guides/tools/proc_info.rst | 31 +++++++++++++++++++++++++++----
 1 file changed, 27 insertions(+), 4 deletions(-)

diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst
index d5b5ed6a6..5c2ce762b 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]]
 
 Parameters
 ~~~~~~~~~~
@@ -41,6 +42,28 @@ 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|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|no ring name, whole list is dump.
+
 Limitations
 -----------
 
-- 
2.17.1

  parent reply	other threads:[~2018-11-22 14:19 UTC|newest]

Thread overview: 69+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-22 14:15 [PATCH v5 1/9] app/procinfo: add usage for new debug Vipin Varghese
2018-11-22 14:15 ` [PATCH v5 2/9] app/procinfo: add compare for new options Vipin Varghese
2018-11-22 14:15 ` [PATCH v5 3/9] app/procinfo: add prototype for debug instances Vipin Varghese
2018-11-22 14:15 ` [PATCH v5 4/9] app/procinfo: add support for show port Vipin Varghese
2018-11-22 14:15 ` [PATCH v5 5/9] app/procinfo: add support for show tm Vipin Varghese
2018-11-22 14:15 ` [PATCH v5 6/9] app/procinfo: add support for show crypto Vipin Varghese
2018-11-22 14:15 ` [PATCH v5 7/9] app/procinfo: add support for debug ring Vipin Varghese
2018-11-22 14:15 ` [PATCH v5 8/9] app/procinfo: add support for show mempool Vipin Varghese
2018-11-22 14:15 ` Vipin Varghese [this message]
2018-11-22 18:08   ` [PATCH v5 9/9] doc/procinfo: add information for debug options Mcnamara, John
2018-11-23  4:58     ` Varghese, Vipin
2018-12-03  5:49 ` [PATCH v6 0/9] app/proc-info: improve debug of proc-info tool Vipin Varghese
2018-12-03  5:49   ` [PATCH v6 1/9] app/procinfo: add usage for new debug Vipin Varghese
2018-12-12 14:14     ` Pattan, Reshma
2018-12-12 15:06       ` Varghese, Vipin
2018-12-13  5:08     ` [PATCH v7 0/9] app/proc-info: improve debug of proc-info tool Vipin Varghese
2018-12-13  5:08       ` [PATCH v7 1/9] app/procinfo: add usage for new debug Vipin Varghese
2018-12-13  5:08       ` [PATCH v7 2/9] app/procinfo: add compare for new options Vipin Varghese
2018-12-13  5:08       ` [PATCH v7 3/9] app/procinfo: add prototype for debug instances Vipin Varghese
2018-12-13  5:08       ` [PATCH v7 4/9] app/procinfo: add support for show port Vipin Varghese
2018-12-13  5:08       ` [PATCH v7 5/9] app/procinfo: add support for show tm Vipin Varghese
2018-12-13  5:08       ` [PATCH v7 6/9] app/procinfo: add support for show crypto Vipin Varghese
2018-12-13  5:08       ` [PATCH v7 7/9] app/procinfo: add support for debug ring Vipin Varghese
2018-12-13  5:08       ` [PATCH v7 8/9] app/procinfo: add support for show iter mempool Vipin Varghese
2018-12-13  5:08       ` [PATCH v7 9/9] doc/procinfo: add information for debug options Vipin Varghese
2018-12-13 14:42       ` [PATCH v7 0/9] app/proc-info: improve debug of proc-info tool Pattan, Reshma
2018-12-13 16:21         ` Varghese, Vipin
2018-12-22 21:02           ` Thomas Monjalon
2018-12-26  5:21             ` Varghese, Vipin
2018-12-26 21:33               ` Thomas Monjalon
2018-12-27  2:46                 ` Varghese, Vipin
2018-12-27  9:32                   ` Thomas Monjalon
2018-12-27 10:45                     ` Varghese, Vipin
2019-01-07 15:38       ` [PATCH v8 0/7] app/proc-info: enhance " Vipin Varghese
2019-01-07 15:38         ` [PATCH v8 1/7] app/procinfo: prepare for new debug functions Vipin Varghese
2019-01-09 23:45           ` Thomas Monjalon
2019-01-10  3:08             ` Varghese, Vipin
2019-01-10  8:39               ` Thomas Monjalon
2019-01-10  8:53                 ` Varghese, Vipin
2019-01-10  9:09                   ` Thomas Monjalon
2019-01-10 21:36           ` [PATCH v9 0/6] app/proc-info: enhance debug of proc-info tool Vipin Varghese
2019-01-10 21:36             ` [PATCH v9 1/6] app/procinfo: add support for show port Vipin Varghese
2019-01-10 17:40               ` Thomas Monjalon
2019-01-11  3:57                 ` Varghese, Vipin
2019-01-11 10:22                   ` Thomas Monjalon
2019-01-10 21:36             ` [PATCH v9 2/6] app/procinfo: add support for show tm Vipin Varghese
2019-01-10 21:36             ` [PATCH v9 3/6] app/procinfo: add support for show crypto Vipin Varghese
2019-01-10 21:36             ` [PATCH v9 4/6] app/procinfo: add support for debug ring Vipin Varghese
2019-01-10 21:36             ` [PATCH v9 5/6] app/procinfo: add support for show mempool Vipin Varghese
2019-01-10 21:36             ` [PATCH v9 6/6] app/procinfo: add support for iter mempool Vipin Varghese
2019-01-11 14:46             ` [PATCH v9 0/6] app/proc-info: enhance debug of proc-info tool Thomas Monjalon
2019-01-14  0:07               ` Varghese, Vipin
2019-01-07 15:38         ` [PATCH v8 2/7] app/procinfo: add support for show port Vipin Varghese
2019-01-07 15:38         ` [PATCH v8 3/7] app/procinfo: add support for show tm Vipin Varghese
2019-01-07 15:38         ` [PATCH v8 4/7] app/procinfo: add support for show crypto Vipin Varghese
2019-01-07 15:38         ` [PATCH v8 5/7] app/procinfo: add support for debug ring Vipin Varghese
2019-01-07 15:38         ` [PATCH v8 6/7] app/procinfo: add support for show mempool Vipin Varghese
2019-01-07 15:38         ` [PATCH v8 7/7] app/procinfo: add support for iter mempool Vipin Varghese
2018-12-03  5:49   ` [PATCH v6 2/9] app/procinfo: add compare for new options Vipin Varghese
2018-12-03  5:49   ` [PATCH v6 3/9] app/procinfo: add prototype for debug instances Vipin Varghese
2018-12-03  5:49   ` [PATCH v6 4/9] app/procinfo: add support for show port Vipin Varghese
2018-12-03  5:49   ` [PATCH v6 5/9] app/procinfo: add support for show tm Vipin Varghese
2018-12-03  5:49   ` [PATCH v6 6/9] app/procinfo: add support for show crypto Vipin Varghese
2018-12-03  5:49   ` [PATCH v6 7/9] app/procinfo: add support for debug ring Vipin Varghese
2018-12-03  5:49   ` [PATCH v6 8/9] app/procinfo: add support for show iter mempool Vipin Varghese
2018-12-12 16:10     ` Pattan, Reshma
2018-12-13  2:26       ` Varghese, Vipin
2018-12-03  5:50   ` [PATCH v6 9/9] doc/procinfo: add information for debug options Vipin Varghese
  -- strict thread matches above, loose matches on Subject: below --
2018-11-05 17:51 [PATCH v3 8/9] app/procinfo: add support for show mempool Vipin Varghese
2018-11-06  2:31 ` [PATCH v5 1/9] app/procinfo: add usage for new debug Vipin Varghese
2018-11-06  2:31   ` [PATCH v5 9/9] doc/procinfo: add information for debug options Vipin Varghese

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20181122141543.37067-9-vipin.varghese@intel.com \
    --to=vipin.varghese@intel.com \
    --cc=amol.patel@intel.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=reshma.pattan@intel.com \
    --cc=stephen@networkplumber.org \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.