From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <vipin.varghese@intel.com>
Received: from mga17.intel.com (mga17.intel.com [192.55.52.151])
by dpdk.org (Postfix) with ESMTP id 50F1C7CB0
for <dev@dpdk.org>; Wed, 24 Oct 2018 08:52:17 +0200 (CEST)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from fmsmga007.fm.intel.com ([10.253.24.52])
by fmsmga107.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
23 Oct 2018 23:52:16 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.54,419,1534834800"; d="scan'208";a="80469149"
Received: from unknown (HELO saesrv02-S2600CWR.intel.com) ([10.224.122.203])
by fmsmga007.fm.intel.com with ESMTP; 23 Oct 2018 23:52:14 -0700
From: Vipin Varghese <vipin.varghese@intel.com>
To: dev@dpdk.org, stephen@networkplumber.org, maryam.tahhan@intel.com,
reshma.pattan@intel.com
Cc: amol.patel@intel.com, sivaprasad.tummala@intel.com,
stephen1.byrne@intel.com, michael.j.glynn@intel.com,
Vipin Varghese <vipin.varghese@intel.com>
Date: Wed, 24 Oct 2018 12:18:05 +0530
Message-Id: <20181024064805.23197-9-vipin.varghese@intel.com>
X-Mailer: git-send-email 2.17.1
In-Reply-To: <20181024064805.23197-1-vipin.varghese@intel.com>
References: <20181023135751.21536-1-vipin.varghese@intel.com>
<20181024064805.23197-1-vipin.varghese@intel.com>
Subject: [dpdk-dev] [PATCH v2 9/9] doc/procinfo: add information for debug
options
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 24 Oct 2018 06:52:17 -0000
Document update for debug options and inforamtion for PMD instances
port, traffic manager, crypto, mempool and ring instances.
Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---
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..2b06e2f86 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, 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 --dbg-port | --dbg-tm | --dbg-crypto |
+ --dbg-mempool[=name] | --dbg-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.
+**--dbg-port**
+The dbg-port parameter displays port level various configuration and
+mbuf pool information associated to RX queues.
+
+**--dbg-tm**
+The dbg-tm parameter displays per port traffic manager settings and
+current configuration. It also display statistics too.
+
+**--dbg-crypto**
+The dbg-crypto parameter displays available cryptodev configurations,
+settings and stats per node.
+
+**--dbg-mempool[=name]**
+The dbg-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.
+
+**--dbg-ring[=name]**
+The dbg-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