doc/guides/sample_app_ug/pdump.rst

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