1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2015 Intel Corporation. 3 4dpdk-proc-info Application 5========================== 6 7The dpdk-proc-info 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 ./<build_dir>/app/dpdk-proc-info -- -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 --show-port-private | --version | --firmware-version | --show-rss-reta | 24 --show-module-eeprom | --show-rx-descriptor queue_id:offset:num | 25 --show-tx-descriptor queue_id:offset:num | --show-edev-queue-xstats=queue_num:evdev_id | 26 --show-edev-port-xstats=port_num :evdev_id | --edev-dump-xstats=evdev_id | 27 --edev-reset-xstats=evdev_id | --show-edev-device-xstats=evdev_id] 28 29Parameters 30~~~~~~~~~~ 31**-p PORTMASK**: Hexadecimal bitmask of ports to configure. 32 33**--stats** 34The stats parameter controls the printing of generic port statistics. If no 35port mask is specified stats are printed for all DPDK ports. 36 37**--xstats** 38The xstats parameter controls the printing of extended port statistics. If no 39port mask is specified xstats are printed for all DPDK ports. 40 41**--stats-reset** 42The stats-reset parameter controls the resetting of generic port statistics. If 43no port mask is specified, the generic stats are reset for all DPDK ports. 44 45**--xstats-reset** 46The xstats-reset parameter controls the resetting of extended port statistics. 47If no port mask is specified xstats are reset for all DPDK ports. 48 49**-m**: Print DPDK memory information. 50 51**--show-port** 52The show-port parameter displays port level various configuration information 53associated to RX port queue pair. 54 55**--show-tm** 56The show-tm parameter displays per port traffic manager settings, current 57configurations and statistics. 58 59**--show-crypto** 60The show-crypto parameter displays available cryptodev configurations, 61settings and stats per node. 62 63**--show-ring[=name]** 64The show-ring parameter display current allocation of all ring with 65debug information. Specifying the name allows to display details for specific 66ring. For invalid or no ring name, whole list is dump. 67 68**--show-mempool[=name]** 69The show-mempool parameter display current allocation of all mempool 70debug information. Specifying the name allows to display details for specific 71mempool. For invalid or no mempool name, whole list is dump. 72 73**--iter-mempool=name** 74The iter-mempool parameter iterates and displays mempool elements specified 75by name. For invalid or no mempool name no elements are displayed. 76 77**--show-port-private** 78The show-port-private parameter displays ports private information. 79 80**--version** 81The version parameter displays DPDK version. 82 83**--firmware-version** 84The firmware-version parameter displays ethdev firmware version. 85 86**--show-rss-reta** 87The show-rss-reta parameter displays ports rss redirection table. 88 89**--show-module-eeprom** 90The show-module-eeprom parameter displays ports module eeprom information. 91 92**--show-rx-descriptor queue_id:offset:num** 93The show-rx-descriptor parameter displays ports Rx descriptor information 94specified by queue_id, offset and num. 95queue_id: A Rx queue identifier on this port. 96offset: The offset of the descriptor starting from tail. 97num: The number of the descriptors to dump. 98 99**--show-tx-descriptor queue_id:offset:num** 100The show-tx-descriptor parameter displays ports Tx descriptor information 101specified by queue_id, offset and num. 102queue_id: A Tx queue identifier on this port. 103offset: The offset of the descriptor starting from tail. 104num: The number of the descriptors to dump. 105 106**--show-edev-queue-xstats queue_num:evdev_id** 107The show-edev-queue-xstats parameter enables stats for specified queue or all queues. 108queue_num: The queue number to get queue xstats for this specified queue or * for all queues. 109evdev_id: Id of the eventdev device to display xstats. 110 111**--show-edev-port-xstats port_num:evdev_id** 112The show-edev-port-xstats parameter enables stats for specified port or all ports. 113port_num: The port number to get port xstats for this specified port or * for all ports. 114evdev_id: Id of the eventdev device to display xstats. 115 116**--edev-dump-xstats evdev_id** 117The edev-dump-xstats parameter dumps all eventdev stats. 118evdev_id: Id of the eventdev device to display xstats. 119 120**--edev-reset-xstats evdev_id** 121The edev-reset-xstats parameter resets eventdev xstats after reading. 122evdev_id: Id of the eventdev device to display xstats. 123 124**--show-edev-device-xstats evdev_id** 125The show-edev-device-xstats parameter displays eventdev device xstats. 126evdev_id: Id of the eventdev device to display xstats. 127 128Limitations 129----------- 130 131* dpdk-proc-info should run alongside primary process with same DPDK version. 132 133* When running ``dpdk-proc-info`` with shared library mode, it is required to 134 pass the same NIC PMD libraries as used for the primary application. Any 135 mismatch in PMD library arguments can lead to undefined behavior and results 136 affecting primary application too. 137 138* Stats retrieval using ``dpdk-proc-info`` is not supported for virtual devices like PCAP and TAP. 139 140* Since default DPDK EAL arguments for ``dpdk-proc-info`` are ``-c1, -n4 & --proc-type=secondary``, 141 It is not expected that the user passes any EAL arguments. 142