1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2016 6WIND S.A.
3 * Copyright 2016 Mellanox Technologies, Ltd
6 #ifndef RTE_FLOW_DRIVER_H_
7 #define RTE_FLOW_DRIVER_H_
11 * RTE generic flow API (driver side)
13 * This file provides implementation helpers for internal use by PMDs, they
14 * are not intended to be exposed to applications and are not subject to ABI
20 #include "rte_ethdev.h"
21 #include "ethdev_driver.h"
29 * Generic flow operations structure implemented and returned by PMDs.
31 * These callback functions are not supposed to be used by applications
32 * directly, which must rely on the API defined in rte_flow.h.
34 * Public-facing wrapper functions perform a few consistency checks so that
35 * unimplemented (i.e. NULL) callbacks simply return -ENOTSUP. These
36 * callbacks otherwise only differ by their first argument (with port ID
37 * already resolved to a pointer to struct rte_eth_dev).
40 /** See rte_flow_validate(). */
42 (struct rte_eth_dev *,
43 const struct rte_flow_attr *,
44 const struct rte_flow_item [],
45 const struct rte_flow_action [],
46 struct rte_flow_error *);
47 /** See rte_flow_create(). */
48 struct rte_flow *(*create)
49 (struct rte_eth_dev *,
50 const struct rte_flow_attr *,
51 const struct rte_flow_item [],
52 const struct rte_flow_action [],
53 struct rte_flow_error *);
54 /** See rte_flow_destroy(). */
56 (struct rte_eth_dev *,
58 struct rte_flow_error *);
59 /** See rte_flow_flush(). */
61 (struct rte_eth_dev *,
62 struct rte_flow_error *);
63 /** See rte_flow_query(). */
65 (struct rte_eth_dev *,
67 const struct rte_flow_action *,
69 struct rte_flow_error *);
70 /** See rte_flow_isolate(). */
72 (struct rte_eth_dev *,
74 struct rte_flow_error *);
75 /** See rte_flow_dev_dump(). */
77 (struct rte_eth_dev *dev,
78 struct rte_flow *flow,
80 struct rte_flow_error *error);
81 /** See rte_flow_get_aged_flows() */
83 (struct rte_eth_dev *dev,
86 struct rte_flow_error *err);
87 /** See rte_flow_action_handle_create() */
88 struct rte_flow_action_handle *(*action_handle_create)
89 (struct rte_eth_dev *dev,
90 const struct rte_flow_indir_action_conf *conf,
91 const struct rte_flow_action *action,
92 struct rte_flow_error *error);
93 /** See rte_flow_action_handle_destroy() */
94 int (*action_handle_destroy)
95 (struct rte_eth_dev *dev,
96 struct rte_flow_action_handle *handle,
97 struct rte_flow_error *error);
98 /** See rte_flow_action_handle_update() */
99 int (*action_handle_update)
100 (struct rte_eth_dev *dev,
101 struct rte_flow_action_handle *handle,
103 struct rte_flow_error *error);
104 /** See rte_flow_action_handle_query() */
105 int (*action_handle_query)
106 (struct rte_eth_dev *dev,
107 const struct rte_flow_action_handle *handle,
109 struct rte_flow_error *error);
110 /** See rte_flow_tunnel_decap_set() */
111 int (*tunnel_decap_set)
112 (struct rte_eth_dev *dev,
113 struct rte_flow_tunnel *tunnel,
114 struct rte_flow_action **pmd_actions,
115 uint32_t *num_of_actions,
116 struct rte_flow_error *err);
117 /** See rte_flow_tunnel_match() */
119 (struct rte_eth_dev *dev,
120 struct rte_flow_tunnel *tunnel,
121 struct rte_flow_item **pmd_items,
122 uint32_t *num_of_items,
123 struct rte_flow_error *err);
124 /** See rte_flow_get_rte_flow_restore_info() */
125 int (*get_restore_info)
126 (struct rte_eth_dev *dev,
128 struct rte_flow_restore_info *info,
129 struct rte_flow_error *err);
130 /** See rte_flow_action_tunnel_decap_release() */
131 int (*tunnel_action_decap_release)
132 (struct rte_eth_dev *dev,
133 struct rte_flow_action *pmd_actions,
134 uint32_t num_of_actions,
135 struct rte_flow_error *err);
136 /** See rte_flow_item_release() */
137 int (*tunnel_item_release)
138 (struct rte_eth_dev *dev,
139 struct rte_flow_item *pmd_items,
140 uint32_t num_of_items,
141 struct rte_flow_error *err);
142 /** See rte_flow_pick_transfer_proxy() */
143 int (*pick_transfer_proxy)
144 (struct rte_eth_dev *dev,
145 uint16_t *proxy_port_id,
146 struct rte_flow_error *error);
147 struct rte_flow_item_flex_handle *(*flex_item_create)
148 (struct rte_eth_dev *dev,
149 const struct rte_flow_item_flex_conf *conf,
150 struct rte_flow_error *error);
151 int (*flex_item_release)
152 (struct rte_eth_dev *dev,
153 const struct rte_flow_item_flex_handle *handle,
154 struct rte_flow_error *error);
155 /** See rte_flow_info_get() */
157 (struct rte_eth_dev *dev,
158 struct rte_flow_port_info *port_info,
159 struct rte_flow_queue_info *queue_info,
160 struct rte_flow_error *err);
161 /** See rte_flow_configure() */
163 (struct rte_eth_dev *dev,
164 const struct rte_flow_port_attr *port_attr,
166 const struct rte_flow_queue_attr *queue_attr[],
167 struct rte_flow_error *err);
168 /** See rte_flow_pattern_template_create() */
169 struct rte_flow_pattern_template *(*pattern_template_create)
170 (struct rte_eth_dev *dev,
171 const struct rte_flow_pattern_template_attr *template_attr,
172 const struct rte_flow_item pattern[],
173 struct rte_flow_error *err);
174 /** See rte_flow_pattern_template_destroy() */
175 int (*pattern_template_destroy)
176 (struct rte_eth_dev *dev,
177 struct rte_flow_pattern_template *pattern_template,
178 struct rte_flow_error *err);
179 /** See rte_flow_actions_template_create() */
180 struct rte_flow_actions_template *(*actions_template_create)
181 (struct rte_eth_dev *dev,
182 const struct rte_flow_actions_template_attr *template_attr,
183 const struct rte_flow_action actions[],
184 const struct rte_flow_action masks[],
185 struct rte_flow_error *err);
186 /** See rte_flow_actions_template_destroy() */
187 int (*actions_template_destroy)
188 (struct rte_eth_dev *dev,
189 struct rte_flow_actions_template *actions_template,
190 struct rte_flow_error *err);
191 /** See rte_flow_template_table_create() */
192 struct rte_flow_template_table *(*template_table_create)
193 (struct rte_eth_dev *dev,
194 const struct rte_flow_template_table_attr *table_attr,
195 struct rte_flow_pattern_template *pattern_templates[],
196 uint8_t nb_pattern_templates,
197 struct rte_flow_actions_template *actions_templates[],
198 uint8_t nb_actions_templates,
199 struct rte_flow_error *err);
200 /** See rte_flow_template_table_destroy() */
201 int (*template_table_destroy)
202 (struct rte_eth_dev *dev,
203 struct rte_flow_template_table *template_table,
204 struct rte_flow_error *err);
205 /** See rte_flow_async_create() */
206 struct rte_flow *(*async_create)
207 (struct rte_eth_dev *dev,
209 const struct rte_flow_op_attr *op_attr,
210 struct rte_flow_template_table *template_table,
211 const struct rte_flow_item pattern[],
212 uint8_t pattern_template_index,
213 const struct rte_flow_action actions[],
214 uint8_t actions_template_index,
216 struct rte_flow_error *err);
217 /** See rte_flow_async_destroy() */
219 (struct rte_eth_dev *dev,
221 const struct rte_flow_op_attr *op_attr,
222 struct rte_flow *flow,
224 struct rte_flow_error *err);
225 /** See rte_flow_push() */
227 (struct rte_eth_dev *dev,
229 struct rte_flow_error *err);
230 /** See rte_flow_pull() */
232 (struct rte_eth_dev *dev,
234 struct rte_flow_op_result res[],
236 struct rte_flow_error *error);
237 /** See rte_flow_async_action_handle_create() */
238 struct rte_flow_action_handle *(*async_action_handle_create)
239 (struct rte_eth_dev *dev,
241 const struct rte_flow_op_attr *op_attr,
242 const struct rte_flow_indir_action_conf *indir_action_conf,
243 const struct rte_flow_action *action,
245 struct rte_flow_error *err);
246 /** See rte_flow_async_action_handle_destroy() */
247 int (*async_action_handle_destroy)
248 (struct rte_eth_dev *dev,
250 const struct rte_flow_op_attr *op_attr,
251 struct rte_flow_action_handle *action_handle,
253 struct rte_flow_error *error);
254 /** See rte_flow_async_action_handle_update() */
255 int (*async_action_handle_update)
256 (struct rte_eth_dev *dev,
258 const struct rte_flow_op_attr *op_attr,
259 struct rte_flow_action_handle *action_handle,
262 struct rte_flow_error *error);
266 * Get generic flow operations structure from a port.
269 * Port identifier to query.
271 * Pointer to flow error structure.
274 * The flow operations structure associated with port_id, NULL in case of
275 * error, in which case rte_errno is set and the error structure contains
276 * additional details.
278 const struct rte_flow_ops *
279 rte_flow_ops_get(uint16_t port_id, struct rte_flow_error *error);
285 #endif /* RTE_FLOW_DRIVER_H_ */