DPDK: Data Plane Development Kit

18.02.0-rc0
rte_pdump.h File Reference
#include <stdint.h>
#include <rte_mempool.h>
#include <rte_ring.h>

Go to the source code of this file.

Functions

int rte_pdump_init (const char *path)
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)
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)
int rte_pdump_disable_by_deviceid (char *device_id, uint16_t queue, uint32_t flags)
int rte_pdump_set_socket_dir (const char *path, enum rte_pdump_socktype type)

Detailed Description

RTE pdump

packet dump library to provide packet capturing support on dpdk.

Definition in file rte_pdump.h.

Function Documentation

int rte_pdump_init ( const char *  path)

Initialize packet capturing handling

Creates pthread and server socket for handling clients requests to enable/disable rxtx callbacks.

Parameters
pathdirectory path for server socket.
Returns
0 on success, -1 on error
int rte_pdump_uninit ( void  )

Un initialize packet capturing handling

Cancels pthread, close server socket, removes server socket address.

Returns
0 on success, -1 on error
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.
filterplace holder for packet filtering.
Returns
0 on success, -1 on error, rte_errno is set accordingly.
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.
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.
filterplace holder for packet filtering.
Returns
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 
)

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.
int rte_pdump_set_socket_dir ( const char *  path,
enum rte_pdump_socktype  type 
)

Allows applications to set server and client socket paths. If specified path is null default path will be selected, i.e. "/var/run/" for root user and "$HOME" for non root user. Clients also need to call this API to set their server path if the server path is different from default path. This API is not thread-safe.

Parameters
pathdirectory path for server or client socket.
typespecifies RTE_PDUMP_SOCKET_SERVER if socket path is for server. (or) specifies RTE_PDUMP_SOCKET_CLIENT if socket path is for client.
Returns
0 on success, -EINVAL on error