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 {
30 struct nsim_dev *nsim_dev;
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_bpf_string_show(struct seq_file *file, void *data)
53 const char **str = file->private;
56 seq_printf(file, "%s\n", *str);
60 DEFINE_SHOW_ATTRIBUTE(nsim_bpf_string);
63 nsim_bpf_verify_insn(struct bpf_verifier_env *env, int insn_idx, int prev_insn)
65 struct nsim_bpf_bound_prog *state;
68 state = env->prog->aux->offload->dev_priv;
69 if (state->nsim_dev->bpf_bind_verifier_delay && !insn_idx)
70 msleep(state->nsim_dev->bpf_bind_verifier_delay);
72 if (insn_idx == env->prog->len - 1) {
73 pr_vlog(env, "Hello from netdevsim!\n");
75 if (!state->nsim_dev->bpf_bind_verifier_accept)
82 static int nsim_bpf_finalize(struct bpf_verifier_env *env)
87 static bool nsim_xdp_offload_active(struct netdevsim *ns)
89 return ns->xdp_hw.prog;
92 static void nsim_prog_set_loaded(struct bpf_prog *prog, bool loaded)
94 struct nsim_bpf_bound_prog *state;
96 if (!prog || !prog->aux->offload)
99 state = prog->aux->offload->dev_priv;
100 state->is_loaded = loaded;
104 nsim_bpf_offload(struct netdevsim *ns, struct bpf_prog *prog, bool oldprog)
106 nsim_prog_set_loaded(ns->bpf_offloaded, false);
108 WARN(!!ns->bpf_offloaded != oldprog,
109 "bad offload state, expected offload %sto be active",
110 oldprog ? "" : "not ");
111 ns->bpf_offloaded = prog;
112 ns->bpf_offloaded_id = prog ? prog->aux->id : 0;
113 nsim_prog_set_loaded(prog, true);
118 int nsim_bpf_setup_tc_block_cb(enum tc_setup_type type,
119 void *type_data, void *cb_priv)
121 struct tc_cls_bpf_offload *cls_bpf = type_data;
122 struct bpf_prog *prog = cls_bpf->prog;
123 struct netdevsim *ns = cb_priv;
124 struct bpf_prog *oldprog;
126 if (type != TC_SETUP_CLSBPF) {
127 NSIM_EA(cls_bpf->common.extack,
128 "only offload of BPF classifiers supported");
132 if (!tc_cls_can_offload_and_chain0(ns->netdev, &cls_bpf->common))
135 if (cls_bpf->common.protocol != htons(ETH_P_ALL)) {
136 NSIM_EA(cls_bpf->common.extack,
137 "only ETH_P_ALL supported as filter protocol");
141 if (!ns->bpf_tc_accept) {
142 NSIM_EA(cls_bpf->common.extack,
143 "netdevsim configured to reject BPF TC offload");
146 /* Note: progs without skip_sw will probably not be dev bound */
147 if (prog && !prog->aux->offload && !ns->bpf_tc_non_bound_accept) {
148 NSIM_EA(cls_bpf->common.extack,
149 "netdevsim configured to reject unbound programs");
153 if (cls_bpf->command != TC_CLSBPF_OFFLOAD)
156 oldprog = cls_bpf->oldprog;
158 /* Don't remove if oldprog doesn't match driver's state */
159 if (ns->bpf_offloaded != oldprog) {
163 if (ns->bpf_offloaded) {
164 NSIM_EA(cls_bpf->common.extack,
165 "driver and netdev offload states mismatch");
170 return nsim_bpf_offload(ns, cls_bpf->prog, oldprog);
173 int nsim_bpf_disable_tc(struct netdevsim *ns)
175 if (ns->bpf_offloaded && !nsim_xdp_offload_active(ns))
180 static int nsim_xdp_offload_prog(struct netdevsim *ns, struct netdev_bpf *bpf)
182 if (!nsim_xdp_offload_active(ns) && !bpf->prog)
184 if (!nsim_xdp_offload_active(ns) && bpf->prog && ns->bpf_offloaded) {
185 NSIM_EA(bpf->extack, "TC program is already loaded");
189 return nsim_bpf_offload(ns, bpf->prog, nsim_xdp_offload_active(ns));
193 nsim_xdp_set_prog(struct netdevsim *ns, struct netdev_bpf *bpf,
194 struct xdp_attachment_info *xdp)
198 if (bpf->command == XDP_SETUP_PROG && !ns->bpf_xdpdrv_accept) {
199 NSIM_EA(bpf->extack, "driver XDP disabled in DebugFS");
202 if (bpf->command == XDP_SETUP_PROG_HW && !ns->bpf_xdpoffload_accept) {
203 NSIM_EA(bpf->extack, "XDP offload disabled in DebugFS");
207 if (bpf->command == XDP_SETUP_PROG_HW) {
208 err = nsim_xdp_offload_prog(ns, bpf);
213 xdp_attachment_setup(xdp, bpf);
218 static int nsim_bpf_create_prog(struct nsim_dev *nsim_dev,
219 struct bpf_prog *prog)
221 struct nsim_bpf_bound_prog *state;
225 state = kzalloc(sizeof(*state), GFP_KERNEL);
229 state->nsim_dev = nsim_dev;
231 state->state = "verify";
233 /* Program id is not populated yet when we create the state. */
234 sprintf(name, "%u", nsim_dev->prog_id_gen++);
235 state->ddir = debugfs_create_dir(name, nsim_dev->ddir_bpf_bound_progs);
236 if (IS_ERR(state->ddir)) {
237 ret = PTR_ERR(state->ddir);
242 debugfs_create_u32("id", 0400, state->ddir, &prog->aux->id);
243 debugfs_create_file("state", 0400, state->ddir,
244 &state->state, &nsim_bpf_string_fops);
245 debugfs_create_bool("loaded", 0400, state->ddir, &state->is_loaded);
247 list_add_tail(&state->l, &nsim_dev->bpf_bound_progs);
249 prog->aux->offload->dev_priv = state;
254 static int nsim_bpf_verifier_prep(struct bpf_prog *prog)
256 struct nsim_dev *nsim_dev =
257 bpf_offload_dev_priv(prog->aux->offload->offdev);
259 if (!nsim_dev->bpf_bind_accept)
262 return nsim_bpf_create_prog(nsim_dev, prog);
265 static int nsim_bpf_translate(struct bpf_prog *prog)
267 struct nsim_bpf_bound_prog *state = prog->aux->offload->dev_priv;
269 state->state = "xlated";
273 static void nsim_bpf_destroy_prog(struct bpf_prog *prog)
275 struct nsim_bpf_bound_prog *state;
277 state = prog->aux->offload->dev_priv;
278 WARN(state->is_loaded,
279 "offload state destroyed while program still bound");
280 debugfs_remove_recursive(state->ddir);
285 static const struct bpf_prog_offload_ops nsim_bpf_dev_ops = {
286 .insn_hook = nsim_bpf_verify_insn,
287 .finalize = nsim_bpf_finalize,
288 .prepare = nsim_bpf_verifier_prep,
289 .translate = nsim_bpf_translate,
290 .destroy = nsim_bpf_destroy_prog,
293 static int nsim_setup_prog_checks(struct netdevsim *ns, struct netdev_bpf *bpf)
295 if (bpf->prog && bpf->prog->aux->offload) {
296 NSIM_EA(bpf->extack, "attempt to load offloaded prog to drv");
299 if (ns->netdev->mtu > NSIM_XDP_MAX_MTU) {
300 NSIM_EA(bpf->extack, "MTU too large w/ XDP enabled");
307 nsim_setup_prog_hw_checks(struct netdevsim *ns, struct netdev_bpf *bpf)
309 struct nsim_bpf_bound_prog *state;
314 if (!bpf->prog->aux->offload) {
315 NSIM_EA(bpf->extack, "xdpoffload of non-bound program");
319 state = bpf->prog->aux->offload->dev_priv;
320 if (WARN_ON(strcmp(state->state, "xlated"))) {
321 NSIM_EA(bpf->extack, "offloading program in bad state");
328 nsim_map_key_match(struct bpf_map *map, struct nsim_map_entry *e, void *key)
330 return e->key && !memcmp(key, e->key, map->key_size);
333 static int nsim_map_key_find(struct bpf_offloaded_map *offmap, void *key)
335 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
338 for (i = 0; i < ARRAY_SIZE(nmap->entry); i++)
339 if (nsim_map_key_match(&offmap->map, &nmap->entry[i], key))
346 nsim_map_alloc_elem(struct bpf_offloaded_map *offmap, unsigned int idx)
348 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
350 nmap->entry[idx].key = kmalloc(offmap->map.key_size,
351 GFP_KERNEL_ACCOUNT | __GFP_NOWARN);
352 if (!nmap->entry[idx].key)
354 nmap->entry[idx].value = kmalloc(offmap->map.value_size,
355 GFP_KERNEL_ACCOUNT | __GFP_NOWARN);
356 if (!nmap->entry[idx].value) {
357 kfree(nmap->entry[idx].key);
358 nmap->entry[idx].key = NULL;
366 nsim_map_get_next_key(struct bpf_offloaded_map *offmap,
367 void *key, void *next_key)
369 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
372 mutex_lock(&nmap->mutex);
375 idx = nsim_map_key_find(offmap, key);
381 for (; idx < ARRAY_SIZE(nmap->entry); idx++) {
382 if (nmap->entry[idx].key) {
383 memcpy(next_key, nmap->entry[idx].key,
384 offmap->map.key_size);
389 mutex_unlock(&nmap->mutex);
391 if (idx == ARRAY_SIZE(nmap->entry))
397 nsim_map_lookup_elem(struct bpf_offloaded_map *offmap, void *key, void *value)
399 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
402 mutex_lock(&nmap->mutex);
404 idx = nsim_map_key_find(offmap, key);
406 memcpy(value, nmap->entry[idx].value, offmap->map.value_size);
408 mutex_unlock(&nmap->mutex);
410 return idx < 0 ? idx : 0;
414 nsim_map_update_elem(struct bpf_offloaded_map *offmap,
415 void *key, void *value, u64 flags)
417 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
420 mutex_lock(&nmap->mutex);
422 idx = nsim_map_key_find(offmap, key);
423 if (idx < 0 && flags == BPF_EXIST) {
427 if (idx >= 0 && flags == BPF_NOEXIST) {
433 for (idx = 0; idx < ARRAY_SIZE(nmap->entry); idx++)
434 if (!nmap->entry[idx].key)
436 if (idx == ARRAY_SIZE(nmap->entry)) {
441 err = nsim_map_alloc_elem(offmap, idx);
446 memcpy(nmap->entry[idx].key, key, offmap->map.key_size);
447 memcpy(nmap->entry[idx].value, value, offmap->map.value_size);
449 mutex_unlock(&nmap->mutex);
454 static int nsim_map_delete_elem(struct bpf_offloaded_map *offmap, void *key)
456 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
459 if (offmap->map.map_type == BPF_MAP_TYPE_ARRAY)
462 mutex_lock(&nmap->mutex);
464 idx = nsim_map_key_find(offmap, key);
466 kfree(nmap->entry[idx].key);
467 kfree(nmap->entry[idx].value);
468 memset(&nmap->entry[idx], 0, sizeof(nmap->entry[idx]));
471 mutex_unlock(&nmap->mutex);
473 return idx < 0 ? idx : 0;
476 static const struct bpf_map_dev_ops nsim_bpf_map_ops = {
477 .map_get_next_key = nsim_map_get_next_key,
478 .map_lookup_elem = nsim_map_lookup_elem,
479 .map_update_elem = nsim_map_update_elem,
480 .map_delete_elem = nsim_map_delete_elem,
484 nsim_bpf_map_alloc(struct netdevsim *ns, struct bpf_offloaded_map *offmap)
486 struct nsim_bpf_bound_map *nmap;
489 if (WARN_ON(offmap->map.map_type != BPF_MAP_TYPE_ARRAY &&
490 offmap->map.map_type != BPF_MAP_TYPE_HASH))
492 if (offmap->map.max_entries > NSIM_BPF_MAX_KEYS)
494 if (offmap->map.map_flags)
497 nmap = kzalloc(sizeof(*nmap), GFP_KERNEL_ACCOUNT);
501 offmap->dev_priv = nmap;
504 mutex_init(&nmap->mutex);
506 if (offmap->map.map_type == BPF_MAP_TYPE_ARRAY) {
507 for (i = 0; i < ARRAY_SIZE(nmap->entry); i++) {
510 err = nsim_map_alloc_elem(offmap, i);
513 key = nmap->entry[i].key;
515 memset(nmap->entry[i].value, 0, offmap->map.value_size);
519 offmap->dev_ops = &nsim_bpf_map_ops;
520 list_add_tail(&nmap->l, &ns->nsim_dev->bpf_bound_maps);
526 kfree(nmap->entry[i].key);
527 kfree(nmap->entry[i].value);
533 static void nsim_bpf_map_free(struct bpf_offloaded_map *offmap)
535 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
538 for (i = 0; i < ARRAY_SIZE(nmap->entry); i++) {
539 kfree(nmap->entry[i].key);
540 kfree(nmap->entry[i].value);
542 list_del_init(&nmap->l);
543 mutex_destroy(&nmap->mutex);
547 int nsim_bpf(struct net_device *dev, struct netdev_bpf *bpf)
549 struct netdevsim *ns = netdev_priv(dev);
554 switch (bpf->command) {
556 err = nsim_setup_prog_checks(ns, bpf);
560 return nsim_xdp_set_prog(ns, bpf, &ns->xdp);
561 case XDP_SETUP_PROG_HW:
562 err = nsim_setup_prog_hw_checks(ns, bpf);
566 return nsim_xdp_set_prog(ns, bpf, &ns->xdp_hw);
567 case BPF_OFFLOAD_MAP_ALLOC:
568 if (!ns->bpf_map_accept)
571 return nsim_bpf_map_alloc(ns, bpf->offmap);
572 case BPF_OFFLOAD_MAP_FREE:
573 nsim_bpf_map_free(bpf->offmap);
580 int nsim_bpf_dev_init(struct nsim_dev *nsim_dev)
584 INIT_LIST_HEAD(&nsim_dev->bpf_bound_progs);
585 INIT_LIST_HEAD(&nsim_dev->bpf_bound_maps);
587 nsim_dev->ddir_bpf_bound_progs = debugfs_create_dir("bpf_bound_progs",
589 if (IS_ERR(nsim_dev->ddir_bpf_bound_progs))
590 return PTR_ERR(nsim_dev->ddir_bpf_bound_progs);
592 nsim_dev->bpf_dev = bpf_offload_dev_create(&nsim_bpf_dev_ops, nsim_dev);
593 err = PTR_ERR_OR_ZERO(nsim_dev->bpf_dev);
597 nsim_dev->bpf_bind_accept = true;
598 debugfs_create_bool("bpf_bind_accept", 0600, nsim_dev->ddir,
599 &nsim_dev->bpf_bind_accept);
600 debugfs_create_u32("bpf_bind_verifier_delay", 0600, nsim_dev->ddir,
601 &nsim_dev->bpf_bind_verifier_delay);
602 nsim_dev->bpf_bind_verifier_accept = true;
603 debugfs_create_bool("bpf_bind_verifier_accept", 0600, nsim_dev->ddir,
604 &nsim_dev->bpf_bind_verifier_accept);
608 void nsim_bpf_dev_exit(struct nsim_dev *nsim_dev)
610 WARN_ON(!list_empty(&nsim_dev->bpf_bound_progs));
611 WARN_ON(!list_empty(&nsim_dev->bpf_bound_maps));
612 bpf_offload_dev_destroy(nsim_dev->bpf_dev);
615 int nsim_bpf_init(struct netdevsim *ns)
617 struct dentry *ddir = ns->nsim_dev_port->ddir;
620 err = bpf_offload_dev_netdev_register(ns->nsim_dev->bpf_dev,
625 debugfs_create_u32("bpf_offloaded_id", 0400, ddir,
626 &ns->bpf_offloaded_id);
628 ns->bpf_tc_accept = true;
629 debugfs_create_bool("bpf_tc_accept", 0600, ddir,
631 debugfs_create_bool("bpf_tc_non_bound_accept", 0600, ddir,
632 &ns->bpf_tc_non_bound_accept);
633 ns->bpf_xdpdrv_accept = true;
634 debugfs_create_bool("bpf_xdpdrv_accept", 0600, ddir,
635 &ns->bpf_xdpdrv_accept);
636 ns->bpf_xdpoffload_accept = true;
637 debugfs_create_bool("bpf_xdpoffload_accept", 0600, ddir,
638 &ns->bpf_xdpoffload_accept);
640 ns->bpf_map_accept = true;
641 debugfs_create_bool("bpf_map_accept", 0600, ddir,
642 &ns->bpf_map_accept);
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->nsim_dev->bpf_dev, ns->netdev);