app: replace dump_cfg by proc_info
authorMaryam Tahhan <maryam.tahhan@intel.com>
Wed, 15 Jul 2015 13:11:32 +0000 (14:11 +0100)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Fri, 17 Jul 2015 00:26:38 +0000 (02:26 +0200)
proc_info displays statistics information including extended stats for
given DPDK ports and dumps the memory information for DPDK.

Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
MAINTAINERS
app/Makefile
app/dump_cfg/Makefile [deleted file]
app/dump_cfg/main.c [deleted file]
app/proc_info/Makefile [new file with mode: 0644]
app/proc_info/main.c [new file with mode: 0644]
doc/guides/sample_app_ug/index.rst
doc/guides/sample_app_ug/proc_info.rst [new file with mode: 0644]
mk/rte.sdktest.mk

index 71e01bb..2a32659 100644 (file)
@@ -451,6 +451,11 @@ M: Pablo de Lara <pablo.de.lara.guarch@intel.com>
 F: app/test-pmd/
 F: doc/guides/testpmd_app_ug/
 
+Dump tool
+M: Maryam Tahhan <maryam.tahhan@intel.com>
+M: John McNamara <john.mcnamara@intel.com>
+F: app/proc_info/
+
 
 Other Example Applications
 --------------------------
index 50c670b..88c0bad 100644 (file)
@@ -36,6 +36,6 @@ DIRS-$(CONFIG_RTE_LIBRTE_ACL) += test-acl
 DIRS-$(CONFIG_RTE_LIBRTE_PIPELINE) += test-pipeline
 DIRS-$(CONFIG_RTE_TEST_PMD) += test-pmd
 DIRS-$(CONFIG_RTE_LIBRTE_CMDLINE) += cmdline_test
-DIRS-$(CONFIG_RTE_LIBRTE_EAL_LINUXAPP) += dump_cfg
+DIRS-$(CONFIG_RTE_LIBRTE_EAL_LINUXAPP) += proc_info
 
 include $(RTE_SDK)/mk/rte.subdir.mk
