doc/guides/tools/proc_info.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2015 Intel Corporation. All rights reserved.
   3     All rights reserved.
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   9     * Redistributions of source code must retain the above copyright
  10     notice, this list of conditions and the following disclaimer.
  11     * Redistributions in binary form must reproduce the above copyright
  12     notice, this list of conditions and the following disclaimer in
  13     the documentation and/or other materials provided with the
  14     distribution.
  15     * Neither the name of Intel Corporation nor the names of its
  16     contributors may be used to endorse or promote products derived
  17     from this software without specific prior written permission.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31
  32 dpdk-procinfo Application
  33 =========================
  34
  35 The dpdk-procinfo application is a Data Plane Development Kit (DPDK) application
  36 that runs as a DPDK secondary process and is capable of retrieving port
  37 statistics, resetting port statistics and printing DPDK memory information.
  38 This application extends the original functionality that was supported by
  39 dump_cfg.
  40
  41 Running the Application
  42 -----------------------
  43 The application has a number of command line options:
  44
  45 .. code-block:: console
  46
  47    ./$(RTE_TARGET)/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats |
  48    --stats-reset | --xstats-reset]
  49
  50 Parameters
  51 ~~~~~~~~~~
  52 **-p PORTMASK**: Hexadecimal bitmask of ports to configure.
  53
  54 **--stats**
  55 The stats parameter controls the printing of generic port statistics. If no
  56 port mask is specified stats are printed for all DPDK ports.
  57
  58 **--xstats**
  59 The xstats parameter controls the printing of extended port statistics. If no
  60 port mask is specified xstats are printed for all DPDK ports.
  61
  62 **--stats-reset**
  63 The stats-reset parameter controls the resetting of generic port statistics. If
  64 no port mask is specified, the generic stats are reset for all DPDK ports.
  65
  66 **--xstats-reset**
  67 The xstats-reset parameter controls the resetting of extended port statistics.
  68 If no port mask is specified xstats are reset for all DPDK ports.
  69
  70 **-m**: Print DPDK memory information.