caa7028276
The new pdump tool is added for packet capturing on dpdk. This tool runs as secondary process by default. Tool facilitates the command line options like port, device_id, queue which user should pass on to the tool to request the packet capture on those devices. Tool creates the rte ring, mempool and pcap vdev and calls the enable API of the pdump library with port/device_id, queue, ring and mempool as arguments to enable the packet capture on specific devices and gets the packets from the primary process over the ring. Once the packets are received, those packets will be send to the pcap vdev. Tool can be terminated by using ctrl+c(SIGINT) upon which tool calls the disable API of the pdump library to disable the packet capture and dequeues the rest of the packets from the ring and sends them on to the pcap vdev, then after releases all allocated resources. Signed-off-by: Reshma Pattan <reshma.pattan@intel.com> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
123 lines
4.8 KiB
ReStructuredText
123 lines
4.8 KiB
ReStructuredText
|
|
.. BSD LICENSE
|
|
Copyright(c) 2016 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.
|
|
|
|
|
|
dpdk_pdump Application
|
|
======================
|
|
|
|
The ``dpdk_pdump`` application is a Data Plane Development Kit (DPDK) application that runs as a DPDK secondary process and
|
|
is capable of enabling packet capture on dpdk ports.
|
|
|
|
|
|
Running the Application
|
|
-----------------------
|
|
|
|
The application has a ``--pdump`` command line option with various sub arguments:
|
|
|
|
.. code-block:: console
|
|
|
|
./build/app/dpdk_pdump --
|
|
--pdump '(port=<port id> | device_id=<pci id or vdev name>),
|
|
(queue=<queue_id>),
|
|
(rx-dev=<iface or pcap file> |
|
|
tx-dev=<iface or pcap file>),
|
|
[ring-size=<ring size>],
|
|
[mbuf-size=<mbuf data size>],
|
|
[total-num-mbufs=<number of mbufs>]'
|
|
|
|
Note:
|
|
|
|
* Parameters inside the parentheses represents mandatory parameters.
|
|
|
|
* Parameters inside the square brackets represents optional parameters.
|
|
|
|
Multiple instances of ``--pdump`` can be passed to capture packets on different port and queue combinations.
|
|
|
|
|
|
Parameters
|
|
~~~~~~~~~~
|
|
|
|
``port``:
|
|
Port id of the eth device on which packets should be captured.
|
|
|
|
``device_id``:
|
|
PCI address (or) name of the eth device on which packets should be captured.
|
|
|
|
.. Note::
|
|
|
|
* As of now the ``dpdk_pdump`` tool cannot capture the packets of virtual devices
|
|
in the primary process due to a bug in the ethdev library. Due to this bug, in a multi process context,
|
|
when the primary and secondary have different ports set, then the secondary process
|
|
(here the ``dpdk_pdump`` tool) overwrites the ``rte_eth_devices[]`` entries of the primary process.
|
|
|
|
``queue``:
|
|
Queue id of the eth device on which packets should be captured. The user can pass a queue value of ``*`` to enable
|
|
packet capture on all queues of the eth device.
|
|
|
|
``rx-dev``:
|
|
Can be either a pcap file name or any Linux iface.
|
|
|
|
``tx-dev``:
|
|
Can be either a pcap file name or any Linux iface.
|
|
|
|
.. Note::
|
|
|
|
* To receive ingress packets only, ``rx-dev`` should be passed.
|
|
|
|
* To receive egress packets only, ``tx-dev`` should be passed.
|
|
|
|
* To receive ingress and egress packets separately ``rx-dev`` and ``tx-dev``
|
|
should both be passed with the different file names or the Linux iface names.
|
|
|
|
* To receive ingress and egress packets separately ``rx-dev`` and ``tx-dev``
|
|
should both be passed with the same file names or the the Linux iface names.
|
|
|
|
``ring-size``:
|
|
Size of the ring. This value is used internally for ring creation. The ring will be used to enqueue the packets from
|
|
the primary application to the secondary. This is an optional parameter with default size 16384.
|
|
|
|
``mbuf-size``:
|
|
Size of the mbuf data. This is used internally for mempool creation. Ideally this value must be same as
|
|
the primary application's mempool's mbuf data size which is used for packet RX. This is an optional parameter with
|
|
default size 2176.
|
|
|
|
``total-num-mbufs``:
|
|
Total number mbufs in mempool. This is used internally for mempool creation. This is an optional parameter with default
|
|
value 65535.
|
|
|
|
|
|
Example
|
|
-------
|
|
|
|
.. code-block:: console
|
|
|
|
$ sudo ./build/app/dpdk_pdump -- --pdump 'port=0,queue=*,rx-dev=/tmp/rx.pcap'
|