1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2015 Intel Corporation. 3 4dpdk-procinfo Application 5========================= 6 7The dpdk-procinfo application is a Data Plane Development Kit (DPDK) application 8that runs as a DPDK secondary process and is capable of retrieving port 9statistics, resetting port statistics, printing DPDK memory information and 10displaying debug information for port. 11This application extends the original functionality that was supported by 12dump_cfg. 13 14Running the Application 15----------------------- 16The application has a number of command line options: 17 18.. code-block:: console 19 20 ./$(RTE_TARGET)/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats | 21 --stats-reset | --xstats-reset] [ --show-port | --show-tm | --show-crypto | 22 --show-ring[=name] | --show-mempool[=name] | --iter-mempool=name ] 23 24Parameters 25~~~~~~~~~~ 26**-p PORTMASK**: Hexadecimal bitmask of ports to configure. 27 28**--stats** 29The stats parameter controls the printing of generic port statistics. If no 30port mask is specified stats are printed for all DPDK ports. 31 32**--xstats** 33The xstats parameter controls the printing of extended port statistics. If no 34port mask is specified xstats are printed for all DPDK ports. 35 36**--stats-reset** 37The stats-reset parameter controls the resetting of generic port statistics. If 38no port mask is specified, the generic stats are reset for all DPDK ports. 39 40**--xstats-reset** 41The xstats-reset parameter controls the resetting of extended port statistics. 42If no port mask is specified xstats are reset for all DPDK ports. 43 44**-m**: Print DPDK memory information. 45 46**--show-port** 47The show-port parameter displays port level various configuration information 48associated to RX port queue pair. 49 50**--show-tm** 51The show-tm parameter displays per port traffic manager settings, current 52configurations and statistics. 53 54**--show-crypto** 55The show-crypto parameter displays available cryptodev configurations, 56settings and stats per node. 57 58**--show-ring[=name]** 59The show-ring parameter display current allocation of all ring with 60debug information. Specifying the name allows to display details for specific 61ring. For invalid or no ring name, whole list is dump. 62 63**--show-mempool[=name]** 64The show-mempool parameter display current allocation of all mempool 65debug information. Specifying the name allows to display details for specific 66mempool. For invalid or no mempool name, whole list is dump. 67 68**--iter-mempool=name** 69The iter-mempool parameter iterates and displays mempool elements specified 70by name. For invalid or no mempool name no elements are displayed. 71 72Limitations 73----------- 74 75* dpdk-procinfo should run alongside primary process with same DPDK version. 76 77* When running ``dpdk-procinfo`` with shared library mode, it is required to 78 pass the same NIC PMD libraries as used for the primary application. Any 79 mismatch in PMD library arguments can lead to undefined behavior and results 80 affecting primary application too. 81 82* Stats retrieval using ``dpdk-procinfo`` is not supported for virtual devices like PCAP and TAP. 83 84* Since default DPDK EAL arguments for ``dpdk-procinfo`` are ``-c1, -n4 & --proc-type=secondary``, 85 It is not expected that the user passes any EAL arguments. 86