doc/guides/sample_app_ug/proc_info.rst

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