diff --git a/app/dump_cfg/Makefile b/app/dump_cfg/Makefile
deleted file mode 100644 (file)
index 3257127..0000000
+++ /dev/null
@@ -1,45 +0,0 @@
-#   BSD LICENSE
-#
-#   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
-#   All rights reserved.
-#
-#   Redistribution and use in source and binary forms, with or without
-#   modification, are permitted provided that the following conditions
-#   are met:
-#
-#     * Redistributions of source code must retain the above copyright
-#       notice, this list of conditions and the following disclaimer.
-#     * Redistributions in binary form must reproduce the above copyright
-#       notice, this list of conditions and the following disclaimer in
-#       the documentation and/or other materials provided with the
-#       distribution.
-#     * Neither the name of Intel Corporation nor the names of its
-#       contributors may be used to endorse or promote products derived
-#       from this software without specific prior written permission.
-#
-#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-#   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-#   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-#   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-#   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-#   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-#   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-#   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-#   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-include $(RTE_SDK)/mk/rte.vars.mk
-
-APP = dump_cfg
-
-CFLAGS += $(WERROR_FLAGS)
-
-# all source are stored in SRCS-y
-
-SRCS-y := main.c
-
-# this application needs libraries first
-DEPDIRS-y += lib
-
-include $(RTE_SDK)/mk/rte.app.mk
diff --git a/app/dump_cfg/main.c b/app/dump_cfg/main.c
deleted file mode 100644 (file)
index 127dbb1..0000000
+++ /dev/null
@@ -1,92 +0,0 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-#include <stdio.h>
-#include <string.h>
-#include <stdint.h>
-#include <errno.h>
-#include <stdarg.h>
-#include <inttypes.h>
-#include <sys/queue.h>
-#include <stdlib.h>
-
-#include <rte_memory.h>
-#include <rte_memzone.h>
-#include <rte_launch.h>
-#include <rte_tailq.h>
-#include <rte_eal.h>
-#include <rte_per_lcore.h>
-#include <rte_lcore.h>
-#include <rte_debug.h>
-#include <rte_log.h>
-#include <rte_atomic.h>
-#include <rte_branch_prediction.h>
-#include <rte_string_fns.h>
-
-int
-main(int argc, char **argv)
-{
-       int ret;
-       int i;
-       char c_flag[] = "-c1";
-       char n_flag[] = "-n4";
-       char mp_flag[] = "--proc-type=secondary";
-       char *argp[argc + 3];
-       argp[0] = argv[0];
-       argp[1] = c_flag;
-       argp[2] = n_flag;
-       argp[3] = mp_flag;
-
-       for(i = 1; i < argc; i++) {
-               argp[i + 3] = argv[i];
-       }
-       argc += 3;
-
-       ret = rte_eal_init(argc, argp);
-       if (ret < 0)
-               rte_panic("Cannot init EAL\n");
-
-       printf("----------- MEMORY_SEGMENTS -----------\n");
-       rte_dump_physmem_layout(stdout);
-       printf("--------- END_MEMORY_SEGMENTS ---------\n");
-
-       printf("------------ MEMORY_ZONES -------------\n");
-       rte_memzone_dump(stdout);
-       printf("---------- END_MEMORY_ZONES -----------\n");
-
-       printf("------------- TAIL_QUEUES -------------\n");
-       rte_dump_tailq(stdout);
-       printf("---------- END_TAIL_QUEUES ------------\n");
-
-       return 0;
-}
diff --git a/app/proc_info/Makefile b/app/proc_info/Makefile
new file mode 100644 (file)
index 0000000..243b060
--- /dev/null
@@ -0,0 +1,45 @@
+#   BSD LICENSE
+#
+#   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
+#   All rights reserved.
+#
+#   Redistribution and use in source and binary forms, with or without
+#   modification, are permitted provided that the following conditions
+#   are met:
+#
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in
+#       the documentation and/or other materials provided with the
+#       distribution.
+#     * Neither the name of Intel Corporation nor the names of its
+#       contributors may be used to endorse or promote products derived
+#       from this software without specific prior written permission.
+#
+#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+#   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+#   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+#   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+#   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+#   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+#   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+#   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+#   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+include $(RTE_SDK)/mk/rte.vars.mk
+
+APP = proc_info
+
+CFLAGS += $(WERROR_FLAGS)
+
+# all source are stored in SRCS-y
+
+SRCS-y := main.c
+
+# this application needs libraries first
+DEPDIRS-y += lib
+
+include $(RTE_SDK)/mk/rte.app.mk
diff --git a/app/proc_info/main.c b/app/proc_info/main.c
new file mode 100644 (file)
index 0000000..6448d7b
--- /dev/null
@@ -0,0 +1,353 @@
+/*
+ *   BSD LICENSE
+ *
+ *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
+ *   All rights reserved.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
+ *   are met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
+ *       distribution.
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
+ *       from this software without specific prior written permission.
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <stdio.h>
+#include <string.h>
+#include <stdint.h>
+#include <errno.h>
+#include <stdarg.h>
+#include <inttypes.h>
+#include <sys/queue.h>
+#include <stdlib.h>
+#include <getopt.h>
+
+#include <rte_eal.h>
+#include <rte_config.h>
+#include <rte_common.h>
+#include <rte_debug.h>
+#include <rte_ethdev.h>
+#include <rte_malloc.h>
+#include <rte_memory.h>
+#include <rte_memzone.h>
+#include <rte_launch.h>
+#include <rte_tailq.h>
+#include <rte_per_lcore.h>
+#include <rte_lcore.h>
+#include <rte_debug.h>
+#include <rte_log.h>
+#include <rte_atomic.h>
+#include <rte_branch_prediction.h>
+#include <rte_string_fns.h>
+
+/* Maximum long option length for option parsing. */
+#define MAX_LONG_OPT_SZ 64
+#define RTE_LOGTYPE_APP RTE_LOGTYPE_USER1
+
+/**< mask of enabled ports */
+static uint32_t enabled_port_mask;
+/**< Enable stats. */
+static uint32_t enable_stats;
+/**< Enable xstats. */
+static uint32_t enable_xstats;
+/**< Enable stats reset. */
+static uint32_t reset_stats;
+/**< Enable xstats reset. */
+static uint32_t reset_xstats;
+/**< Enable memory info. */
+static uint32_t mem_info;
+
+/**< display usage */
+static void
+proc_info_usage(const char *prgname)
+{
+       printf("%s [EAL options] -- -p PORTMASK\n"
+               "  -m to display DPDK memory zones, segments and TAILQ information\n"
+               "  -p PORTMASK: hexadecimal bitmask of ports to retrieve stats for\n"
+               "  --stats: to display port statistics, enabled by default\n"
+               "  --xstats: to display extended port statistics, disabled by "
+                       "default\n"
+               "  --stats-reset: to reset port statistics\n"
+               "  --xstats-reset: to reset port extended statistics\n",
+               prgname);
+}
+
+/*
+ * Parse the portmask provided at run time.
+ */
+static int
+parse_portmask(const char *portmask)
+{
+       char *end = NULL;
+       unsigned long pm;
+
+       errno = 0;
+
+       /* parse hexadecimal string */
+       pm = strtoul(portmask, &end, 16);
+       if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0') ||
+               (errno != 0)) {
+               printf("%s ERROR parsing the port mask\n", __func__);
+               return -1;
+       }
+
+       if (pm == 0)
+               return -1;
+
+       return pm;
+
+}
+
+/* Parse the argument given in the command line of the application */
+static int
+proc_info_parse_args(int argc, char **argv)
+{
+       int opt;
+       int option_index;
+       char *prgname = argv[0];
+       static struct option long_option[] = {
+               {"stats", 0, NULL, 0},
+               {"stats-reset", 0, NULL, 0},
+               {"xstats", 0, NULL, 0},
+               {"xstats-reset", 0, NULL, 0},
+               {NULL, 0, 0, 0}
+       };
+
+       if (argc == 1)
+               proc_info_usage(prgname);
+
+       /* Parse command line */
+       while ((opt = getopt_long(argc, argv, "p:m",
+                       long_option, &option_index)) != EOF) {
+               switch (opt) {
+               /* portmask */
+               case 'p':
+                       enabled_port_mask = parse_portmask(optarg);
+                       if (enabled_port_mask == 0) {
+                               printf("invalid portmask\n");
+                               proc_info_usage(prgname);
+                               return -1;
+                       }
+                       break;
+               case 'm':
+                       mem_info = 1;
+                       break;
+               case 0:
+                       /* Print stats */
+                       if (!strncmp(long_option[option_index].name, "stats",
+                                       MAX_LONG_OPT_SZ))
+                               enable_stats = 1;
+                       /* Print xstats */
+                       else if (!strncmp(long_option[option_index].name, "xstats",
+                                       MAX_LONG_OPT_SZ))
+                               enable_xstats = 1;
+                       /* Reset stats */
+                       if (!strncmp(long_option[option_index].name, "stats-reset",
+                                       MAX_LONG_OPT_SZ))
+                               reset_stats = 1;
+                       /* Reset xstats */
+                       else if (!strncmp(long_option[option_index].name, "xstats-reset",
+                                       MAX_LONG_OPT_SZ))
+                               reset_xstats = 1;
+                       break;
+
+               default:
+                       proc_info_usage(prgname);
+                       return -1;
+               }
+       }
+       return 0;
+}
+
+static void
+meminfo_display(void)
+{
+       printf("----------- MEMORY_SEGMENTS -----------\n");
+       rte_dump_physmem_layout(stdout);
+       printf("--------- END_MEMORY_SEGMENTS ---------\n");
+
+       printf("------------ MEMORY_ZONES -------------\n");
+       rte_memzone_dump(stdout);
+       printf("---------- END_MEMORY_ZONES -----------\n");
+
+       printf("------------- TAIL_QUEUES -------------\n");
+       rte_dump_tailq(stdout);
+       printf("---------- END_TAIL_QUEUES ------------\n");
+}
+
+static void
+nic_stats_display(uint8_t port_id)
+{
+       struct rte_eth_stats stats;
+       uint8_t i;
+
+       static const char *nic_stats_border = "########################";
+
+       rte_eth_stats_get(port_id, &stats);
+       printf("\n  %s NIC statistics for port %-2d %s\n",
+                  nic_stats_border, port_id, nic_stats_border);
+
+       printf("  RX-packets: %-10"PRIu64"  RX-errors:  %-10"PRIu64
+              "  RX-bytes:  %-10"PRIu64"\n", stats.ipackets, stats.ierrors,
+              stats.ibytes);
+       printf("  RX-nombuf:  %-10"PRIu64"\n", stats.rx_nombuf);
+       printf("  TX-packets: %-10"PRIu64"  TX-errors:  %-10"PRIu64
+              "  TX-bytes:  %-10"PRIu64"\n", stats.opackets, stats.oerrors,
+              stats.obytes);
+
+       printf("\n");
+       for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS; i++) {
+               printf("  Stats reg %2d RX-packets: %-10"PRIu64
+                      "  RX-errors: %-10"PRIu64
+                      "  RX-bytes: %-10"PRIu64"\n",
+                      i, stats.q_ipackets[i], stats.q_errors[i], stats.q_ibytes[i]);
+       }
+
+       printf("\n");
+       for (i = 0; i < RTE_ETHDEV_QUEUE_STAT_CNTRS; i++) {
+               printf("  Stats reg %2d TX-packets: %-10"PRIu64
+                      "  TX-bytes: %-10"PRIu64"\n",
+                      i, stats.q_opackets[i], stats.q_obytes[i]);
+       }
+
+       printf("  %s############################%s\n",
+                  nic_stats_border, nic_stats_border);
+}
+
+static void
+nic_stats_clear(uint8_t port_id)
+{
+       printf("\n Clearing NIC stats for port %d\n", port_id);
+       rte_eth_stats_reset(port_id);
+       printf("\n  NIC statistics for port %d cleared\n", port_id);
+}
+
+static void
+nic_xstats_display(uint8_t port_id)
+{
+       struct rte_eth_xstats *xstats;
+       int len, ret, i;
+       static const char *nic_stats_border = "########################";
+
+       len = rte_eth_xstats_get(port_id, NULL, 0);
+       if (len < 0) {
+               printf("Cannot get xstats count\n");
+               return;
+       }
+       xstats = malloc(sizeof(xstats[0]) * len);
+       if (xstats == NULL) {
+               printf("Cannot allocate memory for xstats\n");
+               return;
+       }
+
+       printf("###### NIC extended statistics for port %-2d #########\n",
+                          port_id);
+       printf("%s############################\n",
+                          nic_stats_border);
+       ret = rte_eth_xstats_get(port_id, xstats, len);
+       if (ret < 0 || ret > len) {
+               printf("Cannot get xstats\n");
+               free(xstats);
+               return;
+       }
+
+       for (i = 0; i < len; i++)
+               printf("%s: %"PRIu64"\n", xstats[i].name, xstats[i].value);
+
+       printf("%s############################\n",
+                          nic_stats_border);
+       free(xstats);
+}
+
+static void
+nic_xstats_clear(uint8_t port_id)
+{
+       printf("\n Clearing NIC xstats for port %d\n", port_id);
+       rte_eth_xstats_reset(port_id);
+       printf("\n  NIC extended statistics for port %d cleared\n", port_id);
+}
+
+int
+main(int argc, char **argv)
+{
+       int ret;
+       int i;
+       char c_flag[] = "-c1";
+       char n_flag[] = "-n4";
+       char mp_flag[] = "--proc-type=secondary";
+       char *argp[argc + 3];
+       uint8_t nb_ports;
+
+       argp[0] = argv[0];
+       argp[1] = c_flag;
+       argp[2] = n_flag;
+       argp[3] = mp_flag;
+
+       for (i = 1; i < argc; i++)
+               argp[i + 3] = argv[i];
+
+       argc += 3;
+
+       ret = rte_eal_init(argc, argp);
+       if (ret < 0)
+               rte_panic("Cannot init EAL\n");
+
+       argc -= ret;
+       argv += (ret - 3);
+
+       /* parse app arguments */
+       ret = proc_info_parse_args(argc, argv);
+       if (ret < 0)
+               rte_exit(EXIT_FAILURE, "Invalid argument\n");
+
+       if (mem_info) {
+               meminfo_display();
+               return 0;
+       }
+
+       nb_ports = rte_eth_dev_count();
+       if (nb_ports == 0)
+               rte_exit(EXIT_FAILURE, "No Ethernet ports - bye\n");
+
+
+       if (nb_ports > RTE_MAX_ETHPORTS)
+               nb_ports = RTE_MAX_ETHPORTS;
+
+       /* If no port mask was specified*/
+       if (enabled_port_mask == 0)
+               enabled_port_mask = 0xffff;
+
+       for (i = 0; i < nb_ports; i++) {
+               if (enabled_port_mask & (1 << i)) {
+                       if (enable_stats)
+                               nic_stats_display(i);
+                       else if (enable_xstats)
+                               nic_xstats_display(i);
+                       else if (reset_stats)
+                               nic_stats_clear(i);
+                       else if (reset_xstats)
+                               nic_xstats_clear(i);
+               }
+       }
+
+       return 0;
+}
index e1a0c56..8a3572f 100644 (file)
@@ -71,6 +71,7 @@ Sample Applications User Guide
     test_pipeline
     dist_app
     vm_power_management
