xref: /linux/include/net/flow_offload.h (revision 10a708c24a31ae1be1ea23d1c38da2691d1fd65c)
1 #ifndef _NET_FLOW_OFFLOAD_H
2 #define _NET_FLOW_OFFLOAD_H
3 
4 #include <linux/kernel.h>
5 #include <linux/list.h>
6 #include <net/flow_dissector.h>
7 #include <linux/rhashtable.h>
8 
9 struct flow_match {
10 	struct flow_dissector	*dissector;
11 	void			*mask;
12 	void			*key;
13 };
14 
15 struct flow_match_meta {
16 	struct flow_dissector_key_meta *key, *mask;
17 };
18 
19 struct flow_match_basic {
20 	struct flow_dissector_key_basic *key, *mask;
21 };
22 
23 struct flow_match_control {
24 	struct flow_dissector_key_control *key, *mask;
25 };
26 
27 struct flow_match_eth_addrs {
28 	struct flow_dissector_key_eth_addrs *key, *mask;
29 };
30 
31 struct flow_match_vlan {
32 	struct flow_dissector_key_vlan *key, *mask;
33 };
34 
35 struct flow_match_ipv4_addrs {
36 	struct flow_dissector_key_ipv4_addrs *key, *mask;
37 };
38 
39 struct flow_match_ipv6_addrs {
40 	struct flow_dissector_key_ipv6_addrs *key, *mask;
41 };
42 
43 struct flow_match_ip {
44 	struct flow_dissector_key_ip *key, *mask;
45 };
46 
47 struct flow_match_ports {
48 	struct flow_dissector_key_ports *key, *mask;
49 };
50 
51 struct flow_match_icmp {
52 	struct flow_dissector_key_icmp *key, *mask;
53 };
54 
55 struct flow_match_tcp {
56 	struct flow_dissector_key_tcp *key, *mask;
57 };
58 
59 struct flow_match_mpls {
60 	struct flow_dissector_key_mpls *key, *mask;
61 };
62 
63 struct flow_match_enc_keyid {
64 	struct flow_dissector_key_keyid *key, *mask;
65 };
66 
67 struct flow_match_enc_opts {
68 	struct flow_dissector_key_enc_opts *key, *mask;
69 };
70 
71 struct flow_rule;
72 
73 void flow_rule_match_meta(const struct flow_rule *rule,
74 			  struct flow_match_meta *out);
75 void flow_rule_match_basic(const struct flow_rule *rule,
76 			   struct flow_match_basic *out);
77 void flow_rule_match_control(const struct flow_rule *rule,
78 			     struct flow_match_control *out);
79 void flow_rule_match_eth_addrs(const struct flow_rule *rule,
80 			       struct flow_match_eth_addrs *out);
81 void flow_rule_match_vlan(const struct flow_rule *rule,
82 			  struct flow_match_vlan *out);
83 void flow_rule_match_cvlan(const struct flow_rule *rule,
84 			   struct flow_match_vlan *out);
85 void flow_rule_match_ipv4_addrs(const struct flow_rule *rule,
86 				struct flow_match_ipv4_addrs *out);
87 void flow_rule_match_ipv6_addrs(const struct flow_rule *rule,
88 				struct flow_match_ipv6_addrs *out);
89 void flow_rule_match_ip(const struct flow_rule *rule,
90 			struct flow_match_ip *out);
91 void flow_rule_match_ports(const struct flow_rule *rule,
92 			   struct flow_match_ports *out);
93 void flow_rule_match_tcp(const struct flow_rule *rule,
94 			 struct flow_match_tcp *out);
95 void flow_rule_match_icmp(const struct flow_rule *rule,
96 			  struct flow_match_icmp *out);
97 void flow_rule_match_mpls(const struct flow_rule *rule,
98 			  struct flow_match_mpls *out);
99 void flow_rule_match_enc_control(const struct flow_rule *rule,
100 				 struct flow_match_control *out);
101 void flow_rule_match_enc_ipv4_addrs(const struct flow_rule *rule,
102 				    struct flow_match_ipv4_addrs *out);
103 void flow_rule_match_enc_ipv6_addrs(const struct flow_rule *rule,
104 				    struct flow_match_ipv6_addrs *out);
105 void flow_rule_match_enc_ip(const struct flow_rule *rule,
106 			    struct flow_match_ip *out);
107 void flow_rule_match_enc_ports(const struct flow_rule *rule,
108 			       struct flow_match_ports *out);
109 void flow_rule_match_enc_keyid(const struct flow_rule *rule,
110 			       struct flow_match_enc_keyid *out);
111 void flow_rule_match_enc_opts(const struct flow_rule *rule,
112 			      struct flow_match_enc_opts *out);
113 
114 enum flow_action_id {
115 	FLOW_ACTION_ACCEPT		= 0,
116 	FLOW_ACTION_DROP,
117 	FLOW_ACTION_TRAP,
118 	FLOW_ACTION_GOTO,
119 	FLOW_ACTION_REDIRECT,
120 	FLOW_ACTION_MIRRED,
121 	FLOW_ACTION_REDIRECT_INGRESS,
122 	FLOW_ACTION_MIRRED_INGRESS,
123 	FLOW_ACTION_VLAN_PUSH,
124 	FLOW_ACTION_VLAN_POP,
125 	FLOW_ACTION_VLAN_MANGLE,
126 	FLOW_ACTION_TUNNEL_ENCAP,
127 	FLOW_ACTION_TUNNEL_DECAP,
128 	FLOW_ACTION_MANGLE,
129 	FLOW_ACTION_ADD,
130 	FLOW_ACTION_CSUM,
131 	FLOW_ACTION_MARK,
132 	FLOW_ACTION_PTYPE,
133 	FLOW_ACTION_WAKE,
134 	FLOW_ACTION_QUEUE,
135 	FLOW_ACTION_SAMPLE,
136 	FLOW_ACTION_POLICE,
137 	FLOW_ACTION_CT,
138 	FLOW_ACTION_MPLS_PUSH,
139 	FLOW_ACTION_MPLS_POP,
140 	FLOW_ACTION_MPLS_MANGLE,
141 };
142 
143 /* This is mirroring enum pedit_header_type definition for easy mapping between
144  * tc pedit action. Legacy TCA_PEDIT_KEY_EX_HDR_TYPE_NETWORK is mapped to
145  * FLOW_ACT_MANGLE_UNSPEC, which is supported by no driver.
146  */
147 enum flow_action_mangle_base {
148 	FLOW_ACT_MANGLE_UNSPEC		= 0,
149 	FLOW_ACT_MANGLE_HDR_TYPE_ETH,
150 	FLOW_ACT_MANGLE_HDR_TYPE_IP4,
151 	FLOW_ACT_MANGLE_HDR_TYPE_IP6,
152 	FLOW_ACT_MANGLE_HDR_TYPE_TCP,
153 	FLOW_ACT_MANGLE_HDR_TYPE_UDP,
154 };
155 
156 struct flow_action_entry {
157 	enum flow_action_id		id;
158 	union {
159 		u32			chain_index;	/* FLOW_ACTION_GOTO */
160 		struct net_device	*dev;		/* FLOW_ACTION_REDIRECT */
161 		struct {				/* FLOW_ACTION_VLAN */
162 			u16		vid;
163 			__be16		proto;
164 			u8		prio;
165 		} vlan;
166 		struct {				/* FLOW_ACTION_PACKET_EDIT */
167 			enum flow_action_mangle_base htype;
168 			u32		offset;
169 			u32		mask;
170 			u32		val;
171 		} mangle;
172 		const struct ip_tunnel_info *tunnel;	/* FLOW_ACTION_TUNNEL_ENCAP */
173 		u32			csum_flags;	/* FLOW_ACTION_CSUM */
174 		u32			mark;		/* FLOW_ACTION_MARK */
175 		u16                     ptype;          /* FLOW_ACTION_PTYPE */
176 		struct {				/* FLOW_ACTION_QUEUE */
177 			u32		ctx;
178 			u32		index;
179 			u8		vf;
180 		} queue;
181 		struct {				/* FLOW_ACTION_SAMPLE */
182 			struct psample_group	*psample_group;
183 			u32			rate;
184 			u32			trunc_size;
185 			bool			truncate;
186 		} sample;
187 		struct {				/* FLOW_ACTION_POLICE */
188 			s64			burst;
189 			u64			rate_bytes_ps;
190 		} police;
191 		struct {				/* FLOW_ACTION_CT */
192 			int action;
193 			u16 zone;
194 		} ct;
195 		struct {				/* FLOW_ACTION_MPLS_PUSH */
196 			u32		label;
197 			__be16		proto;
198 			u8		tc;
199 			u8		bos;
200 			u8		ttl;
201 		} mpls_push;
202 		struct {				/* FLOW_ACTION_MPLS_POP */
203 			__be16		proto;
204 		} mpls_pop;
205 		struct {				/* FLOW_ACTION_MPLS_MANGLE */
206 			u32		label;
207 			u8		tc;
208 			u8		bos;
209 			u8		ttl;
210 		} mpls_mangle;
211 	};
212 };
213 
214 struct flow_action {
215 	unsigned int			num_entries;
216 	struct flow_action_entry 	entries[0];
217 };
218 
219 static inline bool flow_action_has_entries(const struct flow_action *action)
220 {
221 	return action->num_entries;
222 }
223 
224 /**
225  * flow_action_has_one_action() - check if exactly one action is present
226  * @action: tc filter flow offload action
227  *
228  * Returns true if exactly one action is present.
229  */
230 static inline bool flow_offload_has_one_action(const struct flow_action *action)
231 {
232 	return action->num_entries == 1;
233 }
234 
235 #define flow_action_for_each(__i, __act, __actions)			\
236         for (__i = 0, __act = &(__actions)->entries[0]; __i < (__actions)->num_entries; __act = &(__actions)->entries[++__i])
237 
238 struct flow_rule {
239 	struct flow_match	match;
240 	struct flow_action	action;
241 };
242 
243 struct flow_rule *flow_rule_alloc(unsigned int num_actions);
244 
245 static inline bool flow_rule_match_key(const struct flow_rule *rule,
246 				       enum flow_dissector_key_id key)
247 {
248 	return dissector_uses_key(rule->match.dissector, key);
249 }
250 
251 struct flow_stats {
252 	u64	pkts;
253 	u64	bytes;
254 	u64	lastused;
255 };
256 
257 static inline void flow_stats_update(struct flow_stats *flow_stats,
258 				     u64 bytes, u64 pkts, u64 lastused)
259 {
260 	flow_stats->pkts	+= pkts;
261 	flow_stats->bytes	+= bytes;
262 	flow_stats->lastused	= max_t(u64, flow_stats->lastused, lastused);
263 }
264 
265 enum flow_block_command {
266 	FLOW_BLOCK_BIND,
267 	FLOW_BLOCK_UNBIND,
268 };
269 
270 enum flow_block_binder_type {
271 	FLOW_BLOCK_BINDER_TYPE_UNSPEC,
272 	FLOW_BLOCK_BINDER_TYPE_CLSACT_INGRESS,
273 	FLOW_BLOCK_BINDER_TYPE_CLSACT_EGRESS,
274 };
275 
276 struct flow_block {
277 	struct list_head cb_list;
278 };
279 
280 struct netlink_ext_ack;
281 
282 struct flow_block_offload {
283 	enum flow_block_command command;
284 	enum flow_block_binder_type binder_type;
285 	bool block_shared;
286 	struct net *net;
287 	struct flow_block *block;
288 	struct list_head cb_list;
289 	struct list_head *driver_block_list;
290 	struct netlink_ext_ack *extack;
291 };
292 
293 enum tc_setup_type;
294 typedef int flow_setup_cb_t(enum tc_setup_type type, void *type_data,
295 			    void *cb_priv);
296 
297 struct flow_block_cb {
298 	struct list_head	driver_list;
299 	struct list_head	list;
300 	flow_setup_cb_t		*cb;
301 	void			*cb_ident;
302 	void			*cb_priv;
303 	void			(*release)(void *cb_priv);
304 	unsigned int		refcnt;
305 };
306 
307 struct flow_block_cb *flow_block_cb_alloc(flow_setup_cb_t *cb,
308 					  void *cb_ident, void *cb_priv,
309 					  void (*release)(void *cb_priv));
310 void flow_block_cb_free(struct flow_block_cb *block_cb);
311 
312 struct flow_block_cb *flow_block_cb_lookup(struct flow_block *block,
313 					   flow_setup_cb_t *cb, void *cb_ident);
314 
315 void *flow_block_cb_priv(struct flow_block_cb *block_cb);
316 void flow_block_cb_incref(struct flow_block_cb *block_cb);
317 unsigned int flow_block_cb_decref(struct flow_block_cb *block_cb);
318 
319 static inline void flow_block_cb_add(struct flow_block_cb *block_cb,
320 				     struct flow_block_offload *offload)
321 {
322 	list_add_tail(&block_cb->list, &offload->cb_list);
323 }
324 
325 static inline void flow_block_cb_remove(struct flow_block_cb *block_cb,
326 					struct flow_block_offload *offload)
327 {
328 	list_move(&block_cb->list, &offload->cb_list);
329 }
330 
331 bool flow_block_cb_is_busy(flow_setup_cb_t *cb, void *cb_ident,
332 			   struct list_head *driver_block_list);
333 
334 int flow_block_cb_setup_simple(struct flow_block_offload *f,
335 			       struct list_head *driver_list,
336 			       flow_setup_cb_t *cb,
337 			       void *cb_ident, void *cb_priv, bool ingress_only);
338 
339 enum flow_cls_command {
340 	FLOW_CLS_REPLACE,
341 	FLOW_CLS_DESTROY,
342 	FLOW_CLS_STATS,
343 	FLOW_CLS_TMPLT_CREATE,
344 	FLOW_CLS_TMPLT_DESTROY,
345 };
346 
347 struct flow_cls_common_offload {
348 	u32 chain_index;
349 	__be16 protocol;
350 	u32 prio;
351 	struct netlink_ext_ack *extack;
352 };
353 
354 struct flow_cls_offload {
355 	struct flow_cls_common_offload common;
356 	enum flow_cls_command command;
357 	unsigned long cookie;
358 	struct flow_rule *rule;
359 	struct flow_stats stats;
360 	u32 classid;
361 };
362 
363 static inline struct flow_rule *
364 flow_cls_offload_flow_rule(struct flow_cls_offload *flow_cmd)
365 {
366 	return flow_cmd->rule;
367 }
368 
369 static inline void flow_block_init(struct flow_block *flow_block)
370 {
371 	INIT_LIST_HEAD(&flow_block->cb_list);
372 }
373 
374 typedef int flow_indr_block_bind_cb_t(struct net_device *dev, void *cb_priv,
375 				      enum tc_setup_type type, void *type_data);
376 
377 typedef void flow_indr_block_ing_cmd_t(struct net_device *dev,
378 					flow_indr_block_bind_cb_t *cb,
379 					void *cb_priv,
380 					enum flow_block_command command);
381 
382 struct flow_indr_block_ing_entry {
383 	flow_indr_block_ing_cmd_t *cb;
384 	struct list_head	list;
385 };
386 
387 void flow_indr_add_block_ing_cb(struct flow_indr_block_ing_entry *entry);
388 
389 void flow_indr_del_block_ing_cb(struct flow_indr_block_ing_entry *entry);
390 
391 int __flow_indr_block_cb_register(struct net_device *dev, void *cb_priv,
392 				  flow_indr_block_bind_cb_t *cb,
393 				  void *cb_ident);
394 
395 void __flow_indr_block_cb_unregister(struct net_device *dev,
396 				     flow_indr_block_bind_cb_t *cb,
397 				     void *cb_ident);
398 
399 int flow_indr_block_cb_register(struct net_device *dev, void *cb_priv,
400 				flow_indr_block_bind_cb_t *cb, void *cb_ident);
401 
402 void flow_indr_block_cb_unregister(struct net_device *dev,
403 				   flow_indr_block_bind_cb_t *cb,
404 				   void *cb_ident);
405 
406 void flow_indr_block_call(struct net_device *dev,
407 			  struct flow_block_offload *bo,
408 			  enum flow_block_command command);
409 
410 #endif /* _NET_FLOW_OFFLOAD_H */
411