DPDK  23.03.0
Data Structures | Functions
rte_pdump.h File Reference
#include <stdint.h>
#include <rte_compat.h>
#include <rte_bpf.h>

Go to the source code of this file.

Data Structures

struct  rte_pdump_stats
 

Functions

int rte_pdump_init (void)
 
int rte_pdump_uninit (void)
 
int rte_pdump_enable (uint16_t port, uint16_t queue, uint32_t flags, struct rte_ring *ring, struct rte_mempool *mp, void *filter)
 
__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)
 
int rte_pdump_disable (uint16_t port, uint16_t queue, uint32_t flags)
 
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)
 
__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)
 
int rte_pdump_disable_by_deviceid (char *device_id, uint16_t queue, uint32_t flags)
 
__rte_experimental int rte_pdump_stats (uint16_t port_id, struct rte_pdump_stats *stats)
 

Detailed Description

RTE pdump

packet dump library to provide packet capturing support on dpdk.

Definition in file rte_pdump.h.

Function Documentation

◆ rte_pdump_init()

int rte_pdump_init ( void  )

Initialize packet capturing handling

Register the IPC action for communication with target (primary) process.

Returns
0 on success, -1 on error

◆ rte_pdump_uninit()

int rte_pdump_uninit ( void  )

Un initialize packet capturing handling

Unregister the IPC action for communication with target (primary) process.

Returns
0 on success, -1 on error

◆ rte_pdump_enable()

int rte_pdump_enable ( uint16_t  port,
uint16_t  queue,
uint32_t  flags,
struct rte_ring ring,
struct rte_mempool mp,
void *  filter 
)

Enables packet capturing on given port and queue.

Parameters
portport on which packet capturing should be enabled.
queuequeue 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.
flagsflags 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.
ringring on which captured packets will be enqueued for user.
mpmempool on to which original packets will be mirrored or duplicated.
filterUnused should be NULL.
Returns
0 on success, -1 on error, rte_errno is set accordingly.

◆ rte_pdump_enable_bpf()

__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 
)
Warning
EXPERIMENTAL: this API may change, or be removed, without prior notice

Enables packet capturing on given port and queue with filtering.

Parameters
port_idThe Ethernet port on which packet capturing should be enabled.
queueThe 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.
flagsPdump library flags that specify direction and packet format.
snaplenThe upper limit on bytes to copy. Passing UINT32_MAX means capture all the possible data.
ringThe ring on which captured packets will be enqueued for user.
mpThe mempool on to which original packets will be mirrored or duplicated.
prmUse BPF program to run to filter packes (can be NULL)
Returns
0 on success, -1 on error, rte_errno is set accordingly.

◆ rte_pdump_disable()

int rte_pdump_disable ( uint16_t  port,
uint16_t  queue,
uint32_t  flags 
)

Disables packet capturing on given port and queue.

Parameters
portport on which packet capturing should be disabled.
queuequeue 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.
flagsflags 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.
Returns
0 on success, -1 on error, rte_errno is set accordingly.

◆ rte_pdump_enable_by_deviceid()

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 
)

Enables packet capturing on given device id and queue. device_id can be name or pci address of device.

Parameters
device_iddevice id on which packet capturing should be enabled.
queuequeue 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.
flagsflags 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.
ringring on which captured packets will be enqueued for user.
mpmempool on to which original packets will be mirrored or duplicated.
filterunused should be NULL
Returns
0 on success, -1 on error, rte_errno is set accordingly.

◆ rte_pdump_enable_bpf_by_deviceid()

__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 
)
Warning
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.

Parameters
device_iddevice id on which packet capturing should be enabled.
queueThe 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.
flagsPdump library flags that specify direction and packet format.
snaplenThe upper limit on bytes to copy. Passing UINT32_MAX means capture all the possible data.
ringThe ring on which captured packets will be enqueued for user.
mpThe mempool on to which original packets will be mirrored or duplicated.
filterUse BPF program to run to filter packes (can be NULL)
Returns
0 on success, -1 on error, rte_errno is set accordingly.

◆ rte_pdump_disable_by_deviceid()

int rte_pdump_disable_by_deviceid ( char *  device_id,
uint16_t  queue,
uint32_t  flags 
)

Disables packet capturing on given device_id and queue. device_id can be name or pci address of device.

Parameters
device_idpci address or name of the device on which packet capturing should be disabled.
queuequeue 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.
flagsflags 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.
Returns
0 on success, -1 on error, rte_errno is set accordingly.

◆ rte_pdump_stats()

__rte_experimental int rte_pdump_stats ( uint16_t  port_id,
struct rte_pdump_stats stats 
)
Warning
EXPERIMENTAL: this API may change, or be removed, without prior notice

Retrieve the packet capture statistics for a queue.

Parameters
port_idThe port identifier of the Ethernet device.
statsA pointer to structure of type rte_pdump_stats to be filled in.
Returns
Zero if successful. -1 on error and rte_errno is set.