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