kernel/bpf/inode.c

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