kernel/bpf/inode.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Minimal file system backend for holding eBPF maps and programs,
   4  * used by bpf(2) object pinning.
   5  *
   6  * Authors:
   7  *
   8  *      Daniel Borkmann <daniel@iogearbox.net>
   9  */
  10
  11 #include <linux/init.h>
  12 #include <linux/magic.h>
  13 #include <linux/major.h>
  14 #include <linux/mount.h>
  15 #include <linux/namei.h>
  16 #include <linux/fs.h>
  17 #include <linux/fs_context.h>
  18 #include <linux/fs_parser.h>
  19 #include <linux/kdev_t.h>
  20 #include <linux/filter.h>
  21 #include <linux/bpf.h>
  22 #include <linux/bpf_trace.h>
  23
  24 enum bpf_type {
  25         BPF_TYPE_UNSPEC = 0,
  26         BPF_TYPE_PROG,
  27         BPF_TYPE_MAP,
  28 };
  29
  30 static void *bpf_any_get(void *raw, enum bpf_type type)
  31 {
  32         switch (type) {
  33         case BPF_TYPE_PROG:
  34                 raw = bpf_prog_inc(raw);
  35                 break;
  36         case BPF_TYPE_MAP:
  37                 raw = bpf_map_inc(raw, true);
  38                 break;
  39         default:
  40                 WARN_ON_ONCE(1);
  41                 break;
  42         }
  43
  44         return raw;
  45 }
  46
  47 static void bpf_any_put(void *raw, enum bpf_type type)
  48 {
  49         switch (type) {
  50         case BPF_TYPE_PROG:
  51                 bpf_prog_put(raw);
  52                 break;
  53         case BPF_TYPE_MAP:
  54                 bpf_map_put_with_uref(raw);
  55                 break;
  56         default:
  57                 WARN_ON_ONCE(1);
  58                 break;
  59         }
  60 }
  61
  62 static void *bpf_fd_probe_obj(u32 ufd, enum bpf_type *type)
  63 {
  64         void *raw;
  65
  66         *type = BPF_TYPE_MAP;
  67         raw = bpf_map_get_with_uref(ufd);
  68         if (IS_ERR(raw)) {
  69                 *type = BPF_TYPE_PROG;
  70                 raw = bpf_prog_get(ufd);
  71         }
  72
  73         return raw;
  74 }
  75
  76 static const struct inode_operations bpf_dir_iops;
  77
  78 static const struct inode_operations bpf_prog_iops = { };
  79 static const struct inode_operations bpf_map_iops  = { };
  80
  81 static struct inode *bpf_get_inode(struct super_block *sb,
  82                                    const struct inode *dir,
  83                                    umode_t mode)
  84 {
  85         struct inode *inode;
  86
  87         switch (mode & S_IFMT) {
  88         case S_IFDIR:
  89         case S_IFREG:
  90         case S_IFLNK:
  91                 break;
  92         default:
  93                 return ERR_PTR(-EINVAL);
  94         }
  95
  96         inode = new_inode(sb);
  97         if (!inode)
  98                 return ERR_PTR(-ENOSPC);
  99
 100         inode->i_ino = get_next_ino();
 101         inode->i_atime = current_time(inode);
 102         inode->i_mtime = inode->i_atime;
 103         inode->i_ctime = inode->i_atime;
 104
 105         inode_init_owner(inode, dir, mode);
 106
 107         return inode;
 108 }
 109
 110 static int bpf_inode_type(const struct inode *inode, enum bpf_type *type)
 111 {
 112         *type = BPF_TYPE_UNSPEC;
 113         if (inode->i_op == &bpf_prog_iops)
 114                 *type = BPF_TYPE_PROG;
 115         else if (inode->i_op == &bpf_map_iops)
 116                 *type = BPF_TYPE_MAP;
 117         else
 118                 return -EACCES;
 119
 120         return 0;
 121 }
 122
 123 static void bpf_dentry_finalize(struct dentry *dentry, struct inode *inode,
 124                                 struct inode *dir)
 125 {
 126         d_instantiate(dentry, inode);
 127         dget(dentry);
 128
 129         dir->i_mtime = current_time(dir);
 130         dir->i_ctime = dir->i_mtime;
 131 }
 132
 133 static int bpf_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
 134 {
 135         struct inode *inode;
 136
 137         inode = bpf_get_inode(dir->i_sb, dir, mode | S_IFDIR);
 138         if (IS_ERR(inode))
 139                 return PTR_ERR(inode);
 140
 141         inode->i_op = &bpf_dir_iops;
 142         inode->i_fop = &simple_dir_operations;
 143
 144         inc_nlink(inode);
 145         inc_nlink(dir);
 146
 147         bpf_dentry_finalize(dentry, inode, dir);
 148         return 0;
 149 }
 150
 151 struct map_iter {
 152         void *key;
 153         bool done;
 154 };
 155
 156 static struct map_iter *map_iter(struct seq_file *m)
 157 {
 158         return m->private;
 159 }
 160
 161 static struct bpf_map *seq_file_to_map(struct seq_file *m)
 162 {
 163         return file_inode(m->file)->i_private;
 164 }
 165
 166 static void map_iter_free(struct map_iter *iter)
 167 {
 168         if (iter) {
 169                 kfree(iter->key);
 170                 kfree(iter);
 171         }
 172 }
 173
 174 static struct map_iter *map_iter_alloc(struct bpf_map *map)
 175 {
 176         struct map_iter *iter;
 177
 178         iter = kzalloc(sizeof(*iter), GFP_KERNEL | __GFP_NOWARN);
 179         if (!iter)
 180                 goto error;
 181
 182         iter->key = kzalloc(map->key_size, GFP_KERNEL | __GFP_NOWARN);
 183         if (!iter->key)
 184                 goto error;
 185
 186         return iter;
 187
 188 error:
 189         map_iter_free(iter);
 190         return NULL;
 191 }
 192
 193 static void *map_seq_next(struct seq_file *m, void *v, loff_t *pos)
 194 {
 195         struct bpf_map *map = seq_file_to_map(m);
 196         void *key = map_iter(m)->key;
 197         void *prev_key;
 198
 199         (*pos)++;
 200         if (map_iter(m)->done)
 201                 return NULL;
 202
 203         if (unlikely(v == SEQ_START_TOKEN))
 204                 prev_key = NULL;
 205         else
 206                 prev_key = key;
 207
 208         rcu_read_lock();
 209         if (map->ops->map_get_next_key(map, prev_key, key)) {
 210                 map_iter(m)->done = true;
 211                 key = NULL;
 212         }
 213         rcu_read_unlock();
 214         return key;
 215 }
 216
 217 static void *map_seq_start(struct seq_file *m, loff_t *pos)
 218 {
 219         if (map_iter(m)->done)
 220                 return NULL;
 221
 222         return *pos ? map_iter(m)->key : SEQ_START_TOKEN;
 223 }
 224
 225 static void map_seq_stop(struct seq_file *m, void *v)
 226 {
 227 }
 228
 229 static int map_seq_show(struct seq_file *m, void *v)
 230 {
 231         struct bpf_map *map = seq_file_to_map(m);
 232         void *key = map_iter(m)->key;
 233
 234         if (unlikely(v == SEQ_START_TOKEN)) {
 235                 seq_puts(m, "# WARNING!! The output is for debug purpose only\n");
 236                 seq_puts(m, "# WARNING!! The output format will change\n");
 237         } else {
 238                 map->ops->map_seq_show_elem(map, key, m);
 239         }
 240
 241         return 0;
 242 }
 243
 244 static const struct seq_operations bpffs_map_seq_ops = {
 245         .start  = map_seq_start,
 246         .next   = map_seq_next,
 247         .show   = map_seq_show,
 248         .stop   = map_seq_stop,
 249 };
 250
 251 static int bpffs_map_open(struct inode *inode, struct file *file)
 252 {
 253         struct bpf_map *map = inode->i_private;
 254         struct map_iter *iter;
 255         struct seq_file *m;
 256         int err;
 257
 258         iter = map_iter_alloc(map);
 259         if (!iter)
 260                 return -ENOMEM;
 261
 262         err = seq_open(file, &bpffs_map_seq_ops);
 263         if (err) {
 264                 map_iter_free(iter);
 265                 return err;
 266         }
 267
 268         m = file->private_data;
 269         m->private = iter;
 270
 271         return 0;
 272 }
 273
 274 static int bpffs_map_release(struct inode *inode, struct file *file)
 275 {
 276         struct seq_file *m = file->private_data;
 277
 278         map_iter_free(map_iter(m));
 279
 280         return seq_release(inode, file);
 281 }
 282
 283 /* bpffs_map_fops should only implement the basic
 284  * read operation for a BPF map.  The purpose is to
 285  * provide a simple user intuitive way to do
 286  * "cat bpffs/pathto/a-pinned-map".
 287  *
 288  * Other operations (e.g. write, lookup...) should be realized by
 289  * the userspace tools (e.g. bpftool) through the
 290  * BPF_OBJ_GET_INFO_BY_FD and the map's lookup/update
 291  * interface.
 292  */
 293 static const struct file_operations bpffs_map_fops = {
 294         .open           = bpffs_map_open,
 295         .read           = seq_read,
 296         .release        = bpffs_map_release,
 297 };
 298
 299 static int bpffs_obj_open(struct inode *inode, struct file *file)
 300 {
 301         return -EIO;
 302 }
 303
 304 static const struct file_operations bpffs_obj_fops = {
 305         .open           = bpffs_obj_open,
 306 };
 307
 308 static int bpf_mkobj_ops(struct dentry *dentry, umode_t mode, void *raw,
 309                          const struct inode_operations *iops,
 310                          const struct file_operations *fops)
 311 {
 312         struct inode *dir = dentry->d_parent->d_inode;
 313         struct inode *inode = bpf_get_inode(dir->i_sb, dir, mode);
 314         if (IS_ERR(inode))
 315                 return PTR_ERR(inode);
 316
 317         inode->i_op = iops;
 318         inode->i_fop = fops;
 319         inode->i_private = raw;
 320
 321         bpf_dentry_finalize(dentry, inode, dir);
 322         return 0;
 323 }
 324
 325 static int bpf_mkprog(struct dentry *dentry, umode_t mode, void *arg)
 326 {
 327         return bpf_mkobj_ops(dentry, mode, arg, &bpf_prog_iops,
 328                              &bpffs_obj_fops);
 329 }
 330
 331 static int bpf_mkmap(struct dentry *dentry, umode_t mode, void *arg)
 332 {
 333         struct bpf_map *map = arg;
 334
 335         return bpf_mkobj_ops(dentry, mode, arg, &bpf_map_iops,
 336                              bpf_map_support_seq_show(map) ?
 337                              &bpffs_map_fops : &bpffs_obj_fops);
 338 }
 339
 340 static struct dentry *
 341 bpf_lookup(struct inode *dir, struct dentry *dentry, unsigned flags)
 342 {
 343         /* Dots in names (e.g. "/sys/fs/bpf/foo.bar") are reserved for future
 344          * extensions.
 345          */
 346         if (strchr(dentry->d_name.name, '.'))
 347                 return ERR_PTR(-EPERM);
 348
 349         return simple_lookup(dir, dentry, flags);
 350 }
 351
 352 static int bpf_symlink(struct inode *dir, struct dentry *dentry,
 353                        const char *target)
 354 {
 355         char *link = kstrdup(target, GFP_USER | __GFP_NOWARN);
 356         struct inode *inode;
 357
 358         if (!link)
 359                 return -ENOMEM;
 360
 361         inode = bpf_get_inode(dir->i_sb, dir, S_IRWXUGO | S_IFLNK);
 362         if (IS_ERR(inode)) {
 363                 kfree(link);
 364                 return PTR_ERR(inode);
 365         }
 366
 367         inode->i_op = &simple_symlink_inode_operations;
 368         inode->i_link = link;
 369
 370         bpf_dentry_finalize(dentry, inode, dir);
 371         return 0;
 372 }
 373
 374 static const struct inode_operations bpf_dir_iops = {
 375         .lookup         = bpf_lookup,
 376         .mkdir          = bpf_mkdir,
 377         .symlink        = bpf_symlink,
 378         .rmdir          = simple_rmdir,
 379         .rename         = simple_rename,
 380         .link           = simple_link,
 381         .unlink         = simple_unlink,
 382 };
 383
 384 static int bpf_obj_do_pin(const struct filename *pathname, void *raw,
 385                           enum bpf_type type)
 386 {
 387         struct dentry *dentry;
 388         struct inode *dir;
 389         struct path path;
 390         umode_t mode;
 391         int ret;
 392
 393         dentry = kern_path_create(AT_FDCWD, pathname->name, &path, 0);
 394         if (IS_ERR(dentry))
 395                 return PTR_ERR(dentry);
 396
 397         mode = S_IFREG | ((S_IRUSR | S_IWUSR) & ~current_umask());
 398
 399         ret = security_path_mknod(&path, dentry, mode, 0);
 400         if (ret)
 401                 goto out;
 402
 403         dir = d_inode(path.dentry);
 404         if (dir->i_op != &bpf_dir_iops) {
 405                 ret = -EPERM;
 406                 goto out;
 407         }
 408
 409         switch (type) {
 410         case BPF_TYPE_PROG:
 411                 ret = vfs_mkobj(dentry, mode, bpf_mkprog, raw);
 412                 break;
 413         case BPF_TYPE_MAP:
 414                 ret = vfs_mkobj(dentry, mode, bpf_mkmap, raw);
 415                 break;
 416         default:
 417                 ret = -EPERM;
 418         }
 419 out:
 420         done_path_create(&path, dentry);
 421         return ret;
 422 }
 423
 424 int bpf_obj_pin_user(u32 ufd, const char __user *pathname)
 425 {
 426         struct filename *pname;
 427         enum bpf_type type;
 428         void *raw;
 429         int ret;
 430
 431         pname = getname(pathname);
 432         if (IS_ERR(pname))
 433                 return PTR_ERR(pname);
 434
 435         raw = bpf_fd_probe_obj(ufd, &type);
 436         if (IS_ERR(raw)) {
 437                 ret = PTR_ERR(raw);
 438                 goto out;
 439         }
 440
 441         ret = bpf_obj_do_pin(pname, raw, type);
 442         if (ret != 0)
 443                 bpf_any_put(raw, type);
 444 out:
 445         putname(pname);
 446         return ret;
 447 }
 448
 449 static void *bpf_obj_do_get(const struct filename *pathname,
 450                             enum bpf_type *type, int flags)
 451 {
 452         struct inode *inode;
 453         struct path path;
 454         void *raw;
 455         int ret;
 456
 457         ret = kern_path(pathname->name, LOOKUP_FOLLOW, &path);
 458         if (ret)
 459                 return ERR_PTR(ret);
 460
 461         inode = d_backing_inode(path.dentry);
 462         ret = inode_permission(inode, ACC_MODE(flags));
 463         if (ret)
 464                 goto out;
 465
 466         ret = bpf_inode_type(inode, type);
 467         if (ret)
 468                 goto out;
 469
 470         raw = bpf_any_get(inode->i_private, *type);
 471         if (!IS_ERR(raw))
 472                 touch_atime(&path);
 473
 474         path_put(&path);
 475         return raw;
 476 out:
 477         path_put(&path);
 478         return ERR_PTR(ret);
 479 }
 480
 481 int bpf_obj_get_user(const char __user *pathname, int flags)
 482 {
 483         enum bpf_type type = BPF_TYPE_UNSPEC;
 484         struct filename *pname;
 485         int ret = -ENOENT;
 486         int f_flags;
 487         void *raw;
 488
 489         f_flags = bpf_get_file_flag(flags);
 490         if (f_flags < 0)
 491                 return f_flags;
 492
 493         pname = getname(pathname);
 494         if (IS_ERR(pname))
 495                 return PTR_ERR(pname);
 496
 497         raw = bpf_obj_do_get(pname, &type, f_flags);
 498         if (IS_ERR(raw)) {
 499                 ret = PTR_ERR(raw);
 500                 goto out;
 501         }
 502
 503         if (type == BPF_TYPE_PROG)
 504                 ret = bpf_prog_new_fd(raw);
 505         else if (type == BPF_TYPE_MAP)
 506                 ret = bpf_map_new_fd(raw, f_flags);
 507         else
 508                 goto out;
 509
 510         if (ret < 0)
 511                 bpf_any_put(raw, type);
 512 out:
 513         putname(pname);
 514         return ret;
 515 }
 516
 517 static struct bpf_prog *__get_prog_inode(struct inode *inode, enum bpf_prog_type type)
 518 {
 519         struct bpf_prog *prog;
 520         int ret = inode_permission(inode, MAY_READ);
 521         if (ret)
 522                 return ERR_PTR(ret);
 523
 524         if (inode->i_op == &bpf_map_iops)
 525                 return ERR_PTR(-EINVAL);
 526         if (inode->i_op != &bpf_prog_iops)
 527                 return ERR_PTR(-EACCES);
 528
 529         prog = inode->i_private;
 530
 531         ret = security_bpf_prog(prog);
 532         if (ret < 0)
 533                 return ERR_PTR(ret);
 534
 535         if (!bpf_prog_get_ok(prog, &type, false))
 536                 return ERR_PTR(-EINVAL);
 537
 538         return bpf_prog_inc(prog);
 539 }
 540
 541 struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type)
 542 {
 543         struct bpf_prog *prog;
 544         struct path path;
 545         int ret = kern_path(name, LOOKUP_FOLLOW, &path);
 546         if (ret)
 547                 return ERR_PTR(ret);
 548         prog = __get_prog_inode(d_backing_inode(path.dentry), type);
 549         if (!IS_ERR(prog))
 550                 touch_atime(&path);
 551         path_put(&path);
 552         return prog;
 553 }
 554 EXPORT_SYMBOL(bpf_prog_get_type_path);
 555
 556 /*
 557  * Display the mount options in /proc/mounts.
 558  */
 559 static int bpf_show_options(struct seq_file *m, struct dentry *root)
 560 {
 561         umode_t mode = d_inode(root)->i_mode & S_IALLUGO & ~S_ISVTX;
 562
 563         if (mode != S_IRWXUGO)
 564                 seq_printf(m, ",mode=%o", mode);
 565         return 0;
 566 }
 567
 568 static void bpf_free_inode(struct inode *inode)
 569 {
 570         enum bpf_type type;
 571
 572         if (S_ISLNK(inode->i_mode))
 573                 kfree(inode->i_link);
 574         if (!bpf_inode_type(inode, &type))
 575                 bpf_any_put(inode->i_private, type);
 576         free_inode_nonrcu(inode);
 577 }
 578
 579 static const struct super_operations bpf_super_ops = {
 580         .statfs         = simple_statfs,
 581         .drop_inode     = generic_delete_inode,
 582         .show_options   = bpf_show_options,
 583         .free_inode     = bpf_free_inode,
 584 };
 585
 586 enum {
 587         OPT_MODE,
 588 };
 589
 590 static const struct fs_parameter_spec bpf_param_specs[] = {
 591         fsparam_u32oct  ("mode",                        OPT_MODE),
 592         {}
 593 };
 594
 595 static const struct fs_parameter_description bpf_fs_parameters = {
 596         .name           = "bpf",
 597         .specs          = bpf_param_specs,
 598 };
 599
 600 struct bpf_mount_opts {
 601         umode_t mode;
 602 };
 603
 604 static int bpf_parse_param(struct fs_context *fc, struct fs_parameter *param)
 605 {
 606         struct bpf_mount_opts *opts = fc->fs_private;
 607         struct fs_parse_result result;
 608         int opt;
 609
 610         opt = fs_parse(fc, &bpf_fs_parameters, param, &result);
 611         if (opt < 0)
 612                 /* We might like to report bad mount options here, but
 613                  * traditionally we've ignored all mount options, so we'd
 614                  * better continue to ignore non-existing options for bpf.
 615                  */
 616                 return opt == -ENOPARAM ? 0 : opt;
 617
 618         switch (opt) {
 619         case OPT_MODE:
 620                 opts->mode = result.uint_32 & S_IALLUGO;
 621                 break;
 622         }
 623
 624         return 0;
 625 }
 626
 627 static int bpf_fill_super(struct super_block *sb, struct fs_context *fc)
 628 {
 629         static const struct tree_descr bpf_rfiles[] = { { "" } };
 630         struct bpf_mount_opts *opts = fc->fs_private;
 631         struct inode *inode;
 632         int ret;
 633
 634         ret = simple_fill_super(sb, BPF_FS_MAGIC, bpf_rfiles);
 635         if (ret)
 636                 return ret;
 637
 638         sb->s_op = &bpf_super_ops;
 639
 640         inode = sb->s_root->d_inode;
 641         inode->i_op = &bpf_dir_iops;
 642         inode->i_mode &= ~S_IALLUGO;
 643         inode->i_mode |= S_ISVTX | opts->mode;
 644
 645         return 0;
 646 }
 647
 648 static int bpf_get_tree(struct fs_context *fc)
 649 {
 650         return get_tree_nodev(fc, bpf_fill_super);
 651 }
 652
 653 static void bpf_free_fc(struct fs_context *fc)
 654 {
 655         kfree(fc->fs_private);
 656 }
 657
 658 static const struct fs_context_operations bpf_context_ops = {
 659         .free           = bpf_free_fc,
 660         .parse_param    = bpf_parse_param,
 661         .get_tree       = bpf_get_tree,
 662 };
 663
 664 /*
 665  * Set up the filesystem mount context.
 666  */
 667 static int bpf_init_fs_context(struct fs_context *fc)
 668 {
 669         struct bpf_mount_opts *opts;
 670
 671         opts = kzalloc(sizeof(struct bpf_mount_opts), GFP_KERNEL);
 672         if (!opts)
 673                 return -ENOMEM;
 674
 675         opts->mode = S_IRWXUGO;
 676
 677         fc->fs_private = opts;
 678         fc->ops = &bpf_context_ops;
 679         return 0;
 680 }
 681
 682 static struct file_system_type bpf_fs_type = {
 683         .owner          = THIS_MODULE,
 684         .name           = "bpf",
 685         .init_fs_context = bpf_init_fs_context,
 686         .parameters     = &bpf_fs_parameters,
 687         .kill_sb        = kill_litter_super,
 688 };
 689
 690 static int __init bpf_init(void)
 691 {
 692         int ret;
 693
 694         ret = sysfs_create_mount_point(fs_kobj, "bpf");
 695         if (ret)
 696                 return ret;
 697
 698         ret = register_filesystem(&bpf_fs_type);
 699         if (ret)
 700                 sysfs_remove_mount_point(fs_kobj, "bpf");
 701
 702         return ret;
 703 }
 704 fs_initcall(bpf_init);