e9436f54af
We already changed to use generic IPC in pdump since below commit:
commit 660098d61f ("pdump: use generic multi-process channel")
The `rte_pdump_set_socket_dir()`, the `path` parameter of
`rte_pdump_init()` and the `enum rte_pdump_socktype` have been
deprecated since then. This commit removes these deprecated
APIs and also bumps the pdump ABI.
Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
Acked-by: Reshma Pattan <reshma.pattan@intel.com>
161 lines
4.3 KiB
C
161 lines
4.3 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright(c) 2016 Intel Corporation
|
|
*/
|
|
|
|
#ifndef _RTE_PDUMP_H_
|
|
#define _RTE_PDUMP_H_
|
|
|
|
/**
|
|
* @file
|
|
* RTE pdump
|
|
*
|
|
* packet dump library to provide packet capturing support on dpdk.
|
|
*/
|
|
|
|
#include <stdint.h>
|
|
#include <rte_mempool.h>
|
|
#include <rte_ring.h>
|
|
|
|
#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 */
|
|
RTE_PDUMP_FLAG_RXTX = (RTE_PDUMP_FLAG_RX|RTE_PDUMP_FLAG_TX)
|
|
};
|
|
|
|
/**
|
|
* Initialize packet capturing handling
|
|
*
|
|
* Register the IPC action for communication with target (primary) process.
|
|
*
|
|
* @return
|
|
* 0 on success, -1 on error
|
|
*/
|
|
int
|
|
rte_pdump_init(void);
|
|
|
|
/**
|
|
* Un initialize packet capturing handling
|
|
*
|
|
* Unregister the IPC action for communication with target (primary) process.
|
|
*
|
|
* @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
|
|
* place holder for packet filtering.
|
|
*
|
|
* @return
|
|
* 0 on success, -1 on error, rte_errno is set accordingly.
|
|
*/
|
|
|
|
int
|
|
rte_pdump_enable(uint16_t port, uint16_t queue, uint32_t flags,
|
|
struct rte_ring *ring,
|
|
struct rte_mempool *mp,
|
|
void *filter);
|
|
|
|
/**
|
|
* 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
|
|
rte_pdump_disable(uint16_t port, uint16_t queue, uint32_t flags);
|
|
|
|
/**
|
|
* 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
|
|
* place holder for packet filtering.
|
|
*
|
|
* @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);
|
|
|
|
/**
|
|
* 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);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _RTE_PDUMP_H_ */
|