suricata
util-dpdk-common.h
Go to the documentation of this file.
1 /* Copyright (C) 2025 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /**
19  * \file
20  *
21  * \author Lukas Sismis <lsismis@oisf.net>
22  */
23 
24 #ifndef UTIL_DPDK_COMMON_H
25 #define UTIL_DPDK_COMMON_H
26 
27 #ifdef HAVE_DPDK
28 
29 #include <rte_eal.h>
30 #include <rte_ethdev.h>
31 #ifdef HAVE_DPDK_BOND
32 #include <rte_eth_bond.h>
33 #endif
34 #include <rte_launch.h>
35 #include <rte_lcore.h>
36 #include <rte_log.h>
37 #include <rte_mempool.h>
38 #include <rte_mbuf.h>
39 #include <rte_flow.h>
40 #include <rte_kvargs.h>
41 #include <rte_version.h>
42 
43 #if RTE_VERSION < RTE_VERSION_NUM(22, 0, 0, 0)
44 #define RTE_ETH_MQ_RX_RSS ETH_MQ_RX_RSS
45 #endif
46 
47 #if RTE_VERSION < RTE_VERSION_NUM(21, 11, 0, 0)
48 #define RTE_ETH_TX_OFFLOAD_MBUF_FAST_FREE DEV_TX_OFFLOAD_MBUF_FAST_FREE
49 
50 #define RTE_ETH_RX_OFFLOAD_CHECKSUM DEV_RX_OFFLOAD_CHECKSUM
51 
52 #define RTE_ETH_RX_OFFLOAD_VLAN_STRIP DEV_RX_OFFLOAD_VLAN_STRIP
53 #define RTE_ETH_RX_OFFLOAD_IPV4_CKSUM DEV_RX_OFFLOAD_IPV4_CKSUM
54 #define RTE_ETH_RX_OFFLOAD_UDP_CKSUM DEV_RX_OFFLOAD_UDP_CKSUM
55 #define RTE_ETH_RX_OFFLOAD_TCP_CKSUM DEV_RX_OFFLOAD_TCP_CKSUM
56 #define RTE_ETH_RX_OFFLOAD_TCP_LRO DEV_RX_OFFLOAD_TCP_LRO
57 #define RTE_ETH_RX_OFFLOAD_QINQ_STRIP DEV_RX_OFFLOAD_QINQ_STRIP
58 #define RTE_ETH_RX_OFFLOAD_OUTER_IPV4_CKSUM DEV_RX_OFFLOAD_OUTER_IPV4_CKSUM
59 #define RTE_ETH_RX_OFFLOAD_MACSEC_STRIP DEV_RX_OFFLOAD_MACSEC_STRIP
60 #define RTE_ETH_RX_OFFLOAD_HEADER_SPLIT DEV_RX_OFFLOAD_HEADER_SPLIT
61 #define RTE_ETH_RX_OFFLOAD_VLAN_FILTER DEV_RX_OFFLOAD_VLAN_FILTER
62 #define RTE_ETH_RX_OFFLOAD_VLAN_EXTEND DEV_RX_OFFLOAD_VLAN_EXTEND
63 #define RTE_ETH_RX_OFFLOAD_SCATTER DEV_RX_OFFLOAD_SCATTER
64 #define RTE_ETH_RX_OFFLOAD_TIMESTAMP DEV_RX_OFFLOAD_TIMESTAMP
65 #define RTE_ETH_RX_OFFLOAD_SECURITY DEV_RX_OFFLOAD_SECURITY
66 #define RTE_ETH_RX_OFFLOAD_KEEP_CRC DEV_RX_OFFLOAD_KEEP_CRC
67 #define RTE_ETH_RX_OFFLOAD_SCTP_CKSUM DEV_RX_OFFLOAD_SCTP_CKSUM
68 #define RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM DEV_RX_OFFLOAD_OUTER_UDP_CKSUM
69 #define RTE_ETH_RX_OFFLOAD_RSS_HASH DEV_RX_OFFLOAD_RSS_HASH
70 
71 #define RTE_ETH_MQ_TX_NONE ETH_MQ_TX_NONE
72 
73 #define RTE_ETH_MQ_RX_NONE ETH_MQ_RX_NONE
74 
75 #define RTE_ETH_RSS_IP ETH_RSS_IP
76 #define RTE_ETH_RSS_UDP ETH_RSS_UDP
77 #define RTE_ETH_RSS_TCP ETH_RSS_TCP
78 #define RTE_ETH_RSS_SCTP ETH_RSS_SCTP
79 #define RTE_ETH_RSS_TUNNEL ETH_RSS_TUNNEL
80 
81 #define RTE_ETH_RSS_L3_SRC_ONLY ETH_RSS_L3_SRC_ONLY
82 #define RTE_ETH_RSS_L3_DST_ONLY ETH_RSS_L3_DST_ONLY
83 #define RTE_ETH_RSS_L4_SRC_ONLY ETH_RSS_L4_SRC_ONLY
84 #define RTE_ETH_RSS_L4_DST_ONLY ETH_RSS_L4_DST_ONLY
85 
86 #define RTE_ETH_RSS_IPV4 ETH_RSS_IPV4
87 #define RTE_ETH_RSS_FRAG_IPV4 ETH_RSS_FRAG_IPV4
88 #define RTE_ETH_RSS_NONFRAG_IPV4_TCP ETH_RSS_NONFRAG_IPV4_TCP
89 #define RTE_ETH_RSS_NONFRAG_IPV4_UDP ETH_RSS_NONFRAG_IPV4_UDP
90 #define RTE_ETH_RSS_NONFRAG_IPV4_SCTP ETH_RSS_NONFRAG_IPV4_SCTP
91 #define RTE_ETH_RSS_NONFRAG_IPV4_OTHER ETH_RSS_NONFRAG_IPV4_OTHER
92 #define RTE_ETH_RSS_IPV6 ETH_RSS_IPV6
93 #define RTE_ETH_RSS_FRAG_IPV6 ETH_RSS_FRAG_IPV6
94 #define RTE_ETH_RSS_NONFRAG_IPV6_TCP ETH_RSS_NONFRAG_IPV6_TCP
95 #define RTE_ETH_RSS_NONFRAG_IPV6_UDP ETH_RSS_NONFRAG_IPV6_UDP
96 #define RTE_ETH_RSS_NONFRAG_IPV6_SCTP ETH_RSS_NONFRAG_IPV6_SCTP
97 #define RTE_ETH_RSS_NONFRAG_IPV6_OTHER ETH_RSS_NONFRAG_IPV6_OTHER
98 #define RTE_ETH_RSS_L2_PAYLOAD ETH_RSS_L2_PAYLOAD
99 #define RTE_ETH_RSS_IPV6_EX ETH_RSS_IPV6_EX
100 #define RTE_ETH_RSS_IPV6_TCP_EX ETH_RSS_IPV6_TCP_EX
101 #define RTE_ETH_RSS_IPV6_UDP_EX ETH_RSS_IPV6_UDP_EX
102 #define RTE_ETH_RSS_PORT ETH_RSS_PORT
103 #define RTE_ETH_RSS_VXLAN ETH_RSS_VXLAN
104 #define RTE_ETH_RSS_NVGRE ETH_RSS_NVGRE
105 #define RTE_ETH_RSS_GTPU ETH_RSS_GTPU
106 
107 #define RTE_MBUF_F_RX_IP_CKSUM_MASK PKT_RX_IP_CKSUM_MASK
108 #define RTE_MBUF_F_RX_IP_CKSUM_NONE PKT_RX_IP_CKSUM_NONE
109 #define RTE_MBUF_F_RX_IP_CKSUM_GOOD PKT_RX_IP_CKSUM_GOOD
110 #define RTE_MBUF_F_RX_IP_CKSUM_BAD PKT_RX_IP_CKSUM_BAD
111 
112 #define RTE_MBUF_F_RX_L4_CKSUM_MASK PKT_RX_L4_CKSUM_MASK
113 #define RTE_MBUF_F_RX_L4_CKSUM_GOOD PKT_RX_L4_CKSUM_GOOD
114 #define RTE_MBUF_F_RX_L4_CKSUM_BAD PKT_RX_L4_CKSUM_BAD
115 #endif
116 
117 #if RTE_VERSION < RTE_VERSION_NUM(20, 11, 0, 0)
118 #define RTE_ETH_LINK_MAX_STR_LEN 40
119 #endif
120 
121 typedef struct {
122  struct rte_mempool **pkt_mp;
123  uint16_t pkt_mp_cnt;
124  uint16_t pkt_mp_capa;
125 } DPDKDeviceResources;
126 
127 int DPDKDeviceResourcesInit(DPDKDeviceResources **dpdk_vars, uint16_t mp_cnt);
128 void DPDKDeviceResourcesDeinit(DPDKDeviceResources **dpdk_vars);
129 
130 #endif /* HAVE_DPDK */
131 
132 #endif /* UTIL_DPDK_COMMON_H */