DPDK patches and discussions
 help / color / mirror / Atom feed
From: Vipin Varghese <vipin.varghese@intel.com>
To: dev@dpdk.org, thomas@monjalon.net, reshma.pattan@intel.com,
	stephen@networkplumber.org, john.mcnamara@intel.com
Cc: stephen1.byrne@intel.com, michael.j.glynn@intel.com,
	amol.patel@intel.com, Vipin Varghese <vipin.varghese@intel.com>
Subject: [dpdk-dev] [PATCH v3 9/9] doc/procinfo: add information for debug options
Date: Mon,  5 Nov 2018 23:21:28 +0530	[thread overview]
Message-ID: <20181105175128.33297-9-vipin.varghese@intel.com> (raw)
In-Reply-To: <20181105175128.33297-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-05 17:55 UTC|newest]

Thread overview: 65+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-23 13:57 [dpdk-dev] [PATCH v1 1/9] app/procinfo: add usage for new debug Vipin Varghese
2018-10-23 13:57 ` [dpdk-dev] [PATCH v1 2/9] app/procinfo: add compare for new options Vipin Varghese
2018-10-25 15:18   ` Pattan, Reshma
2018-10-27  7:17     ` Varghese, Vipin
2018-10-23 13:57 ` [dpdk-dev] [PATCH v1 3/9] app/procinfo: add prototype for debug instances Vipin Varghese
2018-10-23 13:57 ` [dpdk-dev] [PATCH v1 4/9] app/procinfo: add code for debug port Vipin Varghese
2018-10-25 15:38   ` Pattan, Reshma
2018-10-27  7:09     ` Varghese, Vipin
2018-10-25 15:46   ` Pattan, Reshma
2018-10-27  4:47     ` Varghese, Vipin
2018-10-23 13:57 ` [dpdk-dev] [PATCH v1 5/9] app/procinfo: add code for debug tm Vipin Varghese
2018-10-23 13:57 ` [dpdk-dev] [PATCH v1 6/9] app/procinfo: add code for debug crypto Vipin Varghese
2018-10-23 13:57 ` [dpdk-dev] [PATCH v1 7/9] app/procinfo: add code for debug ring Vipin Varghese
2018-10-23 13:57 ` [dpdk-dev] [PATCH v1 8/9] app/procinfo: add code for debug mempool Vipin Varghese
2018-10-23 13:57 ` [dpdk-dev] [PATCH v1 9/9] doc/proc_info: add information for debug options Vipin Varghese
2018-10-23 15:19 ` [dpdk-dev] [PATCH v1 1/9] app/procinfo: add usage for new debug Stephen Hemminger
2018-10-24  5:41   ` Varghese, Vipin
2018-10-24 15:56     ` Stephen Hemminger
2018-10-24  6:47 ` [dpdk-dev] [PATCH v2 " Vipin Varghese
2018-10-24  6:47   ` [dpdk-dev] [PATCH v2 2/9] app/procinfo: add compare for new options Vipin Varghese
2018-10-24  6:47   ` [dpdk-dev] [PATCH v2 3/9] app/procinfo: add prototype for debug instances Vipin Varghese
2018-10-24  6:48   ` [dpdk-dev] [PATCH v2 4/9] app/procinfo: add code for debug port Vipin Varghese
2018-10-25 16:20     ` Pattan, Reshma
2018-10-27  4:45       ` Varghese, Vipin
2018-11-05 11:39         ` Thomas Monjalon
2018-11-05 15:31           ` Varghese, Vipin
2018-10-24  6:48   ` [dpdk-dev] [PATCH v2 5/9] app/procinfo: add code for debug tm Vipin Varghese
2018-10-24  6:48   ` [dpdk-dev] [PATCH v2 6/9] app/procinfo: add code for debug crypto Vipin Varghese
2018-10-26 13:01     ` Pattan, Reshma
2018-10-27  4:42       ` Varghese, Vipin
2018-10-28 15:29         ` Stephen Hemminger
2018-10-29 14:29           ` Varghese, Vipin
2018-10-26 13:16     ` Pattan, Reshma
2018-10-27  4:37       ` Varghese, Vipin
2018-10-24  6:48   ` [dpdk-dev] [PATCH v2 7/9] app/procinfo: add code for debug ring Vipin Varghese
2018-10-24  6:48   ` [dpdk-dev] [PATCH v2 8/9] app/procinfo: add code for debug mempool Vipin Varghese
2018-10-24  6:48   ` [dpdk-dev] [PATCH v2 9/9] doc/procinfo: add information for debug options Vipin Varghese
2018-10-25 15:11     ` Varghese, Vipin
2018-11-05 17:51     ` [dpdk-dev] [PATCH v3 1/9] app/procinfo: add usage for new debug Vipin Varghese
2018-11-05 17:51       ` [dpdk-dev] [PATCH v3 2/9] app/procinfo: add compare for new options Vipin Varghese
2018-11-05 17:51       ` [dpdk-dev] [PATCH v3 3/9] app/procinfo: add prototype for debug instances Vipin Varghese
2018-11-05 17:51       ` [dpdk-dev] [PATCH v3 4/9] app/procinfo: add support for show port Vipin Varghese
2018-11-05 17:51       ` [dpdk-dev] [PATCH v3 5/9] app/procinfo: add support for show tm Vipin Varghese
2018-11-05 17:51       ` [dpdk-dev] [PATCH v3 6/9] app/procinfo: add support for show crypto Vipin Varghese
2018-11-05 18:08         ` [dpdk-dev] [PATCH " Vipin Varghese
2018-11-05 18:08         ` [dpdk-dev] [PATCH v3 " Varghese, Vipin
2018-11-05 18:17         ` [dpdk-dev] [PATCH " Vipin Varghese
2018-11-05 17:51       ` [dpdk-dev] [PATCH v3 7/9] app/procinfo: add support for debug ring Vipin Varghese
2018-11-05 17:51       ` [dpdk-dev] [PATCH v3 8/9] app/procinfo: add support for show mempool Vipin Varghese
2018-11-05 18:06         ` [dpdk-dev] [PATCH " Vipin Varghese
2018-11-05 18:09         ` [dpdk-dev] [PATCH v3 " Varghese, Vipin
2018-11-05 18:18         ` [dpdk-dev] [PATCH " Vipin Varghese
2018-11-05 18:22         ` Vipin Varghese
2018-11-06  2:24         ` [dpdk-dev] [PATCH v4 " Vipin Varghese
2018-11-06  2:25         ` Vipin Varghese
2018-11-06  2:31         ` [dpdk-dev] [PATCH v5 1/9] app/procinfo: add usage for new debug Vipin Varghese
2018-11-06  2:31           ` [dpdk-dev] [PATCH v5 2/9] app/procinfo: add compare for new options Vipin Varghese
2018-11-06  2:31           ` [dpdk-dev] [PATCH v5 3/9] app/procinfo: add prototype for debug instances Vipin Varghese
2018-11-06  2:31           ` [dpdk-dev] [PATCH v5 4/9] app/procinfo: add support for show port Vipin Varghese
2018-11-06  2:31           ` [dpdk-dev] [PATCH v5 5/9] app/procinfo: add support for show tm Vipin Varghese
2018-11-06  2:31           ` [dpdk-dev] [PATCH v5 6/9] app/procinfo: add support for show crypto Vipin Varghese
2018-11-06  2:31           ` [dpdk-dev] [PATCH v5 7/9] app/procinfo: add support for debug ring Vipin Varghese
2018-11-06  2:31           ` [dpdk-dev] [PATCH v5 8/9] app/procinfo: add support for show mempool Vipin Varghese
2018-11-06  2:31           ` [dpdk-dev] [PATCH v5 9/9] doc/procinfo: add information for debug options Vipin Varghese
2018-11-05 17:51       ` Vipin Varghese [this message]

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=20181105175128.33297-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=michael.j.glynn@intel.com \
    --cc=reshma.pattan@intel.com \
    --cc=stephen1.byrne@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).