kernel/bpf/syscall.c

   1 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
   2  *
   3  * This program is free software; you can redistribute it and/or
   4  * modify it under the terms of version 2 of the GNU General Public
   5  * License as published by the Free Software Foundation.
   6  *
   7  * This program is distributed in the hope that it will be useful, but
   8  * WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  10  * General Public License for more details.
  11  */
  12 #include <linux/bpf.h>
  13 #include <linux/syscalls.h>
  14 #include <linux/slab.h>
  15 #include <linux/anon_inodes.h>
  16 #include <linux/file.h>
  17 #include <linux/license.h>
  18 #include <linux/filter.h>
  19 #include <linux/version.h>
  20
  21 int sysctl_unprivileged_bpf_disabled __read_mostly;
  22
  23 static LIST_HEAD(bpf_map_types);
  24
  25 static struct bpf_map *find_and_alloc_map(union bpf_attr *attr)
  26 {
  27         struct bpf_map_type_list *tl;
  28         struct bpf_map *map;
  29
  30         list_for_each_entry(tl, &bpf_map_types, list_node) {
  31                 if (tl->type == attr->map_type) {
  32                         map = tl->ops->map_alloc(attr);
  33                         if (IS_ERR(map))
  34                                 return map;
  35                         map->ops = tl->ops;
  36                         map->map_type = attr->map_type;
  37                         return map;
  38                 }
  39         }
  40         return ERR_PTR(-EINVAL);
  41 }
  42
  43 /* boot time registration of different map implementations */
  44 void bpf_register_map_type(struct bpf_map_type_list *tl)
  45 {
  46         list_add(&tl->list_node, &bpf_map_types);
  47 }
  48
  49 /* called from workqueue */
  50 static void bpf_map_free_deferred(struct work_struct *work)
  51 {
  52         struct bpf_map *map = container_of(work, struct bpf_map, work);
  53
  54         /* implementation dependent freeing */
  55         map->ops->map_free(map);
  56 }
  57
  58 /* decrement map refcnt and schedule it for freeing via workqueue
  59  * (unrelying map implementation ops->map_free() might sleep)
  60  */
  61 void bpf_map_put(struct bpf_map *map)
  62 {
  63         if (atomic_dec_and_test(&map->refcnt)) {
  64                 INIT_WORK(&map->work, bpf_map_free_deferred);
  65                 schedule_work(&map->work);
  66         }
  67 }
  68
  69 static int bpf_map_release(struct inode *inode, struct file *filp)
  70 {
  71         struct bpf_map *map = filp->private_data;
  72
  73         if (map->map_type == BPF_MAP_TYPE_PROG_ARRAY)
  74                 /* prog_array stores refcnt-ed bpf_prog pointers
  75                  * release them all when user space closes prog_array_fd
  76                  */
  77                 bpf_fd_array_map_clear(map);
  78
  79         bpf_map_put(map);
  80         return 0;
  81 }
  82
  83 static const struct file_operations bpf_map_fops = {
  84         .release = bpf_map_release,
  85 };
  86
  87 /* helper macro to check that unused fields 'union bpf_attr' are zero */
  88 #define CHECK_ATTR(CMD) \
  89         memchr_inv((void *) &attr->CMD##_LAST_FIELD + \
  90                    sizeof(attr->CMD##_LAST_FIELD), 0, \
  91                    sizeof(*attr) - \
  92                    offsetof(union bpf_attr, CMD##_LAST_FIELD) - \
  93                    sizeof(attr->CMD##_LAST_FIELD)) != NULL
  94
  95 #define BPF_MAP_CREATE_LAST_FIELD max_entries
  96 /* called via syscall */
  97 static int map_create(union bpf_attr *attr)
  98 {
  99         struct bpf_map *map;
 100         int err;
 101
 102         err = CHECK_ATTR(BPF_MAP_CREATE);
 103         if (err)
 104                 return -EINVAL;
 105
 106         /* find map type and init map: hashtable vs rbtree vs bloom vs ... */
 107         map = find_and_alloc_map(attr);
 108         if (IS_ERR(map))
 109                 return PTR_ERR(map);
 110
 111         atomic_set(&map->refcnt, 1);
 112
 113         err = anon_inode_getfd("bpf-map", &bpf_map_fops, map, O_RDWR | O_CLOEXEC);
 114
 115         if (err < 0)
 116                 /* failed to allocate fd */
 117                 goto free_map;
 118
 119         return err;
 120
 121 free_map:
 122         map->ops->map_free(map);
 123         return err;
 124 }
 125
 126 /* if error is returned, fd is released.
 127  * On success caller should complete fd access with matching fdput()
 128  */
 129 struct bpf_map *bpf_map_get(struct fd f)
 130 {
 131         struct bpf_map *map;
 132
 133         if (!f.file)
 134                 return ERR_PTR(-EBADF);
 135
 136         if (f.file->f_op != &bpf_map_fops) {
 137                 fdput(f);
 138                 return ERR_PTR(-EINVAL);
 139         }
 140
 141         map = f.file->private_data;
 142
 143         return map;
 144 }
 145
 146 /* helper to convert user pointers passed inside __aligned_u64 fields */
 147 static void __user *u64_to_ptr(__u64 val)
 148 {
 149         return (void __user *) (unsigned long) val;
 150 }
 151
 152 /* last field in 'union bpf_attr' used by this command */
 153 #define BPF_MAP_LOOKUP_ELEM_LAST_FIELD value
 154
 155 static int map_lookup_elem(union bpf_attr *attr)
 156 {
 157         void __user *ukey = u64_to_ptr(attr->key);
 158         void __user *uvalue = u64_to_ptr(attr->value);
 159         int ufd = attr->map_fd;
 160         struct bpf_map *map;
 161         void *key, *value, *ptr;
 162         struct fd f;
 163         int err;
 164
 165         if (CHECK_ATTR(BPF_MAP_LOOKUP_ELEM))
 166                 return -EINVAL;
 167
 168         f = fdget(ufd);
 169         map = bpf_map_get(f);
 170         if (IS_ERR(map))
 171                 return PTR_ERR(map);
 172
 173         err = -ENOMEM;
 174         key = kmalloc(map->key_size, GFP_USER);
 175         if (!key)
 176                 goto err_put;
 177
 178         err = -EFAULT;
 179         if (copy_from_user(key, ukey, map->key_size) != 0)
 180                 goto free_key;
 181
 182         err = -ENOMEM;
 183         value = kmalloc(map->value_size, GFP_USER);
 184         if (!value)
 185                 goto free_key;
 186
 187         rcu_read_lock();
 188         ptr = map->ops->map_lookup_elem(map, key);
 189         if (ptr)
 190                 memcpy(value, ptr, map->value_size);
 191         rcu_read_unlock();
 192
 193         err = -ENOENT;
 194         if (!ptr)
 195                 goto free_value;
 196
 197         err = -EFAULT;
 198         if (copy_to_user(uvalue, value, map->value_size) != 0)
 199                 goto free_value;
 200
 201         err = 0;
 202
 203 free_value:
 204         kfree(value);
 205 free_key:
 206         kfree(key);
 207 err_put:
 208         fdput(f);
 209         return err;
 210 }
 211
 212 #define BPF_MAP_UPDATE_ELEM_LAST_FIELD flags
 213
 214 static int map_update_elem(union bpf_attr *attr)
 215 {
 216         void __user *ukey = u64_to_ptr(attr->key);
 217         void __user *uvalue = u64_to_ptr(attr->value);
 218         int ufd = attr->map_fd;
 219         struct bpf_map *map;
 220         void *key, *value;
 221         struct fd f;
 222         int err;
 223
 224         if (CHECK_ATTR(BPF_MAP_UPDATE_ELEM))
 225                 return -EINVAL;
 226
 227         f = fdget(ufd);
 228         map = bpf_map_get(f);
 229         if (IS_ERR(map))
 230                 return PTR_ERR(map);
 231
 232         err = -ENOMEM;
 233         key = kmalloc(map->key_size, GFP_USER);
 234         if (!key)
 235                 goto err_put;
 236
 237         err = -EFAULT;
 238         if (copy_from_user(key, ukey, map->key_size) != 0)
 239                 goto free_key;
 240
 241         err = -ENOMEM;
 242         value = kmalloc(map->value_size, GFP_USER);
 243         if (!value)
 244                 goto free_key;
 245
 246         err = -EFAULT;
 247         if (copy_from_user(value, uvalue, map->value_size) != 0)
 248                 goto free_value;
 249
 250         /* eBPF program that use maps are running under rcu_read_lock(),
 251          * therefore all map accessors rely on this fact, so do the same here
 252          */
 253         rcu_read_lock();
 254         err = map->ops->map_update_elem(map, key, value, attr->flags);
 255         rcu_read_unlock();
 256
 257 free_value:
 258         kfree(value);
 259 free_key:
 260         kfree(key);
 261 err_put:
 262         fdput(f);
 263         return err;
 264 }
 265
 266 #define BPF_MAP_DELETE_ELEM_LAST_FIELD key
 267
 268 static int map_delete_elem(union bpf_attr *attr)
 269 {
 270         void __user *ukey = u64_to_ptr(attr->key);
 271         int ufd = attr->map_fd;
 272         struct bpf_map *map;
 273         struct fd f;
 274         void *key;
 275         int err;
 276
 277         if (CHECK_ATTR(BPF_MAP_DELETE_ELEM))
 278                 return -EINVAL;
 279
 280         f = fdget(ufd);
 281         map = bpf_map_get(f);
 282         if (IS_ERR(map))
 283                 return PTR_ERR(map);
 284
 285         err = -ENOMEM;
 286         key = kmalloc(map->key_size, GFP_USER);
 287         if (!key)
 288                 goto err_put;
 289
 290         err = -EFAULT;
 291         if (copy_from_user(key, ukey, map->key_size) != 0)
 292                 goto free_key;
 293
 294         rcu_read_lock();
 295         err = map->ops->map_delete_elem(map, key);
 296         rcu_read_unlock();
 297
 298 free_key:
 299         kfree(key);
 300 err_put:
 301         fdput(f);
 302         return err;
 303 }
 304
 305 /* last field in 'union bpf_attr' used by this command */
 306 #define BPF_MAP_GET_NEXT_KEY_LAST_FIELD next_key
 307
 308 static int map_get_next_key(union bpf_attr *attr)
 309 {
 310         void __user *ukey = u64_to_ptr(attr->key);
 311         void __user *unext_key = u64_to_ptr(attr->next_key);
 312         int ufd = attr->map_fd;
 313         struct bpf_map *map;
 314         void *key, *next_key;
 315         struct fd f;
 316         int err;
 317
 318         if (CHECK_ATTR(BPF_MAP_GET_NEXT_KEY))
 319                 return -EINVAL;
 320
 321         f = fdget(ufd);
 322         map = bpf_map_get(f);
 323         if (IS_ERR(map))
 324                 return PTR_ERR(map);
 325
 326         err = -ENOMEM;
 327         key = kmalloc(map->key_size, GFP_USER);
 328         if (!key)
 329                 goto err_put;
 330
 331         err = -EFAULT;
 332         if (copy_from_user(key, ukey, map->key_size) != 0)
 333                 goto free_key;
 334
 335         err = -ENOMEM;
 336         next_key = kmalloc(map->key_size, GFP_USER);
 337         if (!next_key)
 338                 goto free_key;
 339
 340         rcu_read_lock();
 341         err = map->ops->map_get_next_key(map, key, next_key);
 342         rcu_read_unlock();
 343         if (err)
 344                 goto free_next_key;
 345
 346         err = -EFAULT;
 347         if (copy_to_user(unext_key, next_key, map->key_size) != 0)
 348                 goto free_next_key;
 349
 350         err = 0;
 351
 352 free_next_key:
 353         kfree(next_key);
 354 free_key:
 355         kfree(key);
 356 err_put:
 357         fdput(f);
 358         return err;
 359 }
 360
 361 static LIST_HEAD(bpf_prog_types);
 362
 363 static int find_prog_type(enum bpf_prog_type type, struct bpf_prog *prog)
 364 {
 365         struct bpf_prog_type_list *tl;
 366
 367         list_for_each_entry(tl, &bpf_prog_types, list_node) {
 368                 if (tl->type == type) {
 369                         prog->aux->ops = tl->ops;
 370                         prog->type = type;
 371                         return 0;
 372                 }
 373         }
 374
 375         return -EINVAL;
 376 }
 377
 378 void bpf_register_prog_type(struct bpf_prog_type_list *tl)
 379 {
 380         list_add(&tl->list_node, &bpf_prog_types);
 381 }
 382
 383 /* fixup insn->imm field of bpf_call instructions:
 384  * if (insn->imm == BPF_FUNC_map_lookup_elem)
 385  *      insn->imm = bpf_map_lookup_elem - __bpf_call_base;
 386  * else if (insn->imm == BPF_FUNC_map_update_elem)
 387  *      insn->imm = bpf_map_update_elem - __bpf_call_base;
 388  * else ...
 389  *
 390  * this function is called after eBPF program passed verification
 391  */
 392 static void fixup_bpf_calls(struct bpf_prog *prog)
 393 {
 394         const struct bpf_func_proto *fn;
 395         int i;
 396
 397         for (i = 0; i < prog->len; i++) {
 398                 struct bpf_insn *insn = &prog->insnsi[i];
 399
 400                 if (insn->code == (BPF_JMP | BPF_CALL)) {
 401                         /* we reach here when program has bpf_call instructions
 402                          * and it passed bpf_check(), means that
 403                          * ops->get_func_proto must have been supplied, check it
 404                          */
 405                         BUG_ON(!prog->aux->ops->get_func_proto);
 406
 407                         if (insn->imm == BPF_FUNC_get_route_realm)
 408                                 prog->dst_needed = 1;
 409                         if (insn->imm == BPF_FUNC_get_prandom_u32)
 410                                 bpf_user_rnd_init_once();
 411                         if (insn->imm == BPF_FUNC_tail_call) {
 412                                 /* mark bpf_tail_call as different opcode
 413                                  * to avoid conditional branch in
 414                                  * interpeter for every normal call
 415                                  * and to prevent accidental JITing by
 416                                  * JIT compiler that doesn't support
 417                                  * bpf_tail_call yet
 418                                  */
 419                                 insn->imm = 0;
 420                                 insn->code |= BPF_X;
 421                                 continue;
 422                         }
 423
 424                         fn = prog->aux->ops->get_func_proto(insn->imm);
 425                         /* all functions that have prototype and verifier allowed
 426                          * programs to call them, must be real in-kernel functions
 427                          */
 428                         BUG_ON(!fn->func);
 429                         insn->imm = fn->func - __bpf_call_base;
 430                 }
 431         }
 432 }
 433
 434 /* drop refcnt on maps used by eBPF program and free auxilary data */
 435 static void free_used_maps(struct bpf_prog_aux *aux)
 436 {
 437         int i;
 438
 439         for (i = 0; i < aux->used_map_cnt; i++)
 440                 bpf_map_put(aux->used_maps[i]);
 441
 442         kfree(aux->used_maps);
 443 }
 444
 445 static void __prog_put_rcu(struct rcu_head *rcu)
 446 {
 447         struct bpf_prog_aux *aux = container_of(rcu, struct bpf_prog_aux, rcu);
 448
 449         free_used_maps(aux);
 450         bpf_prog_free(aux->prog);
 451 }
 452
 453 /* version of bpf_prog_put() that is called after a grace period */
 454 void bpf_prog_put_rcu(struct bpf_prog *prog)
 455 {
 456         if (atomic_dec_and_test(&prog->aux->refcnt)) {
 457                 prog->aux->prog = prog;
 458                 call_rcu(&prog->aux->rcu, __prog_put_rcu);
 459         }
 460 }
 461
 462 void bpf_prog_put(struct bpf_prog *prog)
 463 {
 464         if (atomic_dec_and_test(&prog->aux->refcnt)) {
 465                 free_used_maps(prog->aux);
 466                 bpf_prog_free(prog);
 467         }
 468 }
 469 EXPORT_SYMBOL_GPL(bpf_prog_put);
 470
 471 static int bpf_prog_release(struct inode *inode, struct file *filp)
 472 {
 473         struct bpf_prog *prog = filp->private_data;
 474
 475         bpf_prog_put_rcu(prog);
 476         return 0;
 477 }
 478
 479 static const struct file_operations bpf_prog_fops = {
 480         .release = bpf_prog_release,
 481 };
 482
 483 static struct bpf_prog *get_prog(struct fd f)
 484 {
 485         struct bpf_prog *prog;
 486
 487         if (!f.file)
 488                 return ERR_PTR(-EBADF);
 489
 490         if (f.file->f_op != &bpf_prog_fops) {
 491                 fdput(f);
 492                 return ERR_PTR(-EINVAL);
 493         }
 494
 495         prog = f.file->private_data;
 496
 497         return prog;
 498 }
 499
 500 /* called by sockets/tracing/seccomp before attaching program to an event
 501  * pairs with bpf_prog_put()
 502  */
 503 struct bpf_prog *bpf_prog_get(u32 ufd)
 504 {
 505         struct fd f = fdget(ufd);
 506         struct bpf_prog *prog;
 507
 508         prog = get_prog(f);
 509
 510         if (IS_ERR(prog))
 511                 return prog;
 512
 513         atomic_inc(&prog->aux->refcnt);
 514         fdput(f);
 515         return prog;
 516 }
 517 EXPORT_SYMBOL_GPL(bpf_prog_get);
 518
 519 /* last field in 'union bpf_attr' used by this command */
 520 #define BPF_PROG_LOAD_LAST_FIELD kern_version
 521
 522 static int bpf_prog_load(union bpf_attr *attr)
 523 {
 524         enum bpf_prog_type type = attr->prog_type;
 525         struct bpf_prog *prog;
 526         int err;
 527         char license[128];
 528         bool is_gpl;
 529
 530         if (CHECK_ATTR(BPF_PROG_LOAD))
 531                 return -EINVAL;
 532
 533         /* copy eBPF program license from user space */
 534         if (strncpy_from_user(license, u64_to_ptr(attr->license),
 535                               sizeof(license) - 1) < 0)
 536                 return -EFAULT;
 537         license[sizeof(license) - 1] = 0;
 538
 539         /* eBPF programs must be GPL compatible to use GPL-ed functions */
 540         is_gpl = license_is_gpl_compatible(license);
 541
 542         if (attr->insn_cnt >= BPF_MAXINSNS)
 543                 return -EINVAL;
 544
 545         if (type == BPF_PROG_TYPE_KPROBE &&
 546             attr->kern_version != LINUX_VERSION_CODE)
 547                 return -EINVAL;
 548
 549         if (type != BPF_PROG_TYPE_SOCKET_FILTER && !capable(CAP_SYS_ADMIN))
 550                 return -EPERM;
 551
 552         /* plain bpf_prog allocation */
 553         prog = bpf_prog_alloc(bpf_prog_size(attr->insn_cnt), GFP_USER);
 554         if (!prog)
 555                 return -ENOMEM;
 556
 557         prog->len = attr->insn_cnt;
 558
 559         err = -EFAULT;
 560         if (copy_from_user(prog->insns, u64_to_ptr(attr->insns),
 561                            prog->len * sizeof(struct bpf_insn)) != 0)
 562                 goto free_prog;
 563
 564         prog->orig_prog = NULL;
 565         prog->jited = 0;
 566
 567         atomic_set(&prog->aux->refcnt, 1);
 568         prog->gpl_compatible = is_gpl ? 1 : 0;
 569
 570         /* find program type: socket_filter vs tracing_filter */
 571         err = find_prog_type(type, prog);
 572         if (err < 0)
 573                 goto free_prog;
 574
 575         /* run eBPF verifier */
 576         err = bpf_check(&prog, attr);
 577         if (err < 0)
 578                 goto free_used_maps;
 579
 580         /* fixup BPF_CALL->imm field */
 581         fixup_bpf_calls(prog);
 582
 583         /* eBPF program is ready to be JITed */
 584         err = bpf_prog_select_runtime(prog);
 585         if (err < 0)
 586                 goto free_used_maps;
 587
 588         err = anon_inode_getfd("bpf-prog", &bpf_prog_fops, prog, O_RDWR | O_CLOEXEC);
 589         if (err < 0)
 590                 /* failed to allocate fd */
 591                 goto free_used_maps;
 592
 593         return err;
 594
 595 free_used_maps:
 596         free_used_maps(prog->aux);
 597 free_prog:
 598         bpf_prog_free(prog);
 599         return err;
 600 }
 601
 602 SYSCALL_DEFINE3(bpf, int, cmd, union bpf_attr __user *, uattr, unsigned int, size)
 603 {
 604         union bpf_attr attr = {};
 605         int err;
 606
 607         if (!capable(CAP_SYS_ADMIN) && sysctl_unprivileged_bpf_disabled)
 608                 return -EPERM;
 609
 610         if (!access_ok(VERIFY_READ, uattr, 1))
 611                 return -EFAULT;
 612
 613         if (size > PAGE_SIZE)   /* silly large */
 614                 return -E2BIG;
 615
 616         /* If we're handed a bigger struct than we know of,
 617          * ensure all the unknown bits are 0 - i.e. new
 618          * user-space does not rely on any kernel feature
 619          * extensions we dont know about yet.
 620          */
 621         if (size > sizeof(attr)) {
 622                 unsigned char __user *addr;
 623                 unsigned char __user *end;
 624                 unsigned char val;
 625
 626                 addr = (void __user *)uattr + sizeof(attr);
 627                 end  = (void __user *)uattr + size;
 628
 629                 for (; addr < end; addr++) {
 630                         err = get_user(val, addr);
 631                         if (err)
 632                                 return err;
 633                         if (val)
 634                                 return -E2BIG;
 635                 }
 636                 size = sizeof(attr);
 637         }
 638
 639         /* copy attributes from user space, may be less than sizeof(bpf_attr) */
 640         if (copy_from_user(&attr, uattr, size) != 0)
 641                 return -EFAULT;
 642
 643         switch (cmd) {
 644         case BPF_MAP_CREATE:
 645                 err = map_create(&attr);
 646                 break;
 647         case BPF_MAP_LOOKUP_ELEM:
 648                 err = map_lookup_elem(&attr);
 649                 break;
 650         case BPF_MAP_UPDATE_ELEM:
 651                 err = map_update_elem(&attr);
 652                 break;
 653         case BPF_MAP_DELETE_ELEM:
 654                 err = map_delete_elem(&attr);
 655                 break;
 656         case BPF_MAP_GET_NEXT_KEY:
 657                 err = map_get_next_key(&attr);
 658                 break;
 659         case BPF_PROG_LOAD:
 660                 err = bpf_prog_load(&attr);
 661                 break;
 662         default:
 663                 err = -EINVAL;
 664                 break;
 665         }
 666
 667         return err;
 668 }