debian/patches/dpdk-dev-v2-1-4-doc-move-tool-guides-in-their-own-subdirectory.patch

   1 diff --git a/doc/guides/index.rst b/doc/guides/index.rst
   2 index 0441859..57570f6 100644
   3 --- a/doc/guides/index.rst
   4 +++ b/doc/guides/index.rst
   5 @@ -41,6 +41,7 @@ DPDK documentation
   6     nics/index
   7     cryptodevs/index
   8     sample_app_ug/index
   9 +   tools/index
  10     testpmd_app_ug/index
  11     faq/index
  12     howto/index
  13 diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst
  14 index 96bb317..6573452 100644
  15 --- a/doc/guides/sample_app_ug/index.rst
  16 +++ b/doc/guides/sample_app_ug/index.rst
  17 @@ -72,11 +72,9 @@ Sample Applications User Guide
  18      dist_app
  19      vm_power_management
  20      tep_termination
  21 -    proc_info
  22      ptpclient
  23      performance_thread
  24      ipsec_secgw
  25 -    pdump
  26
  27  **Figures**
  28
  29 diff --git a/doc/guides/sample_app_ug/pdump.rst b/doc/guides/sample_app_ug/pdump.rst
  30 deleted file mode 100644
  31 index ac0e7c9..0000000
  32 --- a/doc/guides/sample_app_ug/pdump.rst
  33 +++ /dev/null
  34 @@ -1,144 +0,0 @@
  35 -
  36 -..  BSD LICENSE
  37 -    Copyright(c) 2016 Intel Corporation. All rights reserved.
  38 -    All rights reserved.
  39 -
  40 -    Redistribution and use in source and binary forms, with or without
  41 -    modification, are permitted provided that the following conditions
  42 -    are met:
  43 -
  44 -    * Redistributions of source code must retain the above copyright
  45 -    notice, this list of conditions and the following disclaimer.
  46 -    * Redistributions in binary form must reproduce the above copyright
  47 -    notice, this list of conditions and the following disclaimer in
  48 -    the documentation and/or other materials provided with the
  49 -    distribution.
  50 -    * Neither the name of Intel Corporation nor the names of its
  51 -    contributors may be used to endorse or promote products derived
  52 -    from this software without specific prior written permission.
  53 -
  54 -    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  55 -    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  56 -    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  57 -    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  58 -    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  59 -    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  60 -    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  61 -    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  62 -    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  63 -    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  64 -    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  65 -
  66 -
  67 -dpdk-pdump Application
  68 -======================
  69 -
  70 -The ``dpdk-pdump`` tool is a Data Plane Development Kit (DPDK) tool that runs as
  71 -a DPDK secondary process and is capable of enabling packet capture on dpdk ports.
  72 -
  73 -   .. Note::
  74 -
  75 -      * The ``dpdk-pdump`` tool depends on libpcap based PMD which is disabled
  76 -        by default in the build configuration files,
  77 -        owing to an external dependency on the libpcap development files
  78 -        which must be installed on the board.
  79 -        Once the libpcap development files are installed, the libpcap based PMD
  80 -        can be enabled by setting CONFIG_RTE_LIBRTE_PMD_PCAP=y and recompiling the DPDK.
  81 -
  82 -
  83 -Running the Application
  84 ------------------------
  85 -
  86 -The tool has a number of command line options:
  87 -
  88 -.. code-block:: console
  89 -
  90 -   ./build/app/dpdk-pdump --
  91 -                          --pdump '(port=<port id> | device_id=<pci id or vdev name>),
  92 -                                   (queue=<queue_id>),
  93 -                                   (rx-dev=<iface or pcap file> |
  94 -                                    tx-dev=<iface or pcap file>),
  95 -                                   [ring-size=<ring size>],
  96 -                                   [mbuf-size=<mbuf data size>],
  97 -                                   [total-num-mbufs=<number of mbufs>]'
  98 -                          [--server-socket-path=<server socket dir>]
  99 -                          [--client-socket-path=<client socket dir>]
 100 -
 101 -The ``--pdump`` command line option is mandatory and it takes various sub arguments which are described in
 102 -below section.
 103 -
 104 -   .. Note::
 105 -
 106 -      * Parameters inside the parentheses represents mandatory parameters.
 107 -
 108 -      * Parameters inside the square brackets represents optional parameters.
 109 -
 110 -      * Multiple instances of ``--pdump`` can be passed to capture packets on different port and queue combinations.
 111 -
 112 -The ``--server-socket-path`` command line option is optional. This represents the server socket directory.
 113 -If no value is passed default values are used i.e. ``/var/run/.dpdk/`` for root users and ``~/.dpdk/``
 114 -for non root users.
 115 -
 116 -The ``--client-socket-path`` command line option is optional. This represents the client socket directory.
 117 -If no value is passed default values are used i.e. ``/var/run/.dpdk/`` for root users and ``~/.dpdk/``
 118 -for non root users.
 119 -
 120 -
 121 -The ``--pdump`` parameters
 122 -~~~~~~~~~~~~~~~~~~~~~~~~~~
 123 -
 124 -``port``:
 125 -Port id of the eth device on which packets should be captured.
 126 -
 127 -``device_id``:
 128 -PCI address (or) name of the eth device on which packets should be captured.
 129 -
 130 -   .. Note::
 131 -
 132 -      * As of now the ``dpdk-pdump`` tool cannot capture the packets of virtual devices
 133 -        in the primary process due to a bug in the ethdev library. Due to this bug, in a multi process context,
 134 -        when the primary and secondary have different ports set, then the secondary process
 135 -        (here the ``dpdk-pdump`` tool) overwrites the ``rte_eth_devices[]`` entries of the primary process.
 136 -
 137 -``queue``:
 138 -Queue id of the eth device on which packets should be captured. The user can pass a queue value of ``*`` to enable
 139 -packet capture on all queues of the eth device.
 140 -
 141 -``rx-dev``:
 142 -Can be either a pcap file name or any Linux iface.
 143 -
 144 -``tx-dev``:
 145 -Can be either a pcap file name or any Linux iface.
 146 -
 147 -   .. Note::
 148 -
 149 -      * To receive ingress packets only, ``rx-dev`` should be passed.
 150 -
 151 -      * To receive egress packets only, ``tx-dev`` should be passed.
 152 -
 153 -      * To receive ingress and egress packets separately ``rx-dev`` and ``tx-dev``
 154 -        should both be passed with the different file names or the Linux iface names.
 155 -
 156 -      * To receive ingress and egress packets separately ``rx-dev`` and ``tx-dev``
 157 -        should both be passed with the same file names or the the Linux iface names.
 158 -
 159 -``ring-size``:
 160 -Size of the ring. This value is used internally for ring creation. The ring will be used to enqueue the packets from
 161 -the primary application to the secondary. This is an optional parameter with default size 16384.
 162 -
 163 -``mbuf-size``:
 164 -Size of the mbuf data. This is used internally for mempool creation. Ideally this value must be same as
 165 -the primary application's mempool's mbuf data size which is used for packet RX. This is an optional parameter with
 166 -default size 2176.
 167 -
 168 -``total-num-mbufs``:
 169 -Total number mbufs in mempool. This is used internally for mempool creation. This is an optional parameter with default
 170 -value 65535.
 171 -
 172 -
 173 -Example
 174 --------
 175 -
 176 -.. code-block:: console
 177 -
 178 -   $ sudo ./build/app/dpdk-pdump -- --pdump 'port=0,queue=*,rx-dev=/tmp/rx.pcap'
 179 diff --git a/doc/guides/sample_app_ug/proc_info.rst b/doc/guides/sample_app_ug/proc_info.rst
 180 deleted file mode 100644
 181 index 73f2195..0000000
 182 --- a/doc/guides/sample_app_ug/proc_info.rst
 183 +++ /dev/null
 184 @@ -1,71 +0,0 @@
 185 -
 186 -..  BSD LICENSE
 187 -    Copyright(c) 2015 Intel Corporation. All rights reserved.
 188 -    All rights reserved.
 189 -
 190 -    Redistribution and use in source and binary forms, with or without
 191 -    modification, are permitted provided that the following conditions
 192 -    are met:
 193 -
 194 -    * Redistributions of source code must retain the above copyright
 195 -    notice, this list of conditions and the following disclaimer.
 196 -    * Redistributions in binary form must reproduce the above copyright
 197 -    notice, this list of conditions and the following disclaimer in
 198 -    the documentation and/or other materials provided with the
 199 -    distribution.
 200 -    * Neither the name of Intel Corporation nor the names of its
 201 -    contributors may be used to endorse or promote products derived
 202 -    from this software without specific prior written permission.
 203 -
 204 -    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 205 -    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 206 -    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 207 -    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 208 -    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 209 -    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 210 -    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 211 -    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 212 -    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 213 -    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 214 -    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 215 -
 216 -
 217 -dpdk-procinfo Application
 218 -=========================
 219 -
 220 -The dpdk-procinfo application is a Data Plane Development Kit (DPDK) application
 221 -that runs as a DPDK secondary process and is capable of retrieving port
 222 -statistics, resetting port statistics and printing DPDK memory information.
 223 -This application extends the original functionality that was supported by
 224 -dump_cfg.
 225 -
 226 -Running the Application
 227 ------------------------
 228 -The application has a number of command line options:
 229 -
 230 -.. code-block:: console
 231 -
 232 -   ./$(RTE_TARGET)/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats |
 233 -   --stats-reset | --xstats-reset]
 234 -
 235 -Parameters
 236 -~~~~~~~~~~
 237 -**-p PORTMASK**: Hexadecimal bitmask of ports to configure.
 238 -
 239 -**--stats**
 240 -The stats parameter controls the printing of generic port statistics. If no
 241 -port mask is specified stats are printed for all DPDK ports.
 242 -
 243 -**--xstats**
 244 -The stats parameter controls the printing of extended port statistics. If no
 245 -port mask is specified xstats are printed for all DPDK ports.
 246 -
 247 -**--stats-reset**
 248 -The stats-reset parameter controls the resetting of generic port statistics. If
 249 -no port mask is specified, the generic stats are reset for all DPDK ports.
 250 -
 251 -**--xstats-reset**
 252 -The xstats-reset parameter controls the resetting of extended port statistics.
 253 -If no port mask is specified xstats are reset for all DPDK ports.
 254 -
 255 -**-m**: Print DPDK memory information.
 256 diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst
 257 new file mode 100644
 258 index 0000000..d7654a2
 259 --- /dev/null
 260 +++ b/doc/guides/tools/index.rst
 261 @@ -0,0 +1,40 @@
 262 +..  BSD LICENSE
 263 +    Copyright(c) 2016 Canonical Limited. All rights reserved.
 264 +    All rights reserved.
 265 +
 266 +    Redistribution and use in source and binary forms, with or without
 267 +    modification, are permitted provided that the following conditions
 268 +    are met:
 269 +
 270 +    * Redistributions of source code must retain the above copyright
 271 +    notice, this list of conditions and the following disclaimer.
 272 +    * Redistributions in binary form must reproduce the above copyright
 273 +    notice, this list of conditions and the following disclaimer in
 274 +    the documentation and/or other materials provided with the
 275 +    distribution.
 276 +    * Neither the name of Intel Corporation nor the names of its
 277 +    contributors may be used to endorse or promote products derived
 278 +    from this software without specific prior written permission.
 279 +
 280 +    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 281 +    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 282 +    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 283 +    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 284 +    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 285 +    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 286 +    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 287 +    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 288 +    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 289 +    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 290 +    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 291 +
 292 +Tool User Guides
 293 +================
 294 +
 295 +.. toctree::
 296 +    :maxdepth: 2
 297 +    :numbered:
 298 +
 299 +    proc_info
 300 +    pdump
 301 +
 302 diff --git a/doc/guides/tools/pdump.rst b/doc/guides/tools/pdump.rst
 303 new file mode 100644
 304 index 0000000..ac0e7c9
 305 --- /dev/null
 306 +++ b/doc/guides/tools/pdump.rst
 307 @@ -0,0 +1,144 @@
 308 +
 309 +..  BSD LICENSE
 310 +    Copyright(c) 2016 Intel Corporation. All rights reserved.
 311 +    All rights reserved.
 312 +
 313 +    Redistribution and use in source and binary forms, with or without
 314 +    modification, are permitted provided that the following conditions
 315 +    are met:
 316 +
 317 +    * Redistributions of source code must retain the above copyright
 318 +    notice, this list of conditions and the following disclaimer.
 319 +    * Redistributions in binary form must reproduce the above copyright
 320 +    notice, this list of conditions and the following disclaimer in
 321 +    the documentation and/or other materials provided with the
 322 +    distribution.
 323 +    * Neither the name of Intel Corporation nor the names of its
 324 +    contributors may be used to endorse or promote products derived
 325 +    from this software without specific prior written permission.
 326 +
 327 +    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 328 +    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 329 +    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 330 +    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 331 +    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 332 +    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 333 +    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 334 +    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 335 +    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 336 +    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 337 +    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 338 +
 339 +
 340 +dpdk-pdump Application
 341 +======================
 342 +
 343 +The ``dpdk-pdump`` tool is a Data Plane Development Kit (DPDK) tool that runs as
 344 +a DPDK secondary process and is capable of enabling packet capture on dpdk ports.
 345 +
 346 +   .. Note::
 347 +
 348 +      * The ``dpdk-pdump`` tool depends on libpcap based PMD which is disabled
 349 +        by default in the build configuration files,
 350 +        owing to an external dependency on the libpcap development files
 351 +        which must be installed on the board.
 352 +        Once the libpcap development files are installed, the libpcap based PMD
 353 +        can be enabled by setting CONFIG_RTE_LIBRTE_PMD_PCAP=y and recompiling the DPDK.
 354 +
 355 +
 356 +Running the Application
 357 +-----------------------
 358 +
 359 +The tool has a number of command line options:
 360 +
 361 +.. code-block:: console
 362 +
 363 +   ./build/app/dpdk-pdump --
 364 +                          --pdump '(port=<port id> | device_id=<pci id or vdev name>),
 365 +                                   (queue=<queue_id>),
 366 +                                   (rx-dev=<iface or pcap file> |
 367 +                                    tx-dev=<iface or pcap file>),
 368 +                                   [ring-size=<ring size>],
 369 +                                   [mbuf-size=<mbuf data size>],
 370 +                                   [total-num-mbufs=<number of mbufs>]'
 371 +                          [--server-socket-path=<server socket dir>]
 372 +                          [--client-socket-path=<client socket dir>]
 373 +
 374 +The ``--pdump`` command line option is mandatory and it takes various sub arguments which are described in
 375 +below section.
 376 +
 377 +   .. Note::
 378 +
 379 +      * Parameters inside the parentheses represents mandatory parameters.
 380 +
 381 +      * Parameters inside the square brackets represents optional parameters.
 382 +
 383 +      * Multiple instances of ``--pdump`` can be passed to capture packets on different port and queue combinations.
 384 +
 385 +The ``--server-socket-path`` command line option is optional. This represents the server socket directory.
 386 +If no value is passed default values are used i.e. ``/var/run/.dpdk/`` for root users and ``~/.dpdk/``
 387 +for non root users.
 388 +
 389 +The ``--client-socket-path`` command line option is optional. This represents the client socket directory.
 390 +If no value is passed default values are used i.e. ``/var/run/.dpdk/`` for root users and ``~/.dpdk/``
 391 +for non root users.
 392 +
 393 +
 394 +The ``--pdump`` parameters
 395 +~~~~~~~~~~~~~~~~~~~~~~~~~~
 396 +
 397 +``port``:
 398 +Port id of the eth device on which packets should be captured.
 399 +
 400 +``device_id``:
 401 +PCI address (or) name of the eth device on which packets should be captured.
 402 +
 403 +   .. Note::
 404 +
 405 +      * As of now the ``dpdk-pdump`` tool cannot capture the packets of virtual devices
 406 +        in the primary process due to a bug in the ethdev library. Due to this bug, in a multi process context,
 407 +        when the primary and secondary have different ports set, then the secondary process
 408 +        (here the ``dpdk-pdump`` tool) overwrites the ``rte_eth_devices[]`` entries of the primary process.
 409 +
 410 +``queue``:
 411 +Queue id of the eth device on which packets should be captured. The user can pass a queue value of ``*`` to enable
 412 +packet capture on all queues of the eth device.
 413 +
 414 +``rx-dev``:
 415 +Can be either a pcap file name or any Linux iface.
 416 +
 417 +``tx-dev``:
 418 +Can be either a pcap file name or any Linux iface.
 419 +
 420 +   .. Note::
 421 +
 422 +      * To receive ingress packets only, ``rx-dev`` should be passed.
 423 +
 424 +      * To receive egress packets only, ``tx-dev`` should be passed.
 425 +
 426 +      * To receive ingress and egress packets separately ``rx-dev`` and ``tx-dev``
 427 +        should both be passed with the different file names or the Linux iface names.
 428 +
 429 +      * To receive ingress and egress packets separately ``rx-dev`` and ``tx-dev``
 430 +        should both be passed with the same file names or the the Linux iface names.
 431 +
 432 +``ring-size``:
 433 +Size of the ring. This value is used internally for ring creation. The ring will be used to enqueue the packets from
 434 +the primary application to the secondary. This is an optional parameter with default size 16384.
 435 +
 436 +``mbuf-size``:
 437 +Size of the mbuf data. This is used internally for mempool creation. Ideally this value must be same as
 438 +the primary application's mempool's mbuf data size which is used for packet RX. This is an optional parameter with
 439 +default size 2176.
 440 +
 441 +``total-num-mbufs``:
 442 +Total number mbufs in mempool. This is used internally for mempool creation. This is an optional parameter with default
 443 +value 65535.
 444 +
 445 +
 446 +Example
 447 +-------
 448 +
 449 +.. code-block:: console
 450 +
 451 +   $ sudo ./build/app/dpdk-pdump -- --pdump 'port=0,queue=*,rx-dev=/tmp/rx.pcap'
 452 diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst
 453 new file mode 100644
 454 index 0000000..73f2195
 455 --- /dev/null
 456 +++ b/doc/guides/tools/proc_info.rst
 457 @@ -0,0 +1,71 @@
 458 +
 459 +..  BSD LICENSE
 460 +    Copyright(c) 2015 Intel Corporation. All rights reserved.
 461 +    All rights reserved.
 462 +
 463 +    Redistribution and use in source and binary forms, with or without
 464 +    modification, are permitted provided that the following conditions
 465 +    are met:
 466 +
 467 +    * Redistributions of source code must retain the above copyright
 468 +    notice, this list of conditions and the following disclaimer.
 469 +    * Redistributions in binary form must reproduce the above copyright
 470 +    notice, this list of conditions and the following disclaimer in
 471 +    the documentation and/or other materials provided with the
 472 +    distribution.
 473 +    * Neither the name of Intel Corporation nor the names of its
 474 +    contributors may be used to endorse or promote products derived
 475 +    from this software without specific prior written permission.
 476 +
 477 +    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 478 +    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 479 +    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 480 +    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 481 +    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 482 +    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 483 +    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 484 +    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 485 +    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 486 +    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 487 +    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 488 +
 489 +
 490 +dpdk-procinfo Application
 491 +=========================
 492 +
 493 +The dpdk-procinfo application is a Data Plane Development Kit (DPDK) application
 494 +that runs as a DPDK secondary process and is capable of retrieving port
 495 +statistics, resetting port statistics and printing DPDK memory information.
 496 +This application extends the original functionality that was supported by
 497 +dump_cfg.
 498 +
 499 +Running the Application
 500 +-----------------------
 501 +The application has a number of command line options:
 502 +
 503 +.. code-block:: console
 504 +
 505 +   ./$(RTE_TARGET)/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats |
 506 +   --stats-reset | --xstats-reset]
 507 +
 508 +Parameters
 509 +~~~~~~~~~~
 510 +**-p PORTMASK**: Hexadecimal bitmask of ports to configure.
 511 +
 512 +**--stats**
 513 +The stats parameter controls the printing of generic port statistics. If no
 514 +port mask is specified stats are printed for all DPDK ports.
 515 +
 516 +**--xstats**
 517 +The stats parameter controls the printing of extended port statistics. If no
 518 +port mask is specified xstats are printed for all DPDK ports.
 519 +
 520 +**--stats-reset**
 521 +The stats-reset parameter controls the resetting of generic port statistics. If
 522 +no port mask is specified, the generic stats are reset for all DPDK ports.
 523 +
 524 +**--xstats-reset**
 525 +The xstats-reset parameter controls the resetting of extended port statistics.
 526 +If no port mask is specified xstats are reset for all DPDK ports.
 527 +
 528 +**-m**: Print DPDK memory information.