]>
Commit | Line | Data |
---|---|---|
11fdf7f2 TL |
1 | .. SPDX-License-Identifier: BSD-3-Clause |
2 | Copyright(c) 2015 Intel Corporation. | |
3 | ||
4 | dpdk-procinfo Application | |
5 | ========================= | |
6 | ||
7 | The dpdk-procinfo application is a Data Plane Development Kit (DPDK) application | |
8 | that runs as a DPDK secondary process and is capable of retrieving port | |
9f95a23c TL |
9 | statistics, resetting port statistics, printing DPDK memory information and |
10 | displaying debug information for port. | |
11fdf7f2 TL |
11 | This application extends the original functionality that was supported by |
12 | dump_cfg. | |
13 | ||
14 | Running the Application | |
15 | ----------------------- | |
16 | The 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 | | |
9f95a23c TL |
21 | --stats-reset | --xstats-reset] [ --show-port | --show-tm | --show-crypto | |
22 | --show-ring[=name] | --show-mempool[=name] | --iter-mempool=name ] | |
11fdf7f2 TL |
23 | |
24 | Parameters | |
25 | ~~~~~~~~~~ | |
26 | **-p PORTMASK**: Hexadecimal bitmask of ports to configure. | |
27 | ||
28 | **--stats** | |
29 | The stats parameter controls the printing of generic port statistics. If no | |
30 | port mask is specified stats are printed for all DPDK ports. | |
31 | ||
32 | **--xstats** | |
33 | The xstats parameter controls the printing of extended port statistics. If no | |
34 | port mask is specified xstats are printed for all DPDK ports. | |
35 | ||
36 | **--stats-reset** | |
37 | The stats-reset parameter controls the resetting of generic port statistics. If | |
38 | no port mask is specified, the generic stats are reset for all DPDK ports. | |
39 | ||
40 | **--xstats-reset** | |
41 | The xstats-reset parameter controls the resetting of extended port statistics. | |
42 | If no port mask is specified xstats are reset for all DPDK ports. | |
43 | ||
44 | **-m**: Print DPDK memory information. | |
45 | ||
9f95a23c TL |
46 | **--show-port** |
47 | The show-port parameter displays port level various configuration information | |
48 | associated to RX port queue pair. | |
49 | ||
50 | **--show-tm** | |
51 | The show-tm parameter displays per port traffic manager settings, current | |
52 | configurations and statistics. | |
53 | ||
54 | **--show-crypto** | |
55 | The show-crypto parameter displays available cryptodev configurations, | |
56 | settings and stats per node. | |
57 | ||
58 | **--show-ring[=name]** | |
59 | The show-ring parameter display current allocation of all ring with | |
60 | debug information. Specifying the name allows to display details for specific | |
61 | ring. For invalid or no ring name, whole list is dump. | |
62 | ||
63 | **--show-mempool[=name]** | |
64 | The show-mempool parameter display current allocation of all mempool | |
65 | debug information. Specifying the name allows to display details for specific | |
f67539c2 | 66 | mempool. For invalid or no mempool name, whole list is dump. |
9f95a23c TL |
67 | |
68 | **--iter-mempool=name** | |
69 | The iter-mempool parameter iterates and displays mempool elements specified | |
70 | by name. For invalid or no mempool name no elements are displayed. | |
71 | ||
11fdf7f2 TL |
72 | Limitations |
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 | |
9f95a23c | 79 | mismatch in PMD library arguments can lead to undefined behavior and results |
11fdf7f2 TL |
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. |