2017-12-19 15:49:03 +00:00
|
|
|
/* SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
|
* Copyright(c) 2016 Intel Corporation
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef _RTE_PDUMP_H_
|
|
|
|
|
#define _RTE_PDUMP_H_
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @file
|
|
|
|
|
* RTE pdump
|
|
|
|
|
*
|
|
|
|
|
* packet dump library to provide packet capturing support on dpdk.
|
|
|
|
|
*/
|
|
|
|
|
|
2016-09-08 14:25:07 +02:00
|
|
|
#include <stdint.h>
|
|
|
|
|
#include <rte_mempool.h>
|
|
|
|
|
#include <rte_ring.h>
|
2021-10-20 14:42:30 -07:00
|
|
|
#include <rte_bpf.h>
|
2016-09-08 14:25:07 +02:00
|
|
|
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
#ifdef __cplusplus
|
|
|
|
|
extern "C" {
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#define RTE_PDUMP_ALL_QUEUES UINT16_MAX
|
|
|
|
|
|
|
|
|
|
enum {
|
|
|
|
|
RTE_PDUMP_FLAG_RX = 1, /* receive direction */
|
|
|
|
|
RTE_PDUMP_FLAG_TX = 2, /* transmit direction */
|
|
|
|
|
/* both receive and transmit directions */
|
2021-10-20 14:42:30 -07:00
|
|
|
RTE_PDUMP_FLAG_RXTX = (RTE_PDUMP_FLAG_RX|RTE_PDUMP_FLAG_TX),
|
|
|
|
|
|
|
|
|
|
RTE_PDUMP_FLAG_PCAPNG = 4, /* format for pcapng */
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Initialize packet capturing handling
|
|
|
|
|
*
|
2018-04-05 12:28:37 +00:00
|
|
|
* Register the IPC action for communication with target (primary) process.
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* 0 on success, -1 on error
|
|
|
|
|
*/
|
|
|
|
|
int
|
2018-12-03 10:58:57 +08:00
|
|
|
rte_pdump_init(void);
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Un initialize packet capturing handling
|
|
|
|
|
*
|
2018-04-05 12:28:37 +00:00
|
|
|
* Unregister the IPC action for communication with target (primary) process.
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* 0 on success, -1 on error
|
|
|
|
|
*/
|
|
|
|
|
int
|
|
|
|
|
rte_pdump_uninit(void);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Enables packet capturing on given port and queue.
|
|
|
|
|
*
|
|
|
|
|
* @param port
|
|
|
|
|
* port on which packet capturing should be enabled.
|
|
|
|
|
* @param queue
|
|
|
|
|
* queue of a given port on which packet capturing should be enabled.
|
|
|
|
|
* users should pass on value UINT16_MAX to enable packet capturing on all
|
|
|
|
|
* queues of a given port.
|
|
|
|
|
* @param flags
|
|
|
|
|
* flags specifies RTE_PDUMP_FLAG_RX/RTE_PDUMP_FLAG_TX/RTE_PDUMP_FLAG_RXTX
|
|
|
|
|
* on which packet capturing should be enabled for a given port and queue.
|
|
|
|
|
* @param ring
|
|
|
|
|
* ring on which captured packets will be enqueued for user.
|
|
|
|
|
* @param mp
|
|
|
|
|
* mempool on to which original packets will be mirrored or duplicated.
|
|
|
|
|
* @param filter
|
2021-10-20 14:42:30 -07:00
|
|
|
* Unused should be NULL.
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* 0 on success, -1 on error, rte_errno is set accordingly.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
int
|
2017-09-29 15:17:24 +08:00
|
|
|
rte_pdump_enable(uint16_t port, uint16_t queue, uint32_t flags,
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
struct rte_ring *ring,
|
|
|
|
|
struct rte_mempool *mp,
|
|
|
|
|
void *filter);
|
|
|
|
|
|
2021-10-20 14:42:30 -07:00
|
|
|
/**
|
|
|
|
|
* @warning
|
|
|
|
|
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice
|
|
|
|
|
*
|
|
|
|
|
* Enables packet capturing on given port and queue with filtering.
|
|
|
|
|
*
|
|
|
|
|
* @param port_id
|
|
|
|
|
* The Ethernet port on which packet capturing should be enabled.
|
|
|
|
|
* @param queue
|
|
|
|
|
* The queue on the Ethernet port which packet capturing
|
|
|
|
|
* should be enabled. Pass UINT16_MAX to enable packet capturing on all
|
|
|
|
|
* queues of a given port.
|
|
|
|
|
* @param flags
|
|
|
|
|
* Pdump library flags that specify direction and packet format.
|
|
|
|
|
* @param snaplen
|
|
|
|
|
* The upper limit on bytes to copy.
|
|
|
|
|
* Passing UINT32_MAX means capture all the possible data.
|
|
|
|
|
* @param ring
|
|
|
|
|
* The ring on which captured packets will be enqueued for user.
|
|
|
|
|
* @param mp
|
|
|
|
|
* The mempool on to which original packets will be mirrored or duplicated.
|
|
|
|
|
* @param prm
|
|
|
|
|
* Use BPF program to run to filter packes (can be NULL)
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* 0 on success, -1 on error, rte_errno is set accordingly.
|
|
|
|
|
*/
|
|
|
|
|
__rte_experimental
|
|
|
|
|
int
|
|
|
|
|
rte_pdump_enable_bpf(uint16_t port_id, uint16_t queue,
|
|
|
|
|
uint32_t flags, uint32_t snaplen,
|
|
|
|
|
struct rte_ring *ring,
|
|
|
|
|
struct rte_mempool *mp,
|
|
|
|
|
const struct rte_bpf_prm *prm);
|
|
|
|
|
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
/**
|
|
|
|
|
* Disables packet capturing on given port and queue.
|
|
|
|
|
*
|
|
|
|
|
* @param port
|
|
|
|
|
* port on which packet capturing should be disabled.
|
|
|
|
|
* @param queue
|
|
|
|
|
* queue of a given port on which packet capturing should be disabled.
|
|
|
|
|
* users should pass on value UINT16_MAX to disable packet capturing on all
|
|
|
|
|
* queues of a given port.
|
|
|
|
|
* @param flags
|
|
|
|
|
* flags specifies RTE_PDUMP_FLAG_RX/RTE_PDUMP_FLAG_TX/RTE_PDUMP_FLAG_RXTX
|
|
|
|
|
* on which packet capturing should be enabled for a given port and queue.
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* 0 on success, -1 on error, rte_errno is set accordingly.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
int
|
2017-09-29 15:17:24 +08:00
|
|
|
rte_pdump_disable(uint16_t port, uint16_t queue, uint32_t flags);
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Enables packet capturing on given device id and queue.
|
|
|
|
|
* device_id can be name or pci address of device.
|
|
|
|
|
*
|
|
|
|
|
* @param device_id
|
|
|
|
|
* device id on which packet capturing should be enabled.
|
|
|
|
|
* @param queue
|
|
|
|
|
* queue of a given device id on which packet capturing should be enabled.
|
|
|
|
|
* users should pass on value UINT16_MAX to enable packet capturing on all
|
|
|
|
|
* queues of a given device id.
|
|
|
|
|
* @param flags
|
|
|
|
|
* flags specifies RTE_PDUMP_FLAG_RX/RTE_PDUMP_FLAG_TX/RTE_PDUMP_FLAG_RXTX
|
|
|
|
|
* on which packet capturing should be enabled for a given port and queue.
|
|
|
|
|
* @param ring
|
|
|
|
|
* ring on which captured packets will be enqueued for user.
|
|
|
|
|
* @param mp
|
|
|
|
|
* mempool on to which original packets will be mirrored or duplicated.
|
|
|
|
|
* @param filter
|
2021-10-20 14:42:30 -07:00
|
|
|
* unused should be NULL
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* 0 on success, -1 on error, rte_errno is set accordingly.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
int
|
|
|
|
|
rte_pdump_enable_by_deviceid(char *device_id, uint16_t queue,
|
|
|
|
|
uint32_t flags,
|
|
|
|
|
struct rte_ring *ring,
|
|
|
|
|
struct rte_mempool *mp,
|
|
|
|
|
void *filter);
|
|
|
|
|
|
2021-10-20 14:42:30 -07:00
|
|
|
/**
|
|
|
|
|
* @warning
|
|
|
|
|
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice
|
|
|
|
|
*
|
|
|
|
|
* Enables packet capturing on given device id and queue with filtering.
|
|
|
|
|
* device_id can be name or pci address of device.
|
|
|
|
|
*
|
|
|
|
|
* @param device_id
|
|
|
|
|
* device id on which packet capturing should be enabled.
|
|
|
|
|
* @param queue
|
|
|
|
|
* The queue on the Ethernet port which packet capturing
|
|
|
|
|
* should be enabled. Pass UINT16_MAX to enable packet capturing on all
|
|
|
|
|
* queues of a given port.
|
|
|
|
|
* @param flags
|
|
|
|
|
* Pdump library flags that specify direction and packet format.
|
|
|
|
|
* @param snaplen
|
|
|
|
|
* The upper limit on bytes to copy.
|
|
|
|
|
* Passing UINT32_MAX means capture all the possible data.
|
|
|
|
|
* @param ring
|
|
|
|
|
* The ring on which captured packets will be enqueued for user.
|
|
|
|
|
* @param mp
|
|
|
|
|
* The mempool on to which original packets will be mirrored or duplicated.
|
|
|
|
|
* @param filter
|
|
|
|
|
* Use BPF program to run to filter packes (can be NULL)
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* 0 on success, -1 on error, rte_errno is set accordingly.
|
|
|
|
|
*/
|
|
|
|
|
__rte_experimental
|
|
|
|
|
int
|
|
|
|
|
rte_pdump_enable_bpf_by_deviceid(const char *device_id, uint16_t queue,
|
|
|
|
|
uint32_t flags, uint32_t snaplen,
|
|
|
|
|
struct rte_ring *ring,
|
|
|
|
|
struct rte_mempool *mp,
|
|
|
|
|
const struct rte_bpf_prm *filter);
|
|
|
|
|
|
|
|
|
|
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
/**
|
|
|
|
|
* Disables packet capturing on given device_id and queue.
|
|
|
|
|
* device_id can be name or pci address of device.
|
|
|
|
|
*
|
|
|
|
|
* @param device_id
|
|
|
|
|
* pci address or name of the device on which packet capturing
|
|
|
|
|
* should be disabled.
|
|
|
|
|
* @param queue
|
|
|
|
|
* queue of a given device on which packet capturing should be disabled.
|
|
|
|
|
* users should pass on value UINT16_MAX to disable packet capturing on all
|
|
|
|
|
* queues of a given device id.
|
|
|
|
|
* @param flags
|
|
|
|
|
* flags specifies RTE_PDUMP_FLAG_RX/RTE_PDUMP_FLAG_TX/RTE_PDUMP_FLAG_RXTX
|
|
|
|
|
* on which packet capturing should be enabled for a given port and queue.
|
|
|
|
|
*
|
|
|
|
|
* @return
|
|
|
|
|
* 0 on success, -1 on error, rte_errno is set accordingly.
|
|
|
|
|
*/
|
|
|
|
|
int
|
|
|
|
|
rte_pdump_disable_by_deviceid(char *device_id, uint16_t queue,
|
|
|
|
|
uint32_t flags);
|
|
|
|
|
|
2021-10-20 14:42:30 -07:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* A structure used to retrieve statistics from packet capture.
|
|
|
|
|
* The statistics are sum of both receive and transmit queues.
|
|
|
|
|
*/
|
|
|
|
|
struct rte_pdump_stats {
|
|
|
|
|
uint64_t accepted; /**< Number of packets accepted by filter. */
|
|
|
|
|
uint64_t filtered; /**< Number of packets rejected by filter. */
|
|
|
|
|
uint64_t nombuf; /**< Number of mbuf allocation failures. */
|
|
|
|
|
uint64_t ringfull; /**< Number of missed packets due to ring full. */
|
|
|
|
|
|
|
|
|
|
uint64_t reserved[4]; /**< Reserved and pad to cache line */
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @warning
|
|
|
|
|
* @b EXPERIMENTAL: this API may change, or be removed, without prior notice
|
|
|
|
|
*
|
|
|
|
|
* Retrieve the packet capture statistics for a queue.
|
|
|
|
|
*
|
|
|
|
|
* @param port_id
|
|
|
|
|
* The port identifier of the Ethernet device.
|
|
|
|
|
* @param stats
|
|
|
|
|
* A pointer to structure of type *rte_pdump_stats* to be filled in.
|
|
|
|
|
* @return
|
|
|
|
|
* Zero if successful. -1 on error and rte_errno is set.
|
|
|
|
|
*/
|
|
|
|
|
__rte_experimental
|
|
|
|
|
int
|
|
|
|
|
rte_pdump_stats(uint16_t port_id, struct rte_pdump_stats *stats);
|
|
|
|
|
|
|
|
|
|
|
pdump: add new library for packet capture
The librte_pdump library provides a framework for
packet capturing in dpdk. The library provides set of
APIs to initialize the packet capture framework, to
enable or disable the packet capture, and to uninitialize
it.
The librte_pdump library works on a client/server model.
The server is responsible for enabling or disabling the
packet capture and the clients are responsible
for requesting the enabling or disabling of the packet
capture.
Enabling APIs are supported with port, queue, ring and
mempool parameters. Applications should pass on this information
to get the packets from the dpdk ports.
For enabling requests from applications, library creates the client
request containing the mempool, ring, port and queue information and
sends the request to the server. After receiving the request, server
registers the Rx and Tx callbacks for all the port and queues.
After the callbacks registration, registered callbacks will get the
Rx and Tx packets. Packets then will be copied to the new mbufs that
are allocated from the user passed mempool. These new mbufs then will
be enqueued to the application passed ring. Applications need to dequeue
the mbufs from the rings and direct them to the devices like
pcap vdev for viewing the packets outside of the dpdk
using the packet capture tools.
For disabling requests, library creates the client request containing
the port and queue information and sends the request to the server.
After receiving the request, server removes the Rx and Tx callback
for all the port and queues.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
2016-06-15 15:06:22 +01:00
|
|
|
#ifdef __cplusplus
|
|
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
#endif /* _RTE_PDUMP_H_ */
|
