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_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;
67 state = env->prog->aux->offload->dev_priv;
68 if (state->ns->bpf_bind_verifier_delay && !insn_idx)
69 msleep(state->ns->bpf_bind_verifier_delay);
71 if (insn_idx == env->prog->len - 1)
72 pr_vlog(env, "Hello from netdevsim!\n");
77 static int nsim_bpf_finalize(struct bpf_verifier_env *env)
82 static bool nsim_xdp_offload_active(struct netdevsim *ns)
84 return ns->xdp_hw.prog;
87 static void nsim_prog_set_loaded(struct bpf_prog *prog, bool loaded)
89 struct nsim_bpf_bound_prog *state;
91 if (!prog || !prog->aux->offload)
94 state = prog->aux->offload->dev_priv;
95 state->is_loaded = loaded;
99 nsim_bpf_offload(struct netdevsim *ns, struct bpf_prog *prog, bool oldprog)
101 nsim_prog_set_loaded(ns->bpf_offloaded, false);
103 WARN(!!ns->bpf_offloaded != oldprog,
104 "bad offload state, expected offload %sto be active",
105 oldprog ? "" : "not ");
106 ns->bpf_offloaded = prog;
107 ns->bpf_offloaded_id = prog ? prog->aux->id : 0;
108 nsim_prog_set_loaded(prog, true);
113 int nsim_bpf_setup_tc_block_cb(enum tc_setup_type type,
114 void *type_data, void *cb_priv)
116 struct tc_cls_bpf_offload *cls_bpf = type_data;
117 struct bpf_prog *prog = cls_bpf->prog;
118 struct netdevsim *ns = cb_priv;
119 struct bpf_prog *oldprog;
121 if (type != TC_SETUP_CLSBPF) {
122 NSIM_EA(cls_bpf->common.extack,
123 "only offload of BPF classifiers supported");
127 if (!tc_cls_can_offload_and_chain0(ns->netdev, &cls_bpf->common))
130 if (cls_bpf->common.protocol != htons(ETH_P_ALL)) {
131 NSIM_EA(cls_bpf->common.extack,
132 "only ETH_P_ALL supported as filter protocol");
136 if (!ns->bpf_tc_accept) {
137 NSIM_EA(cls_bpf->common.extack,
138 "netdevsim configured to reject BPF TC offload");
141 /* Note: progs without skip_sw will probably not be dev bound */
142 if (prog && !prog->aux->offload && !ns->bpf_tc_non_bound_accept) {
143 NSIM_EA(cls_bpf->common.extack,
144 "netdevsim configured to reject unbound programs");
148 if (cls_bpf->command != TC_CLSBPF_OFFLOAD)
151 oldprog = cls_bpf->oldprog;
153 /* Don't remove if oldprog doesn't match driver's state */
154 if (ns->bpf_offloaded != oldprog) {
158 if (ns->bpf_offloaded) {
159 NSIM_EA(cls_bpf->common.extack,
160 "driver and netdev offload states mismatch");
165 return nsim_bpf_offload(ns, cls_bpf->prog, oldprog);
168 int nsim_bpf_disable_tc(struct netdevsim *ns)
170 if (ns->bpf_offloaded && !nsim_xdp_offload_active(ns))
175 static int nsim_xdp_offload_prog(struct netdevsim *ns, struct netdev_bpf *bpf)
177 if (!nsim_xdp_offload_active(ns) && !bpf->prog)
179 if (!nsim_xdp_offload_active(ns) && bpf->prog && ns->bpf_offloaded) {
180 NSIM_EA(bpf->extack, "TC program is already loaded");
184 return nsim_bpf_offload(ns, bpf->prog, nsim_xdp_offload_active(ns));
188 nsim_xdp_set_prog(struct netdevsim *ns, struct netdev_bpf *bpf,
189 struct xdp_attachment_info *xdp)
193 if (!xdp_attachment_flags_ok(xdp, bpf))
196 if (bpf->command == XDP_SETUP_PROG && !ns->bpf_xdpdrv_accept) {
197 NSIM_EA(bpf->extack, "driver XDP disabled in DebugFS");
200 if (bpf->command == XDP_SETUP_PROG_HW && !ns->bpf_xdpoffload_accept) {
201 NSIM_EA(bpf->extack, "XDP offload disabled in DebugFS");
205 if (bpf->command == XDP_SETUP_PROG_HW) {
206 err = nsim_xdp_offload_prog(ns, bpf);
211 xdp_attachment_setup(xdp, bpf);
216 static int nsim_bpf_create_prog(struct netdevsim *ns, struct bpf_prog *prog)
218 struct nsim_bpf_bound_prog *state;
221 state = kzalloc(sizeof(*state), GFP_KERNEL);
227 state->state = "verify";
229 /* Program id is not populated yet when we create the state. */
230 sprintf(name, "%u", ns->sdev->prog_id_gen++);
231 state->ddir = debugfs_create_dir(name, ns->sdev->ddir_bpf_bound_progs);
232 if (IS_ERR_OR_NULL(state->ddir)) {
237 debugfs_create_u32("id", 0400, state->ddir, &prog->aux->id);
238 debugfs_create_file("state", 0400, state->ddir,
239 &state->state, &nsim_bpf_string_fops);
240 debugfs_create_bool("loaded", 0400, state->ddir, &state->is_loaded);
242 list_add_tail(&state->l, &ns->sdev->bpf_bound_progs);
244 prog->aux->offload->dev_priv = state;
249 static int nsim_bpf_verifier_prep(struct bpf_prog *prog)
251 struct netdevsim *ns = bpf_offload_dev_priv(prog->aux->offload->offdev);
253 if (!ns->bpf_bind_accept)
256 return nsim_bpf_create_prog(ns, prog);
259 static int nsim_bpf_translate(struct bpf_prog *prog)
261 struct nsim_bpf_bound_prog *state = prog->aux->offload->dev_priv;
263 state->state = "xlated";
267 static void nsim_bpf_destroy_prog(struct bpf_prog *prog)
269 struct nsim_bpf_bound_prog *state;
271 state = prog->aux->offload->dev_priv;
272 WARN(state->is_loaded,
273 "offload state destroyed while program still bound");
274 debugfs_remove_recursive(state->ddir);
279 static const struct bpf_prog_offload_ops nsim_bpf_dev_ops = {
280 .insn_hook = nsim_bpf_verify_insn,
281 .finalize = nsim_bpf_finalize,
282 .prepare = nsim_bpf_verifier_prep,
283 .translate = nsim_bpf_translate,
284 .destroy = nsim_bpf_destroy_prog,
287 static int nsim_setup_prog_checks(struct netdevsim *ns, struct netdev_bpf *bpf)
289 if (bpf->prog && bpf->prog->aux->offload) {
290 NSIM_EA(bpf->extack, "attempt to load offloaded prog to drv");
293 if (ns->netdev->mtu > NSIM_XDP_MAX_MTU) {
294 NSIM_EA(bpf->extack, "MTU too large w/ XDP enabled");
301 nsim_setup_prog_hw_checks(struct netdevsim *ns, struct netdev_bpf *bpf)
303 struct nsim_bpf_bound_prog *state;
308 if (!bpf->prog->aux->offload) {
309 NSIM_EA(bpf->extack, "xdpoffload of non-bound program");
312 if (!bpf_offload_dev_match(bpf->prog, ns->netdev)) {
313 NSIM_EA(bpf->extack, "program bound to different dev");
317 state = bpf->prog->aux->offload->dev_priv;
318 if (WARN_ON(strcmp(state->state, "xlated"))) {
319 NSIM_EA(bpf->extack, "offloading program in bad state");
326 nsim_map_key_match(struct bpf_map *map, struct nsim_map_entry *e, void *key)
328 return e->key && !memcmp(key, e->key, map->key_size);
331 static int nsim_map_key_find(struct bpf_offloaded_map *offmap, void *key)
333 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
336 for (i = 0; i < ARRAY_SIZE(nmap->entry); i++)
337 if (nsim_map_key_match(&offmap->map, &nmap->entry[i], key))
344 nsim_map_alloc_elem(struct bpf_offloaded_map *offmap, unsigned int idx)
346 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
348 nmap->entry[idx].key = kmalloc(offmap->map.key_size, GFP_USER);
349 if (!nmap->entry[idx].key)
351 nmap->entry[idx].value = kmalloc(offmap->map.value_size, GFP_USER);
352 if (!nmap->entry[idx].value) {
353 kfree(nmap->entry[idx].key);
354 nmap->entry[idx].key = NULL;
362 nsim_map_get_next_key(struct bpf_offloaded_map *offmap,
363 void *key, void *next_key)
365 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
368 mutex_lock(&nmap->mutex);
371 idx = nsim_map_key_find(offmap, key);
377 for (; idx < ARRAY_SIZE(nmap->entry); idx++) {
378 if (nmap->entry[idx].key) {
379 memcpy(next_key, nmap->entry[idx].key,
380 offmap->map.key_size);
385 mutex_unlock(&nmap->mutex);
387 if (idx == ARRAY_SIZE(nmap->entry))
393 nsim_map_lookup_elem(struct bpf_offloaded_map *offmap, void *key, void *value)
395 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
398 mutex_lock(&nmap->mutex);
400 idx = nsim_map_key_find(offmap, key);
402 memcpy(value, nmap->entry[idx].value, offmap->map.value_size);
404 mutex_unlock(&nmap->mutex);
406 return idx < 0 ? idx : 0;
410 nsim_map_update_elem(struct bpf_offloaded_map *offmap,
411 void *key, void *value, u64 flags)
413 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
416 mutex_lock(&nmap->mutex);
418 idx = nsim_map_key_find(offmap, key);
419 if (idx < 0 && flags == BPF_EXIST) {
423 if (idx >= 0 && flags == BPF_NOEXIST) {
429 for (idx = 0; idx < ARRAY_SIZE(nmap->entry); idx++)
430 if (!nmap->entry[idx].key)
432 if (idx == ARRAY_SIZE(nmap->entry)) {
437 err = nsim_map_alloc_elem(offmap, idx);
442 memcpy(nmap->entry[idx].key, key, offmap->map.key_size);
443 memcpy(nmap->entry[idx].value, value, offmap->map.value_size);
445 mutex_unlock(&nmap->mutex);
450 static int nsim_map_delete_elem(struct bpf_offloaded_map *offmap, void *key)
452 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
455 if (offmap->map.map_type == BPF_MAP_TYPE_ARRAY)
458 mutex_lock(&nmap->mutex);
460 idx = nsim_map_key_find(offmap, key);
462 kfree(nmap->entry[idx].key);
463 kfree(nmap->entry[idx].value);
464 memset(&nmap->entry[idx], 0, sizeof(nmap->entry[idx]));
467 mutex_unlock(&nmap->mutex);
469 return idx < 0 ? idx : 0;
472 static const struct bpf_map_dev_ops nsim_bpf_map_ops = {
473 .map_get_next_key = nsim_map_get_next_key,
474 .map_lookup_elem = nsim_map_lookup_elem,
475 .map_update_elem = nsim_map_update_elem,
476 .map_delete_elem = nsim_map_delete_elem,
480 nsim_bpf_map_alloc(struct netdevsim *ns, struct bpf_offloaded_map *offmap)
482 struct nsim_bpf_bound_map *nmap;
485 if (WARN_ON(offmap->map.map_type != BPF_MAP_TYPE_ARRAY &&
486 offmap->map.map_type != BPF_MAP_TYPE_HASH))
488 if (offmap->map.max_entries > NSIM_BPF_MAX_KEYS)
490 if (offmap->map.map_flags)
493 nmap = kzalloc(sizeof(*nmap), GFP_USER);
497 offmap->dev_priv = nmap;
500 mutex_init(&nmap->mutex);
502 if (offmap->map.map_type == BPF_MAP_TYPE_ARRAY) {
503 for (i = 0; i < ARRAY_SIZE(nmap->entry); i++) {
506 err = nsim_map_alloc_elem(offmap, i);
509 key = nmap->entry[i].key;
514 offmap->dev_ops = &nsim_bpf_map_ops;
515 list_add_tail(&nmap->l, &ns->sdev->bpf_bound_maps);
521 kfree(nmap->entry[i].key);
522 kfree(nmap->entry[i].value);
528 static void nsim_bpf_map_free(struct bpf_offloaded_map *offmap)
530 struct nsim_bpf_bound_map *nmap = offmap->dev_priv;
533 for (i = 0; i < ARRAY_SIZE(nmap->entry); i++) {
534 kfree(nmap->entry[i].key);
535 kfree(nmap->entry[i].value);
537 list_del_init(&nmap->l);
538 mutex_destroy(&nmap->mutex);
542 int nsim_bpf(struct net_device *dev, struct netdev_bpf *bpf)
544 struct netdevsim *ns = netdev_priv(dev);
549 switch (bpf->command) {
551 return xdp_attachment_query(&ns->xdp, bpf);
552 case XDP_QUERY_PROG_HW:
553 return xdp_attachment_query(&ns->xdp_hw, bpf);
555 err = nsim_setup_prog_checks(ns, bpf);
559 return nsim_xdp_set_prog(ns, bpf, &ns->xdp);
560 case XDP_SETUP_PROG_HW:
561 err = nsim_setup_prog_hw_checks(ns, bpf);
565 return nsim_xdp_set_prog(ns, bpf, &ns->xdp_hw);
566 case BPF_OFFLOAD_MAP_ALLOC:
567 if (!ns->bpf_map_accept)
570 return nsim_bpf_map_alloc(ns, bpf->offmap);
571 case BPF_OFFLOAD_MAP_FREE:
572 nsim_bpf_map_free(bpf->offmap);
579 int nsim_bpf_init(struct netdevsim *ns)
583 if (ns->sdev->refcnt == 1) {
584 INIT_LIST_HEAD(&ns->sdev->bpf_bound_progs);
585 INIT_LIST_HEAD(&ns->sdev->bpf_bound_maps);
587 ns->sdev->ddir_bpf_bound_progs =
588 debugfs_create_dir("bpf_bound_progs", ns->sdev->ddir);
589 if (IS_ERR_OR_NULL(ns->sdev->ddir_bpf_bound_progs))
592 ns->sdev->bpf_dev = bpf_offload_dev_create(&nsim_bpf_dev_ops,
594 err = PTR_ERR_OR_ZERO(ns->sdev->bpf_dev);
599 err = bpf_offload_dev_netdev_register(ns->sdev->bpf_dev, ns->netdev);
601 goto err_destroy_bdev;
603 debugfs_create_u32("bpf_offloaded_id", 0400, ns->ddir,
604 &ns->bpf_offloaded_id);
606 ns->bpf_bind_accept = true;
607 debugfs_create_bool("bpf_bind_accept", 0600, ns->ddir,
608 &ns->bpf_bind_accept);
609 debugfs_create_u32("bpf_bind_verifier_delay", 0600, ns->ddir,
610 &ns->bpf_bind_verifier_delay);
612 ns->bpf_tc_accept = true;
613 debugfs_create_bool("bpf_tc_accept", 0600, ns->ddir,
615 debugfs_create_bool("bpf_tc_non_bound_accept", 0600, ns->ddir,
616 &ns->bpf_tc_non_bound_accept);
617 ns->bpf_xdpdrv_accept = true;
618 debugfs_create_bool("bpf_xdpdrv_accept", 0600, ns->ddir,
619 &ns->bpf_xdpdrv_accept);
620 ns->bpf_xdpoffload_accept = true;
621 debugfs_create_bool("bpf_xdpoffload_accept", 0600, ns->ddir,
622 &ns->bpf_xdpoffload_accept);
624 ns->bpf_map_accept = true;
625 debugfs_create_bool("bpf_map_accept", 0600, ns->ddir,
626 &ns->bpf_map_accept);
631 if (ns->sdev->refcnt == 1)
632 bpf_offload_dev_destroy(ns->sdev->bpf_dev);
636 void nsim_bpf_uninit(struct netdevsim *ns)
638 WARN_ON(ns->xdp.prog);
639 WARN_ON(ns->xdp_hw.prog);
640 WARN_ON(ns->bpf_offloaded);
641 bpf_offload_dev_netdev_unregister(ns->sdev->bpf_dev, ns->netdev);
643 if (ns->sdev->refcnt == 1) {
644 WARN_ON(!list_empty(&ns->sdev->bpf_bound_progs));
645 WARN_ON(!list_empty(&ns->sdev->bpf_bound_maps));
646 bpf_offload_dev_destroy(ns->sdev->bpf_dev);