> > This patch set include below changes > > 1)Changes to librte_ether. > 2)A new library librte_pdump added for packet capture framework. > 3)A new app/pdump tool added for packet capturing. > 4)Test pmd changes done to initialize packet capture framework. > 5)Documentation update. > > 1)librte_pdump > ============== > To support packet capturing on dpdk Ethernet devices, a new library > librte_pdump > is added.Users can develop their own packet capturing application using new > library APIs. > > Operation: > ---------- > Pdump library provides APIs to support packet capturing on dpdk Ethernet > devices. > Library provides APIs to initialize the packet capture framework, > enable/disable > the packet capture and uninitialize the packet capture framework. > > Pdump library works on client/server based model. > > Sever is responsible for enabling/disabling the packet captures. > Clients are responsible for requesting enable/disable of the > packet captures. > > As part of packet capture framework initialization, pthread and > the server socket is created. Only one server socket is allowed on the system. > As part of enabling/disabling the packet capture, client sockets are created > and multiple client sockets are allowed. > Who ever calls initialization first they will succeed with the initialization, > next subsequent calls of initialization are not allowed. So next users can > only > request enabling/disabling the packet capture. > > Applications using below APIs need to pass port/device_id, queue, mempool and > ring parameters. Library uses user provided ring and mempool to mirror the > rx/tx > packets of the port for users. Users need to dequeue the rings and write the > packets > to vdev(pcap/tuntap) to view the packets using any standard tools. > > Note: > Mempool and Ring should be mc/mp supportable. > Mempool mbuf size should be big enough to handle the rx/tx packets of a port. > > APIs: > ----- > rte_pdump_init() > rte_pdump_enable() > rte_pdump_enable_by_deviceid() > rte_pdump_disable() > rte_pdump_disable_by_deviceid() > rte_pdump_uninit() > > 2)app/pdump tool > ================ > Tool app/pdump is designed based on librte_pdump for packet capturing in DPDK. > This tool by default runs as secondary process, and provides the support for > the command line options for packet capture. > > ./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>]' > > Parameters inside the parenthesis represents the mandatory parameters. > Parameters inside the square brackets represents optional parameters. > User has to pass on packet capture parameters under --pdump parameters, > multiples of > --pdump can be passed to capture packets on different port and queue > combinations > > Operation: > ---------- > *Tool parse the user command line arguments, > creates the mempool, ring and the PCAP PMD vdev with 'tx_stream' as either > of the device passed in rx-dev|tx-dev parameters. > > *Then calls the APIs of librte_pdump i.e. > rte_pdump_enable()/rte_pdump_enable_by_deviceid() > to enable packet capturing on a specific port/device_id and queue by passing > on > port|device_id, queue, mempool and ring info. > > *Tool runs in while loop to dequeue the packets from the ring and write them > to pcap device. > > *Tool can be stopped using SIGINT, upon which tool calls > rte_pdump_disable()/rte_pdump_disable_by_deviceid() and free the allocated > resources. > > Note: > CONFIG_RTE_LIBRTE_PMD_PCAP flag should be set to yes to compile and run the > pdump tool. > > 3)Test-pmd changes > ================== > Changes are done to test-pmd application to initialize/uninitialize the > packet capture framework. > So app/pdump tool can be run to see packets of dpdk ports that are used by > test-pmd. > > Similarly any application which needs packet capture should call > initialize/uninitialize APIs of > librte_pdump and use pdump tool to start the capture. > > 4)Packet capture flow between pdump tool and librte_pdump > ========================================================= > * Pdump tool (Secondary process) requests packet capture > for specific port|device_id and queue combinations. > > *Library in secondary process context creates client socket and communicates > the port|device_id, queue, ring and mempool to server. > > *Library initializes server in primary process 'test-pmd' context and server > serves > the client request to enable Ethernet rxtx call-backs for a given > port|device_id and queue. > > *Copy the rx/tx packets to passed mempool and enqueue the packets to ring for > secondary process. > > *Pdump tool will dequeue the packets from ring and writes them to PCAPMD vdev, > so ultimately packets will be seen on the device that is passed in > rx-dev|tx-dev. > > *Once the pdump tool is terminated with SIGINT it will disable the packet > capturing. > > *Library receives the disable packet capture request, communicate the info to > server, > server will remove the Ethernet rxtx call-backs. > > *Packet capture can be seen using tcpdump command > "tcpdump -ni <iface>" (or) "tcpdump ?nr <pcapfile>" > > 5)Example command line > ====================== > ./build/app/dpdk_pdump -- --pdump > 'device_id=0000:02:0.0,queue=*,tx-dev=/tmp/dt-file.pcap,rx-dev=/tmp/dr-file.pcap,ring- > size=8192,mbuf-size=2176,total-num-mbufs=32768' --pdump > 'device_id=0000:01:00.0,queue=*,rx-dev=/tmp/d-file.pcap,tx- > dev=/tmp/d-file.pcap,ring-size=16384,mbuf-size=2176,total-num-mbufs=32768' > > v7: > fixed lines over 90 characters. > > v6: > removed below deprecation notice patch from patch set. > http://dpdk.org/dev/patchwork/patch/13372/ > > v5: > addressed code review comments for below patches > http://dpdk.org/dev/patchwork/patch/12955/ > http://dpdk.org/dev/patchwork/patch/12951/ > > v4: > added missing deprecation notice for ABI changes of rte_eth_dev_info > structure. > made doc changes as per doc guidelines. > replaced rte_eal_vdev_init with rte_eth_dev_attach in pdump tool. > removed rxtx-dev parameter from pdump tool command line. > > v3: > app/pdump: Moved cleanup code from signal handler to main. > divided librte_ether changes into multiple patches. > example command changed in app/pdump application guide > > v2: > fix compilation issues for 4.8.3 > fix unnecessary #includes > > > Reshma Pattan (8): > librte_ether: protect add/remove of rxtx callbacks with spinlocks > librte_ether: add new api rte_eth_add_first_rx_callback > librte_ether: add new fields to rte_eth_dev_info struct > librte_ether: make rte_eth_dev_get_port_by_name > rte_eth_dev_get_name_by_port public > lib/librte_pdump: add new library for packet capturing support > app/pdump: add pdump tool for packet capturing > app/test-pmd: add pdump initialization uninitialization > doc: update doc for packet capture framework >
Acked-by: Konstantin Ananyev <konstantin.ananyev at intel.com> > -- > 2.5.0
