X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fguides%2Ftools%2Fproc_info.rst;h=9772d97ef065142f236f91baeade5ba0fa363082;hb=7775172c045f3387cee47d3f32633255d37ba785;hp=d5b5ed6a61989326b72f77f854522e87aa2cadfd;hpb=bacf34762ac54bdc8906eafeaac6042697128211;p=dpdk.git diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst index d5b5ed6a61..9772d97ef0 100644 --- a/doc/guides/tools/proc_info.rst +++ b/doc/guides/tools/proc_info.rst @@ -6,7 +6,8 @@ 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. +statistics, resetting port statistics, printing DPDK memory information and +displaying debug information for port. This application extends the original functionality that was supported by dump_cfg. @@ -16,8 +17,9 @@ 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] + .//app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats | + --stats-reset | --xstats-reset] [ --show-port | --show-tm | --show-crypto | + --show-ring[=name] | --show-mempool[=name] | --iter-mempool=name ] Parameters ~~~~~~~~~~ @@ -41,6 +43,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 information +associated to RX port queue pair. + +**--show-tm** +The show-tm parameter displays per port traffic manager settings, current +configurations and statistics. + +**--show-crypto** +The show-crypto parameter displays available cryptodev configurations, +settings and stats per node. + +**--show-ring[=name]** +The show-ring parameter 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. + +**--show-mempool[=name]** +The show-mempool parameter display current allocation of all mempool +debug information. Specifying the name allows to display details for specific +mempool. For invalid or no mempool 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 ----------- @@ -48,7 +76,7 @@ Limitations * When running ``dpdk-procinfo`` with shared library mode, it is required to pass the same NIC PMD libraries as used for the primary application. Any - mismatch in PMD library arguments can lead to undefined behaviour and results + mismatch in PMD library arguments can lead to undefined behavior and results affecting primary application too. * Stats retrieval using ``dpdk-procinfo`` is not supported for virtual devices like PCAP and TAP.