DPDK  17.05.2
rte_pdump.h
Go to the documentation of this file.
1 /*-
2  * BSD LICENSE
3  *
4  * Copyright(c) 2016 Intel Corporation. All rights reserved.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  * * Neither the name of Intel Corporation nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef _RTE_PDUMP_H_
35 #define _RTE_PDUMP_H_
36 
44 #include <stdint.h>
45 #include <rte_mempool.h>
46 #include <rte_ring.h>
47 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 #define RTE_PDUMP_ALL_QUEUES UINT16_MAX
53 
54 enum {
55  RTE_PDUMP_FLAG_RX = 1, /* receive direction */
56  RTE_PDUMP_FLAG_TX = 2, /* transmit direction */
57  /* both receive and transmit directions */
58  RTE_PDUMP_FLAG_RXTX = (RTE_PDUMP_FLAG_RX|RTE_PDUMP_FLAG_TX)
59 };
60 
61 enum rte_pdump_socktype {
62  RTE_PDUMP_SOCKET_SERVER = 1,
63  RTE_PDUMP_SOCKET_CLIENT = 2
64 };
65 
78 int
79 rte_pdump_init(const char *path);
80 
89 int
90 rte_pdump_uninit(void);
91 
115 int
116 rte_pdump_enable(uint8_t port, uint16_t queue, uint32_t flags,
117  struct rte_ring *ring,
118  struct rte_mempool *mp,
119  void *filter);
120 
138 int
139 rte_pdump_disable(uint8_t port, uint16_t queue, uint32_t flags);
140 
165 int
166 rte_pdump_enable_by_deviceid(char *device_id, uint16_t queue,
167  uint32_t flags,
168  struct rte_ring *ring,
169  struct rte_mempool *mp,
170  void *filter);
171 
190 int
191 rte_pdump_disable_by_deviceid(char *device_id, uint16_t queue,
192  uint32_t flags);
193 
213 int
214 rte_pdump_set_socket_dir(const char *path, enum rte_pdump_socktype type);
215 
216 #ifdef __cplusplus
217 }
218 #endif
219 
220 #endif /* _RTE_PDUMP_H_ */