1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2018 Mellanox Technologies, Ltd
5 #ifndef RTE_PMD_MLX5_FLOW_H_
6 #define RTE_PMD_MLX5_FLOW_H_
8 #include <netinet/in.h>
15 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
17 #pragma GCC diagnostic ignored "-Wpedantic"
19 #include <infiniband/verbs.h>
21 #pragma GCC diagnostic error "-Wpedantic"
24 /* Pattern outer Layer bits. */
25 #define MLX5_FLOW_LAYER_OUTER_L2 (1u << 0)
26 #define MLX5_FLOW_LAYER_OUTER_L3_IPV4 (1u << 1)
27 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6 (1u << 2)
28 #define MLX5_FLOW_LAYER_OUTER_L4_UDP (1u << 3)
29 #define MLX5_FLOW_LAYER_OUTER_L4_TCP (1u << 4)
30 #define MLX5_FLOW_LAYER_OUTER_VLAN (1u << 5)
32 /* Pattern inner Layer bits. */
33 #define MLX5_FLOW_LAYER_INNER_L2 (1u << 6)
34 #define MLX5_FLOW_LAYER_INNER_L3_IPV4 (1u << 7)
35 #define MLX5_FLOW_LAYER_INNER_L3_IPV6 (1u << 8)
36 #define MLX5_FLOW_LAYER_INNER_L4_UDP (1u << 9)
37 #define MLX5_FLOW_LAYER_INNER_L4_TCP (1u << 10)
38 #define MLX5_FLOW_LAYER_INNER_VLAN (1u << 11)
40 /* Pattern tunnel Layer bits. */
41 #define MLX5_FLOW_LAYER_VXLAN (1u << 12)
42 #define MLX5_FLOW_LAYER_VXLAN_GPE (1u << 13)
43 #define MLX5_FLOW_LAYER_GRE (1u << 14)
44 #define MLX5_FLOW_LAYER_MPLS (1u << 15)
47 #define MLX5_FLOW_LAYER_OUTER_L3 \
48 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_OUTER_L3_IPV6)
49 #define MLX5_FLOW_LAYER_OUTER_L4 \
50 (MLX5_FLOW_LAYER_OUTER_L4_UDP | MLX5_FLOW_LAYER_OUTER_L4_TCP)
51 #define MLX5_FLOW_LAYER_OUTER \
52 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_OUTER_L3 | \
53 MLX5_FLOW_LAYER_OUTER_L4)
56 #define MLX5_FLOW_LAYER_TUNNEL \
57 (MLX5_FLOW_LAYER_VXLAN | MLX5_FLOW_LAYER_VXLAN_GPE | \
58 MLX5_FLOW_LAYER_GRE | MLX5_FLOW_LAYER_MPLS)
61 #define MLX5_FLOW_LAYER_INNER_L3 \
62 (MLX5_FLOW_LAYER_INNER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
63 #define MLX5_FLOW_LAYER_INNER_L4 \
64 (MLX5_FLOW_LAYER_INNER_L4_UDP | MLX5_FLOW_LAYER_INNER_L4_TCP)
65 #define MLX5_FLOW_LAYER_INNER \
66 (MLX5_FLOW_LAYER_INNER_L2 | MLX5_FLOW_LAYER_INNER_L3 | \
67 MLX5_FLOW_LAYER_INNER_L4)
70 #define MLX5_FLOW_ACTION_DROP (1u << 0)
71 #define MLX5_FLOW_ACTION_QUEUE (1u << 1)
72 #define MLX5_FLOW_ACTION_RSS (1u << 2)
73 #define MLX5_FLOW_ACTION_FLAG (1u << 3)
74 #define MLX5_FLOW_ACTION_MARK (1u << 4)
75 #define MLX5_FLOW_ACTION_COUNT (1u << 5)
76 #define MLX5_FLOW_ACTION_PORT_ID (1u << 6)
77 #define MLX5_FLOW_ACTION_OF_POP_VLAN (1u << 7)
78 #define MLX5_FLOW_ACTION_OF_PUSH_VLAN (1u << 8)
79 #define MLX5_FLOW_ACTION_OF_SET_VLAN_VID (1u << 9)
80 #define MLX5_FLOW_ACTION_OF_SET_VLAN_PCP (1u << 10)
82 #define MLX5_FLOW_FATE_ACTIONS \
83 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_QUEUE | MLX5_FLOW_ACTION_RSS)
86 #define IPPROTO_MPLS 137
89 /* UDP port numbers for VxLAN. */
90 #define MLX5_UDP_PORT_VXLAN 4789
91 #define MLX5_UDP_PORT_VXLAN_GPE 4790
93 /* Priority reserved for default flows. */
94 #define MLX5_FLOW_PRIO_RSVD ((uint32_t)-1)
97 * Number of sub priorities.
98 * For each kind of pattern matching i.e. L2, L3, L4 to have a correct
99 * matching on the NIC (firmware dependent) L4 most have the higher priority
100 * followed by L3 and ending with L2.
102 #define MLX5_PRIORITY_MAP_L2 2
103 #define MLX5_PRIORITY_MAP_L3 1
104 #define MLX5_PRIORITY_MAP_L4 0
105 #define MLX5_PRIORITY_MAP_MAX 3
107 /* Valid layer type for IPV4 RSS. */
108 #define MLX5_IPV4_LAYER_TYPES \
109 (ETH_RSS_IPV4 | ETH_RSS_FRAG_IPV4 | \
110 ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_NONFRAG_IPV4_UDP | \
111 ETH_RSS_NONFRAG_IPV4_OTHER)
113 /* IBV hash source bits for IPV4. */
114 #define MLX5_IPV4_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
116 /* Valid layer type for IPV6 RSS. */
117 #define MLX5_IPV6_LAYER_TYPES \
118 (ETH_RSS_IPV6 | ETH_RSS_FRAG_IPV6 | ETH_RSS_NONFRAG_IPV6_TCP | \
119 ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_IPV6_EX | ETH_RSS_IPV6_TCP_EX | \
120 ETH_RSS_IPV6_UDP_EX | ETH_RSS_NONFRAG_IPV6_OTHER)
122 /* IBV hash source bits for IPV6. */
123 #define MLX5_IPV6_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
125 /* Max number of actions per DV flow. */
126 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
128 enum mlx5_flow_drv_type {
132 MLX5_FLOW_TYPE_VERBS,
136 /* Matcher PRM representation */
137 struct mlx5_flow_dv_match_params {
139 /**< Size of match value. Do NOT split size and key! */
140 uint32_t buf[MLX5_ST_SZ_DW(fte_match_param)];
141 /**< Matcher value. This value is used as the mask or as a key. */
144 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
146 /* Matcher structure. */
147 struct mlx5_flow_dv_matcher {
148 LIST_ENTRY(mlx5_flow_dv_matcher) next;
149 /* Pointer to the next element. */
150 rte_atomic32_t refcnt; /**< Reference counter. */
151 void *matcher_object; /**< Pointer to DV matcher */
152 uint16_t crc; /**< CRC of key. */
153 uint16_t priority; /**< Priority of matcher. */
154 uint8_t egress; /**< Egress matcher. */
155 struct mlx5_flow_dv_match_params mask; /**< Matcher mask. */
158 /* DV flows structure. */
159 struct mlx5_flow_dv {
160 uint64_t hash_fields; /**< Fields that participate in the hash. */
161 struct mlx5_hrxq *hrxq; /**< Hash Rx queues. */
163 struct mlx5_flow_dv_matcher *matcher; /**< Cache to matcher. */
164 struct mlx5_flow_dv_match_params value;
165 /**< Holds the value that the packet is compared to. */
166 struct ibv_flow *flow; /**< Installed flow. */
167 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
168 struct mlx5dv_flow_action_attr actions[MLX5_DV_MAX_NUMBER_OF_ACTIONS];
171 int actions_n; /**< number of actions. */
174 /** Linux TC flower driver for E-Switch flow. */
175 struct mlx5_flow_tcf {
176 struct nlmsghdr *nlh;
180 /* Verbs specification header. */
181 struct ibv_spec_header {
182 enum ibv_flow_spec_type type;
186 /** Handles information leading to a drop fate. */
187 struct mlx5_flow_verbs {
188 LIST_ENTRY(mlx5_flow_verbs) next;
189 unsigned int size; /**< Size of the attribute. */
191 struct ibv_flow_attr *attr;
192 /**< Pointer to the Specification buffer. */
193 uint8_t *specs; /**< Pointer to the specifications. */
195 struct ibv_flow *flow; /**< Verbs flow pointer. */
196 struct mlx5_hrxq *hrxq; /**< Hash Rx queue object. */
197 uint64_t hash_fields; /**< Verbs hash Rx queue hash fields. */
200 /** Device flow structure. */
202 LIST_ENTRY(mlx5_flow) next;
203 struct rte_flow *flow; /**< Pointer to the main flow. */
204 uint32_t layers; /**< Bit-fields that holds the detected layers. */
206 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
207 struct mlx5_flow_dv dv;
209 struct mlx5_flow_tcf tcf;
210 struct mlx5_flow_verbs verbs;
214 /* Counters information. */
215 struct mlx5_flow_counter {
216 LIST_ENTRY(mlx5_flow_counter) next; /**< Pointer to the next counter. */
217 uint32_t shared:1; /**< Share counter ID with other flow rules. */
218 uint32_t ref_cnt:31; /**< Reference counter. */
219 uint32_t id; /**< Counter ID. */
220 struct ibv_counter_set *cs; /**< Holds the counters for the rule. */
221 uint64_t hits; /**< Number of packets matched by the rule. */
222 uint64_t bytes; /**< Number of bytes matched by the rule. */
225 /* Flow structure. */
227 TAILQ_ENTRY(rte_flow) next; /**< Pointer to the next flow structure. */
228 enum mlx5_flow_drv_type drv_type; /**< Drvier type. */
230 /**< Bit-fields of present layers see MLX5_FLOW_LAYER_*. */
231 struct mlx5_flow_counter *counter; /**< Holds flow counter. */
232 struct rte_flow_action_rss rss;/**< RSS context. */
233 uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
234 uint16_t (*queue)[]; /**< Destination queues to redirect traffic to. */
235 void *nl_flow; /**< Netlink flow buffer if relevant. */
236 LIST_HEAD(dev_flows, mlx5_flow) dev_flows;
237 /**< Device flows that are part of the flow. */
238 uint32_t actions; /**< Bit-fields which mark all detected actions. */
240 typedef int (*mlx5_flow_validate_t)(struct rte_eth_dev *dev,
241 const struct rte_flow_attr *attr,
242 const struct rte_flow_item items[],
243 const struct rte_flow_action actions[],
244 struct rte_flow_error *error);
245 typedef struct mlx5_flow *(*mlx5_flow_prepare_t)
246 (const struct rte_flow_attr *attr, const struct rte_flow_item items[],
247 const struct rte_flow_action actions[], uint64_t *item_flags,
248 uint64_t *action_flags, struct rte_flow_error *error);
249 typedef int (*mlx5_flow_translate_t)(struct rte_eth_dev *dev,
250 struct mlx5_flow *dev_flow,
251 const struct rte_flow_attr *attr,
252 const struct rte_flow_item items[],
253 const struct rte_flow_action actions[],
254 struct rte_flow_error *error);
255 typedef int (*mlx5_flow_apply_t)(struct rte_eth_dev *dev, struct rte_flow *flow,
256 struct rte_flow_error *error);
257 typedef void (*mlx5_flow_remove_t)(struct rte_eth_dev *dev,
258 struct rte_flow *flow);
259 typedef void (*mlx5_flow_destroy_t)(struct rte_eth_dev *dev,
260 struct rte_flow *flow);
261 struct mlx5_flow_driver_ops {
262 mlx5_flow_validate_t validate;
263 mlx5_flow_prepare_t prepare;
264 mlx5_flow_translate_t translate;
265 mlx5_flow_apply_t apply;
266 mlx5_flow_remove_t remove;
267 mlx5_flow_destroy_t destroy;
272 uint64_t mlx5_flow_hashfields_adjust(struct mlx5_flow *dev_flow, int tunnel,
273 uint32_t layer_types,
274 uint64_t hash_fields);
275 uint32_t mlx5_flow_adjust_priority(struct rte_eth_dev *dev, int32_t priority,
276 uint32_t subpriority);
277 int mlx5_flow_validate_action_count(struct rte_eth_dev *dev,
278 struct rte_flow_error *error);
279 int mlx5_flow_validate_action_drop(uint64_t action_flags,
280 struct rte_flow_error *error);
281 int mlx5_flow_validate_action_flag(uint64_t action_flags,
282 struct rte_flow_error *error);
283 int mlx5_flow_validate_action_mark(const struct rte_flow_action *action,
284 uint64_t action_flags,
285 struct rte_flow_error *error);
286 int mlx5_flow_validate_action_queue(const struct rte_flow_action *action,
287 uint64_t action_flags,
288 struct rte_eth_dev *dev,
289 struct rte_flow_error *error);
290 int mlx5_flow_validate_action_rss(const struct rte_flow_action *action,
291 uint64_t action_flags,
292 struct rte_eth_dev *dev,
293 struct rte_flow_error *error);
294 int mlx5_flow_validate_attributes(struct rte_eth_dev *dev,
295 const struct rte_flow_attr *attributes,
296 struct rte_flow_error *error);
297 int mlx5_flow_validate_item_eth(const struct rte_flow_item *item,
299 struct rte_flow_error *error);
300 int mlx5_flow_validate_item_gre(const struct rte_flow_item *item,
302 uint8_t target_protocol,
303 struct rte_flow_error *error);
304 int mlx5_flow_validate_item_ipv4(const struct rte_flow_item *item,
306 struct rte_flow_error *error);
307 int mlx5_flow_validate_item_ipv6(const struct rte_flow_item *item,
309 struct rte_flow_error *error);
310 int mlx5_flow_validate_item_mpls(const struct rte_flow_item *item,
312 uint8_t target_protocol,
313 struct rte_flow_error *error);
314 int mlx5_flow_validate_item_tcp(const struct rte_flow_item *item,
316 uint8_t target_protocol,
317 struct rte_flow_error *error);
318 int mlx5_flow_validate_item_udp(const struct rte_flow_item *item,
320 uint8_t target_protocol,
321 struct rte_flow_error *error);
322 int mlx5_flow_validate_item_vlan(const struct rte_flow_item *item,
324 struct rte_flow_error *error);
325 int mlx5_flow_validate_item_vxlan(const struct rte_flow_item *item,
327 struct rte_flow_error *error);
328 int mlx5_flow_validate_item_vxlan_gpe(const struct rte_flow_item *item,
330 struct rte_eth_dev *dev,
331 struct rte_flow_error *error);
333 /* mlx5_flow_tcf.c */
335 int mlx5_flow_tcf_init(struct mnl_socket *nl, unsigned int ifindex,
336 struct rte_flow_error *error);
337 struct mnl_socket *mlx5_flow_tcf_socket_create(void);
338 void mlx5_flow_tcf_socket_destroy(struct mnl_socket *nl);
340 #endif /* RTE_PMD_MLX5_FLOW_H_ */