doc/guides/tools/proc_info.rst

   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
   9 statistics, resetting port statistics and printing DPDK memory information.
  10 This application extends the original functionality that was supported by
  11 dump_cfg.
  12
  13 Running the Application
  14 -----------------------
  15 The application has a number of command line options:
  16
  17 .. code-block:: console
  18
  19    ./$(RTE_TARGET)/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats |
  20    --stats-reset | --xstats-reset]
  21
  22 Parameters
  23 ~~~~~~~~~~
  24 **-p PORTMASK**: Hexadecimal bitmask of ports to configure.
  25
  26 **--stats**
  27 The stats parameter controls the printing of generic port statistics. If no
  28 port mask is specified stats are printed for all DPDK ports.
  29
  30 **--xstats**
  31 The xstats parameter controls the printing of extended port statistics. If no
  32 port mask is specified xstats are printed for all DPDK ports.
  33
  34 **--stats-reset**
  35 The stats-reset parameter controls the resetting of generic port statistics. If
  36 no port mask is specified, the generic stats are reset for all DPDK ports.
  37
  38 **--xstats-reset**
  39 The xstats-reset parameter controls the resetting of extended port statistics.
  40 If no port mask is specified xstats are reset for all DPDK ports.
  41
  42 **-m**: Print DPDK memory information.
  43
  44 Limitations
  45 -----------
  46
  47 * dpdk-procinfo should run alongside primary process with same DPDK version.
  48
  49 * When running ``dpdk-procinfo`` with shared library mode, it is required to
  50   pass the same NIC PMD libraries as used for the primary application. Any
  51   mismatch in PMD library arguments can lead to undefined behaviour and results
  52   affecting primary application too.
  53
  54 * Stats retrieval using ``dpdk-procinfo`` is not supported for virtual devices like PCAP and TAP.
  55
  56 * Since default DPDK EAL arguments for ``dpdk-procinfo`` are ``-c1, -n4 & --proc-type=secondary``,
  57   It is not expected that the user passes any EAL arguments.