2 * Copyright (C) 2017-2018 Netronome Systems, Inc.
4 * This software is licensed under the GNU General License Version 2,
5 * June 1991 as shown in the file COPYING in the top-level directory of this
8 * THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
9 * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
10 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
11 * FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
12 * OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
13 * THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16 #include <linux/bpf.h>
17 #include <linux/bpf_verifier.h>
18 #include <linux/bug.h>
19 #include <linux/kdev_t.h>
20 #include <linux/list.h>
21 #include <linux/lockdep.h>
22 #include <linux/netdevice.h>
23 #include <linux/printk.h>
24 #include <linux/proc_ns.h>
25 #include <linux/rhashtable.h>
26 #include <linux/rtnetlink.h>
27 #include <linux/rwsem.h>
29 /* Protects offdevs, members of bpf_offload_netdev and offload members
31 * RTNL lock cannot be taken when holding this lock.
33 static DECLARE_RWSEM(bpf_devs_lock);
35 struct bpf_offload_dev {
36 const struct bpf_prog_offload_ops *ops;
37 struct list_head netdevs;
41 struct bpf_offload_netdev {
43 struct net_device *netdev;
44 struct bpf_offload_dev *offdev; /* NULL when bound-only */
45 struct list_head progs;
46 struct list_head maps;
47 struct list_head offdev_netdevs;
50 static const struct rhashtable_params offdevs_params = {
52 .key_len = sizeof(struct net_device *),
53 .key_offset = offsetof(struct bpf_offload_netdev, netdev),
54 .head_offset = offsetof(struct bpf_offload_netdev, l),
55 .automatic_shrinking = true,
58 static struct rhashtable offdevs;
60 static int bpf_dev_offload_check(struct net_device *netdev)
64 if (!netdev->netdev_ops->ndo_bpf)
69 static struct bpf_offload_netdev *
70 bpf_offload_find_netdev(struct net_device *netdev)
72 lockdep_assert_held(&bpf_devs_lock);
74 return rhashtable_lookup_fast(&offdevs, &netdev, offdevs_params);
77 static int __bpf_offload_dev_netdev_register(struct bpf_offload_dev *offdev,
78 struct net_device *netdev)
80 struct bpf_offload_netdev *ondev;
83 ondev = kzalloc(sizeof(*ondev), GFP_KERNEL);
87 ondev->netdev = netdev;
88 ondev->offdev = offdev;
89 INIT_LIST_HEAD(&ondev->progs);
90 INIT_LIST_HEAD(&ondev->maps);
92 err = rhashtable_insert_fast(&offdevs, &ondev->l, offdevs_params);
94 netdev_warn(netdev, "failed to register for BPF offload\n");
99 list_add(&ondev->offdev_netdevs, &offdev->netdevs);
107 static void __bpf_prog_offload_destroy(struct bpf_prog *prog)
109 struct bpf_prog_offload *offload = prog->aux->offload;
111 if (offload->dev_state)
112 offload->offdev->ops->destroy(prog);
114 list_del_init(&offload->offloads);
116 prog->aux->offload = NULL;
119 static int bpf_map_offload_ndo(struct bpf_offloaded_map *offmap,
120 enum bpf_netdev_command cmd)
122 struct netdev_bpf data = {};
123 struct net_device *netdev;
128 data.offmap = offmap;
129 /* Caller must make sure netdev is valid */
130 netdev = offmap->netdev;
132 return netdev->netdev_ops->ndo_bpf(netdev, &data);
135 static void __bpf_map_offload_destroy(struct bpf_offloaded_map *offmap)
137 WARN_ON(bpf_map_offload_ndo(offmap, BPF_OFFLOAD_MAP_FREE));
138 /* Make sure BPF_MAP_GET_NEXT_ID can't find this dead map */
139 bpf_map_free_id(&offmap->map);
140 list_del_init(&offmap->offloads);
141 offmap->netdev = NULL;
144 static void __bpf_offload_dev_netdev_unregister(struct bpf_offload_dev *offdev,
145 struct net_device *netdev)
147 struct bpf_offload_netdev *ondev, *altdev = NULL;
148 struct bpf_offloaded_map *offmap, *mtmp;
149 struct bpf_prog_offload *offload, *ptmp;
153 ondev = rhashtable_lookup_fast(&offdevs, &netdev, offdevs_params);
157 WARN_ON(rhashtable_remove_fast(&offdevs, &ondev->l, offdevs_params));
159 /* Try to move the objects to another netdev of the device */
161 list_del(&ondev->offdev_netdevs);
162 altdev = list_first_entry_or_null(&offdev->netdevs,
163 struct bpf_offload_netdev,
168 list_for_each_entry(offload, &ondev->progs, offloads)
169 offload->netdev = altdev->netdev;
170 list_splice_init(&ondev->progs, &altdev->progs);
172 list_for_each_entry(offmap, &ondev->maps, offloads)
173 offmap->netdev = altdev->netdev;
174 list_splice_init(&ondev->maps, &altdev->maps);
176 list_for_each_entry_safe(offload, ptmp, &ondev->progs, offloads)
177 __bpf_prog_offload_destroy(offload->prog);
178 list_for_each_entry_safe(offmap, mtmp, &ondev->maps, offloads)
179 __bpf_map_offload_destroy(offmap);
182 WARN_ON(!list_empty(&ondev->progs));
183 WARN_ON(!list_empty(&ondev->maps));
187 static int __bpf_prog_dev_bound_init(struct bpf_prog *prog, struct net_device *netdev)
189 struct bpf_offload_netdev *ondev;
190 struct bpf_prog_offload *offload;
193 offload = kzalloc(sizeof(*offload), GFP_USER);
197 offload->prog = prog;
198 offload->netdev = netdev;
200 ondev = bpf_offload_find_netdev(offload->netdev);
202 if (bpf_prog_is_offloaded(prog->aux)) {
207 /* When only binding to the device, explicitly
208 * create an entry in the hashtable.
210 err = __bpf_offload_dev_netdev_register(NULL, offload->netdev);
213 ondev = bpf_offload_find_netdev(offload->netdev);
215 offload->offdev = ondev->offdev;
216 prog->aux->offload = offload;
217 list_add_tail(&offload->offloads, &ondev->progs);
225 int bpf_prog_dev_bound_init(struct bpf_prog *prog, union bpf_attr *attr)
227 struct net_device *netdev;
230 if (attr->prog_type != BPF_PROG_TYPE_SCHED_CLS &&
231 attr->prog_type != BPF_PROG_TYPE_XDP)
234 if (attr->prog_flags & ~BPF_F_XDP_DEV_BOUND_ONLY)
237 if (attr->prog_type == BPF_PROG_TYPE_SCHED_CLS &&
238 attr->prog_flags & BPF_F_XDP_DEV_BOUND_ONLY)
241 netdev = dev_get_by_index(current->nsproxy->net_ns, attr->prog_ifindex);
245 err = bpf_dev_offload_check(netdev);
249 prog->aux->offload_requested = !(attr->prog_flags & BPF_F_XDP_DEV_BOUND_ONLY);
251 down_write(&bpf_devs_lock);
252 err = __bpf_prog_dev_bound_init(prog, netdev);
253 up_write(&bpf_devs_lock);
260 int bpf_prog_dev_bound_inherit(struct bpf_prog *new_prog, struct bpf_prog *old_prog)
264 if (!bpf_prog_is_dev_bound(old_prog->aux))
267 if (bpf_prog_is_offloaded(old_prog->aux))
270 new_prog->aux->dev_bound = old_prog->aux->dev_bound;
271 new_prog->aux->offload_requested = old_prog->aux->offload_requested;
273 down_write(&bpf_devs_lock);
274 if (!old_prog->aux->offload) {
279 err = __bpf_prog_dev_bound_init(new_prog, old_prog->aux->offload->netdev);
282 up_write(&bpf_devs_lock);
286 int bpf_prog_offload_verifier_prep(struct bpf_prog *prog)
288 struct bpf_prog_offload *offload;
291 down_read(&bpf_devs_lock);
292 offload = prog->aux->offload;
294 ret = offload->offdev->ops->prepare(prog);
295 offload->dev_state = !ret;
297 up_read(&bpf_devs_lock);
302 int bpf_prog_offload_verify_insn(struct bpf_verifier_env *env,
303 int insn_idx, int prev_insn_idx)
305 struct bpf_prog_offload *offload;
308 down_read(&bpf_devs_lock);
309 offload = env->prog->aux->offload;
311 ret = offload->offdev->ops->insn_hook(env, insn_idx,
313 up_read(&bpf_devs_lock);
318 int bpf_prog_offload_finalize(struct bpf_verifier_env *env)
320 struct bpf_prog_offload *offload;
323 down_read(&bpf_devs_lock);
324 offload = env->prog->aux->offload;
326 if (offload->offdev->ops->finalize)
327 ret = offload->offdev->ops->finalize(env);
331 up_read(&bpf_devs_lock);
337 bpf_prog_offload_replace_insn(struct bpf_verifier_env *env, u32 off,
338 struct bpf_insn *insn)
340 const struct bpf_prog_offload_ops *ops;
341 struct bpf_prog_offload *offload;
342 int ret = -EOPNOTSUPP;
344 down_read(&bpf_devs_lock);
345 offload = env->prog->aux->offload;
347 ops = offload->offdev->ops;
348 if (!offload->opt_failed && ops->replace_insn)
349 ret = ops->replace_insn(env, off, insn);
350 offload->opt_failed |= ret;
352 up_read(&bpf_devs_lock);
356 bpf_prog_offload_remove_insns(struct bpf_verifier_env *env, u32 off, u32 cnt)
358 struct bpf_prog_offload *offload;
359 int ret = -EOPNOTSUPP;
361 down_read(&bpf_devs_lock);
362 offload = env->prog->aux->offload;
364 if (!offload->opt_failed && offload->offdev->ops->remove_insns)
365 ret = offload->offdev->ops->remove_insns(env, off, cnt);
366 offload->opt_failed |= ret;
368 up_read(&bpf_devs_lock);
371 void bpf_prog_dev_bound_destroy(struct bpf_prog *prog)
373 struct bpf_offload_netdev *ondev;
374 struct net_device *netdev;
377 down_write(&bpf_devs_lock);
378 if (prog->aux->offload) {
379 list_del_init(&prog->aux->offload->offloads);
381 netdev = prog->aux->offload->netdev;
382 __bpf_prog_offload_destroy(prog);
384 ondev = bpf_offload_find_netdev(netdev);
385 if (!ondev->offdev && list_empty(&ondev->progs))
386 __bpf_offload_dev_netdev_unregister(NULL, netdev);
388 up_write(&bpf_devs_lock);
392 static int bpf_prog_offload_translate(struct bpf_prog *prog)
394 struct bpf_prog_offload *offload;
397 down_read(&bpf_devs_lock);
398 offload = prog->aux->offload;
400 ret = offload->offdev->ops->translate(prog);
401 up_read(&bpf_devs_lock);
406 static unsigned int bpf_prog_warn_on_exec(const void *ctx,
407 const struct bpf_insn *insn)
409 WARN(1, "attempt to execute device eBPF program on the host!");
413 int bpf_prog_offload_compile(struct bpf_prog *prog)
415 prog->bpf_func = bpf_prog_warn_on_exec;
417 return bpf_prog_offload_translate(prog);
420 struct ns_get_path_bpf_prog_args {
421 struct bpf_prog *prog;
422 struct bpf_prog_info *info;
425 static struct ns_common *bpf_prog_offload_info_fill_ns(void *private_data)
427 struct ns_get_path_bpf_prog_args *args = private_data;
428 struct bpf_prog_aux *aux = args->prog->aux;
429 struct ns_common *ns;
433 down_read(&bpf_devs_lock);
436 args->info->ifindex = aux->offload->netdev->ifindex;
437 net = dev_net(aux->offload->netdev);
441 args->info->ifindex = 0;
445 up_read(&bpf_devs_lock);
451 int bpf_prog_offload_info_fill(struct bpf_prog_info *info,
452 struct bpf_prog *prog)
454 struct ns_get_path_bpf_prog_args args = {
458 struct bpf_prog_aux *aux = prog->aux;
459 struct inode *ns_inode;
465 res = ns_get_path_cb(&ns_path, bpf_prog_offload_info_fill_ns, &args);
472 down_read(&bpf_devs_lock);
475 up_read(&bpf_devs_lock);
479 ulen = info->jited_prog_len;
480 info->jited_prog_len = aux->offload->jited_len;
481 if (info->jited_prog_len && ulen) {
482 uinsns = u64_to_user_ptr(info->jited_prog_insns);
483 ulen = min_t(u32, info->jited_prog_len, ulen);
484 if (copy_to_user(uinsns, aux->offload->jited_image, ulen)) {
485 up_read(&bpf_devs_lock);
490 up_read(&bpf_devs_lock);
492 ns_inode = ns_path.dentry->d_inode;
493 info->netns_dev = new_encode_dev(ns_inode->i_sb->s_dev);
494 info->netns_ino = ns_inode->i_ino;
500 const struct bpf_prog_ops bpf_offload_prog_ops = {
503 struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr)
505 struct net *net = current->nsproxy->net_ns;
506 struct bpf_offload_netdev *ondev;
507 struct bpf_offloaded_map *offmap;
510 if (!capable(CAP_SYS_ADMIN))
511 return ERR_PTR(-EPERM);
512 if (attr->map_type != BPF_MAP_TYPE_ARRAY &&
513 attr->map_type != BPF_MAP_TYPE_HASH)
514 return ERR_PTR(-EINVAL);
516 offmap = bpf_map_area_alloc(sizeof(*offmap), NUMA_NO_NODE);
518 return ERR_PTR(-ENOMEM);
520 bpf_map_init_from_attr(&offmap->map, attr);
523 down_write(&bpf_devs_lock);
524 offmap->netdev = __dev_get_by_index(net, attr->map_ifindex);
525 err = bpf_dev_offload_check(offmap->netdev);
529 ondev = bpf_offload_find_netdev(offmap->netdev);
535 err = bpf_map_offload_ndo(offmap, BPF_OFFLOAD_MAP_ALLOC);
539 list_add_tail(&offmap->offloads, &ondev->maps);
540 up_write(&bpf_devs_lock);
546 up_write(&bpf_devs_lock);
548 bpf_map_area_free(offmap);
552 void bpf_map_offload_map_free(struct bpf_map *map)
554 struct bpf_offloaded_map *offmap = map_to_offmap(map);
557 down_write(&bpf_devs_lock);
559 __bpf_map_offload_destroy(offmap);
560 up_write(&bpf_devs_lock);
563 bpf_map_area_free(offmap);
566 u64 bpf_map_offload_map_mem_usage(const struct bpf_map *map)
568 /* The memory dynamically allocated in netdev dev_ops is not counted */
569 return sizeof(struct bpf_offloaded_map);
572 int bpf_map_offload_lookup_elem(struct bpf_map *map, void *key, void *value)
574 struct bpf_offloaded_map *offmap = map_to_offmap(map);
577 down_read(&bpf_devs_lock);
579 ret = offmap->dev_ops->map_lookup_elem(offmap, key, value);
580 up_read(&bpf_devs_lock);
585 int bpf_map_offload_update_elem(struct bpf_map *map,
586 void *key, void *value, u64 flags)
588 struct bpf_offloaded_map *offmap = map_to_offmap(map);
591 if (unlikely(flags > BPF_EXIST))
594 down_read(&bpf_devs_lock);
596 ret = offmap->dev_ops->map_update_elem(offmap, key, value,
598 up_read(&bpf_devs_lock);
603 int bpf_map_offload_delete_elem(struct bpf_map *map, void *key)
605 struct bpf_offloaded_map *offmap = map_to_offmap(map);
608 down_read(&bpf_devs_lock);
610 ret = offmap->dev_ops->map_delete_elem(offmap, key);
611 up_read(&bpf_devs_lock);
616 int bpf_map_offload_get_next_key(struct bpf_map *map, void *key, void *next_key)
618 struct bpf_offloaded_map *offmap = map_to_offmap(map);
621 down_read(&bpf_devs_lock);
623 ret = offmap->dev_ops->map_get_next_key(offmap, key, next_key);
624 up_read(&bpf_devs_lock);
629 struct ns_get_path_bpf_map_args {
630 struct bpf_offloaded_map *offmap;
631 struct bpf_map_info *info;
634 static struct ns_common *bpf_map_offload_info_fill_ns(void *private_data)
636 struct ns_get_path_bpf_map_args *args = private_data;
637 struct ns_common *ns;
641 down_read(&bpf_devs_lock);
643 if (args->offmap->netdev) {
644 args->info->ifindex = args->offmap->netdev->ifindex;
645 net = dev_net(args->offmap->netdev);
649 args->info->ifindex = 0;
653 up_read(&bpf_devs_lock);
659 int bpf_map_offload_info_fill(struct bpf_map_info *info, struct bpf_map *map)
661 struct ns_get_path_bpf_map_args args = {
662 .offmap = map_to_offmap(map),
665 struct inode *ns_inode;
669 res = ns_get_path_cb(&ns_path, bpf_map_offload_info_fill_ns, &args);
676 ns_inode = ns_path.dentry->d_inode;
677 info->netns_dev = new_encode_dev(ns_inode->i_sb->s_dev);
678 info->netns_ino = ns_inode->i_ino;
684 static bool __bpf_offload_dev_match(struct bpf_prog *prog,
685 struct net_device *netdev)
687 struct bpf_offload_netdev *ondev1, *ondev2;
688 struct bpf_prog_offload *offload;
690 if (!bpf_prog_is_dev_bound(prog->aux))
693 offload = prog->aux->offload;
696 if (offload->netdev == netdev)
699 ondev1 = bpf_offload_find_netdev(offload->netdev);
700 ondev2 = bpf_offload_find_netdev(netdev);
702 return ondev1 && ondev2 && ondev1->offdev == ondev2->offdev;
705 bool bpf_offload_dev_match(struct bpf_prog *prog, struct net_device *netdev)
709 down_read(&bpf_devs_lock);
710 ret = __bpf_offload_dev_match(prog, netdev);
711 up_read(&bpf_devs_lock);
715 EXPORT_SYMBOL_GPL(bpf_offload_dev_match);
717 bool bpf_prog_dev_bound_match(const struct bpf_prog *lhs, const struct bpf_prog *rhs)
721 if (bpf_prog_is_offloaded(lhs->aux) != bpf_prog_is_offloaded(rhs->aux))
724 down_read(&bpf_devs_lock);
725 ret = lhs->aux->offload && rhs->aux->offload &&
726 lhs->aux->offload->netdev &&
727 lhs->aux->offload->netdev == rhs->aux->offload->netdev;
728 up_read(&bpf_devs_lock);
733 bool bpf_offload_prog_map_match(struct bpf_prog *prog, struct bpf_map *map)
735 struct bpf_offloaded_map *offmap;
738 if (!bpf_map_is_offloaded(map))
739 return bpf_map_offload_neutral(map);
740 offmap = map_to_offmap(map);
742 down_read(&bpf_devs_lock);
743 ret = __bpf_offload_dev_match(prog, offmap->netdev);
744 up_read(&bpf_devs_lock);
749 int bpf_offload_dev_netdev_register(struct bpf_offload_dev *offdev,
750 struct net_device *netdev)
754 down_write(&bpf_devs_lock);
755 err = __bpf_offload_dev_netdev_register(offdev, netdev);
756 up_write(&bpf_devs_lock);
759 EXPORT_SYMBOL_GPL(bpf_offload_dev_netdev_register);
761 void bpf_offload_dev_netdev_unregister(struct bpf_offload_dev *offdev,
762 struct net_device *netdev)
764 down_write(&bpf_devs_lock);
765 __bpf_offload_dev_netdev_unregister(offdev, netdev);
766 up_write(&bpf_devs_lock);
768 EXPORT_SYMBOL_GPL(bpf_offload_dev_netdev_unregister);
770 struct bpf_offload_dev *
771 bpf_offload_dev_create(const struct bpf_prog_offload_ops *ops, void *priv)
773 struct bpf_offload_dev *offdev;
775 offdev = kzalloc(sizeof(*offdev), GFP_KERNEL);
777 return ERR_PTR(-ENOMEM);
781 INIT_LIST_HEAD(&offdev->netdevs);
785 EXPORT_SYMBOL_GPL(bpf_offload_dev_create);
787 void bpf_offload_dev_destroy(struct bpf_offload_dev *offdev)
789 WARN_ON(!list_empty(&offdev->netdevs));
792 EXPORT_SYMBOL_GPL(bpf_offload_dev_destroy);
794 void *bpf_offload_dev_priv(struct bpf_offload_dev *offdev)
798 EXPORT_SYMBOL_GPL(bpf_offload_dev_priv);
800 void bpf_dev_bound_netdev_unregister(struct net_device *dev)
802 struct bpf_offload_netdev *ondev;
806 down_write(&bpf_devs_lock);
807 ondev = bpf_offload_find_netdev(dev);
808 if (ondev && !ondev->offdev)
809 __bpf_offload_dev_netdev_unregister(NULL, ondev->netdev);
810 up_write(&bpf_devs_lock);
813 int bpf_dev_bound_kfunc_check(struct bpf_verifier_log *log,
814 struct bpf_prog_aux *prog_aux)
816 if (!bpf_prog_is_dev_bound(prog_aux)) {
817 bpf_log(log, "metadata kfuncs require device-bound program\n");
821 if (bpf_prog_is_offloaded(prog_aux)) {
822 bpf_log(log, "metadata kfuncs can't be offloaded\n");
829 void *bpf_dev_bound_resolve_kfunc(struct bpf_prog *prog, u32 func_id)
831 const struct xdp_metadata_ops *ops;
834 /* We don't hold bpf_devs_lock while resolving several
835 * kfuncs and can race with the unregister_netdevice().
836 * We rely on bpf_dev_bound_match() check at attach
837 * to render this program unusable.
839 down_read(&bpf_devs_lock);
840 if (!prog->aux->offload)
843 ops = prog->aux->offload->netdev->xdp_metadata_ops;
847 if (func_id == bpf_xdp_metadata_kfunc_id(XDP_METADATA_KFUNC_RX_TIMESTAMP))
848 p = ops->xmo_rx_timestamp;
849 else if (func_id == bpf_xdp_metadata_kfunc_id(XDP_METADATA_KFUNC_RX_HASH))
850 p = ops->xmo_rx_hash;
852 up_read(&bpf_devs_lock);
857 static int __init bpf_offload_init(void)
859 return rhashtable_init(&offdevs, &offdevs_params);
862 core_initcall(bpf_offload_init);