mirror of https://github.com/F-Stack/f-stack.git
58 lines
2.0 KiB
ReStructuredText
58 lines
2.0 KiB
ReStructuredText
.. SPDX-License-Identifier: BSD-3-Clause
|
|
Copyright(c) 2015 Intel Corporation.
|
|
|
|
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.
|
|
|
|
Running the Application
|
|
-----------------------
|
|
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]
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
**-p PORTMASK**: Hexadecimal bitmask of ports to configure.
|
|
|
|
**--stats**
|
|
The stats parameter controls the printing of generic port statistics. If no
|
|
port mask is specified stats are printed for all DPDK ports.
|
|
|
|
**--xstats**
|
|
The xstats parameter controls the printing of extended port statistics. If no
|
|
port mask is specified xstats are printed for all DPDK ports.
|
|
|
|
**--stats-reset**
|
|
The stats-reset parameter controls the resetting of generic port statistics. If
|
|
no port mask is specified, the generic stats are reset for all DPDK ports.
|
|
|
|
**--xstats-reset**
|
|
The xstats-reset parameter controls the resetting of extended port statistics.
|
|
If no port mask is specified xstats are reset for all DPDK ports.
|
|
|
|
**-m**: Print DPDK memory information.
|
|
|
|
Limitations
|
|
-----------
|
|
|
|
* dpdk-procinfo should run alongside primary process with same DPDK version.
|
|
|
|
* 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
|
|
affecting primary application too.
|
|
|
|
* Stats retrieval using ``dpdk-procinfo`` is not supported for virtual devices like PCAP and TAP.
|
|
|
|
* Since default DPDK EAL arguments for ``dpdk-procinfo`` are ``-c1, -n4 & --proc-type=secondary``,
|
|
It is not expected that the user passes any EAL arguments.
|