+    proc_info
 
 **Figures**
 
diff --git a/doc/guides/sample_app_ug/proc_info.rst b/doc/guides/sample_app_ug/proc_info.rst
new file mode 100644 (file)
index 0000000..a0c0b06
--- /dev/null
@@ -0,0 +1,71 @@
+
+..  BSD LICENSE
+    Copyright(c) 2015 Intel Corporation. All rights reserved.
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+    * Neither the name of Intel Corporation nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+proc_info Application
+========================
+
+The proc_info 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/proc_info -- -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 stats 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.
index 2696142..59a29de 100644 (file)
@@ -66,7 +66,7 @@ test fast_test ring_test mempool_test perf_test:
        fi
 
 # this is a special target to ease the pain of running coverage tests
-# this runs all the autotests, cmdline_test script and dump_cfg
+# this runs all the autotests, cmdline_test script and proc_info
 coverage:
        @mkdir -p $(AUTOTEST_DIR) ; \
        cd $(AUTOTEST_DIR) ; \
@@ -78,7 +78,7 @@ coverage:
                        $(RTE_OUTPUT)/app/test \
                        $(RTE_TARGET) \
                        $(BLACKLIST) $(WHITELIST) ; \
-               $(RTE_OUTPUT)/app/dump_cfg --file-prefix=ring_perf ; \
+               $(RTE_OUTPUT)/app/proc_info --file-prefix=ring_perf -- -m; \
        else \
                echo "No test found, please do a 'make build' first, or specify O=" ;\
        fi