From mboxrd@z Thu Jan 1 00:00:00 1970 From: Vipin Varghese Subject: [PATCH v5 9/9] doc/procinfo: add information for debug options Date: Thu, 22 Nov 2018 19:45:43 +0530 Message-ID: <20181122141543.37067-9-vipin.varghese@intel.com> References: <20181122141543.37067-1-vipin.varghese@intel.com> Cc: amol.patel@intel.com, Vipin Varghese To: dev@dpdk.org, reshma.pattan@intel.com, thomas@monjalon.net, stephen@networkplumber.org, john.mcnamara@intel.com Return-path: Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 3DC0C1B480 for ; Thu, 22 Nov 2018 15:19:48 +0100 (CET) In-Reply-To: <20181122141543.37067-1-vipin.varghese@intel.com> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Document update for debug options and information for PMD instances like port, traffic manager, crypto, mempool and ring instances. Signed-off-by: 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 | 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