doc/guides/tools/pdump.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2016 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-pdump Application
  33 ======================
  34
  35 The ``dpdk-pdump`` tool is a Data Plane Development Kit (DPDK) tool that runs as
  36 a DPDK secondary process and is capable of enabling packet capture on dpdk ports.
  37
  38    .. Note::
  39       * The ``dpdk-pdump`` tool can only be used in conjunction with a primary
  40         application which has the packet capture framework initialized already.
  41
  42       * The ``dpdk-pdump`` tool depends on libpcap based PMD which is disabled
  43         by default in the build configuration files,
  44         owing to an external dependency on the libpcap development files
  45         which must be installed on the board.
  46         Once the libpcap development files are installed, the libpcap based PMD
  47         can be enabled by setting CONFIG_RTE_LIBRTE_PMD_PCAP=y and recompiling the DPDK.
  48
  49
  50 Running the Application
  51 -----------------------
  52
  53 The tool has a number of command line options:
  54
  55 .. code-block:: console
  56
  57    ./build/app/dpdk-pdump --
  58                           --pdump '(port=<port id> | device_id=<pci id or vdev name>),
  59                                    (queue=<queue_id>),
  60                                    (rx-dev=<iface or pcap file> |
  61                                     tx-dev=<iface or pcap file>),
  62                                    [ring-size=<ring size>],
  63                                    [mbuf-size=<mbuf data size>],
  64                                    [total-num-mbufs=<number of mbufs>]'
  65                           [--server-socket-path=<server socket dir>]
  66                           [--client-socket-path=<client socket dir>]
  67
  68 The ``--pdump`` command line option is mandatory and it takes various sub arguments which are described in
  69 below section.
  70
  71    .. Note::
  72
  73       * Parameters inside the parentheses represents mandatory parameters.
  74
  75       * Parameters inside the square brackets represents optional parameters.
  76
  77       * Multiple instances of ``--pdump`` can be passed to capture packets on different port and queue combinations.
  78
  79 The ``--server-socket-path`` command line option is optional. This represents the server socket directory.
  80 If no value is passed default values are used i.e. ``/var/run/.dpdk/`` for root users and ``~/.dpdk/``
  81 for non root users.
  82
  83 The ``--client-socket-path`` command line option is optional. This represents the client socket directory.
  84 If no value is passed default values are used i.e. ``/var/run/.dpdk/`` for root users and ``~/.dpdk/``
  85 for non root users.
  86
  87
  88 The ``--pdump`` parameters
  89 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  90
  91 ``port``:
  92 Port id of the eth device on which packets should be captured.
  93
  94 ``device_id``:
  95 PCI address (or) name of the eth device on which packets should be captured.
  96
  97    .. Note::
  98
  99       * As of now the ``dpdk-pdump`` tool cannot capture the packets of virtual devices
 100         in the primary process due to a bug in the ethdev library. Due to this bug, in a multi process context,
 101         when the primary and secondary have different ports set, then the secondary process
 102         (here the ``dpdk-pdump`` tool) overwrites the ``rte_eth_devices[]`` entries of the primary process.
 103
 104 ``queue``:
 105 Queue id of the eth device on which packets should be captured. The user can pass a queue value of ``*`` to enable
 106 packet capture on all queues of the eth device.
 107
 108 ``rx-dev``:
 109 Can be either a pcap file name or any Linux iface.
 110
 111 ``tx-dev``:
 112 Can be either a pcap file name or any Linux iface.
 113
 114    .. Note::
 115
 116       * To receive ingress packets only, ``rx-dev`` should be passed.
 117
 118       * To receive egress packets only, ``tx-dev`` should be passed.
 119
 120       * To receive ingress and egress packets separately ``rx-dev`` and ``tx-dev``
 121         should both be passed with the different file names or the Linux iface names.
 122
 123       * To receive ingress and egress packets together, ``rx-dev`` and ``tx-dev``
 124         should both be passed with the same file name or the same Linux iface name.
 125
 126 ``ring-size``:
 127 Size of the ring. This value is used internally for ring creation. The ring will be used to enqueue the packets from
 128 the primary application to the secondary. This is an optional parameter with default size 16384.
 129
 130 ``mbuf-size``:
 131 Size of the mbuf data. This is used internally for mempool creation. Ideally this value must be same as
 132 the primary application's mempool's mbuf data size which is used for packet RX. This is an optional parameter with
 133 default size 2176.
 134
 135 ``total-num-mbufs``:
 136 Total number mbufs in mempool. This is used internally for mempool creation. This is an optional parameter with default
 137 value 65535.
 138
 139
 140 Example
 141 -------
 142
 143 .. code-block:: console
 144
 145    $ sudo ./build/app/dpdk-pdump -- --pdump 'port=0,queue=*,rx-dev=/tmp/rx.pcap'