1 // SPDX-License-Identifier: GPL-2.0-only
3 * Berkeley Packet Filter based traffic classifier
5 * Might be used to classify traffic through flexible, user-defined and
6 * possibly JIT-ed BPF filters for traffic control as an alternative to
9 * (C) 2013 Daniel Borkmann <dborkman@redhat.com>
12 #include <linux/module.h>
13 #include <linux/types.h>
14 #include <linux/skbuff.h>
15 #include <linux/filter.h>
16 #include <linux/bpf.h>
17 #include <linux/idr.h>
19 #include <net/rtnetlink.h>
20 #include <net/pkt_cls.h>
23 MODULE_LICENSE("GPL");
24 MODULE_AUTHOR("Daniel Borkmann <dborkman@redhat.com>");
25 MODULE_DESCRIPTION("TC BPF based classifier");
27 #define CLS_BPF_NAME_LEN 256
28 #define CLS_BPF_SUPPORTED_GEN_FLAGS \
29 (TCA_CLS_FLAGS_SKIP_HW | TCA_CLS_FLAGS_SKIP_SW)
32 struct list_head plist;
33 struct idr handle_idr;
38 struct bpf_prog *filter;
39 struct list_head link;
40 struct tcf_result res;
43 unsigned int in_hw_count;
47 struct sock_filter *bpf_ops;
50 struct rcu_work rwork;
53 static const struct nla_policy bpf_policy[TCA_BPF_MAX + 1] = {
54 [TCA_BPF_CLASSID] = { .type = NLA_U32 },
55 [TCA_BPF_FLAGS] = { .type = NLA_U32 },
56 [TCA_BPF_FLAGS_GEN] = { .type = NLA_U32 },
57 [TCA_BPF_FD] = { .type = NLA_U32 },
58 [TCA_BPF_NAME] = { .type = NLA_NUL_STRING,
59 .len = CLS_BPF_NAME_LEN },
60 [TCA_BPF_OPS_LEN] = { .type = NLA_U16 },
61 [TCA_BPF_OPS] = { .type = NLA_BINARY,
62 .len = sizeof(struct sock_filter) * BPF_MAXINSNS },
65 static int cls_bpf_exec_opcode(int code)
80 static int cls_bpf_classify(struct sk_buff *skb, const struct tcf_proto *tp,
81 struct tcf_result *res)
83 struct cls_bpf_head *head = rcu_dereference_bh(tp->root);
84 bool at_ingress = skb_at_tc_ingress(skb);
85 struct cls_bpf_prog *prog;
88 list_for_each_entry_rcu(prog, &head->plist, link) {
91 qdisc_skb_cb(skb)->tc_classid = prog->res.classid;
93 if (tc_skip_sw(prog->gen_flags)) {
94 filter_res = prog->exts_integrated ? TC_ACT_UNSPEC : 0;
95 } else if (at_ingress) {
96 /* It is safe to push/pull even if skb_shared() */
97 __skb_push(skb, skb->mac_len);
98 bpf_compute_data_pointers(skb);
99 filter_res = bpf_prog_run(prog->filter, skb);
100 __skb_pull(skb, skb->mac_len);
102 bpf_compute_data_pointers(skb);
103 filter_res = bpf_prog_run(prog->filter, skb);
105 if (unlikely(!skb->tstamp && skb->mono_delivery_time))
106 skb->mono_delivery_time = 0;
108 if (prog->exts_integrated) {
110 res->classid = TC_H_MAJ(prog->res.classid) |
111 qdisc_skb_cb(skb)->tc_classid;
113 ret = cls_bpf_exec_opcode(filter_res);
114 if (ret == TC_ACT_UNSPEC)
121 if (filter_res != -1) {
123 res->classid = filter_res;
128 ret = tcf_exts_exec(skb, &prog->exts, res);
138 static bool cls_bpf_is_ebpf(const struct cls_bpf_prog *prog)
140 return !prog->bpf_ops;
143 static int cls_bpf_offload_cmd(struct tcf_proto *tp, struct cls_bpf_prog *prog,
144 struct cls_bpf_prog *oldprog,
145 struct netlink_ext_ack *extack)
147 struct tcf_block *block = tp->chain->block;
148 struct tc_cls_bpf_offload cls_bpf = {};
149 struct cls_bpf_prog *obj;
153 skip_sw = prog && tc_skip_sw(prog->gen_flags);
154 obj = prog ?: oldprog;
156 tc_cls_common_offload_init(&cls_bpf.common, tp, obj->gen_flags, extack);
157 cls_bpf.command = TC_CLSBPF_OFFLOAD;
158 cls_bpf.exts = &obj->exts;
159 cls_bpf.prog = prog ? prog->filter : NULL;
160 cls_bpf.oldprog = oldprog ? oldprog->filter : NULL;
161 cls_bpf.name = obj->bpf_name;
162 cls_bpf.exts_integrated = obj->exts_integrated;
165 err = tc_setup_cb_replace(block, tp, TC_SETUP_CLSBPF, &cls_bpf,
166 skip_sw, &oldprog->gen_flags,
167 &oldprog->in_hw_count,
168 &prog->gen_flags, &prog->in_hw_count,
171 err = tc_setup_cb_add(block, tp, TC_SETUP_CLSBPF, &cls_bpf,
172 skip_sw, &prog->gen_flags,
173 &prog->in_hw_count, true);
175 err = tc_setup_cb_destroy(block, tp, TC_SETUP_CLSBPF, &cls_bpf,
176 skip_sw, &oldprog->gen_flags,
177 &oldprog->in_hw_count, true);
180 cls_bpf_offload_cmd(tp, oldprog, prog, extack);
184 if (prog && skip_sw && !(prog->gen_flags & TCA_CLS_FLAGS_IN_HW))
190 static u32 cls_bpf_flags(u32 flags)
192 return flags & CLS_BPF_SUPPORTED_GEN_FLAGS;
195 static int cls_bpf_offload(struct tcf_proto *tp, struct cls_bpf_prog *prog,
196 struct cls_bpf_prog *oldprog,
197 struct netlink_ext_ack *extack)
199 if (prog && oldprog &&
200 cls_bpf_flags(prog->gen_flags) !=
201 cls_bpf_flags(oldprog->gen_flags))
204 if (prog && tc_skip_hw(prog->gen_flags))
206 if (oldprog && tc_skip_hw(oldprog->gen_flags))
208 if (!prog && !oldprog)
211 return cls_bpf_offload_cmd(tp, prog, oldprog, extack);
214 static void cls_bpf_stop_offload(struct tcf_proto *tp,
215 struct cls_bpf_prog *prog,
216 struct netlink_ext_ack *extack)
220 err = cls_bpf_offload_cmd(tp, NULL, prog, extack);
222 pr_err("Stopping hardware offload failed: %d\n", err);
225 static void cls_bpf_offload_update_stats(struct tcf_proto *tp,
226 struct cls_bpf_prog *prog)
228 struct tcf_block *block = tp->chain->block;
229 struct tc_cls_bpf_offload cls_bpf = {};
231 tc_cls_common_offload_init(&cls_bpf.common, tp, prog->gen_flags, NULL);
232 cls_bpf.command = TC_CLSBPF_STATS;
233 cls_bpf.exts = &prog->exts;
234 cls_bpf.prog = prog->filter;
235 cls_bpf.name = prog->bpf_name;
236 cls_bpf.exts_integrated = prog->exts_integrated;
238 tc_setup_cb_call(block, TC_SETUP_CLSBPF, &cls_bpf, false, true);
241 static int cls_bpf_init(struct tcf_proto *tp)
243 struct cls_bpf_head *head;
245 head = kzalloc(sizeof(*head), GFP_KERNEL);
249 INIT_LIST_HEAD_RCU(&head->plist);
250 idr_init(&head->handle_idr);
251 rcu_assign_pointer(tp->root, head);
256 static void cls_bpf_free_parms(struct cls_bpf_prog *prog)
258 if (cls_bpf_is_ebpf(prog))
259 bpf_prog_put(prog->filter);
261 bpf_prog_destroy(prog->filter);
263 kfree(prog->bpf_name);
264 kfree(prog->bpf_ops);
267 static void __cls_bpf_delete_prog(struct cls_bpf_prog *prog)
269 tcf_exts_destroy(&prog->exts);
270 tcf_exts_put_net(&prog->exts);
272 cls_bpf_free_parms(prog);
276 static void cls_bpf_delete_prog_work(struct work_struct *work)
278 struct cls_bpf_prog *prog = container_of(to_rcu_work(work),
282 __cls_bpf_delete_prog(prog);
286 static void __cls_bpf_delete(struct tcf_proto *tp, struct cls_bpf_prog *prog,
287 struct netlink_ext_ack *extack)
289 struct cls_bpf_head *head = rtnl_dereference(tp->root);
291 idr_remove(&head->handle_idr, prog->handle);
292 cls_bpf_stop_offload(tp, prog, extack);
293 list_del_rcu(&prog->link);
294 tcf_unbind_filter(tp, &prog->res);
295 if (tcf_exts_get_net(&prog->exts))
296 tcf_queue_work(&prog->rwork, cls_bpf_delete_prog_work);
298 __cls_bpf_delete_prog(prog);
301 static int cls_bpf_delete(struct tcf_proto *tp, void *arg, bool *last,
302 bool rtnl_held, struct netlink_ext_ack *extack)
304 struct cls_bpf_head *head = rtnl_dereference(tp->root);
306 __cls_bpf_delete(tp, arg, extack);
307 *last = list_empty(&head->plist);
311 static void cls_bpf_destroy(struct tcf_proto *tp, bool rtnl_held,
312 struct netlink_ext_ack *extack)
314 struct cls_bpf_head *head = rtnl_dereference(tp->root);
315 struct cls_bpf_prog *prog, *tmp;
317 list_for_each_entry_safe(prog, tmp, &head->plist, link)
318 __cls_bpf_delete(tp, prog, extack);
320 idr_destroy(&head->handle_idr);
321 kfree_rcu(head, rcu);
324 static void *cls_bpf_get(struct tcf_proto *tp, u32 handle)
326 struct cls_bpf_head *head = rtnl_dereference(tp->root);
327 struct cls_bpf_prog *prog;
329 list_for_each_entry(prog, &head->plist, link) {
330 if (prog->handle == handle)
337 static int cls_bpf_prog_from_ops(struct nlattr **tb, struct cls_bpf_prog *prog)
339 struct sock_filter *bpf_ops;
340 struct sock_fprog_kern fprog_tmp;
342 u16 bpf_size, bpf_num_ops;
345 bpf_num_ops = nla_get_u16(tb[TCA_BPF_OPS_LEN]);
346 if (bpf_num_ops > BPF_MAXINSNS || bpf_num_ops == 0)
349 bpf_size = bpf_num_ops * sizeof(*bpf_ops);
350 if (bpf_size != nla_len(tb[TCA_BPF_OPS]))
353 bpf_ops = kmemdup(nla_data(tb[TCA_BPF_OPS]), bpf_size, GFP_KERNEL);
357 fprog_tmp.len = bpf_num_ops;
358 fprog_tmp.filter = bpf_ops;
360 ret = bpf_prog_create(&fp, &fprog_tmp);
366 prog->bpf_ops = bpf_ops;
367 prog->bpf_num_ops = bpf_num_ops;
368 prog->bpf_name = NULL;
374 static int cls_bpf_prog_from_efd(struct nlattr **tb, struct cls_bpf_prog *prog,
375 u32 gen_flags, const struct tcf_proto *tp)
382 bpf_fd = nla_get_u32(tb[TCA_BPF_FD]);
383 skip_sw = gen_flags & TCA_CLS_FLAGS_SKIP_SW;
385 fp = bpf_prog_get_type_dev(bpf_fd, BPF_PROG_TYPE_SCHED_CLS, skip_sw);
389 if (tb[TCA_BPF_NAME]) {
390 name = nla_memdup(tb[TCA_BPF_NAME], GFP_KERNEL);
397 prog->bpf_ops = NULL;
398 prog->bpf_name = name;
402 tcf_block_netif_keep_dst(tp->chain->block);
407 static int cls_bpf_set_parms(struct net *net, struct tcf_proto *tp,
408 struct cls_bpf_prog *prog, unsigned long base,
409 struct nlattr **tb, struct nlattr *est, u32 flags,
410 struct netlink_ext_ack *extack)
412 bool is_bpf, is_ebpf, have_exts = false;
416 is_bpf = tb[TCA_BPF_OPS_LEN] && tb[TCA_BPF_OPS];
417 is_ebpf = tb[TCA_BPF_FD];
418 if ((!is_bpf && !is_ebpf) || (is_bpf && is_ebpf))
421 ret = tcf_exts_validate(net, tp, tb, est, &prog->exts, flags,
426 if (tb[TCA_BPF_FLAGS]) {
427 u32 bpf_flags = nla_get_u32(tb[TCA_BPF_FLAGS]);
429 if (bpf_flags & ~TCA_BPF_FLAG_ACT_DIRECT)
432 have_exts = bpf_flags & TCA_BPF_FLAG_ACT_DIRECT;
434 if (tb[TCA_BPF_FLAGS_GEN]) {
435 gen_flags = nla_get_u32(tb[TCA_BPF_FLAGS_GEN]);
436 if (gen_flags & ~CLS_BPF_SUPPORTED_GEN_FLAGS ||
437 !tc_flags_valid(gen_flags))
441 prog->exts_integrated = have_exts;
442 prog->gen_flags = gen_flags;
444 ret = is_bpf ? cls_bpf_prog_from_ops(tb, prog) :
445 cls_bpf_prog_from_efd(tb, prog, gen_flags, tp);
449 if (tb[TCA_BPF_CLASSID]) {
450 prog->res.classid = nla_get_u32(tb[TCA_BPF_CLASSID]);
451 tcf_bind_filter(tp, &prog->res, base);
457 static int cls_bpf_change(struct net *net, struct sk_buff *in_skb,
458 struct tcf_proto *tp, unsigned long base,
459 u32 handle, struct nlattr **tca,
460 void **arg, u32 flags,
461 struct netlink_ext_ack *extack)
463 struct cls_bpf_head *head = rtnl_dereference(tp->root);
464 struct cls_bpf_prog *oldprog = *arg;
465 struct nlattr *tb[TCA_BPF_MAX + 1];
466 struct cls_bpf_prog *prog;
469 if (tca[TCA_OPTIONS] == NULL)
472 ret = nla_parse_nested_deprecated(tb, TCA_BPF_MAX, tca[TCA_OPTIONS],
477 prog = kzalloc(sizeof(*prog), GFP_KERNEL);
481 ret = tcf_exts_init(&prog->exts, net, TCA_BPF_ACT, TCA_BPF_POLICE);
486 if (handle && oldprog->handle != handle) {
494 ret = idr_alloc_u32(&head->handle_idr, prog, &handle,
495 INT_MAX, GFP_KERNEL);
496 } else if (!oldprog) {
497 ret = idr_alloc_u32(&head->handle_idr, prog, &handle,
503 prog->handle = handle;
505 ret = cls_bpf_set_parms(net, tp, prog, base, tb, tca[TCA_RATE], flags,
510 ret = cls_bpf_offload(tp, prog, oldprog, extack);
514 if (!tc_in_hw(prog->gen_flags))
515 prog->gen_flags |= TCA_CLS_FLAGS_NOT_IN_HW;
518 idr_replace(&head->handle_idr, prog, handle);
519 list_replace_rcu(&oldprog->link, &prog->link);
520 tcf_unbind_filter(tp, &oldprog->res);
521 tcf_exts_get_net(&oldprog->exts);
522 tcf_queue_work(&oldprog->rwork, cls_bpf_delete_prog_work);
524 list_add_rcu(&prog->link, &head->plist);
531 cls_bpf_free_parms(prog);
534 idr_remove(&head->handle_idr, prog->handle);
536 tcf_exts_destroy(&prog->exts);
541 static int cls_bpf_dump_bpf_info(const struct cls_bpf_prog *prog,
546 if (nla_put_u16(skb, TCA_BPF_OPS_LEN, prog->bpf_num_ops))
549 nla = nla_reserve(skb, TCA_BPF_OPS, prog->bpf_num_ops *
550 sizeof(struct sock_filter));
554 memcpy(nla_data(nla), prog->bpf_ops, nla_len(nla));
559 static int cls_bpf_dump_ebpf_info(const struct cls_bpf_prog *prog,
564 if (prog->bpf_name &&
565 nla_put_string(skb, TCA_BPF_NAME, prog->bpf_name))
568 if (nla_put_u32(skb, TCA_BPF_ID, prog->filter->aux->id))
571 nla = nla_reserve(skb, TCA_BPF_TAG, sizeof(prog->filter->tag));
575 memcpy(nla_data(nla), prog->filter->tag, nla_len(nla));
580 static int cls_bpf_dump(struct net *net, struct tcf_proto *tp, void *fh,
581 struct sk_buff *skb, struct tcmsg *tm, bool rtnl_held)
583 struct cls_bpf_prog *prog = fh;
591 tm->tcm_handle = prog->handle;
593 cls_bpf_offload_update_stats(tp, prog);
595 nest = nla_nest_start_noflag(skb, TCA_OPTIONS);
597 goto nla_put_failure;
599 if (prog->res.classid &&
600 nla_put_u32(skb, TCA_BPF_CLASSID, prog->res.classid))
601 goto nla_put_failure;
603 if (cls_bpf_is_ebpf(prog))
604 ret = cls_bpf_dump_ebpf_info(prog, skb);
606 ret = cls_bpf_dump_bpf_info(prog, skb);
608 goto nla_put_failure;
610 if (tcf_exts_dump(skb, &prog->exts) < 0)
611 goto nla_put_failure;
613 if (prog->exts_integrated)
614 bpf_flags |= TCA_BPF_FLAG_ACT_DIRECT;
615 if (bpf_flags && nla_put_u32(skb, TCA_BPF_FLAGS, bpf_flags))
616 goto nla_put_failure;
617 if (prog->gen_flags &&
618 nla_put_u32(skb, TCA_BPF_FLAGS_GEN, prog->gen_flags))
619 goto nla_put_failure;
621 nla_nest_end(skb, nest);
623 if (tcf_exts_dump_stats(skb, &prog->exts) < 0)
624 goto nla_put_failure;
629 nla_nest_cancel(skb, nest);
633 static void cls_bpf_bind_class(void *fh, u32 classid, unsigned long cl,
634 void *q, unsigned long base)
636 struct cls_bpf_prog *prog = fh;
638 tc_cls_bind_class(classid, cl, q, &prog->res, base);
641 static void cls_bpf_walk(struct tcf_proto *tp, struct tcf_walker *arg,
644 struct cls_bpf_head *head = rtnl_dereference(tp->root);
645 struct cls_bpf_prog *prog;
647 list_for_each_entry(prog, &head->plist, link) {
648 if (!tc_cls_stats_dump(tp, arg, prog))
653 static int cls_bpf_reoffload(struct tcf_proto *tp, bool add, flow_setup_cb_t *cb,
654 void *cb_priv, struct netlink_ext_ack *extack)
656 struct cls_bpf_head *head = rtnl_dereference(tp->root);
657 struct tcf_block *block = tp->chain->block;
658 struct tc_cls_bpf_offload cls_bpf = {};
659 struct cls_bpf_prog *prog;
662 list_for_each_entry(prog, &head->plist, link) {
663 if (tc_skip_hw(prog->gen_flags))
666 tc_cls_common_offload_init(&cls_bpf.common, tp, prog->gen_flags,
668 cls_bpf.command = TC_CLSBPF_OFFLOAD;
669 cls_bpf.exts = &prog->exts;
670 cls_bpf.prog = add ? prog->filter : NULL;
671 cls_bpf.oldprog = add ? NULL : prog->filter;
672 cls_bpf.name = prog->bpf_name;
673 cls_bpf.exts_integrated = prog->exts_integrated;
675 err = tc_setup_cb_reoffload(block, tp, add, cb, TC_SETUP_CLSBPF,
676 &cls_bpf, cb_priv, &prog->gen_flags,
685 static struct tcf_proto_ops cls_bpf_ops __read_mostly = {
687 .owner = THIS_MODULE,
688 .classify = cls_bpf_classify,
689 .init = cls_bpf_init,
690 .destroy = cls_bpf_destroy,
692 .change = cls_bpf_change,
693 .delete = cls_bpf_delete,
694 .walk = cls_bpf_walk,
695 .reoffload = cls_bpf_reoffload,
696 .dump = cls_bpf_dump,
697 .bind_class = cls_bpf_bind_class,
700 static int __init cls_bpf_init_mod(void)
702 return register_tcf_proto_ops(&cls_bpf_ops);
705 static void __exit cls_bpf_exit_mod(void)
707 unregister_tcf_proto_ops(&cls_bpf_ops);
710 module_init(cls_bpf_init_mod);
711 module_exit(cls_bpf_exit_mod);