2 * Copyright (C) 2017 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/debugfs.h>
19 #include <linux/kernel.h>
20 #include <linux/mutex.h>
21 #include <linux/rtnetlink.h>
22 #include <net/pkt_cls.h>
24 #include "netdevsim.h"
26 #define pr_vlog(env, fmt, ...) \
27 bpf_verifier_log_write(env, "[netdevsim] " fmt, ##__VA_ARGS__)
29 struct nsim_bpf_bound_prog {
31 struct bpf_prog *prog;
38 #define NSIM_BPF_MAX_KEYS 2
40 struct nsim_bpf_bound_map {
42 struct bpf_offloaded_map *map;
44 struct nsim_map_entry {
47 } entry[NSIM_BPF_MAX_KEYS];
51 static int nsim_debugfs_bpf_string_read(struct seq_file *file, void *data)
53 const char **str = file->private;
56 seq_printf(file, "%s\n", *str);
61 static int nsim_debugfs_bpf_string_open(struct inode *inode, struct file *f)
63 return single_open(f, nsim_debugfs_bpf_string_read, inode->i_private);
66 static const struct file_operations nsim_bpf_string_fops = {
68 .open = nsim_debugfs_bpf_string_open,
69 .release = single_release,
75 nsim_bpf_verify_insn(struct bpf_verifier_env *env, int insn_idx, int prev_insn)
77 struct nsim_bpf_bound_prog *state;
79 state = env->prog->aux->offload->dev_priv;
80 if (state->ns->bpf_bind_verifier_delay && !insn_idx)
81 msleep(state->ns->bpf_bind_verifier_delay);
83 if (insn_idx == env->prog->len - 1)
84 pr_vlog(env, "Hello from netdevsim!\n");
89 static int nsim_bpf_finalize(struct bpf_verifier_env *env)
94 static bool nsim_xdp_offload_active(struct netdevsim *ns)
96 return ns->xdp_hw.prog;
99 static void nsim_prog_set_loaded(struct bpf_prog *prog, bool loaded)
101 struct nsim_bpf_bound_prog *state;
103 if (!prog || !prog->aux->offload)
106 state = prog->aux->offload->dev_priv;
107 state->is_loaded = loaded;
111 nsim_bpf_offload(struct netdevsim *ns, struct bpf_prog *prog, bool oldprog)
113 nsim_prog_set_loaded(ns->bpf_offloaded, false);
115 WARN(!!ns->bpf_offloaded != oldprog,
116 "bad offload state, expected offload %sto be active",
117 oldprog ? "" : "not ");
118 ns->bpf_offloaded = prog;
119 ns->bpf_offloaded_id = prog ? prog->aux->id : 0;
120 nsim_prog_set_loaded(prog, true);
125 int nsim_bpf_setup_tc_block_cb(enum tc_setup_type type,
126 void *type_data, void *cb_priv)
128 struct tc_cls_bpf_offload *cls_bpf = type_data;
129 struct bpf_prog *prog = cls_bpf->prog;
130 struct netdevsim *ns = cb_priv;
131 struct bpf_prog *oldprog;
133 if (type != TC_SETUP_CLSBPF) {
134 NSIM_EA(cls_bpf->common.extack,
135 "only offload of BPF classifiers supported");
139 if (!tc_cls_can_offload_and_chain0(ns->netdev, &cls_bpf->common))
142 if (cls_bpf->common.protocol != htons(ETH_P_ALL)) {
143 NSIM_EA(cls_bpf->common.extack,
144 "only ETH_P_ALL supported as filter protocol");
148 if (!ns->bpf_tc_accept) {
149 NSIM_EA(cls_bpf->common.extack,
150 "netdevsim configured to reject BPF TC offload");
153 /* Note: progs without skip_sw will probably not be dev bound */
154 if (prog && !prog->aux->offload && !ns->bpf_tc_non_bound_accept) {
155 NSIM_EA(cls_bpf->common.extack,
156 "netdevsim configured to reject unbound programs");
160 if (cls_bpf->command != TC_CLSBPF_OFFLOAD)
163 oldprog = cls_bpf->oldprog;
165 /* Don't remove if oldprog doesn't match driver's state */
166 if (ns->bpf_offloaded != oldprog) {
170 if (ns->bpf_offloaded) {
171 NSIM_EA(cls_bpf->common.extack,
172 "driver and netdev offload states mismatch");
177 return nsim_bpf_offload(ns, cls_bpf->prog, oldprog);
180 int nsim_bpf_disable_tc(struct netdevsim *ns)
182 if (ns->bpf_offloaded && !nsim_xdp_offload_active(ns))
187 static int nsim_xdp_offload_prog(struct netdevsim *ns, struct netdev_bpf *bpf)
189 if (!nsim_xdp_offload_active(ns) && !bpf->prog)
191 if (!nsim_xdp_offload_active(ns) && bpf->prog && ns->bpf_offloaded) {
192 NSIM_EA(bpf->extack, "TC program is already loaded");
196 return nsim_bpf_offload(ns, bpf->prog, nsim_xdp_offload_active(ns));
200 nsim_xdp_set_prog(struct netdevsim *ns, struct netdev_bpf *bpf,
201 struct xdp_attachment_info *xdp)
205 if (!xdp_attachment_flags_ok(xdp, bpf))
208 if (bpf->command == XDP_SETUP_PROG && !ns->bpf_xdpdrv_accept) {
209 NSIM_EA(bpf->extack, "driver XDP disabled in DebugFS");
212 if (bpf->command == XDP_SETUP_PROG_HW && !ns->bpf_xdpoffload_accept) {
213 NSIM_EA(bpf->extack, "XDP offload disabled in DebugFS");
217 if (bpf->command == XDP_SETUP_PROG_HW) {
218 err = nsim_xdp_offload_prog(ns, bpf);
223 xdp_attachment_setup(xdp, bpf);
228 static int nsim_bpf_create_prog(struct netdevsim *ns, struct bpf_prog *prog)
230 struct nsim_bpf_bound_prog *state;
233 state = kzalloc(sizeof(*state), GFP_KERNEL);
239 state->state = "verify";
241 /* Program id is not populated yet when we create the state. */
242 sprintf(name, "%u", ns->sdev->prog_id_gen++);
243 state->ddir = debugfs_create_dir(name, ns->sdev->ddir_bpf_bound_progs);
244 if (IS_ERR_OR_NULL(state->ddir)) {
249 debugfs_create_u32("id", 0400, state->ddir, &prog->aux->id);
250 debugfs_create_file("state", 0400, state->ddir,
251 &state->state, &nsim_bpf_string_fops);
252 debugfs_create_bool("loaded", 0400, state->ddir, &state->is_loaded);
254 list_add_tail(&state->l, &ns->sdev->bpf_bound_progs);
256 prog->aux->offload->dev_priv = state;
261 static int nsim_bpf_verifier_prep(struct bpf_prog *prog)
263 struct netdevsim *ns = netdev_priv(prog->aux->offload->netdev);
265 if (!ns->bpf_bind_accept)
268 return nsim_bpf_create_prog(ns, prog);
271 static int nsim_bpf_translate(struct bpf_prog *prog)
273 struct nsim_bpf_bound_prog *state = prog->aux->offload->dev_priv;
275 state->state = "xlated";
279 static void nsim_bpf_destroy_prog(struct bpf_prog *prog)
281 struct nsim_bpf_bound_prog *state;
283 state = prog->aux->offload->dev_priv;
284 WARN(state->is_loaded,
285 "offload state destroyed while program still bound");
286 debugfs_remove_recursive(state->ddir);
291 static const struct bpf_prog_offload_ops nsim_bpf_dev_ops = {
292 .insn_hook = nsim_bpf_verify_insn,
293 .finalize = nsim_bpf_finalize,
294 .prepare = nsim_bpf_verifier_prep,
295 .translate = nsim_bpf_translate,
296 .destroy = nsim_bpf_destroy_prog,
299 static int nsim_setup_prog_checks(struct netdevsim *ns, struct netdev_bpf *bpf)
301 if (bpf->prog && bpf->prog->aux->offload) {
302 NSIM_EA(bpf->extack, "attempt to load offloaded prog to drv");
305 if (ns->netdev->mtu > NSIM_XDP_MAX_MTU) {
306 NSIM_EA(bpf->extack, "MTU too large w/ XDP enabled");
313 nsim_setup_prog_hw_checks(struct netdevsim *ns, struct netdev_bpf *bpf)
315 struct nsim_bpf_bound_prog *state;
320 if (!bpf->prog->aux->offload) {
321 NSIM_EA(bpf->extack, "xdpoffload of non-bound program");
324 if (!bpf_offload_dev_match(bpf->prog, ns->netdev)) {
325 NSIM_EA(bpf->extack, "program bound to different dev");
329 state = bpf->prog->aux->offload->dev_priv;
330 if (WARN_ON(strcmp(state->state, "xlated"))) {
331 NSIM_EA(bpf->extack, "offloading program in bad state");
338 nsim_map_key_match(struct bpf_map *map, struct nsim_map_entry *e, void *key)
340 return e->key && !memcmp(key, e->key, map->key_size);
343 static int nsim_map_key_find(struct bpf_offloaded_map *offmap, void *key)
345 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
348 for (i = 0; i < ARRAY_SIZE(nmap->entry); i++)
349 if (nsim_map_key_match(&offmap->map, &nmap->entry[i], key))
356 nsim_map_alloc_elem(struct bpf_offloaded_map *offmap, unsigned int idx)
358 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
360 nmap->entry[idx].key = kmalloc(offmap->map.key_size, GFP_USER);
361 if (!nmap->entry[idx].key)
363 nmap->entry[idx].value = kmalloc(offmap->map.value_size, GFP_USER);
364 if (!nmap->entry[idx].value) {
365 kfree(nmap->entry[idx].key);
366 nmap->entry[idx].key = NULL;
374 nsim_map_get_next_key(struct bpf_offloaded_map *offmap,
375 void *key, void *next_key)
377 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
380 mutex_lock(&nmap->mutex);
383 idx = nsim_map_key_find(offmap, key);
389 for (; idx < ARRAY_SIZE(nmap->entry); idx++) {
390 if (nmap->entry[idx].key) {
391 memcpy(next_key, nmap->entry[idx].key,
392 offmap->map.key_size);
397 mutex_unlock(&nmap->mutex);
399 if (idx == ARRAY_SIZE(nmap->entry))
405 nsim_map_lookup_elem(struct bpf_offloaded_map *offmap, void *key, void *value)
407 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
410 mutex_lock(&nmap->mutex);
412 idx = nsim_map_key_find(offmap, key);
414 memcpy(value, nmap->entry[idx].value, offmap->map.value_size);
416 mutex_unlock(&nmap->mutex);
418 return idx < 0 ? idx : 0;
422 nsim_map_update_elem(struct bpf_offloaded_map *offmap,
423 void *key, void *value, u64 flags)
425 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
428 mutex_lock(&nmap->mutex);
430 idx = nsim_map_key_find(offmap, key);
431 if (idx < 0 && flags == BPF_EXIST) {
435 if (idx >= 0 && flags == BPF_NOEXIST) {
441 for (idx = 0; idx < ARRAY_SIZE(nmap->entry); idx++)
442 if (!nmap->entry[idx].key)
444 if (idx == ARRAY_SIZE(nmap->entry)) {
449 err = nsim_map_alloc_elem(offmap, idx);
454 memcpy(nmap->entry[idx].key, key, offmap->map.key_size);
455 memcpy(nmap->entry[idx].value, value, offmap->map.value_size);
457 mutex_unlock(&nmap->mutex);
462 static int nsim_map_delete_elem(struct bpf_offloaded_map *offmap, void *key)
464 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
467 if (offmap->map.map_type == BPF_MAP_TYPE_ARRAY)
470 mutex_lock(&nmap->mutex);
472 idx = nsim_map_key_find(offmap, key);
474 kfree(nmap->entry[idx].key);
475 kfree(nmap->entry[idx].value);
476 memset(&nmap->entry[idx], 0, sizeof(nmap->entry[idx]));
479 mutex_unlock(&nmap->mutex);
481 return idx < 0 ? idx : 0;
484 static const struct bpf_map_dev_ops nsim_bpf_map_ops = {
485 .map_get_next_key = nsim_map_get_next_key,
486 .map_lookup_elem = nsim_map_lookup_elem,
487 .map_update_elem = nsim_map_update_elem,
488 .map_delete_elem = nsim_map_delete_elem,
492 nsim_bpf_map_alloc(struct netdevsim *ns, struct bpf_offloaded_map *offmap)
494 struct nsim_bpf_bound_map *nmap;
497 if (WARN_ON(offmap->map.map_type != BPF_MAP_TYPE_ARRAY &&
498 offmap->map.map_type != BPF_MAP_TYPE_HASH))
500 if (offmap->map.max_entries > NSIM_BPF_MAX_KEYS)
502 if (offmap->map.map_flags)
505 nmap = kzalloc(sizeof(*nmap), GFP_USER);
509 offmap->dev_priv = nmap;
512 mutex_init(&nmap->mutex);
514 if (offmap->map.map_type == BPF_MAP_TYPE_ARRAY) {
515 for (i = 0; i < ARRAY_SIZE(nmap->entry); i++) {
518 err = nsim_map_alloc_elem(offmap, i);
521 key = nmap->entry[i].key;
526 offmap->dev_ops = &nsim_bpf_map_ops;
527 list_add_tail(&nmap->l, &ns->sdev->bpf_bound_maps);
533 kfree(nmap->entry[i].key);
534 kfree(nmap->entry[i].value);
540 static void nsim_bpf_map_free(struct bpf_offloaded_map *offmap)
542 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
545 for (i = 0; i < ARRAY_SIZE(nmap->entry); i++) {
546 kfree(nmap->entry[i].key);
547 kfree(nmap->entry[i].value);
549 list_del_init(&nmap->l);
550 mutex_destroy(&nmap->mutex);
554 int nsim_bpf(struct net_device *dev, struct netdev_bpf *bpf)
556 struct netdevsim *ns = netdev_priv(dev);
561 switch (bpf->command) {
563 return xdp_attachment_query(&ns->xdp, bpf);
564 case XDP_QUERY_PROG_HW:
565 return xdp_attachment_query(&ns->xdp_hw, bpf);
567 err = nsim_setup_prog_checks(ns, bpf);
571 return nsim_xdp_set_prog(ns, bpf, &ns->xdp);
572 case XDP_SETUP_PROG_HW:
573 err = nsim_setup_prog_hw_checks(ns, bpf);
577 return nsim_xdp_set_prog(ns, bpf, &ns->xdp_hw);
578 case BPF_OFFLOAD_MAP_ALLOC:
579 if (!ns->bpf_map_accept)
582 return nsim_bpf_map_alloc(ns, bpf->offmap);
583 case BPF_OFFLOAD_MAP_FREE:
584 nsim_bpf_map_free(bpf->offmap);
591 int nsim_bpf_init(struct netdevsim *ns)
595 if (ns->sdev->refcnt == 1) {
596 INIT_LIST_HEAD(&ns->sdev->bpf_bound_progs);
597 INIT_LIST_HEAD(&ns->sdev->bpf_bound_maps);
599 ns->sdev->ddir_bpf_bound_progs =
600 debugfs_create_dir("bpf_bound_progs", ns->sdev->ddir);
601 if (IS_ERR_OR_NULL(ns->sdev->ddir_bpf_bound_progs))
604 ns->sdev->bpf_dev = bpf_offload_dev_create(&nsim_bpf_dev_ops);
605 err = PTR_ERR_OR_ZERO(ns->sdev->bpf_dev);
610 err = bpf_offload_dev_netdev_register(ns->sdev->bpf_dev, ns->netdev);
612 goto err_destroy_bdev;
614 debugfs_create_u32("bpf_offloaded_id", 0400, ns->ddir,
615 &ns->bpf_offloaded_id);
617 ns->bpf_bind_accept = true;
618 debugfs_create_bool("bpf_bind_accept", 0600, ns->ddir,
619 &ns->bpf_bind_accept);
620 debugfs_create_u32("bpf_bind_verifier_delay", 0600, ns->ddir,
621 &ns->bpf_bind_verifier_delay);
623 ns->bpf_tc_accept = true;
624 debugfs_create_bool("bpf_tc_accept", 0600, ns->ddir,
626 debugfs_create_bool("bpf_tc_non_bound_accept", 0600, ns->ddir,
627 &ns->bpf_tc_non_bound_accept);
628 ns->bpf_xdpdrv_accept = true;
629 debugfs_create_bool("bpf_xdpdrv_accept", 0600, ns->ddir,
630 &ns->bpf_xdpdrv_accept);
631 ns->bpf_xdpoffload_accept = true;
632 debugfs_create_bool("bpf_xdpoffload_accept", 0600, ns->ddir,
633 &ns->bpf_xdpoffload_accept);
635 ns->bpf_map_accept = true;
636 debugfs_create_bool("bpf_map_accept", 0600, ns->ddir,
637 &ns->bpf_map_accept);
642 if (ns->sdev->refcnt == 1)
643 bpf_offload_dev_destroy(ns->sdev->bpf_dev);
647 void nsim_bpf_uninit(struct netdevsim *ns)
649 WARN_ON(ns->xdp.prog);
650 WARN_ON(ns->xdp_hw.prog);
651 WARN_ON(ns->bpf_offloaded);
652 bpf_offload_dev_netdev_unregister(ns->sdev->bpf_dev, ns->netdev);
654 if (ns->sdev->refcnt == 1) {
655 WARN_ON(!list_empty(&ns->sdev->bpf_bound_progs));
656 WARN_ON(!list_empty(&ns->sdev->bpf_bound_maps));
657 bpf_offload_dev_destroy(ns->sdev->bpf_dev);