1 #ifndef __NET_PKT_CLS_H
2 #define __NET_PKT_CLS_H
4 #include <linux/pkt_cls.h>
5 #include <net/sch_generic.h>
6 #include <net/act_api.h>
8 /* Basic packet classifier frontend definitions. */
14 int (*fn)(struct tcf_proto *, unsigned long node, struct tcf_walker *);
17 int register_tcf_proto_ops(struct tcf_proto_ops *ops);
18 int unregister_tcf_proto_ops(struct tcf_proto_ops *ops);
21 void tcf_destroy_chain(struct tcf_proto __rcu **fl);
23 static inline void tcf_destroy_chain(struct tcf_proto __rcu **fl)
28 static inline unsigned long
29 __cls_set_class(unsigned long *clp, unsigned long cl)
34 static inline unsigned long
35 cls_set_class(struct tcf_proto *tp, unsigned long *clp,
41 old_cl = __cls_set_class(clp, cl);
48 tcf_bind_filter(struct tcf_proto *tp, struct tcf_result *r, unsigned long base)
52 cl = tp->q->ops->cl_ops->bind_tcf(tp->q, base, r->classid);
53 cl = cls_set_class(tp, &r->class, cl);
55 tp->q->ops->cl_ops->unbind_tcf(tp->q, cl);
59 tcf_unbind_filter(struct tcf_proto *tp, struct tcf_result *r)
63 if ((cl = __cls_set_class(&r->class, 0)) != 0)
64 tp->q->ops->cl_ops->unbind_tcf(tp->q, cl);
68 #ifdef CONFIG_NET_CLS_ACT
69 __u32 type; /* for backward compat(TCA_OLD_COMPAT) */
71 struct tc_action **actions;
73 /* Map to export classifier specific extension TLV types to the
74 * generic extensions API. Unsupported extensions must be set to 0.
80 static inline int tcf_exts_init(struct tcf_exts *exts, int action, int police)
82 #ifdef CONFIG_NET_CLS_ACT
85 exts->actions = kcalloc(TCA_ACT_MAX_PRIO, sizeof(struct tc_action *),
90 exts->action = action;
91 exts->police = police;
96 * tcf_exts_is_predicative - check if a predicative extension is present
97 * @exts: tc filter extensions handle
99 * Returns 1 if a predicative extension is present, i.e. an extension which
100 * might cause further actions and thus overrule the regular tcf_result.
103 tcf_exts_is_predicative(struct tcf_exts *exts)
105 #ifdef CONFIG_NET_CLS_ACT
106 return exts->nr_actions;
113 * tcf_exts_is_available - check if at least one extension is present
114 * @exts: tc filter extensions handle
116 * Returns 1 if at least one extension is present.
119 tcf_exts_is_available(struct tcf_exts *exts)
121 /* All non-predicative extensions must be added here. */
122 return tcf_exts_is_predicative(exts);
125 static inline void tcf_exts_to_list(const struct tcf_exts *exts,
126 struct list_head *actions)
128 #ifdef CONFIG_NET_CLS_ACT
131 for (i = 0; i < exts->nr_actions; i++) {
132 struct tc_action *a = exts->actions[i];
134 list_add_tail(&a->list, actions);
140 * tcf_exts_exec - execute tc filter extensions
141 * @skb: socket buffer
142 * @exts: tc filter extensions handle
143 * @res: desired result
145 * Executes all configured extensions. Returns 0 on a normal execution,
146 * a negative number if the filter must be considered unmatched or
147 * a positive action code (TC_ACT_*) which must be returned to the
151 tcf_exts_exec(struct sk_buff *skb, struct tcf_exts *exts,
152 struct tcf_result *res)
154 #ifdef CONFIG_NET_CLS_ACT
155 if (exts->nr_actions)
156 return tcf_action_exec(skb, exts->actions, exts->nr_actions,
162 #ifdef CONFIG_NET_CLS_ACT
164 #define tc_no_actions(_exts) ((_exts)->nr_actions == 0)
165 #define tc_single_action(_exts) ((_exts)->nr_actions == 1)
167 #else /* CONFIG_NET_CLS_ACT */
169 #define tc_no_actions(_exts) true
170 #define tc_single_action(_exts) false
172 #endif /* CONFIG_NET_CLS_ACT */
174 int tcf_exts_validate(struct net *net, struct tcf_proto *tp,
175 struct nlattr **tb, struct nlattr *rate_tlv,
176 struct tcf_exts *exts, bool ovr);
177 void tcf_exts_destroy(struct tcf_exts *exts);
178 void tcf_exts_change(struct tcf_proto *tp, struct tcf_exts *dst,
179 struct tcf_exts *src);
180 int tcf_exts_dump(struct sk_buff *skb, struct tcf_exts *exts);
181 int tcf_exts_dump_stats(struct sk_buff *skb, struct tcf_exts *exts);
182 int tcf_exts_get_dev(struct net_device *dev, struct tcf_exts *exts,
183 struct net_device **hw_dev);
186 * struct tcf_pkt_info - packet information
188 struct tcf_pkt_info {
193 #ifdef CONFIG_NET_EMATCH
195 struct tcf_ematch_ops;
198 * struct tcf_ematch - extended match (ematch)
200 * @matchid: identifier to allow userspace to reidentify a match
201 * @flags: flags specifying attributes and the relation to other matches
202 * @ops: the operations lookup table of the corresponding ematch module
203 * @datalen: length of the ematch specific configuration data
204 * @data: ematch specific data
207 struct tcf_ematch_ops * ops;
209 unsigned int datalen;
215 static inline int tcf_em_is_container(struct tcf_ematch *em)
220 static inline int tcf_em_is_simple(struct tcf_ematch *em)
222 return em->flags & TCF_EM_SIMPLE;
225 static inline int tcf_em_is_inverted(struct tcf_ematch *em)
227 return em->flags & TCF_EM_INVERT;
230 static inline int tcf_em_last_match(struct tcf_ematch *em)
232 return (em->flags & TCF_EM_REL_MASK) == TCF_EM_REL_END;
235 static inline int tcf_em_early_end(struct tcf_ematch *em, int result)
237 if (tcf_em_last_match(em))
240 if (result == 0 && em->flags & TCF_EM_REL_AND)
243 if (result != 0 && em->flags & TCF_EM_REL_OR)
250 * struct tcf_ematch_tree - ematch tree handle
252 * @hdr: ematch tree header supplied by userspace
253 * @matches: array of ematches
255 struct tcf_ematch_tree {
256 struct tcf_ematch_tree_hdr hdr;
257 struct tcf_ematch * matches;
262 * struct tcf_ematch_ops - ematch module operations
264 * @kind: identifier (kind) of this ematch module
265 * @datalen: length of expected configuration data (optional)
266 * @change: called during validation (optional)
267 * @match: called during ematch tree evaluation, must return 1/0
268 * @destroy: called during destroyage (optional)
269 * @dump: called during dumping process (optional)
270 * @owner: owner, must be set to THIS_MODULE
271 * @link: link to previous/next ematch module (internal use)
273 struct tcf_ematch_ops {
276 int (*change)(struct net *net, void *,
277 int, struct tcf_ematch *);
278 int (*match)(struct sk_buff *, struct tcf_ematch *,
279 struct tcf_pkt_info *);
280 void (*destroy)(struct tcf_ematch *);
281 int (*dump)(struct sk_buff *, struct tcf_ematch *);
282 struct module *owner;
283 struct list_head link;
286 int tcf_em_register(struct tcf_ematch_ops *);
287 void tcf_em_unregister(struct tcf_ematch_ops *);
288 int tcf_em_tree_validate(struct tcf_proto *, struct nlattr *,
289 struct tcf_ematch_tree *);
290 void tcf_em_tree_destroy(struct tcf_ematch_tree *);
291 int tcf_em_tree_dump(struct sk_buff *, struct tcf_ematch_tree *, int);
292 int __tcf_em_tree_match(struct sk_buff *, struct tcf_ematch_tree *,
293 struct tcf_pkt_info *);
296 * tcf_em_tree_change - replace ematch tree of a running classifier
298 * @tp: classifier kind handle
299 * @dst: destination ematch tree variable
300 * @src: source ematch tree (temporary tree from tcf_em_tree_validate)
302 * This functions replaces the ematch tree in @dst with the ematch
303 * tree in @src. The classifier in charge of the ematch tree may be
306 static inline void tcf_em_tree_change(struct tcf_proto *tp,
307 struct tcf_ematch_tree *dst,
308 struct tcf_ematch_tree *src)
311 memcpy(dst, src, sizeof(*dst));
316 * tcf_em_tree_match - evaulate an ematch tree
318 * @skb: socket buffer of the packet in question
319 * @tree: ematch tree to be used for evaluation
320 * @info: packet information examined by classifier
322 * This function matches @skb against the ematch tree in @tree by going
323 * through all ematches respecting their logic relations returning
324 * as soon as the result is obvious.
326 * Returns 1 if the ematch tree as-one matches, no ematches are configured
327 * or ematch is not enabled in the kernel, otherwise 0 is returned.
329 static inline int tcf_em_tree_match(struct sk_buff *skb,
330 struct tcf_ematch_tree *tree,
331 struct tcf_pkt_info *info)
333 if (tree->hdr.nmatches)
334 return __tcf_em_tree_match(skb, tree, info);
339 #define MODULE_ALIAS_TCF_EMATCH(kind) MODULE_ALIAS("ematch-kind-" __stringify(kind))
341 #else /* CONFIG_NET_EMATCH */
343 struct tcf_ematch_tree {
346 #define tcf_em_tree_validate(tp, tb, t) ((void)(t), 0)
347 #define tcf_em_tree_destroy(t) do { (void)(t); } while(0)
348 #define tcf_em_tree_dump(skb, t, tlv) (0)
349 #define tcf_em_tree_change(tp, dst, src) do { } while(0)
350 #define tcf_em_tree_match(skb, t, info) ((void)(info), 1)
352 #endif /* CONFIG_NET_EMATCH */
354 static inline unsigned char * tcf_get_base_ptr(struct sk_buff *skb, int layer)
359 case TCF_LAYER_NETWORK:
360 return skb_network_header(skb);
361 case TCF_LAYER_TRANSPORT:
362 return skb_transport_header(skb);
368 static inline int tcf_valid_offset(const struct sk_buff *skb,
369 const unsigned char *ptr, const int len)
371 return likely((ptr + len) <= skb_tail_pointer(skb) &&
373 (ptr <= (ptr + len)));
376 #ifdef CONFIG_NET_CLS_IND
377 #include <net/net_namespace.h>
380 tcf_change_indev(struct net *net, struct nlattr *indev_tlv)
382 char indev[IFNAMSIZ];
383 struct net_device *dev;
385 if (nla_strlcpy(indev, indev_tlv, IFNAMSIZ) >= IFNAMSIZ)
387 dev = __dev_get_by_name(net, indev);
394 tcf_match_indev(struct sk_buff *skb, int ifindex)
400 return ifindex == skb->skb_iif;
402 #endif /* CONFIG_NET_CLS_IND */
404 struct tc_cls_u32_knode {
405 struct tcf_exts *exts;
406 struct tc_u32_sel *sel;
414 struct tc_cls_u32_hnode {
417 unsigned int divisor;
420 enum tc_clsu32_command {
422 TC_CLSU32_REPLACE_KNODE,
423 TC_CLSU32_DELETE_KNODE,
425 TC_CLSU32_REPLACE_HNODE,
426 TC_CLSU32_DELETE_HNODE,
429 struct tc_cls_u32_offload {
431 enum tc_clsu32_command command;
433 struct tc_cls_u32_knode knode;
434 struct tc_cls_u32_hnode hnode;
438 static inline bool tc_can_offload(const struct net_device *dev,
439 const struct tcf_proto *tp)
441 const struct Qdisc *sch = tp->q;
442 const struct Qdisc_class_ops *cops = sch->ops->cl_ops;
444 if (!(dev->features & NETIF_F_HW_TC))
446 if (!dev->netdev_ops->ndo_setup_tc)
448 if (cops && cops->tcf_cl_offload)
449 return cops->tcf_cl_offload(tp->classid);
454 static inline bool tc_skip_hw(u32 flags)
456 return (flags & TCA_CLS_FLAGS_SKIP_HW) ? true : false;
459 static inline bool tc_should_offload(const struct net_device *dev,
460 const struct tcf_proto *tp, u32 flags)
462 if (tc_skip_hw(flags))
464 return tc_can_offload(dev, tp);
467 static inline bool tc_skip_sw(u32 flags)
469 return (flags & TCA_CLS_FLAGS_SKIP_SW) ? true : false;
472 /* SKIP_HW and SKIP_SW are mutually exclusive flags. */
473 static inline bool tc_flags_valid(u32 flags)
475 if (flags & ~(TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW))
478 if (!(flags ^ (TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW)))
484 static inline bool tc_in_hw(u32 flags)
486 return (flags & TCA_CLS_FLAGS_IN_HW) ? true : false;
490 TC_CLSFLOWER_REPLACE,
491 TC_CLSFLOWER_DESTROY,
495 struct tc_cls_flower_offload {
496 enum tc_fl_command command;
498 unsigned long cookie;
499 struct flow_dissector *dissector;
500 struct fl_flow_key *mask;
501 struct fl_flow_key *key;
502 struct tcf_exts *exts;
505 enum tc_matchall_command {
506 TC_CLSMATCHALL_REPLACE,
507 TC_CLSMATCHALL_DESTROY,
510 struct tc_cls_matchall_offload {
511 enum tc_matchall_command command;
512 struct tcf_exts *exts;
513 unsigned long cookie;
516 enum tc_clsbpf_command {
523 struct tc_cls_bpf_offload {
524 enum tc_clsbpf_command command;
525 struct tcf_exts *exts;
526 struct bpf_prog *prog;
528 bool exts_integrated;
533 /* This structure holds cookie structure that is passed from user
534 * to the kernel for actions and classifiers