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
 200         if (map_iter(m)->done)
 201                 return NULL;
 202
 203         if (unlikely(v == SEQ_START_TOKEN))
 204                 goto done;
 205
 206         if (map->ops->map_get_next_key(map, key, key)) {
 207                 map_iter(m)->done = true;
 208                 return NULL;
 209         }
 210
 211 done:
 212         ++(*pos);
 213         return key;
 214 }
 215
 216 static void *map_seq_start(struct seq_file *m, loff_t *pos)
 217 {
 218         if (map_iter(m)->done)
 219                 return NULL;
 220
 221         return *pos ? map_iter(m)->key : SEQ_START_TOKEN;
 222 }
 223
 224 static void map_seq_stop(struct seq_file *m, void *v)
 225 {
 226 }
 227
 228 static int map_seq_show(struct seq_file *m, void *v)
 229 {
 230         struct bpf_map *map = seq_file_to_map(m);
 231         void *key = map_iter(m)->key;
 232
 233         if (unlikely(v == SEQ_START_TOKEN)) {
 234                 seq_puts(m, "# WARNING!! The output is for debug purpose only\n");
 235                 seq_puts(m, "# WARNING!! The output format will change\n");
 236         } else {
 237                 map->ops->map_seq_show_elem(map, key, m);
 238         }
 239
 240         return 0;
 241 }
 242
 243 static const struct seq_operations bpffs_map_seq_ops = {
 244         .start  = map_seq_start,
 245         .next   = map_seq_next,
 246         .show   = map_seq_show,
 247         .stop   = map_seq_stop,
 248 };
 249
 250 static int bpffs_map_open(struct inode *inode, struct file *file)
 251 {
 252         struct bpf_map *map = inode->i_private;
 253         struct map_iter *iter;
 254         struct seq_file *m;
 255         int err;
 256
 257         iter = map_iter_alloc(map);
 258         if (!iter)
 259                 return -ENOMEM;
 260
 261         err = seq_open(file, &bpffs_map_seq_ops);
 262         if (err) {
 263                 map_iter_free(iter);
 264                 return err;
 265         }
 266
 267         m = file->private_data;
 268         m->private = iter;
 269
 270         return 0;
 271 }
 272
 273 static int bpffs_map_release(struct inode *inode, struct file *file)
 274 {
 275         struct seq_file *m = file->private_data;
 276
 277         map_iter_free(map_iter(m));
 278
 279         return seq_release(inode, file);
 280 }
 281
 282 /* bpffs_map_fops should only implement the basic
 283  * read operation for a BPF map.  The purpose is to
 284  * provide a simple user intuitive way to do
 285  * "cat bpffs/pathto/a-pinned-map".
 286  *
 287  * Other operations (e.g. write, lookup...) should be realized by
 288  * the userspace tools (e.g. bpftool) through the
 289  * BPF_OBJ_GET_INFO_BY_FD and the map's lookup/update
 290  * interface.
 291  */
 292 static const struct file_operations bpffs_map_fops = {
 293         .open           = bpffs_map_open,
 294         .read           = seq_read,
 295         .release        = bpffs_map_release,
 296 };
 297
 298 static int bpffs_obj_open(struct inode *inode, struct file *file)
 299 {
 300         return -EIO;
 301 }
 302
 303 static const struct file_operations bpffs_obj_fops = {
 304         .open           = bpffs_obj_open,
 305 };
 306
 307 static int bpf_mkobj_ops(struct dentry *dentry, umode_t mode, void *raw,
 308                          const struct inode_operations *iops,
 309                          const struct file_operations *fops)
 310 {
 311         struct inode *dir = dentry->d_parent->d_inode;
 312         struct inode *inode = bpf_get_inode(dir->i_sb, dir, mode);
 313         if (IS_ERR(inode))
 314                 return PTR_ERR(inode);
 315
 316         inode->i_op = iops;
 317         inode->i_fop = fops;
 318         inode->i_private = raw;
 319
 320         bpf_dentry_finalize(dentry, inode, dir);
 321         return 0;
 322 }
 323
 324 static int bpf_mkprog(struct dentry *dentry, umode_t mode, void *arg)
 325 {
 326         return bpf_mkobj_ops(dentry, mode, arg, &bpf_prog_iops,
 327                              &bpffs_obj_fops);
 328 }
 329
 330 static int bpf_mkmap(struct dentry *dentry, umode_t mode, void *arg)
 331 {
 332         struct bpf_map *map = arg;
 333
 334         return bpf_mkobj_ops(dentry, mode, arg, &bpf_map_iops,
 335                              map->btf ? &bpffs_map_fops : &bpffs_obj_fops);
 336 }
 337
 338 static struct dentry *
 339 bpf_lookup(struct inode *dir, struct dentry *dentry, unsigned flags)
 340 {
 341         /* Dots in names (e.g. "/sys/fs/bpf/foo.bar") are reserved for future
 342          * extensions.
 343          */
 344         if (strchr(dentry->d_name.name, '.'))
 345                 return ERR_PTR(-EPERM);
 346
 347         return simple_lookup(dir, dentry, flags);
 348 }
 349
 350 static int bpf_symlink(struct inode *dir, struct dentry *dentry,
 351                        const char *target)
 352 {
 353         char *link = kstrdup(target, GFP_USER | __GFP_NOWARN);
 354         struct inode *inode;
 355
 356         if (!link)
 357                 return -ENOMEM;
 358
 359         inode = bpf_get_inode(dir->i_sb, dir, S_IRWXUGO | S_IFLNK);
 360         if (IS_ERR(inode)) {
 361                 kfree(link);
 362                 return PTR_ERR(inode);
 363         }
 364
 365         inode->i_op = &simple_symlink_inode_operations;
 366         inode->i_link = link;
 367
 368         bpf_dentry_finalize(dentry, inode, dir);
 369         return 0;
 370 }
 371
 372 static const struct inode_operations bpf_dir_iops = {
 373         .lookup         = bpf_lookup,
 374         .mkdir          = bpf_mkdir,
 375         .symlink        = bpf_symlink,
 376         .rmdir          = simple_rmdir,
 377         .rename         = simple_rename,
 378         .link           = simple_link,
 379         .unlink         = simple_unlink,
 380 };
 381
 382 static int bpf_obj_do_pin(const struct filename *pathname, void *raw,
 383                           enum bpf_type type)
 384 {
 385         struct dentry *dentry;
 386         struct inode *dir;
 387         struct path path;
 388         umode_t mode;
 389         int ret;
 390
 391         dentry = kern_path_create(AT_FDCWD, pathname->name, &path, 0);
 392         if (IS_ERR(dentry))
 393                 return PTR_ERR(dentry);
 394
 395         mode = S_IFREG | ((S_IRUSR | S_IWUSR) & ~current_umask());
 396
 397         ret = security_path_mknod(&path, dentry, mode, 0);
 398         if (ret)
 399                 goto out;
 400
 401         dir = d_inode(path.dentry);
 402         if (dir->i_op != &bpf_dir_iops) {
 403                 ret = -EPERM;
 404                 goto out;
 405         }
 406
 407         switch (type) {
 408         case BPF_TYPE_PROG:
 409                 ret = vfs_mkobj(dentry, mode, bpf_mkprog, raw);
 410                 break;
 411         case BPF_TYPE_MAP:
 412                 ret = vfs_mkobj(dentry, mode, bpf_mkmap, raw);
 413                 break;
 414         default:
 415                 ret = -EPERM;
 416         }
 417 out:
 418         done_path_create(&path, dentry);
 419         return ret;
 420 }
 421
 422 int bpf_obj_pin_user(u32 ufd, const char __user *pathname)
 423 {
 424         struct filename *pname;
 425         enum bpf_type type;
 426         void *raw;
 427         int ret;
 428
 429         pname = getname(pathname);
 430         if (IS_ERR(pname))
 431                 return PTR_ERR(pname);
 432
 433         raw = bpf_fd_probe_obj(ufd, &type);
 434         if (IS_ERR(raw)) {
 435                 ret = PTR_ERR(raw);
 436                 goto out;
 437         }
 438
 439         ret = bpf_obj_do_pin(pname, raw, type);
 440         if (ret != 0)
 441                 bpf_any_put(raw, type);
 442 out:
 443         putname(pname);
 444         return ret;
 445 }
 446
 447 static void *bpf_obj_do_get(const struct filename *pathname,
 448                             enum bpf_type *type, int flags)
 449 {
 450         struct inode *inode;
 451         struct path path;
 452         void *raw;
 453         int ret;
 454
 455         ret = kern_path(pathname->name, LOOKUP_FOLLOW, &path);
 456         if (ret)
 457                 return ERR_PTR(ret);
 458
 459         inode = d_backing_inode(path.dentry);
 460         ret = inode_permission(inode, ACC_MODE(flags));
 461         if (ret)
 462                 goto out;
 463
 464         ret = bpf_inode_type(inode, type);
 465         if (ret)
 466                 goto out;
 467
 468         raw = bpf_any_get(inode->i_private, *type);
 469         if (!IS_ERR(raw))
 470                 touch_atime(&path);
 471
 472         path_put(&path);
 473         return raw;
 474 out:
 475         path_put(&path);
 476         return ERR_PTR(ret);
 477 }
 478
 479 int bpf_obj_get_user(const char __user *pathname, int flags)
 480 {
 481         enum bpf_type type = BPF_TYPE_UNSPEC;
 482         struct filename *pname;
 483         int ret = -ENOENT;
 484         int f_flags;
 485         void *raw;
 486
 487         f_flags = bpf_get_file_flag(flags);
 488         if (f_flags < 0)
 489                 return f_flags;
 490
 491         pname = getname(pathname);
 492         if (IS_ERR(pname))
 493                 return PTR_ERR(pname);
 494
 495         raw = bpf_obj_do_get(pname, &type, f_flags);
 496         if (IS_ERR(raw)) {
 497                 ret = PTR_ERR(raw);
 498                 goto out;
 499         }
 500
 501         if (type == BPF_TYPE_PROG)
 502                 ret = bpf_prog_new_fd(raw);
 503         else if (type == BPF_TYPE_MAP)
 504                 ret = bpf_map_new_fd(raw, f_flags);
 505         else
 506                 goto out;
 507
 508         if (ret < 0)
 509                 bpf_any_put(raw, type);
 510 out:
 511         putname(pname);
 512         return ret;
 513 }
 514
 515 static struct bpf_prog *__get_prog_inode(struct inode *inode, enum bpf_prog_type type)
 516 {
 517         struct bpf_prog *prog;
 518         int ret = inode_permission(inode, MAY_READ | MAY_WRITE);
 519         if (ret)
 520                 return ERR_PTR(ret);
 521
 522         if (inode->i_op == &bpf_map_iops)
 523                 return ERR_PTR(-EINVAL);
 524         if (inode->i_op != &bpf_prog_iops)
 525                 return ERR_PTR(-EACCES);
 526
 527         prog = inode->i_private;
 528
 529         ret = security_bpf_prog(prog);
 530         if (ret < 0)
 531                 return ERR_PTR(ret);
 532
 533         if (!bpf_prog_get_ok(prog, &type, false))
 534                 return ERR_PTR(-EINVAL);
 535
 536         return bpf_prog_inc(prog);
 537 }
 538
 539 struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type)
 540 {
 541         struct bpf_prog *prog;
 542         struct path path;
 543         int ret = kern_path(name, LOOKUP_FOLLOW, &path);
 544         if (ret)
 545                 return ERR_PTR(ret);
 546         prog = __get_prog_inode(d_backing_inode(path.dentry), type);
 547         if (!IS_ERR(prog))
 548                 touch_atime(&path);
 549         path_put(&path);
 550         return prog;
 551 }
 552 EXPORT_SYMBOL(bpf_prog_get_type_path);
 553
 554 static void bpf_evict_inode(struct inode *inode)
 555 {
 556         enum bpf_type type;
 557
 558         truncate_inode_pages_final(&inode->i_data);
 559         clear_inode(inode);
 560
 561         if (S_ISLNK(inode->i_mode))
 562                 kfree(inode->i_link);
 563         if (!bpf_inode_type(inode, &type))
 564                 bpf_any_put(inode->i_private, type);
 565 }
 566
 567 /*
 568  * Display the mount options in /proc/mounts.
 569  */
 570 static int bpf_show_options(struct seq_file *m, struct dentry *root)
 571 {
 572         umode_t mode = d_inode(root)->i_mode & S_IALLUGO & ~S_ISVTX;
 573
 574         if (mode != S_IRWXUGO)
 575                 seq_printf(m, ",mode=%o", mode);
 576         return 0;
 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         .evict_inode    = bpf_evict_inode,
 584 };
 585
 586 enum {
 587         OPT_MODE,
 588         OPT_ERR,
 589 };
 590
 591 static const match_table_t bpf_mount_tokens = {
 592         { OPT_MODE, "mode=%o" },
 593         { OPT_ERR, NULL },
 594 };
 595
 596 struct bpf_mount_opts {
 597         umode_t mode;
 598 };
 599
 600 static int bpf_parse_options(char *data, struct bpf_mount_opts *opts)
 601 {
 602         substring_t args[MAX_OPT_ARGS];
 603         int option, token;
 604         char *ptr;
 605
 606         opts->mode = S_IRWXUGO;
 607
 608         while ((ptr = strsep(&data, ",")) != NULL) {
 609                 if (!*ptr)
 610                         continue;
 611
 612                 token = match_token(ptr, bpf_mount_tokens, args);
 613                 switch (token) {
 614                 case OPT_MODE:
 615                         if (match_octal(&args[0], &option))
 616                                 return -EINVAL;
 617                         opts->mode = option & S_IALLUGO;
 618                         break;
 619                 /* We might like to report bad mount options here, but
 620                  * traditionally we've ignored all mount options, so we'd
 621                  * better continue to ignore non-existing options for bpf.
 622                  */
 623                 }
 624         }
 625
 626         return 0;
 627 }
 628
 629 static int bpf_fill_super(struct super_block *sb, void *data, int silent)
 630 {
 631         static const struct tree_descr bpf_rfiles[] = { { "" } };
 632         struct bpf_mount_opts opts;
 633         struct inode *inode;
 634         int ret;
 635
 636         ret = bpf_parse_options(data, &opts);
 637         if (ret)
 638                 return ret;
 639
 640         ret = simple_fill_super(sb, BPF_FS_MAGIC, bpf_rfiles);
 641         if (ret)
 642                 return ret;
 643
 644         sb->s_op = &bpf_super_ops;
 645
 646         inode = sb->s_root->d_inode;
 647         inode->i_op = &bpf_dir_iops;
 648         inode->i_mode &= ~S_IALLUGO;
 649         inode->i_mode |= S_ISVTX | opts.mode;
 650
 651         return 0;
 652 }
 653
 654 static struct dentry *bpf_mount(struct file_system_type *type, int flags,
 655                                 const char *dev_name, void *data)
 656 {
 657         return mount_nodev(type, flags, data, bpf_fill_super);
 658 }
 659
 660 static struct file_system_type bpf_fs_type = {
 661         .owner          = THIS_MODULE,
 662         .name           = "bpf",
 663         .mount          = bpf_mount,
 664         .kill_sb        = kill_litter_super,
 665 };
 666
 667 static int __init bpf_init(void)
 668 {
 669         int ret;
 670
 671         ret = sysfs_create_mount_point(fs_kobj, "bpf");
 672         if (ret)
 673                 return ret;
 674
 675         ret = register_filesystem(&bpf_fs_type);
 676         if (ret)
 677                 sysfs_remove_mount_point(fs_kobj, "bpf");
 678
 679         return ret;
 680 }
 681 fs_initcall(bpf_init);