1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * net/sched/cls_flow.c Generic flow classifier
5 * Copyright (c) 2007, 2008 Patrick McHardy <kaber@trash.net>
8 #include <linux/kernel.h>
9 #include <linux/init.h>
10 #include <linux/list.h>
11 #include <linux/jhash.h>
12 #include <linux/random.h>
13 #include <linux/pkt_cls.h>
14 #include <linux/skbuff.h>
17 #include <linux/ipv6.h>
18 #include <linux/if_vlan.h>
19 #include <linux/slab.h>
20 #include <linux/module.h>
21 #include <net/inet_sock.h>
23 #include <net/pkt_cls.h>
25 #include <net/route.h>
26 #include <net/flow_dissector.h>
27 #include <net/tc_wrapper.h>
29 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
30 #include <net/netfilter/nf_conntrack.h>
34 struct list_head filters
;
39 struct list_head list
;
41 struct tcf_ematch_tree ematches
;
43 struct timer_list perturb_timer
;
57 struct rcu_work rwork
;
60 static inline u32
addr_fold(void *addr
)
62 unsigned long a
= (unsigned long)addr
;
64 return (a
& 0xFFFFFFFF) ^ (BITS_PER_LONG
> 32 ? a
>> 32 : 0);
67 static u32
flow_get_src(const struct sk_buff
*skb
, const struct flow_keys
*flow
)
69 __be32 src
= flow_get_u32_src(flow
);
74 return addr_fold(skb
->sk
);
77 static u32
flow_get_dst(const struct sk_buff
*skb
, const struct flow_keys
*flow
)
79 __be32 dst
= flow_get_u32_dst(flow
);
84 return addr_fold(skb_dst(skb
)) ^ (__force u16
)skb_protocol(skb
, true);
87 static u32
flow_get_proto(const struct sk_buff
*skb
,
88 const struct flow_keys
*flow
)
90 return flow
->basic
.ip_proto
;
93 static u32
flow_get_proto_src(const struct sk_buff
*skb
,
94 const struct flow_keys
*flow
)
96 if (flow
->ports
.ports
)
97 return ntohs(flow
->ports
.src
);
99 return addr_fold(skb
->sk
);
102 static u32
flow_get_proto_dst(const struct sk_buff
*skb
,
103 const struct flow_keys
*flow
)
105 if (flow
->ports
.ports
)
106 return ntohs(flow
->ports
.dst
);
108 return addr_fold(skb_dst(skb
)) ^ (__force u16
)skb_protocol(skb
, true);
111 static u32
flow_get_iif(const struct sk_buff
*skb
)
116 static u32
flow_get_priority(const struct sk_buff
*skb
)
118 return skb
->priority
;
121 static u32
flow_get_mark(const struct sk_buff
*skb
)
126 static u32
flow_get_nfct(const struct sk_buff
*skb
)
128 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
129 return addr_fold(skb_nfct(skb
));
135 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
136 #define CTTUPLE(skb, member) \
138 enum ip_conntrack_info ctinfo; \
139 const struct nf_conn *ct = nf_ct_get(skb, &ctinfo); \
142 ct->tuplehash[CTINFO2DIR(ctinfo)].tuple.member; \
145 #define CTTUPLE(skb, member) \
152 static u32
flow_get_nfct_src(const struct sk_buff
*skb
,
153 const struct flow_keys
*flow
)
155 switch (skb_protocol(skb
, true)) {
156 case htons(ETH_P_IP
):
157 return ntohl(CTTUPLE(skb
, src
.u3
.ip
));
158 case htons(ETH_P_IPV6
):
159 return ntohl(CTTUPLE(skb
, src
.u3
.ip6
[3]));
162 return flow_get_src(skb
, flow
);
165 static u32
flow_get_nfct_dst(const struct sk_buff
*skb
,
166 const struct flow_keys
*flow
)
168 switch (skb_protocol(skb
, true)) {
169 case htons(ETH_P_IP
):
170 return ntohl(CTTUPLE(skb
, dst
.u3
.ip
));
171 case htons(ETH_P_IPV6
):
172 return ntohl(CTTUPLE(skb
, dst
.u3
.ip6
[3]));
175 return flow_get_dst(skb
, flow
);
178 static u32
flow_get_nfct_proto_src(const struct sk_buff
*skb
,
179 const struct flow_keys
*flow
)
181 return ntohs(CTTUPLE(skb
, src
.u
.all
));
183 return flow_get_proto_src(skb
, flow
);
186 static u32
flow_get_nfct_proto_dst(const struct sk_buff
*skb
,
187 const struct flow_keys
*flow
)
189 return ntohs(CTTUPLE(skb
, dst
.u
.all
));
191 return flow_get_proto_dst(skb
, flow
);
194 static u32
flow_get_rtclassid(const struct sk_buff
*skb
)
196 #ifdef CONFIG_IP_ROUTE_CLASSID
198 return skb_dst(skb
)->tclassid
;
203 static u32
flow_get_skuid(const struct sk_buff
*skb
)
205 struct sock
*sk
= skb_to_full_sk(skb
);
207 if (sk
&& sk
->sk_socket
&& sk
->sk_socket
->file
) {
208 kuid_t skuid
= sk
->sk_socket
->file
->f_cred
->fsuid
;
210 return from_kuid(&init_user_ns
, skuid
);
215 static u32
flow_get_skgid(const struct sk_buff
*skb
)
217 struct sock
*sk
= skb_to_full_sk(skb
);
219 if (sk
&& sk
->sk_socket
&& sk
->sk_socket
->file
) {
220 kgid_t skgid
= sk
->sk_socket
->file
->f_cred
->fsgid
;
222 return from_kgid(&init_user_ns
, skgid
);
227 static u32
flow_get_vlan_tag(const struct sk_buff
*skb
)
231 if (vlan_get_tag(skb
, &tag
) < 0)
233 return tag
& VLAN_VID_MASK
;
236 static u32
flow_get_rxhash(struct sk_buff
*skb
)
238 return skb_get_hash(skb
);
241 static u32
flow_key_get(struct sk_buff
*skb
, int key
, struct flow_keys
*flow
)
245 return flow_get_src(skb
, flow
);
247 return flow_get_dst(skb
, flow
);
249 return flow_get_proto(skb
, flow
);
250 case FLOW_KEY_PROTO_SRC
:
251 return flow_get_proto_src(skb
, flow
);
252 case FLOW_KEY_PROTO_DST
:
253 return flow_get_proto_dst(skb
, flow
);
255 return flow_get_iif(skb
);
256 case FLOW_KEY_PRIORITY
:
257 return flow_get_priority(skb
);
259 return flow_get_mark(skb
);
261 return flow_get_nfct(skb
);
262 case FLOW_KEY_NFCT_SRC
:
263 return flow_get_nfct_src(skb
, flow
);
264 case FLOW_KEY_NFCT_DST
:
265 return flow_get_nfct_dst(skb
, flow
);
266 case FLOW_KEY_NFCT_PROTO_SRC
:
267 return flow_get_nfct_proto_src(skb
, flow
);
268 case FLOW_KEY_NFCT_PROTO_DST
:
269 return flow_get_nfct_proto_dst(skb
, flow
);
270 case FLOW_KEY_RTCLASSID
:
271 return flow_get_rtclassid(skb
);
273 return flow_get_skuid(skb
);
275 return flow_get_skgid(skb
);
276 case FLOW_KEY_VLAN_TAG
:
277 return flow_get_vlan_tag(skb
);
278 case FLOW_KEY_RXHASH
:
279 return flow_get_rxhash(skb
);
286 #define FLOW_KEYS_NEEDED ((1 << FLOW_KEY_SRC) | \
287 (1 << FLOW_KEY_DST) | \
288 (1 << FLOW_KEY_PROTO) | \
289 (1 << FLOW_KEY_PROTO_SRC) | \
290 (1 << FLOW_KEY_PROTO_DST) | \
291 (1 << FLOW_KEY_NFCT_SRC) | \
292 (1 << FLOW_KEY_NFCT_DST) | \
293 (1 << FLOW_KEY_NFCT_PROTO_SRC) | \
294 (1 << FLOW_KEY_NFCT_PROTO_DST))
296 TC_INDIRECT_SCOPE
int flow_classify(struct sk_buff
*skb
,
297 const struct tcf_proto
*tp
,
298 struct tcf_result
*res
)
300 struct flow_head
*head
= rcu_dereference_bh(tp
->root
);
301 struct flow_filter
*f
;
307 list_for_each_entry_rcu(f
, &head
->filters
, list
) {
308 u32 keys
[FLOW_KEY_MAX
+ 1];
309 struct flow_keys flow_keys
;
311 if (!tcf_em_tree_match(skb
, &f
->ematches
, NULL
))
314 keymask
= f
->keymask
;
315 if (keymask
& FLOW_KEYS_NEEDED
)
316 skb_flow_dissect_flow_keys(skb
, &flow_keys
, 0);
318 for (n
= 0; n
< f
->nkeys
; n
++) {
319 key
= ffs(keymask
) - 1;
320 keymask
&= ~(1 << key
);
321 keys
[n
] = flow_key_get(skb
, key
, &flow_keys
);
324 if (f
->mode
== FLOW_MODE_HASH
)
325 classid
= jhash2(keys
, f
->nkeys
, f
->hashrnd
);
328 classid
= (classid
& f
->mask
) ^ f
->xor;
329 classid
= (classid
>> f
->rshift
) + f
->addend
;
333 classid
%= f
->divisor
;
336 res
->classid
= TC_H_MAKE(f
->baseclass
, f
->baseclass
+ classid
);
338 r
= tcf_exts_exec(skb
, &f
->exts
, res
);
346 static void flow_perturbation(struct timer_list
*t
)
348 struct flow_filter
*f
= from_timer(f
, t
, perturb_timer
);
350 get_random_bytes(&f
->hashrnd
, 4);
351 if (f
->perturb_period
)
352 mod_timer(&f
->perturb_timer
, jiffies
+ f
->perturb_period
);
355 static const struct nla_policy flow_policy
[TCA_FLOW_MAX
+ 1] = {
356 [TCA_FLOW_KEYS
] = { .type
= NLA_U32
},
357 [TCA_FLOW_MODE
] = { .type
= NLA_U32
},
358 [TCA_FLOW_BASECLASS
] = { .type
= NLA_U32
},
359 [TCA_FLOW_RSHIFT
] = NLA_POLICY_MAX(NLA_U32
,
360 31 /* BITS_PER_U32 - 1 */),
361 [TCA_FLOW_ADDEND
] = { .type
= NLA_U32
},
362 [TCA_FLOW_MASK
] = { .type
= NLA_U32
},
363 [TCA_FLOW_XOR
] = { .type
= NLA_U32
},
364 [TCA_FLOW_DIVISOR
] = { .type
= NLA_U32
},
365 [TCA_FLOW_ACT
] = { .type
= NLA_NESTED
},
366 [TCA_FLOW_POLICE
] = { .type
= NLA_NESTED
},
367 [TCA_FLOW_EMATCHES
] = { .type
= NLA_NESTED
},
368 [TCA_FLOW_PERTURB
] = { .type
= NLA_U32
},
371 static void __flow_destroy_filter(struct flow_filter
*f
)
373 timer_shutdown_sync(&f
->perturb_timer
);
374 tcf_exts_destroy(&f
->exts
);
375 tcf_em_tree_destroy(&f
->ematches
);
376 tcf_exts_put_net(&f
->exts
);
380 static void flow_destroy_filter_work(struct work_struct
*work
)
382 struct flow_filter
*f
= container_of(to_rcu_work(work
),
386 __flow_destroy_filter(f
);
390 static int flow_change(struct net
*net
, struct sk_buff
*in_skb
,
391 struct tcf_proto
*tp
, unsigned long base
,
392 u32 handle
, struct nlattr
**tca
,
393 void **arg
, u32 flags
,
394 struct netlink_ext_ack
*extack
)
396 struct flow_head
*head
= rtnl_dereference(tp
->root
);
397 struct flow_filter
*fold
, *fnew
;
398 struct nlattr
*opt
= tca
[TCA_OPTIONS
];
399 struct nlattr
*tb
[TCA_FLOW_MAX
+ 1];
400 unsigned int nkeys
= 0;
401 unsigned int perturb_period
= 0;
410 err
= nla_parse_nested_deprecated(tb
, TCA_FLOW_MAX
, opt
, flow_policy
,
415 if (tb
[TCA_FLOW_BASECLASS
]) {
416 baseclass
= nla_get_u32(tb
[TCA_FLOW_BASECLASS
]);
417 if (TC_H_MIN(baseclass
) == 0)
421 if (tb
[TCA_FLOW_KEYS
]) {
422 keymask
= nla_get_u32(tb
[TCA_FLOW_KEYS
]);
424 nkeys
= hweight32(keymask
);
428 if (fls(keymask
) - 1 > FLOW_KEY_MAX
)
431 if ((keymask
& (FLOW_KEY_SKUID
|FLOW_KEY_SKGID
)) &&
432 sk_user_ns(NETLINK_CB(in_skb
).sk
) != &init_user_ns
)
436 fnew
= kzalloc(sizeof(*fnew
), GFP_KERNEL
);
440 err
= tcf_em_tree_validate(tp
, tb
[TCA_FLOW_EMATCHES
], &fnew
->ematches
);
444 err
= tcf_exts_init(&fnew
->exts
, net
, TCA_FLOW_ACT
, TCA_FLOW_POLICE
);
448 err
= tcf_exts_validate(net
, tp
, tb
, tca
[TCA_RATE
], &fnew
->exts
, flags
,
456 if (fold
->handle
!= handle
&& handle
)
459 /* Copy fold into fnew */
461 fnew
->handle
= fold
->handle
;
462 fnew
->nkeys
= fold
->nkeys
;
463 fnew
->keymask
= fold
->keymask
;
464 fnew
->mode
= fold
->mode
;
465 fnew
->mask
= fold
->mask
;
466 fnew
->xor = fold
->xor;
467 fnew
->rshift
= fold
->rshift
;
468 fnew
->addend
= fold
->addend
;
469 fnew
->divisor
= fold
->divisor
;
470 fnew
->baseclass
= fold
->baseclass
;
471 fnew
->hashrnd
= fold
->hashrnd
;
474 if (tb
[TCA_FLOW_MODE
])
475 mode
= nla_get_u32(tb
[TCA_FLOW_MODE
]);
476 if (mode
!= FLOW_MODE_HASH
&& nkeys
> 1)
479 if (mode
== FLOW_MODE_HASH
)
480 perturb_period
= fold
->perturb_period
;
481 if (tb
[TCA_FLOW_PERTURB
]) {
482 if (mode
!= FLOW_MODE_HASH
)
484 perturb_period
= nla_get_u32(tb
[TCA_FLOW_PERTURB
]) * HZ
;
490 if (!tb
[TCA_FLOW_KEYS
])
493 mode
= FLOW_MODE_MAP
;
494 if (tb
[TCA_FLOW_MODE
])
495 mode
= nla_get_u32(tb
[TCA_FLOW_MODE
]);
496 if (mode
!= FLOW_MODE_HASH
&& nkeys
> 1)
499 if (tb
[TCA_FLOW_PERTURB
]) {
500 if (mode
!= FLOW_MODE_HASH
)
502 perturb_period
= nla_get_u32(tb
[TCA_FLOW_PERTURB
]) * HZ
;
505 if (TC_H_MAJ(baseclass
) == 0) {
506 struct Qdisc
*q
= tcf_block_q(tp
->chain
->block
);
508 baseclass
= TC_H_MAKE(q
->handle
, baseclass
);
510 if (TC_H_MIN(baseclass
) == 0)
511 baseclass
= TC_H_MAKE(baseclass
, 1);
513 fnew
->handle
= handle
;
516 get_random_bytes(&fnew
->hashrnd
, 4);
519 timer_setup(&fnew
->perturb_timer
, flow_perturbation
, TIMER_DEFERRABLE
);
521 tcf_block_netif_keep_dst(tp
->chain
->block
);
523 if (tb
[TCA_FLOW_KEYS
]) {
524 fnew
->keymask
= keymask
;
530 if (tb
[TCA_FLOW_MASK
])
531 fnew
->mask
= nla_get_u32(tb
[TCA_FLOW_MASK
]);
532 if (tb
[TCA_FLOW_XOR
])
533 fnew
->xor = nla_get_u32(tb
[TCA_FLOW_XOR
]);
534 if (tb
[TCA_FLOW_RSHIFT
])
535 fnew
->rshift
= nla_get_u32(tb
[TCA_FLOW_RSHIFT
]);
536 if (tb
[TCA_FLOW_ADDEND
])
537 fnew
->addend
= nla_get_u32(tb
[TCA_FLOW_ADDEND
]);
539 if (tb
[TCA_FLOW_DIVISOR
])
540 fnew
->divisor
= nla_get_u32(tb
[TCA_FLOW_DIVISOR
]);
542 fnew
->baseclass
= baseclass
;
544 fnew
->perturb_period
= perturb_period
;
546 mod_timer(&fnew
->perturb_timer
, jiffies
+ perturb_period
);
549 list_add_tail_rcu(&fnew
->list
, &head
->filters
);
551 list_replace_rcu(&fold
->list
, &fnew
->list
);
556 tcf_exts_get_net(&fold
->exts
);
557 tcf_queue_work(&fold
->rwork
, flow_destroy_filter_work
);
562 tcf_exts_destroy(&fnew
->exts
);
563 tcf_em_tree_destroy(&fnew
->ematches
);
569 static int flow_delete(struct tcf_proto
*tp
, void *arg
, bool *last
,
570 bool rtnl_held
, struct netlink_ext_ack
*extack
)
572 struct flow_head
*head
= rtnl_dereference(tp
->root
);
573 struct flow_filter
*f
= arg
;
575 list_del_rcu(&f
->list
);
576 tcf_exts_get_net(&f
->exts
);
577 tcf_queue_work(&f
->rwork
, flow_destroy_filter_work
);
578 *last
= list_empty(&head
->filters
);
582 static int flow_init(struct tcf_proto
*tp
)
584 struct flow_head
*head
;
586 head
= kzalloc(sizeof(*head
), GFP_KERNEL
);
589 INIT_LIST_HEAD(&head
->filters
);
590 rcu_assign_pointer(tp
->root
, head
);
594 static void flow_destroy(struct tcf_proto
*tp
, bool rtnl_held
,
595 struct netlink_ext_ack
*extack
)
597 struct flow_head
*head
= rtnl_dereference(tp
->root
);
598 struct flow_filter
*f
, *next
;
600 list_for_each_entry_safe(f
, next
, &head
->filters
, list
) {
601 list_del_rcu(&f
->list
);
602 if (tcf_exts_get_net(&f
->exts
))
603 tcf_queue_work(&f
->rwork
, flow_destroy_filter_work
);
605 __flow_destroy_filter(f
);
607 kfree_rcu(head
, rcu
);
610 static void *flow_get(struct tcf_proto
*tp
, u32 handle
)
612 struct flow_head
*head
= rtnl_dereference(tp
->root
);
613 struct flow_filter
*f
;
615 list_for_each_entry(f
, &head
->filters
, list
)
616 if (f
->handle
== handle
)
621 static int flow_dump(struct net
*net
, struct tcf_proto
*tp
, void *fh
,
622 struct sk_buff
*skb
, struct tcmsg
*t
, bool rtnl_held
)
624 struct flow_filter
*f
= fh
;
630 t
->tcm_handle
= f
->handle
;
632 nest
= nla_nest_start_noflag(skb
, TCA_OPTIONS
);
634 goto nla_put_failure
;
636 if (nla_put_u32(skb
, TCA_FLOW_KEYS
, f
->keymask
) ||
637 nla_put_u32(skb
, TCA_FLOW_MODE
, f
->mode
))
638 goto nla_put_failure
;
640 if (f
->mask
!= ~0 || f
->xor != 0) {
641 if (nla_put_u32(skb
, TCA_FLOW_MASK
, f
->mask
) ||
642 nla_put_u32(skb
, TCA_FLOW_XOR
, f
->xor))
643 goto nla_put_failure
;
646 nla_put_u32(skb
, TCA_FLOW_RSHIFT
, f
->rshift
))
647 goto nla_put_failure
;
649 nla_put_u32(skb
, TCA_FLOW_ADDEND
, f
->addend
))
650 goto nla_put_failure
;
653 nla_put_u32(skb
, TCA_FLOW_DIVISOR
, f
->divisor
))
654 goto nla_put_failure
;
656 nla_put_u32(skb
, TCA_FLOW_BASECLASS
, f
->baseclass
))
657 goto nla_put_failure
;
659 if (f
->perturb_period
&&
660 nla_put_u32(skb
, TCA_FLOW_PERTURB
, f
->perturb_period
/ HZ
))
661 goto nla_put_failure
;
663 if (tcf_exts_dump(skb
, &f
->exts
) < 0)
664 goto nla_put_failure
;
665 #ifdef CONFIG_NET_EMATCH
666 if (f
->ematches
.hdr
.nmatches
&&
667 tcf_em_tree_dump(skb
, &f
->ematches
, TCA_FLOW_EMATCHES
) < 0)
668 goto nla_put_failure
;
670 nla_nest_end(skb
, nest
);
672 if (tcf_exts_dump_stats(skb
, &f
->exts
) < 0)
673 goto nla_put_failure
;
678 nla_nest_cancel(skb
, nest
);
682 static void flow_walk(struct tcf_proto
*tp
, struct tcf_walker
*arg
,
685 struct flow_head
*head
= rtnl_dereference(tp
->root
);
686 struct flow_filter
*f
;
688 list_for_each_entry(f
, &head
->filters
, list
) {
689 if (!tc_cls_stats_dump(tp
, arg
, f
))
694 static struct tcf_proto_ops cls_flow_ops __read_mostly
= {
696 .classify
= flow_classify
,
698 .destroy
= flow_destroy
,
699 .change
= flow_change
,
700 .delete = flow_delete
,
704 .owner
= THIS_MODULE
,
706 MODULE_ALIAS_NET_CLS("flow");
708 static int __init
cls_flow_init(void)
710 return register_tcf_proto_ops(&cls_flow_ops
);
713 static void __exit
cls_flow_exit(void)
715 unregister_tcf_proto_ops(&cls_flow_ops
);
718 module_init(cls_flow_init
);
719 module_exit(cls_flow_exit
);
721 MODULE_LICENSE("GPL");
722 MODULE_AUTHOR("Patrick McHardy <kaber@trash.net>");
723 MODULE_DESCRIPTION("TC flow classifier");