1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
5 #ifndef _RTE_FLOW_CLASSIFY_H_
6 #define _RTE_FLOW_CLASSIFY_H_
11 * RTE Flow Classify Library
13 * @b EXPERIMENTAL: this API may change without prior notice
15 * This library provides flow record information with some measured properties.
17 * Application should define the flow and measurement criteria (action) for it.
19 * The Library doesn't maintain any flow records itself, instead flow
20 * information is returned to upper layer only for given packets.
22 * It is application's responsibility to call rte_flow_classifier_query()
23 * for a burst of packets, just after receiving them or before transmitting
25 * Application should provide the flow type interested in, measurement to apply
26 * to that flow in rte_flow_classify_table_entry_add() API, and should provide
27 * the rte_flow_classifier object and storage to put results in for the
28 * rte_flow_classifier_query() API.
31 * - application calls rte_flow_classifier_create() to create an
32 * rte_flow_classifier object.
33 * - application calls rte_flow_classify_table_create() to create a table
34 * in the rte_flow_classifier object.
35 * - application calls rte_flow_classify_table_entry_add() to add a rule to
36 * the table in the rte_flow_classifier object.
37 * - application calls rte_flow_classifier_query() in a polling manner,
38 * preferably after rte_eth_rx_burst(). This will cause the library to
39 * match packet information to flow information with some measurements.
40 * - rte_flow_classifier object can be destroyed when it is no longer needed
41 * with rte_flow_classifier_free()
44 #include <rte_compat.h>
45 #include <rte_common.h>
46 #include <rte_ethdev.h>
47 #include <rte_ether.h>
50 #include <rte_table_acl.h>
56 extern int librte_flow_classify_logtype;
58 #define RTE_FLOW_CLASSIFY_LOG(level, ...) \
59 rte_log(RTE_LOG_ ## level, \
60 librte_flow_classify_logtype, \
61 RTE_FMT("%s(): " RTE_FMT_HEAD(__VA_ARGS__,), \
63 RTE_FMT_TAIL(__VA_ARGS__,)))
65 #ifndef RTE_FLOW_CLASSIFY_TABLE_MAX
66 #define RTE_FLOW_CLASSIFY_TABLE_MAX 32
69 /** Opaque data type for flow classifier */
70 struct rte_flow_classifier;
72 /** Opaque data type for flow classify rule */
73 struct rte_flow_classify_rule;
75 /** Flow classify rule type */
76 enum rte_flow_classify_rule_type {
78 RTE_FLOW_CLASSIFY_RULE_TYPE_NONE,
79 /** IPv4 5tuple type */
80 RTE_FLOW_CLASSIFY_RULE_TYPE_IPV4_5TUPLE,
83 /** Flow classify table type */
84 enum rte_flow_classify_table_type {
86 RTE_FLOW_CLASSIFY_TABLE_TYPE_NONE = 1 << 0,
88 RTE_FLOW_CLASSIFY_TABLE_ACL_IP4_5TUPLE = 1 << 1,
89 /** ACL VLAN IP4 5TUPLE */
90 RTE_FLOW_CLASSIFY_TABLE_ACL_VLAN_IP4_5TUPLE = 1 << 2,
91 /** ACL QinQ IP4 5TUPLE */
92 RTE_FLOW_CLASSIFY_TABLE_ACL_QINQ_IP4_5TUPLE = 1 << 3,
96 /** Parameters for flow classifier creation */
97 struct rte_flow_classifier_params {
98 /** flow classifier name */
101 /** CPU socket ID where memory for the flow classifier and its */
102 /** elements (tables) should be allocated */
106 /** Parameters for table creation */
107 struct rte_flow_classify_table_params {
108 /** Table operations (specific to each table type) */
109 struct rte_table_ops *ops;
111 /** Opaque param to be passed to the table create operation */
114 /** Classifier table type */
115 enum rte_flow_classify_table_type type;
118 /** IPv4 5-tuple data */
119 struct rte_flow_classify_ipv4_5tuple {
120 uint32_t dst_ip; /**< Destination IP address in big endian. */
121 uint32_t dst_ip_mask; /**< Mask of destination IP address. */
122 uint32_t src_ip; /**< Source IP address in big endian. */
123 uint32_t src_ip_mask; /**< Mask of destination IP address. */
124 uint16_t dst_port; /**< Destination port in big endian. */
125 uint16_t dst_port_mask; /**< Mask of destination port. */
126 uint16_t src_port; /**< Source Port in big endian. */
127 uint16_t src_port_mask; /**< Mask of source port. */
128 uint8_t proto; /**< L4 protocol. */
129 uint8_t proto_mask; /**< Mask of L4 protocol. */
135 * For the count action, stats can be returned by the query API.
137 * Storage for stats is provided by application.
139 struct rte_flow_classify_stats {
143 struct rte_flow_classify_ipv4_5tuple_stats {
144 /** count of packets that match IPv4 5tuple pattern */
146 /** IPv4 5tuple data */
147 struct rte_flow_classify_ipv4_5tuple ipv4_5tuple;
151 * Flow classifier create
154 * Parameters for flow classifier creation
156 * Handle to flow classifier instance on success or NULL otherwise
159 struct rte_flow_classifier *
160 rte_flow_classifier_create(struct rte_flow_classifier_params *params);
163 * Flow classifier free
166 * Handle to flow classifier instance
168 * 0 on success, error code otherwise
172 rte_flow_classifier_free(struct rte_flow_classifier *cls);
175 * Flow classify table create
178 * Handle to flow classifier instance
180 * Parameters for flow_classify table creation
182 * 0 on success, error code otherwise
186 rte_flow_classify_table_create(struct rte_flow_classifier *cls,
187 struct rte_flow_classify_table_params *params);
190 * Flow classify validate
193 * Handle to flow classifier instance
195 * Flow rule attributes
197 * Pattern specification (list terminated by the END pattern item).
199 * Associated actions (list terminated by the END pattern item).
201 * Perform verbose error reporting if not NULL. Structure
202 * initialised in case of error only.
204 * 0 on success, error code otherwise
208 rte_flow_classify_validate(struct rte_flow_classifier *cls,
209 const struct rte_flow_attr *attr,
210 const struct rte_flow_item pattern[],
211 const struct rte_flow_action actions[],
212 struct rte_flow_error *error);
215 * Add a flow classify rule to the flow_classifier table.
218 * Flow classifier handle
220 * Flow rule attributes
222 * Pattern specification (list terminated by the END pattern item).
224 * Associated actions (list terminated by the END pattern item).
225 * @param[out] key_found
226 * returns 1 if rule present already, 0 otherwise.
228 * Perform verbose error reporting if not NULL. Structure
229 * initialised in case of error only.
231 * A valid handle in case of success, NULL otherwise.
234 struct rte_flow_classify_rule *
235 rte_flow_classify_table_entry_add(struct rte_flow_classifier *cls,
236 const struct rte_flow_attr *attr,
237 const struct rte_flow_item pattern[],
238 const struct rte_flow_action actions[],
240 struct rte_flow_error *error);
243 * Delete a flow classify rule from the flow_classifier table.
246 * Flow classifier handle
250 * 0 on success, error code otherwise.
254 rte_flow_classify_table_entry_delete(struct rte_flow_classifier *cls,
255 struct rte_flow_classify_rule *rule);
258 * Query flow classifier for given rule.
261 * Flow classifier handle
263 * Pointer to packets to process
265 * Number of packets to process
269 * Flow classify stats
272 * 0 on success, error code otherwise.
276 rte_flow_classifier_query(struct rte_flow_classifier *cls,
277 struct rte_mbuf **pkts,
278 const uint16_t nb_pkts,
279 struct rte_flow_classify_rule *rule,
280 struct rte_flow_classify_stats *stats);
286 #endif /* _RTE_FLOW_CLASSIFY_H_ */