X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Ftools%2Fpdump.rst;h=6f9bd77ab135607bf1855e7d3d2bd3c5bcfd073c;hb=b94c709decbe39582c68cf3605745b60a4f7985a;hp=5168c81abae3ca40b6e8f4e64637c8564bcfd864;hpb=5630257fcc30397e7217139ec55da4f301f59fb7;p=dpdk.git diff --git a/doc/guides/tools/pdump.rst b/doc/guides/tools/pdump.rst index 5168c81aba..6f9bd77ab1 100644 --- a/doc/guides/tools/pdump.rst +++ b/doc/guides/tools/pdump.rst @@ -19,12 +19,12 @@ a DPDK secondary process and is capable of enabling packet capture on dpdk ports framework initialization code. Refer ``app/test-pmd/testpmd.c`` code to see how this is done. - * The ``dpdk-pdump`` tool depends on libpcap based PMD which is disabled - by default in the build configuration files, - owing to an external dependency on the libpcap development files - which must be installed on the board. - Once the libpcap development files are installed, the libpcap based PMD - can be enabled by setting CONFIG_RTE_LIBRTE_PMD_PCAP=y and recompiling the DPDK. + * The ``dpdk-pdump`` tool depends on DPDK pcap PMD, so the system should + have libpcap development files installed and the pcap PMD not disabled + in the build. + + * The ``dpdk-pdump`` tool runs as a DPDK secondary process. It exits when + the primary application exits. Running the Application @@ -34,7 +34,8 @@ The tool has a number of command line options: .. code-block:: console - ./build/app/dpdk-pdump -- + .//app/dpdk-pdump -- + [--multi] --pdump '(port= | device_id=), (queue=), (rx-dev= | @@ -42,8 +43,10 @@ The tool has a number of command line options: [ring-size=], [mbuf-size=], [total-num-mbufs=]' - [--server-socket-path=] - [--client-socket-path=] + +The ``--multi`` command line option is optional argument. If passed, capture +will be running on unique cores for all ``--pdump`` options. If ignored, +capture will be running on single core for all ``--pdump`` options. The ``--pdump`` command line option is mandatory and it takes various sub arguments which are described in below section. @@ -56,14 +59,6 @@ below section. * Multiple instances of ``--pdump`` can be passed to capture packets on different port and queue combinations. -The ``--server-socket-path`` command line option is optional. This represents the server socket directory. -If no value is passed default values are used i.e. ``/var/run/.dpdk/`` for root users and ``~/.dpdk/`` -for non root users. - -The ``--client-socket-path`` command line option is optional. This represents the client socket directory. -If no value is passed default values are used i.e. ``/var/run/.dpdk/`` for root users and ``~/.dpdk/`` -for non root users. - The ``--pdump`` parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -122,4 +117,5 @@ Example .. code-block:: console - $ sudo ./build/app/dpdk-pdump -- --pdump 'port=0,queue=*,rx-dev=/tmp/rx.pcap' + $ sudo .//app/dpdk-pdump -l 3 -- --pdump 'port=0,queue=*,rx-dev=/tmp/rx.pcap' + $ sudo .//app/dpdk-pdump -l 3,4,5 -- --multi --pdump 'port=0,queue=*,rx-dev=/tmp/rx-1.pcap' --pdump 'port=1,queue=*,rx-dev=/tmp/rx-2.pcap'