1 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
2 * Copyright (c) 2016,2017 Facebook
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of version 2 of the GNU General Public
6 * License as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 #include <linux/bpf.h>
14 #include <linux/btf.h>
15 #include <linux/err.h>
16 #include <linux/slab.h>
18 #include <linux/filter.h>
19 #include <linux/perf_event.h>
20 #include <uapi/linux/btf.h>
22 #include "map_in_map.h"
24 #define ARRAY_CREATE_FLAG_MASK \
25 (BPF_F_NUMA_NODE | BPF_F_RDONLY | BPF_F_WRONLY)
27 static void bpf_array_free_percpu(struct bpf_array *array)
31 for (i = 0; i < array->map.max_entries; i++) {
32 free_percpu(array->pptrs[i]);
37 static int bpf_array_alloc_percpu(struct bpf_array *array)
42 for (i = 0; i < array->map.max_entries; i++) {
43 ptr = __alloc_percpu_gfp(array->elem_size, 8,
44 GFP_USER | __GFP_NOWARN);
46 bpf_array_free_percpu(array);
49 array->pptrs[i] = ptr;
56 /* Called from syscall */
57 int array_map_alloc_check(union bpf_attr *attr)
59 bool percpu = attr->map_type == BPF_MAP_TYPE_PERCPU_ARRAY;
60 int numa_node = bpf_map_attr_numa_node(attr);
62 /* check sanity of attributes */
63 if (attr->max_entries == 0 || attr->key_size != 4 ||
64 attr->value_size == 0 ||
65 attr->map_flags & ~ARRAY_CREATE_FLAG_MASK ||
66 (percpu && numa_node != NUMA_NO_NODE))
69 if (attr->value_size > KMALLOC_MAX_SIZE)
70 /* if value_size is bigger, the user space won't be able to
71 * access the elements.
78 static struct bpf_map *array_map_alloc(union bpf_attr *attr)
80 bool percpu = attr->map_type == BPF_MAP_TYPE_PERCPU_ARRAY;
81 int ret, numa_node = bpf_map_attr_numa_node(attr);
82 u32 elem_size, index_mask, max_entries;
83 bool unpriv = !capable(CAP_SYS_ADMIN);
84 u64 cost, array_size, mask64;
85 struct bpf_array *array;
87 elem_size = round_up(attr->value_size, 8);
89 max_entries = attr->max_entries;
91 /* On 32 bit archs roundup_pow_of_two() with max_entries that has
92 * upper most bit set in u32 space is undefined behavior due to
93 * resulting 1U << 32, so do it manually here in u64 space.
95 mask64 = fls_long(max_entries - 1);
96 mask64 = 1ULL << mask64;
101 /* round up array size to nearest power of 2,
102 * since cpu will speculate within index_mask limits
104 max_entries = index_mask + 1;
105 /* Check for overflows. */
106 if (max_entries < attr->max_entries)
107 return ERR_PTR(-E2BIG);
110 array_size = sizeof(*array);
112 array_size += (u64) max_entries * sizeof(void *);
114 array_size += (u64) max_entries * elem_size;
116 /* make sure there is no u32 overflow later in round_up() */
118 if (cost >= U32_MAX - PAGE_SIZE)
119 return ERR_PTR(-ENOMEM);
121 cost += (u64)attr->max_entries * elem_size * num_possible_cpus();
122 if (cost >= U32_MAX - PAGE_SIZE)
123 return ERR_PTR(-ENOMEM);
125 cost = round_up(cost, PAGE_SIZE) >> PAGE_SHIFT;
127 ret = bpf_map_precharge_memlock(cost);
131 /* allocate all map elements and zero-initialize them */
132 array = bpf_map_area_alloc(array_size, numa_node);
134 return ERR_PTR(-ENOMEM);
135 array->index_mask = index_mask;
136 array->map.unpriv_array = unpriv;
138 /* copy mandatory map attributes */
139 bpf_map_init_from_attr(&array->map, attr);
140 array->map.pages = cost;
141 array->elem_size = elem_size;
143 if (percpu && bpf_array_alloc_percpu(array)) {
144 bpf_map_area_free(array);
145 return ERR_PTR(-ENOMEM);
151 /* Called from syscall or from eBPF program */
152 static void *array_map_lookup_elem(struct bpf_map *map, void *key)
154 struct bpf_array *array = container_of(map, struct bpf_array, map);
155 u32 index = *(u32 *)key;
157 if (unlikely(index >= array->map.max_entries))
160 return array->value + array->elem_size * (index & array->index_mask);
163 /* emit BPF instructions equivalent to C code of array_map_lookup_elem() */
164 static u32 array_map_gen_lookup(struct bpf_map *map, struct bpf_insn *insn_buf)
166 struct bpf_array *array = container_of(map, struct bpf_array, map);
167 struct bpf_insn *insn = insn_buf;
168 u32 elem_size = round_up(map->value_size, 8);
169 const int ret = BPF_REG_0;
170 const int map_ptr = BPF_REG_1;
171 const int index = BPF_REG_2;
173 *insn++ = BPF_ALU64_IMM(BPF_ADD, map_ptr, offsetof(struct bpf_array, value));
174 *insn++ = BPF_LDX_MEM(BPF_W, ret, index, 0);
175 if (map->unpriv_array) {
176 *insn++ = BPF_JMP_IMM(BPF_JGE, ret, map->max_entries, 4);
177 *insn++ = BPF_ALU32_IMM(BPF_AND, ret, array->index_mask);
179 *insn++ = BPF_JMP_IMM(BPF_JGE, ret, map->max_entries, 3);
182 if (is_power_of_2(elem_size)) {
183 *insn++ = BPF_ALU64_IMM(BPF_LSH, ret, ilog2(elem_size));
185 *insn++ = BPF_ALU64_IMM(BPF_MUL, ret, elem_size);
187 *insn++ = BPF_ALU64_REG(BPF_ADD, ret, map_ptr);
188 *insn++ = BPF_JMP_IMM(BPF_JA, 0, 0, 1);
189 *insn++ = BPF_MOV64_IMM(ret, 0);
190 return insn - insn_buf;
193 /* Called from eBPF program */
194 static void *percpu_array_map_lookup_elem(struct bpf_map *map, void *key)
196 struct bpf_array *array = container_of(map, struct bpf_array, map);
197 u32 index = *(u32 *)key;
199 if (unlikely(index >= array->map.max_entries))
202 return this_cpu_ptr(array->pptrs[index & array->index_mask]);
205 int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value)
207 struct bpf_array *array = container_of(map, struct bpf_array, map);
208 u32 index = *(u32 *)key;
213 if (unlikely(index >= array->map.max_entries))
216 /* per_cpu areas are zero-filled and bpf programs can only
217 * access 'value_size' of them, so copying rounded areas
218 * will not leak any kernel data
220 size = round_up(map->value_size, 8);
222 pptr = array->pptrs[index & array->index_mask];
223 for_each_possible_cpu(cpu) {
224 bpf_long_memcpy(value + off, per_cpu_ptr(pptr, cpu), size);
231 /* Called from syscall */
232 static int array_map_get_next_key(struct bpf_map *map, void *key, void *next_key)
234 struct bpf_array *array = container_of(map, struct bpf_array, map);
235 u32 index = key ? *(u32 *)key : U32_MAX;
236 u32 *next = (u32 *)next_key;
238 if (index >= array->map.max_entries) {
243 if (index == array->map.max_entries - 1)
250 /* Called from syscall or from eBPF program */
251 static int array_map_update_elem(struct bpf_map *map, void *key, void *value,
254 struct bpf_array *array = container_of(map, struct bpf_array, map);
255 u32 index = *(u32 *)key;
257 if (unlikely(map_flags > BPF_EXIST))
261 if (unlikely(index >= array->map.max_entries))
262 /* all elements were pre-allocated, cannot insert a new one */
265 if (unlikely(map_flags == BPF_NOEXIST))
266 /* all elements already exist */
269 if (array->map.map_type == BPF_MAP_TYPE_PERCPU_ARRAY)
270 memcpy(this_cpu_ptr(array->pptrs[index & array->index_mask]),
271 value, map->value_size);
273 memcpy(array->value +
274 array->elem_size * (index & array->index_mask),
275 value, map->value_size);
279 int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
282 struct bpf_array *array = container_of(map, struct bpf_array, map);
283 u32 index = *(u32 *)key;
288 if (unlikely(map_flags > BPF_EXIST))
292 if (unlikely(index >= array->map.max_entries))
293 /* all elements were pre-allocated, cannot insert a new one */
296 if (unlikely(map_flags == BPF_NOEXIST))
297 /* all elements already exist */
300 /* the user space will provide round_up(value_size, 8) bytes that
301 * will be copied into per-cpu area. bpf programs can only access
302 * value_size of it. During lookup the same extra bytes will be
303 * returned or zeros which were zero-filled by percpu_alloc,
304 * so no kernel data leaks possible
306 size = round_up(map->value_size, 8);
308 pptr = array->pptrs[index & array->index_mask];
309 for_each_possible_cpu(cpu) {
310 bpf_long_memcpy(per_cpu_ptr(pptr, cpu), value + off, size);
317 /* Called from syscall or from eBPF program */
318 static int array_map_delete_elem(struct bpf_map *map, void *key)
323 /* Called when map->refcnt goes to zero, either from workqueue or from syscall */
324 static void array_map_free(struct bpf_map *map)
326 struct bpf_array *array = container_of(map, struct bpf_array, map);
328 /* at this point bpf_prog->aux->refcnt == 0 and this map->refcnt == 0,
329 * so the programs (can be more than one that used this map) were
330 * disconnected from events. Wait for outstanding programs to complete
335 if (array->map.map_type == BPF_MAP_TYPE_PERCPU_ARRAY)
336 bpf_array_free_percpu(array);
338 bpf_map_area_free(array);
341 static void array_map_seq_show_elem(struct bpf_map *map, void *key,
348 value = array_map_lookup_elem(map, key);
354 seq_printf(m, "%u: ", *(u32 *)key);
355 btf_type_seq_show(map->btf, map->btf_value_type_id, value, m);
361 static void percpu_array_map_seq_show_elem(struct bpf_map *map, void *key,
364 struct bpf_array *array = container_of(map, struct bpf_array, map);
365 u32 index = *(u32 *)key;
371 seq_printf(m, "%u: {\n", *(u32 *)key);
372 pptr = array->pptrs[index & array->index_mask];
373 for_each_possible_cpu(cpu) {
374 seq_printf(m, "\tcpu%d: ", cpu);
375 btf_type_seq_show(map->btf, map->btf_value_type_id,
376 per_cpu_ptr(pptr, cpu), m);
384 static int array_map_check_btf(const struct bpf_map *map,
385 const struct btf *btf,
386 const struct btf_type *key_type,
387 const struct btf_type *value_type)
391 if (BTF_INFO_KIND(key_type->info) != BTF_KIND_INT)
394 int_data = *(u32 *)(key_type + 1);
395 /* bpf array can only take a u32 key. This check makes sure
396 * that the btf matches the attr used during map_create.
398 if (BTF_INT_BITS(int_data) != 32 || BTF_INT_OFFSET(int_data))
404 const struct bpf_map_ops array_map_ops = {
405 .map_alloc_check = array_map_alloc_check,
406 .map_alloc = array_map_alloc,
407 .map_free = array_map_free,
408 .map_get_next_key = array_map_get_next_key,
409 .map_lookup_elem = array_map_lookup_elem,
410 .map_update_elem = array_map_update_elem,
411 .map_delete_elem = array_map_delete_elem,
412 .map_gen_lookup = array_map_gen_lookup,
413 .map_seq_show_elem = array_map_seq_show_elem,
414 .map_check_btf = array_map_check_btf,
417 const struct bpf_map_ops percpu_array_map_ops = {
418 .map_alloc_check = array_map_alloc_check,
419 .map_alloc = array_map_alloc,
420 .map_free = array_map_free,
421 .map_get_next_key = array_map_get_next_key,
422 .map_lookup_elem = percpu_array_map_lookup_elem,
423 .map_update_elem = array_map_update_elem,
424 .map_delete_elem = array_map_delete_elem,
425 .map_seq_show_elem = percpu_array_map_seq_show_elem,
426 .map_check_btf = array_map_check_btf,
429 static int fd_array_map_alloc_check(union bpf_attr *attr)
431 /* only file descriptors can be stored in this type of map */
432 if (attr->value_size != sizeof(u32))
434 return array_map_alloc_check(attr);
437 static void fd_array_map_free(struct bpf_map *map)
439 struct bpf_array *array = container_of(map, struct bpf_array, map);
444 /* make sure it's empty */
445 for (i = 0; i < array->map.max_entries; i++)
446 BUG_ON(array->ptrs[i] != NULL);
448 bpf_map_area_free(array);
451 static void *fd_array_map_lookup_elem(struct bpf_map *map, void *key)
453 return ERR_PTR(-EOPNOTSUPP);
456 /* only called from syscall */
457 int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value)
462 if (!map->ops->map_fd_sys_lookup_elem)
466 elem = array_map_lookup_elem(map, key);
467 if (elem && (ptr = READ_ONCE(*elem)))
468 *value = map->ops->map_fd_sys_lookup_elem(ptr);
476 /* only called from syscall */
477 int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
478 void *key, void *value, u64 map_flags)
480 struct bpf_array *array = container_of(map, struct bpf_array, map);
481 void *new_ptr, *old_ptr;
482 u32 index = *(u32 *)key, ufd;
484 if (map_flags != BPF_ANY)
487 if (index >= array->map.max_entries)
491 new_ptr = map->ops->map_fd_get_ptr(map, map_file, ufd);
493 return PTR_ERR(new_ptr);
495 old_ptr = xchg(array->ptrs + index, new_ptr);
497 map->ops->map_fd_put_ptr(old_ptr);
502 static int fd_array_map_delete_elem(struct bpf_map *map, void *key)
504 struct bpf_array *array = container_of(map, struct bpf_array, map);
506 u32 index = *(u32 *)key;
508 if (index >= array->map.max_entries)
511 old_ptr = xchg(array->ptrs + index, NULL);
513 map->ops->map_fd_put_ptr(old_ptr);
520 static void *prog_fd_array_get_ptr(struct bpf_map *map,
521 struct file *map_file, int fd)
523 struct bpf_array *array = container_of(map, struct bpf_array, map);
524 struct bpf_prog *prog = bpf_prog_get(fd);
529 if (!bpf_prog_array_compatible(array, prog)) {
531 return ERR_PTR(-EINVAL);
537 static void prog_fd_array_put_ptr(void *ptr)
542 static u32 prog_fd_array_sys_lookup_elem(void *ptr)
544 return ((struct bpf_prog *)ptr)->aux->id;
547 /* decrement refcnt of all bpf_progs that are stored in this map */
548 static void bpf_fd_array_map_clear(struct bpf_map *map)
550 struct bpf_array *array = container_of(map, struct bpf_array, map);
553 for (i = 0; i < array->map.max_entries; i++)
554 fd_array_map_delete_elem(map, &i);
557 static void prog_array_map_seq_show_elem(struct bpf_map *map, void *key,
565 elem = array_map_lookup_elem(map, key);
567 ptr = READ_ONCE(*elem);
569 seq_printf(m, "%u: ", *(u32 *)key);
570 prog_id = prog_fd_array_sys_lookup_elem(ptr);
571 btf_type_seq_show(map->btf, map->btf_value_type_id,
580 const struct bpf_map_ops prog_array_map_ops = {
581 .map_alloc_check = fd_array_map_alloc_check,
582 .map_alloc = array_map_alloc,
583 .map_free = fd_array_map_free,
584 .map_get_next_key = array_map_get_next_key,
585 .map_lookup_elem = fd_array_map_lookup_elem,
586 .map_delete_elem = fd_array_map_delete_elem,
587 .map_fd_get_ptr = prog_fd_array_get_ptr,
588 .map_fd_put_ptr = prog_fd_array_put_ptr,
589 .map_fd_sys_lookup_elem = prog_fd_array_sys_lookup_elem,
590 .map_release_uref = bpf_fd_array_map_clear,
591 .map_seq_show_elem = prog_array_map_seq_show_elem,
594 static struct bpf_event_entry *bpf_event_entry_gen(struct file *perf_file,
595 struct file *map_file)
597 struct bpf_event_entry *ee;
599 ee = kzalloc(sizeof(*ee), GFP_ATOMIC);
601 ee->event = perf_file->private_data;
602 ee->perf_file = perf_file;
603 ee->map_file = map_file;
609 static void __bpf_event_entry_free(struct rcu_head *rcu)
611 struct bpf_event_entry *ee;
613 ee = container_of(rcu, struct bpf_event_entry, rcu);
618 static void bpf_event_entry_free_rcu(struct bpf_event_entry *ee)
620 call_rcu(&ee->rcu, __bpf_event_entry_free);
623 static void *perf_event_fd_array_get_ptr(struct bpf_map *map,
624 struct file *map_file, int fd)
626 struct bpf_event_entry *ee;
627 struct perf_event *event;
628 struct file *perf_file;
631 perf_file = perf_event_get(fd);
632 if (IS_ERR(perf_file))
635 ee = ERR_PTR(-EOPNOTSUPP);
636 event = perf_file->private_data;
637 if (perf_event_read_local(event, &value, NULL, NULL) == -EOPNOTSUPP)
640 ee = bpf_event_entry_gen(perf_file, map_file);
643 ee = ERR_PTR(-ENOMEM);
649 static void perf_event_fd_array_put_ptr(void *ptr)
651 bpf_event_entry_free_rcu(ptr);
654 static void perf_event_fd_array_release(struct bpf_map *map,
655 struct file *map_file)
657 struct bpf_array *array = container_of(map, struct bpf_array, map);
658 struct bpf_event_entry *ee;
662 for (i = 0; i < array->map.max_entries; i++) {
663 ee = READ_ONCE(array->ptrs[i]);
664 if (ee && ee->map_file == map_file)
665 fd_array_map_delete_elem(map, &i);
670 const struct bpf_map_ops perf_event_array_map_ops = {
671 .map_alloc_check = fd_array_map_alloc_check,
672 .map_alloc = array_map_alloc,
673 .map_free = fd_array_map_free,
674 .map_get_next_key = array_map_get_next_key,
675 .map_lookup_elem = fd_array_map_lookup_elem,
676 .map_delete_elem = fd_array_map_delete_elem,
677 .map_fd_get_ptr = perf_event_fd_array_get_ptr,
678 .map_fd_put_ptr = perf_event_fd_array_put_ptr,
679 .map_release = perf_event_fd_array_release,
680 .map_check_btf = map_check_no_btf,
683 #ifdef CONFIG_CGROUPS
684 static void *cgroup_fd_array_get_ptr(struct bpf_map *map,
685 struct file *map_file /* not used */,
688 return cgroup_get_from_fd(fd);
691 static void cgroup_fd_array_put_ptr(void *ptr)
693 /* cgroup_put free cgrp after a rcu grace period */
697 static void cgroup_fd_array_free(struct bpf_map *map)
699 bpf_fd_array_map_clear(map);
700 fd_array_map_free(map);
703 const struct bpf_map_ops cgroup_array_map_ops = {
704 .map_alloc_check = fd_array_map_alloc_check,
705 .map_alloc = array_map_alloc,
706 .map_free = cgroup_fd_array_free,
707 .map_get_next_key = array_map_get_next_key,
708 .map_lookup_elem = fd_array_map_lookup_elem,
709 .map_delete_elem = fd_array_map_delete_elem,
710 .map_fd_get_ptr = cgroup_fd_array_get_ptr,
711 .map_fd_put_ptr = cgroup_fd_array_put_ptr,
712 .map_check_btf = map_check_no_btf,
716 static struct bpf_map *array_of_map_alloc(union bpf_attr *attr)
718 struct bpf_map *map, *inner_map_meta;
720 inner_map_meta = bpf_map_meta_alloc(attr->inner_map_fd);
721 if (IS_ERR(inner_map_meta))
722 return inner_map_meta;
724 map = array_map_alloc(attr);
726 bpf_map_meta_free(inner_map_meta);
730 map->inner_map_meta = inner_map_meta;
735 static void array_of_map_free(struct bpf_map *map)
737 /* map->inner_map_meta is only accessed by syscall which
738 * is protected by fdget/fdput.
740 bpf_map_meta_free(map->inner_map_meta);
741 bpf_fd_array_map_clear(map);
742 fd_array_map_free(map);
745 static void *array_of_map_lookup_elem(struct bpf_map *map, void *key)
747 struct bpf_map **inner_map = array_map_lookup_elem(map, key);
752 return READ_ONCE(*inner_map);
755 static u32 array_of_map_gen_lookup(struct bpf_map *map,
756 struct bpf_insn *insn_buf)
758 struct bpf_array *array = container_of(map, struct bpf_array, map);
759 u32 elem_size = round_up(map->value_size, 8);
760 struct bpf_insn *insn = insn_buf;
761 const int ret = BPF_REG_0;
762 const int map_ptr = BPF_REG_1;
763 const int index = BPF_REG_2;
765 *insn++ = BPF_ALU64_IMM(BPF_ADD, map_ptr, offsetof(struct bpf_array, value));
766 *insn++ = BPF_LDX_MEM(BPF_W, ret, index, 0);
767 if (map->unpriv_array) {
768 *insn++ = BPF_JMP_IMM(BPF_JGE, ret, map->max_entries, 6);
769 *insn++ = BPF_ALU32_IMM(BPF_AND, ret, array->index_mask);
771 *insn++ = BPF_JMP_IMM(BPF_JGE, ret, map->max_entries, 5);
773 if (is_power_of_2(elem_size))
774 *insn++ = BPF_ALU64_IMM(BPF_LSH, ret, ilog2(elem_size));
776 *insn++ = BPF_ALU64_IMM(BPF_MUL, ret, elem_size);
777 *insn++ = BPF_ALU64_REG(BPF_ADD, ret, map_ptr);
778 *insn++ = BPF_LDX_MEM(BPF_DW, ret, ret, 0);
779 *insn++ = BPF_JMP_IMM(BPF_JEQ, ret, 0, 1);
780 *insn++ = BPF_JMP_IMM(BPF_JA, 0, 0, 1);
781 *insn++ = BPF_MOV64_IMM(ret, 0);
783 return insn - insn_buf;
786 const struct bpf_map_ops array_of_maps_map_ops = {
787 .map_alloc_check = fd_array_map_alloc_check,
788 .map_alloc = array_of_map_alloc,
789 .map_free = array_of_map_free,
790 .map_get_next_key = array_map_get_next_key,
791 .map_lookup_elem = array_of_map_lookup_elem,
792 .map_delete_elem = fd_array_map_delete_elem,
793 .map_fd_get_ptr = bpf_map_fd_get_ptr,
794 .map_fd_put_ptr = bpf_map_fd_put_ptr,
795 .map_fd_sys_lookup_elem = bpf_map_fd_sys_lookup_elem,
796 .map_gen_lookup = array_of_map_gen_lookup,
797 .map_check_btf = map_check_no_btf,