1 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
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.
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.
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>
21 int sysctl_unprivileged_bpf_disabled __read_mostly
;
23 static LIST_HEAD(bpf_map_types
);
25 static struct bpf_map
*find_and_alloc_map(union bpf_attr
*attr
)
27 struct bpf_map_type_list
*tl
;
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
);
36 map
->map_type
= attr
->map_type
;
40 return ERR_PTR(-EINVAL
);
43 /* boot time registration of different map implementations */
44 void bpf_register_map_type(struct bpf_map_type_list
*tl
)
46 list_add(&tl
->list_node
, &bpf_map_types
);
49 static int bpf_map_charge_memlock(struct bpf_map
*map
)
51 struct user_struct
*user
= get_current_user();
52 unsigned long memlock_limit
;
54 memlock_limit
= rlimit(RLIMIT_MEMLOCK
) >> PAGE_SHIFT
;
56 atomic_long_add(map
->pages
, &user
->locked_vm
);
58 if (atomic_long_read(&user
->locked_vm
) > memlock_limit
) {
59 atomic_long_sub(map
->pages
, &user
->locked_vm
);
67 static void bpf_map_uncharge_memlock(struct bpf_map
*map
)
69 struct user_struct
*user
= map
->user
;
71 atomic_long_sub(map
->pages
, &user
->locked_vm
);
75 /* called from workqueue */
76 static void bpf_map_free_deferred(struct work_struct
*work
)
78 struct bpf_map
*map
= container_of(work
, struct bpf_map
, work
);
80 bpf_map_uncharge_memlock(map
);
81 /* implementation dependent freeing */
82 map
->ops
->map_free(map
);
85 static void bpf_map_put_uref(struct bpf_map
*map
)
87 if (atomic_dec_and_test(&map
->usercnt
)) {
88 if (map
->map_type
== BPF_MAP_TYPE_PROG_ARRAY
)
89 bpf_fd_array_map_clear(map
);
93 /* decrement map refcnt and schedule it for freeing via workqueue
94 * (unrelying map implementation ops->map_free() might sleep)
96 void bpf_map_put(struct bpf_map
*map
)
98 if (atomic_dec_and_test(&map
->refcnt
)) {
99 INIT_WORK(&map
->work
, bpf_map_free_deferred
);
100 schedule_work(&map
->work
);
104 void bpf_map_put_with_uref(struct bpf_map
*map
)
106 bpf_map_put_uref(map
);
110 static int bpf_map_release(struct inode
*inode
, struct file
*filp
)
112 bpf_map_put_with_uref(filp
->private_data
);
116 static const struct file_operations bpf_map_fops
= {
117 .release
= bpf_map_release
,
120 int bpf_map_new_fd(struct bpf_map
*map
)
122 return anon_inode_getfd("bpf-map", &bpf_map_fops
, map
,
126 /* helper macro to check that unused fields 'union bpf_attr' are zero */
127 #define CHECK_ATTR(CMD) \
128 memchr_inv((void *) &attr->CMD##_LAST_FIELD + \
129 sizeof(attr->CMD##_LAST_FIELD), 0, \
131 offsetof(union bpf_attr, CMD##_LAST_FIELD) - \
132 sizeof(attr->CMD##_LAST_FIELD)) != NULL
134 #define BPF_MAP_CREATE_LAST_FIELD max_entries
135 /* called via syscall */
136 static int map_create(union bpf_attr
*attr
)
141 err
= CHECK_ATTR(BPF_MAP_CREATE
);
145 /* find map type and init map: hashtable vs rbtree vs bloom vs ... */
146 map
= find_and_alloc_map(attr
);
150 atomic_set(&map
->refcnt
, 1);
151 atomic_set(&map
->usercnt
, 1);
153 err
= bpf_map_charge_memlock(map
);
157 err
= bpf_map_new_fd(map
);
159 /* failed to allocate fd */
165 map
->ops
->map_free(map
);
169 /* if error is returned, fd is released.
170 * On success caller should complete fd access with matching fdput()
172 struct bpf_map
*__bpf_map_get(struct fd f
)
175 return ERR_PTR(-EBADF
);
176 if (f
.file
->f_op
!= &bpf_map_fops
) {
178 return ERR_PTR(-EINVAL
);
181 return f
.file
->private_data
;
184 void bpf_map_inc(struct bpf_map
*map
, bool uref
)
186 atomic_inc(&map
->refcnt
);
188 atomic_inc(&map
->usercnt
);
191 struct bpf_map
*bpf_map_get_with_uref(u32 ufd
)
193 struct fd f
= fdget(ufd
);
196 map
= __bpf_map_get(f
);
200 bpf_map_inc(map
, true);
206 /* helper to convert user pointers passed inside __aligned_u64 fields */
207 static void __user
*u64_to_ptr(__u64 val
)
209 return (void __user
*) (unsigned long) val
;
212 /* last field in 'union bpf_attr' used by this command */
213 #define BPF_MAP_LOOKUP_ELEM_LAST_FIELD value
215 static int map_lookup_elem(union bpf_attr
*attr
)
217 void __user
*ukey
= u64_to_ptr(attr
->key
);
218 void __user
*uvalue
= u64_to_ptr(attr
->value
);
219 int ufd
= attr
->map_fd
;
221 void *key
, *value
, *ptr
;
225 if (CHECK_ATTR(BPF_MAP_LOOKUP_ELEM
))
229 map
= __bpf_map_get(f
);
234 key
= kmalloc(map
->key_size
, GFP_USER
);
239 if (copy_from_user(key
, ukey
, map
->key_size
) != 0)
243 value
= kmalloc(map
->value_size
, GFP_USER
| __GFP_NOWARN
);
248 ptr
= map
->ops
->map_lookup_elem(map
, key
);
250 memcpy(value
, ptr
, map
->value_size
);
258 if (copy_to_user(uvalue
, value
, map
->value_size
) != 0)
272 #define BPF_MAP_UPDATE_ELEM_LAST_FIELD flags
274 static int map_update_elem(union bpf_attr
*attr
)
276 void __user
*ukey
= u64_to_ptr(attr
->key
);
277 void __user
*uvalue
= u64_to_ptr(attr
->value
);
278 int ufd
= attr
->map_fd
;
284 if (CHECK_ATTR(BPF_MAP_UPDATE_ELEM
))
288 map
= __bpf_map_get(f
);
293 key
= kmalloc(map
->key_size
, GFP_USER
);
298 if (copy_from_user(key
, ukey
, map
->key_size
) != 0)
302 value
= kmalloc(map
->value_size
, GFP_USER
| __GFP_NOWARN
);
307 if (copy_from_user(value
, uvalue
, map
->value_size
) != 0)
310 /* eBPF program that use maps are running under rcu_read_lock(),
311 * therefore all map accessors rely on this fact, so do the same here
314 err
= map
->ops
->map_update_elem(map
, key
, value
, attr
->flags
);
326 #define BPF_MAP_DELETE_ELEM_LAST_FIELD key
328 static int map_delete_elem(union bpf_attr
*attr
)
330 void __user
*ukey
= u64_to_ptr(attr
->key
);
331 int ufd
= attr
->map_fd
;
337 if (CHECK_ATTR(BPF_MAP_DELETE_ELEM
))
341 map
= __bpf_map_get(f
);
346 key
= kmalloc(map
->key_size
, GFP_USER
);
351 if (copy_from_user(key
, ukey
, map
->key_size
) != 0)
355 err
= map
->ops
->map_delete_elem(map
, key
);
365 /* last field in 'union bpf_attr' used by this command */
366 #define BPF_MAP_GET_NEXT_KEY_LAST_FIELD next_key
368 static int map_get_next_key(union bpf_attr
*attr
)
370 void __user
*ukey
= u64_to_ptr(attr
->key
);
371 void __user
*unext_key
= u64_to_ptr(attr
->next_key
);
372 int ufd
= attr
->map_fd
;
374 void *key
, *next_key
;
378 if (CHECK_ATTR(BPF_MAP_GET_NEXT_KEY
))
382 map
= __bpf_map_get(f
);
387 key
= kmalloc(map
->key_size
, GFP_USER
);
392 if (copy_from_user(key
, ukey
, map
->key_size
) != 0)
396 next_key
= kmalloc(map
->key_size
, GFP_USER
);
401 err
= map
->ops
->map_get_next_key(map
, key
, next_key
);
407 if (copy_to_user(unext_key
, next_key
, map
->key_size
) != 0)
421 static LIST_HEAD(bpf_prog_types
);
423 static int find_prog_type(enum bpf_prog_type type
, struct bpf_prog
*prog
)
425 struct bpf_prog_type_list
*tl
;
427 list_for_each_entry(tl
, &bpf_prog_types
, list_node
) {
428 if (tl
->type
== type
) {
429 prog
->aux
->ops
= tl
->ops
;
438 void bpf_register_prog_type(struct bpf_prog_type_list
*tl
)
440 list_add(&tl
->list_node
, &bpf_prog_types
);
443 /* fixup insn->imm field of bpf_call instructions:
444 * if (insn->imm == BPF_FUNC_map_lookup_elem)
445 * insn->imm = bpf_map_lookup_elem - __bpf_call_base;
446 * else if (insn->imm == BPF_FUNC_map_update_elem)
447 * insn->imm = bpf_map_update_elem - __bpf_call_base;
450 * this function is called after eBPF program passed verification
452 static void fixup_bpf_calls(struct bpf_prog
*prog
)
454 const struct bpf_func_proto
*fn
;
457 for (i
= 0; i
< prog
->len
; i
++) {
458 struct bpf_insn
*insn
= &prog
->insnsi
[i
];
460 if (insn
->code
== (BPF_JMP
| BPF_CALL
)) {
461 /* we reach here when program has bpf_call instructions
462 * and it passed bpf_check(), means that
463 * ops->get_func_proto must have been supplied, check it
465 BUG_ON(!prog
->aux
->ops
->get_func_proto
);
467 if (insn
->imm
== BPF_FUNC_get_route_realm
)
468 prog
->dst_needed
= 1;
469 if (insn
->imm
== BPF_FUNC_get_prandom_u32
)
470 bpf_user_rnd_init_once();
471 if (insn
->imm
== BPF_FUNC_tail_call
) {
472 /* mark bpf_tail_call as different opcode
473 * to avoid conditional branch in
474 * interpeter for every normal call
475 * and to prevent accidental JITing by
476 * JIT compiler that doesn't support
484 fn
= prog
->aux
->ops
->get_func_proto(insn
->imm
);
485 /* all functions that have prototype and verifier allowed
486 * programs to call them, must be real in-kernel functions
489 insn
->imm
= fn
->func
- __bpf_call_base
;
494 /* drop refcnt on maps used by eBPF program and free auxilary data */
495 static void free_used_maps(struct bpf_prog_aux
*aux
)
499 for (i
= 0; i
< aux
->used_map_cnt
; i
++)
500 bpf_map_put(aux
->used_maps
[i
]);
502 kfree(aux
->used_maps
);
505 static int bpf_prog_charge_memlock(struct bpf_prog
*prog
)
507 struct user_struct
*user
= get_current_user();
508 unsigned long memlock_limit
;
510 memlock_limit
= rlimit(RLIMIT_MEMLOCK
) >> PAGE_SHIFT
;
512 atomic_long_add(prog
->pages
, &user
->locked_vm
);
513 if (atomic_long_read(&user
->locked_vm
) > memlock_limit
) {
514 atomic_long_sub(prog
->pages
, &user
->locked_vm
);
518 prog
->aux
->user
= user
;
522 static void bpf_prog_uncharge_memlock(struct bpf_prog
*prog
)
524 struct user_struct
*user
= prog
->aux
->user
;
526 atomic_long_sub(prog
->pages
, &user
->locked_vm
);
530 static void __prog_put_common(struct rcu_head
*rcu
)
532 struct bpf_prog_aux
*aux
= container_of(rcu
, struct bpf_prog_aux
, rcu
);
535 bpf_prog_uncharge_memlock(aux
->prog
);
536 bpf_prog_free(aux
->prog
);
539 /* version of bpf_prog_put() that is called after a grace period */
540 void bpf_prog_put_rcu(struct bpf_prog
*prog
)
542 if (atomic_dec_and_test(&prog
->aux
->refcnt
))
543 call_rcu(&prog
->aux
->rcu
, __prog_put_common
);
546 void bpf_prog_put(struct bpf_prog
*prog
)
548 if (atomic_dec_and_test(&prog
->aux
->refcnt
))
549 __prog_put_common(&prog
->aux
->rcu
);
551 EXPORT_SYMBOL_GPL(bpf_prog_put
);
553 static int bpf_prog_release(struct inode
*inode
, struct file
*filp
)
555 struct bpf_prog
*prog
= filp
->private_data
;
557 bpf_prog_put_rcu(prog
);
561 static const struct file_operations bpf_prog_fops
= {
562 .release
= bpf_prog_release
,
565 int bpf_prog_new_fd(struct bpf_prog
*prog
)
567 return anon_inode_getfd("bpf-prog", &bpf_prog_fops
, prog
,
571 static struct bpf_prog
*__bpf_prog_get(struct fd f
)
574 return ERR_PTR(-EBADF
);
575 if (f
.file
->f_op
!= &bpf_prog_fops
) {
577 return ERR_PTR(-EINVAL
);
580 return f
.file
->private_data
;
583 /* called by sockets/tracing/seccomp before attaching program to an event
584 * pairs with bpf_prog_put()
586 struct bpf_prog
*bpf_prog_get(u32 ufd
)
588 struct fd f
= fdget(ufd
);
589 struct bpf_prog
*prog
;
591 prog
= __bpf_prog_get(f
);
595 atomic_inc(&prog
->aux
->refcnt
);
600 EXPORT_SYMBOL_GPL(bpf_prog_get
);
602 /* last field in 'union bpf_attr' used by this command */
603 #define BPF_PROG_LOAD_LAST_FIELD kern_version
605 static int bpf_prog_load(union bpf_attr
*attr
)
607 enum bpf_prog_type type
= attr
->prog_type
;
608 struct bpf_prog
*prog
;
613 if (CHECK_ATTR(BPF_PROG_LOAD
))
616 /* copy eBPF program license from user space */
617 if (strncpy_from_user(license
, u64_to_ptr(attr
->license
),
618 sizeof(license
) - 1) < 0)
620 license
[sizeof(license
) - 1] = 0;
622 /* eBPF programs must be GPL compatible to use GPL-ed functions */
623 is_gpl
= license_is_gpl_compatible(license
);
625 if (attr
->insn_cnt
>= BPF_MAXINSNS
)
628 if (type
== BPF_PROG_TYPE_KPROBE
&&
629 attr
->kern_version
!= LINUX_VERSION_CODE
)
632 if (type
!= BPF_PROG_TYPE_SOCKET_FILTER
&& !capable(CAP_SYS_ADMIN
))
635 /* plain bpf_prog allocation */
636 prog
= bpf_prog_alloc(bpf_prog_size(attr
->insn_cnt
), GFP_USER
);
640 err
= bpf_prog_charge_memlock(prog
);
642 goto free_prog_nouncharge
;
644 prog
->len
= attr
->insn_cnt
;
647 if (copy_from_user(prog
->insns
, u64_to_ptr(attr
->insns
),
648 prog
->len
* sizeof(struct bpf_insn
)) != 0)
651 prog
->orig_prog
= NULL
;
654 atomic_set(&prog
->aux
->refcnt
, 1);
655 prog
->gpl_compatible
= is_gpl
? 1 : 0;
657 /* find program type: socket_filter vs tracing_filter */
658 err
= find_prog_type(type
, prog
);
662 /* run eBPF verifier */
663 err
= bpf_check(&prog
, attr
);
667 /* fixup BPF_CALL->imm field */
668 fixup_bpf_calls(prog
);
670 /* eBPF program is ready to be JITed */
671 err
= bpf_prog_select_runtime(prog
);
675 err
= bpf_prog_new_fd(prog
);
677 /* failed to allocate fd */
683 free_used_maps(prog
->aux
);
685 bpf_prog_uncharge_memlock(prog
);
686 free_prog_nouncharge
:
691 #define BPF_OBJ_LAST_FIELD bpf_fd
693 static int bpf_obj_pin(const union bpf_attr
*attr
)
695 if (CHECK_ATTR(BPF_OBJ
))
698 return bpf_obj_pin_user(attr
->bpf_fd
, u64_to_ptr(attr
->pathname
));
701 static int bpf_obj_get(const union bpf_attr
*attr
)
703 if (CHECK_ATTR(BPF_OBJ
) || attr
->bpf_fd
!= 0)
706 return bpf_obj_get_user(u64_to_ptr(attr
->pathname
));
709 SYSCALL_DEFINE3(bpf
, int, cmd
, union bpf_attr __user
*, uattr
, unsigned int, size
)
711 union bpf_attr attr
= {};
714 if (!capable(CAP_SYS_ADMIN
) && sysctl_unprivileged_bpf_disabled
)
717 if (!access_ok(VERIFY_READ
, uattr
, 1))
720 if (size
> PAGE_SIZE
) /* silly large */
723 /* If we're handed a bigger struct than we know of,
724 * ensure all the unknown bits are 0 - i.e. new
725 * user-space does not rely on any kernel feature
726 * extensions we dont know about yet.
728 if (size
> sizeof(attr
)) {
729 unsigned char __user
*addr
;
730 unsigned char __user
*end
;
733 addr
= (void __user
*)uattr
+ sizeof(attr
);
734 end
= (void __user
*)uattr
+ size
;
736 for (; addr
< end
; addr
++) {
737 err
= get_user(val
, addr
);
746 /* copy attributes from user space, may be less than sizeof(bpf_attr) */
747 if (copy_from_user(&attr
, uattr
, size
) != 0)
752 err
= map_create(&attr
);
754 case BPF_MAP_LOOKUP_ELEM
:
755 err
= map_lookup_elem(&attr
);
757 case BPF_MAP_UPDATE_ELEM
:
758 err
= map_update_elem(&attr
);
760 case BPF_MAP_DELETE_ELEM
:
761 err
= map_delete_elem(&attr
);
763 case BPF_MAP_GET_NEXT_KEY
:
764 err
= map_get_next_key(&attr
);
767 err
= bpf_prog_load(&attr
);
770 err
= bpf_obj_pin(&attr
);
773 err
= bpf_obj_get(&attr
);