1 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
2 * Copyright (c) 2016 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/jhash.h>
15 #include <linux/filter.h>
16 #include <linux/rculist_nulls.h>
17 #include "percpu_freelist.h"
18 #include "bpf_lru_list.h"
19 #include "map_in_map.h"
21 #define HTAB_CREATE_FLAG_MASK \
22 (BPF_F_NO_PREALLOC | BPF_F_NO_COMMON_LRU | BPF_F_NUMA_NODE | \
23 BPF_F_RDONLY | BPF_F_WRONLY)
26 struct hlist_nulls_head head
;
32 struct bucket
*buckets
;
35 struct pcpu_freelist freelist
;
38 struct htab_elem
*__percpu
*extra_elems
;
39 atomic_t count
; /* number of elements in this hashtable */
40 u32 n_buckets
; /* number of hash buckets */
41 u32 elem_size
; /* size of each element in bytes */
44 /* each htab element is struct htab_elem + key + value */
47 struct hlist_nulls_node hash_node
;
51 struct bpf_htab
*htab
;
52 struct pcpu_freelist_node fnode
;
58 struct bpf_lru_node lru_node
;
61 char key
[0] __aligned(8);
64 static bool htab_lru_map_delete_node(void *arg
, struct bpf_lru_node
*node
);
66 static bool htab_is_lru(const struct bpf_htab
*htab
)
68 return htab
->map
.map_type
== BPF_MAP_TYPE_LRU_HASH
||
69 htab
->map
.map_type
== BPF_MAP_TYPE_LRU_PERCPU_HASH
;
72 static bool htab_is_percpu(const struct bpf_htab
*htab
)
74 return htab
->map
.map_type
== BPF_MAP_TYPE_PERCPU_HASH
||
75 htab
->map
.map_type
== BPF_MAP_TYPE_LRU_PERCPU_HASH
;
78 static bool htab_is_prealloc(const struct bpf_htab
*htab
)
80 return !(htab
->map
.map_flags
& BPF_F_NO_PREALLOC
);
83 static inline void htab_elem_set_ptr(struct htab_elem
*l
, u32 key_size
,
86 *(void __percpu
**)(l
->key
+ key_size
) = pptr
;
89 static inline void __percpu
*htab_elem_get_ptr(struct htab_elem
*l
, u32 key_size
)
91 return *(void __percpu
**)(l
->key
+ key_size
);
94 static void *fd_htab_map_get_ptr(const struct bpf_map
*map
, struct htab_elem
*l
)
96 return *(void **)(l
->key
+ roundup(map
->key_size
, 8));
99 static struct htab_elem
*get_htab_elem(struct bpf_htab
*htab
, int i
)
101 return (struct htab_elem
*) (htab
->elems
+ i
* htab
->elem_size
);
104 static void htab_free_elems(struct bpf_htab
*htab
)
108 if (!htab_is_percpu(htab
))
111 for (i
= 0; i
< htab
->map
.max_entries
; i
++) {
114 pptr
= htab_elem_get_ptr(get_htab_elem(htab
, i
),
120 bpf_map_area_free(htab
->elems
);
123 static struct htab_elem
*prealloc_lru_pop(struct bpf_htab
*htab
, void *key
,
126 struct bpf_lru_node
*node
= bpf_lru_pop_free(&htab
->lru
, hash
);
130 l
= container_of(node
, struct htab_elem
, lru_node
);
131 memcpy(l
->key
, key
, htab
->map
.key_size
);
138 static int prealloc_init(struct bpf_htab
*htab
)
140 u32 num_entries
= htab
->map
.max_entries
;
141 int err
= -ENOMEM
, i
;
143 if (!htab_is_percpu(htab
) && !htab_is_lru(htab
))
144 num_entries
+= num_possible_cpus();
146 htab
->elems
= bpf_map_area_alloc(htab
->elem_size
* num_entries
,
147 htab
->map
.numa_node
);
151 if (!htab_is_percpu(htab
))
152 goto skip_percpu_elems
;
154 for (i
= 0; i
< num_entries
; i
++) {
155 u32 size
= round_up(htab
->map
.value_size
, 8);
158 pptr
= __alloc_percpu_gfp(size
, 8, GFP_USER
| __GFP_NOWARN
);
161 htab_elem_set_ptr(get_htab_elem(htab
, i
), htab
->map
.key_size
,
167 if (htab_is_lru(htab
))
168 err
= bpf_lru_init(&htab
->lru
,
169 htab
->map
.map_flags
& BPF_F_NO_COMMON_LRU
,
170 offsetof(struct htab_elem
, hash
) -
171 offsetof(struct htab_elem
, lru_node
),
172 htab_lru_map_delete_node
,
175 err
= pcpu_freelist_init(&htab
->freelist
);
180 if (htab_is_lru(htab
))
181 bpf_lru_populate(&htab
->lru
, htab
->elems
,
182 offsetof(struct htab_elem
, lru_node
),
183 htab
->elem_size
, num_entries
);
185 pcpu_freelist_populate(&htab
->freelist
,
186 htab
->elems
+ offsetof(struct htab_elem
, fnode
),
187 htab
->elem_size
, num_entries
);
192 htab_free_elems(htab
);
196 static void prealloc_destroy(struct bpf_htab
*htab
)
198 htab_free_elems(htab
);
200 if (htab_is_lru(htab
))
201 bpf_lru_destroy(&htab
->lru
);
203 pcpu_freelist_destroy(&htab
->freelist
);
206 static int alloc_extra_elems(struct bpf_htab
*htab
)
208 struct htab_elem
*__percpu
*pptr
, *l_new
;
209 struct pcpu_freelist_node
*l
;
212 pptr
= __alloc_percpu_gfp(sizeof(struct htab_elem
*), 8,
213 GFP_USER
| __GFP_NOWARN
);
217 for_each_possible_cpu(cpu
) {
218 l
= pcpu_freelist_pop(&htab
->freelist
);
219 /* pop will succeed, since prealloc_init()
220 * preallocated extra num_possible_cpus elements
222 l_new
= container_of(l
, struct htab_elem
, fnode
);
223 *per_cpu_ptr(pptr
, cpu
) = l_new
;
225 htab
->extra_elems
= pptr
;
229 /* Called from syscall */
230 static int htab_map_alloc_check(union bpf_attr
*attr
)
232 bool percpu
= (attr
->map_type
== BPF_MAP_TYPE_PERCPU_HASH
||
233 attr
->map_type
== BPF_MAP_TYPE_LRU_PERCPU_HASH
);
234 bool lru
= (attr
->map_type
== BPF_MAP_TYPE_LRU_HASH
||
235 attr
->map_type
== BPF_MAP_TYPE_LRU_PERCPU_HASH
);
236 /* percpu_lru means each cpu has its own LRU list.
237 * it is different from BPF_MAP_TYPE_PERCPU_HASH where
238 * the map's value itself is percpu. percpu_lru has
239 * nothing to do with the map's value.
241 bool percpu_lru
= (attr
->map_flags
& BPF_F_NO_COMMON_LRU
);
242 bool prealloc
= !(attr
->map_flags
& BPF_F_NO_PREALLOC
);
243 int numa_node
= bpf_map_attr_numa_node(attr
);
245 BUILD_BUG_ON(offsetof(struct htab_elem
, htab
) !=
246 offsetof(struct htab_elem
, hash_node
.pprev
));
247 BUILD_BUG_ON(offsetof(struct htab_elem
, fnode
.next
) !=
248 offsetof(struct htab_elem
, hash_node
.pprev
));
250 if (lru
&& !capable(CAP_SYS_ADMIN
))
251 /* LRU implementation is much complicated than other
252 * maps. Hence, limit to CAP_SYS_ADMIN for now.
256 if (attr
->map_flags
& ~HTAB_CREATE_FLAG_MASK
)
257 /* reserved bits should not be used */
260 if (!lru
&& percpu_lru
)
263 if (lru
&& !prealloc
)
266 if (numa_node
!= NUMA_NO_NODE
&& (percpu
|| percpu_lru
))
269 /* check sanity of attributes.
270 * value_size == 0 may be allowed in the future to use map as a set
272 if (attr
->max_entries
== 0 || attr
->key_size
== 0 ||
273 attr
->value_size
== 0)
276 if (attr
->key_size
> MAX_BPF_STACK
)
277 /* eBPF programs initialize keys on stack, so they cannot be
278 * larger than max stack size
282 if (attr
->value_size
>= KMALLOC_MAX_SIZE
-
283 MAX_BPF_STACK
- sizeof(struct htab_elem
))
284 /* if value_size is bigger, the user space won't be able to
285 * access the elements via bpf syscall. This check also makes
286 * sure that the elem_size doesn't overflow and it's
287 * kmalloc-able later in htab_map_update_elem()
294 static struct bpf_map
*htab_map_alloc(union bpf_attr
*attr
)
296 bool percpu
= (attr
->map_type
== BPF_MAP_TYPE_PERCPU_HASH
||
297 attr
->map_type
== BPF_MAP_TYPE_LRU_PERCPU_HASH
);
298 bool lru
= (attr
->map_type
== BPF_MAP_TYPE_LRU_HASH
||
299 attr
->map_type
== BPF_MAP_TYPE_LRU_PERCPU_HASH
);
300 /* percpu_lru means each cpu has its own LRU list.
301 * it is different from BPF_MAP_TYPE_PERCPU_HASH where
302 * the map's value itself is percpu. percpu_lru has
303 * nothing to do with the map's value.
305 bool percpu_lru
= (attr
->map_flags
& BPF_F_NO_COMMON_LRU
);
306 bool prealloc
= !(attr
->map_flags
& BPF_F_NO_PREALLOC
);
307 struct bpf_htab
*htab
;
311 htab
= kzalloc(sizeof(*htab
), GFP_USER
);
313 return ERR_PTR(-ENOMEM
);
315 bpf_map_init_from_attr(&htab
->map
, attr
);
318 /* ensure each CPU's lru list has >=1 elements.
319 * since we are at it, make each lru list has the same
320 * number of elements.
322 htab
->map
.max_entries
= roundup(attr
->max_entries
,
323 num_possible_cpus());
324 if (htab
->map
.max_entries
< attr
->max_entries
)
325 htab
->map
.max_entries
= rounddown(attr
->max_entries
,
326 num_possible_cpus());
329 /* hash table size must be power of 2 */
330 htab
->n_buckets
= roundup_pow_of_two(htab
->map
.max_entries
);
332 htab
->elem_size
= sizeof(struct htab_elem
) +
333 round_up(htab
->map
.key_size
, 8);
335 htab
->elem_size
+= sizeof(void *);
337 htab
->elem_size
+= round_up(htab
->map
.value_size
, 8);
340 /* prevent zero size kmalloc and check for u32 overflow */
341 if (htab
->n_buckets
== 0 ||
342 htab
->n_buckets
> U32_MAX
/ sizeof(struct bucket
))
345 cost
= (u64
) htab
->n_buckets
* sizeof(struct bucket
) +
346 (u64
) htab
->elem_size
* htab
->map
.max_entries
;
349 cost
+= (u64
) round_up(htab
->map
.value_size
, 8) *
350 num_possible_cpus() * htab
->map
.max_entries
;
352 cost
+= (u64
) htab
->elem_size
* num_possible_cpus();
354 if (cost
>= U32_MAX
- PAGE_SIZE
)
355 /* make sure page count doesn't overflow */
358 htab
->map
.pages
= round_up(cost
, PAGE_SIZE
) >> PAGE_SHIFT
;
360 /* if map size is larger than memlock limit, reject it early */
361 err
= bpf_map_precharge_memlock(htab
->map
.pages
);
366 htab
->buckets
= bpf_map_area_alloc(htab
->n_buckets
*
367 sizeof(struct bucket
),
368 htab
->map
.numa_node
);
372 for (i
= 0; i
< htab
->n_buckets
; i
++) {
373 INIT_HLIST_NULLS_HEAD(&htab
->buckets
[i
].head
, i
);
374 raw_spin_lock_init(&htab
->buckets
[i
].lock
);
378 err
= prealloc_init(htab
);
382 if (!percpu
&& !lru
) {
383 /* lru itself can remove the least used element, so
384 * there is no need for an extra elem during map_update.
386 err
= alloc_extra_elems(htab
);
395 prealloc_destroy(htab
);
397 bpf_map_area_free(htab
->buckets
);
403 static inline u32
htab_map_hash(const void *key
, u32 key_len
)
405 return jhash(key
, key_len
, 0);
408 static inline struct bucket
*__select_bucket(struct bpf_htab
*htab
, u32 hash
)
410 return &htab
->buckets
[hash
& (htab
->n_buckets
- 1)];
413 static inline struct hlist_nulls_head
*select_bucket(struct bpf_htab
*htab
, u32 hash
)
415 return &__select_bucket(htab
, hash
)->head
;
418 /* this lookup function can only be called with bucket lock taken */
419 static struct htab_elem
*lookup_elem_raw(struct hlist_nulls_head
*head
, u32 hash
,
420 void *key
, u32 key_size
)
422 struct hlist_nulls_node
*n
;
425 hlist_nulls_for_each_entry_rcu(l
, n
, head
, hash_node
)
426 if (l
->hash
== hash
&& !memcmp(&l
->key
, key
, key_size
))
432 /* can be called without bucket lock. it will repeat the loop in
433 * the unlikely event when elements moved from one bucket into another
434 * while link list is being walked
436 static struct htab_elem
*lookup_nulls_elem_raw(struct hlist_nulls_head
*head
,
438 u32 key_size
, u32 n_buckets
)
440 struct hlist_nulls_node
*n
;
444 hlist_nulls_for_each_entry_rcu(l
, n
, head
, hash_node
)
445 if (l
->hash
== hash
&& !memcmp(&l
->key
, key
, key_size
))
448 if (unlikely(get_nulls_value(n
) != (hash
& (n_buckets
- 1))))
454 /* Called from syscall or from eBPF program directly, so
455 * arguments have to match bpf_map_lookup_elem() exactly.
456 * The return value is adjusted by BPF instructions
457 * in htab_map_gen_lookup().
459 static void *__htab_map_lookup_elem(struct bpf_map
*map
, void *key
)
461 struct bpf_htab
*htab
= container_of(map
, struct bpf_htab
, map
);
462 struct hlist_nulls_head
*head
;
466 /* Must be called with rcu_read_lock. */
467 WARN_ON_ONCE(!rcu_read_lock_held());
469 key_size
= map
->key_size
;
471 hash
= htab_map_hash(key
, key_size
);
473 head
= select_bucket(htab
, hash
);
475 l
= lookup_nulls_elem_raw(head
, hash
, key
, key_size
, htab
->n_buckets
);
480 static void *htab_map_lookup_elem(struct bpf_map
*map
, void *key
)
482 struct htab_elem
*l
= __htab_map_lookup_elem(map
, key
);
485 return l
->key
+ round_up(map
->key_size
, 8);
490 /* inline bpf_map_lookup_elem() call.
493 * bpf_map_lookup_elem
494 * map->ops->map_lookup_elem
495 * htab_map_lookup_elem
496 * __htab_map_lookup_elem
499 * __htab_map_lookup_elem
501 static u32
htab_map_gen_lookup(struct bpf_map
*map
, struct bpf_insn
*insn_buf
)
503 struct bpf_insn
*insn
= insn_buf
;
504 const int ret
= BPF_REG_0
;
506 *insn
++ = BPF_EMIT_CALL((u64 (*)(u64
, u64
, u64
, u64
, u64
))__htab_map_lookup_elem
);
507 *insn
++ = BPF_JMP_IMM(BPF_JEQ
, ret
, 0, 1);
508 *insn
++ = BPF_ALU64_IMM(BPF_ADD
, ret
,
509 offsetof(struct htab_elem
, key
) +
510 round_up(map
->key_size
, 8));
511 return insn
- insn_buf
;
514 static void *htab_lru_map_lookup_elem(struct bpf_map
*map
, void *key
)
516 struct htab_elem
*l
= __htab_map_lookup_elem(map
, key
);
519 bpf_lru_node_set_ref(&l
->lru_node
);
520 return l
->key
+ round_up(map
->key_size
, 8);
526 static u32
htab_lru_map_gen_lookup(struct bpf_map
*map
,
527 struct bpf_insn
*insn_buf
)
529 struct bpf_insn
*insn
= insn_buf
;
530 const int ret
= BPF_REG_0
;
531 const int ref_reg
= BPF_REG_1
;
533 *insn
++ = BPF_EMIT_CALL((u64 (*)(u64
, u64
, u64
, u64
, u64
))__htab_map_lookup_elem
);
534 *insn
++ = BPF_JMP_IMM(BPF_JEQ
, ret
, 0, 4);
535 *insn
++ = BPF_LDX_MEM(BPF_B
, ref_reg
, ret
,
536 offsetof(struct htab_elem
, lru_node
) +
537 offsetof(struct bpf_lru_node
, ref
));
538 *insn
++ = BPF_JMP_IMM(BPF_JNE
, ref_reg
, 0, 1);
539 *insn
++ = BPF_ST_MEM(BPF_B
, ret
,
540 offsetof(struct htab_elem
, lru_node
) +
541 offsetof(struct bpf_lru_node
, ref
),
543 *insn
++ = BPF_ALU64_IMM(BPF_ADD
, ret
,
544 offsetof(struct htab_elem
, key
) +
545 round_up(map
->key_size
, 8));
546 return insn
- insn_buf
;
549 /* It is called from the bpf_lru_list when the LRU needs to delete
550 * older elements from the htab.
552 static bool htab_lru_map_delete_node(void *arg
, struct bpf_lru_node
*node
)
554 struct bpf_htab
*htab
= (struct bpf_htab
*)arg
;
555 struct htab_elem
*l
= NULL
, *tgt_l
;
556 struct hlist_nulls_head
*head
;
557 struct hlist_nulls_node
*n
;
561 tgt_l
= container_of(node
, struct htab_elem
, lru_node
);
562 b
= __select_bucket(htab
, tgt_l
->hash
);
565 raw_spin_lock_irqsave(&b
->lock
, flags
);
567 hlist_nulls_for_each_entry_rcu(l
, n
, head
, hash_node
)
569 hlist_nulls_del_rcu(&l
->hash_node
);
573 raw_spin_unlock_irqrestore(&b
->lock
, flags
);
578 /* Called from syscall */
579 static int htab_map_get_next_key(struct bpf_map
*map
, void *key
, void *next_key
)
581 struct bpf_htab
*htab
= container_of(map
, struct bpf_htab
, map
);
582 struct hlist_nulls_head
*head
;
583 struct htab_elem
*l
, *next_l
;
587 WARN_ON_ONCE(!rcu_read_lock_held());
589 key_size
= map
->key_size
;
592 goto find_first_elem
;
594 hash
= htab_map_hash(key
, key_size
);
596 head
= select_bucket(htab
, hash
);
599 l
= lookup_nulls_elem_raw(head
, hash
, key
, key_size
, htab
->n_buckets
);
602 goto find_first_elem
;
604 /* key was found, get next key in the same bucket */
605 next_l
= hlist_nulls_entry_safe(rcu_dereference_raw(hlist_nulls_next_rcu(&l
->hash_node
)),
606 struct htab_elem
, hash_node
);
609 /* if next elem in this hash list is non-zero, just return it */
610 memcpy(next_key
, next_l
->key
, key_size
);
614 /* no more elements in this hash list, go to the next bucket */
615 i
= hash
& (htab
->n_buckets
- 1);
619 /* iterate over buckets */
620 for (; i
< htab
->n_buckets
; i
++) {
621 head
= select_bucket(htab
, i
);
623 /* pick first element in the bucket */
624 next_l
= hlist_nulls_entry_safe(rcu_dereference_raw(hlist_nulls_first_rcu(head
)),
625 struct htab_elem
, hash_node
);
627 /* if it's not empty, just return it */
628 memcpy(next_key
, next_l
->key
, key_size
);
633 /* iterated over all buckets and all elements */
637 static void htab_elem_free(struct bpf_htab
*htab
, struct htab_elem
*l
)
639 if (htab
->map
.map_type
== BPF_MAP_TYPE_PERCPU_HASH
)
640 free_percpu(htab_elem_get_ptr(l
, htab
->map
.key_size
));
644 static void htab_elem_free_rcu(struct rcu_head
*head
)
646 struct htab_elem
*l
= container_of(head
, struct htab_elem
, rcu
);
647 struct bpf_htab
*htab
= l
->htab
;
649 /* must increment bpf_prog_active to avoid kprobe+bpf triggering while
650 * we're calling kfree, otherwise deadlock is possible if kprobes
651 * are placed somewhere inside of slub
654 __this_cpu_inc(bpf_prog_active
);
655 htab_elem_free(htab
, l
);
656 __this_cpu_dec(bpf_prog_active
);
660 static void free_htab_elem(struct bpf_htab
*htab
, struct htab_elem
*l
)
662 struct bpf_map
*map
= &htab
->map
;
664 if (map
->ops
->map_fd_put_ptr
) {
665 void *ptr
= fd_htab_map_get_ptr(map
, l
);
667 map
->ops
->map_fd_put_ptr(ptr
);
670 if (htab_is_prealloc(htab
)) {
671 pcpu_freelist_push(&htab
->freelist
, &l
->fnode
);
673 atomic_dec(&htab
->count
);
675 call_rcu(&l
->rcu
, htab_elem_free_rcu
);
679 static void pcpu_copy_value(struct bpf_htab
*htab
, void __percpu
*pptr
,
680 void *value
, bool onallcpus
)
683 /* copy true value_size bytes */
684 memcpy(this_cpu_ptr(pptr
), value
, htab
->map
.value_size
);
686 u32 size
= round_up(htab
->map
.value_size
, 8);
689 for_each_possible_cpu(cpu
) {
690 bpf_long_memcpy(per_cpu_ptr(pptr
, cpu
),
697 static bool fd_htab_map_needs_adjust(const struct bpf_htab
*htab
)
699 return htab
->map
.map_type
== BPF_MAP_TYPE_HASH_OF_MAPS
&&
703 static u32
htab_size_value(const struct bpf_htab
*htab
, bool percpu
)
705 u32 size
= htab
->map
.value_size
;
707 if (percpu
|| fd_htab_map_needs_adjust(htab
))
708 size
= round_up(size
, 8);
712 static struct htab_elem
*alloc_htab_elem(struct bpf_htab
*htab
, void *key
,
713 void *value
, u32 key_size
, u32 hash
,
714 bool percpu
, bool onallcpus
,
715 struct htab_elem
*old_elem
)
717 u32 size
= htab_size_value(htab
, percpu
);
718 bool prealloc
= htab_is_prealloc(htab
);
719 struct htab_elem
*l_new
, **pl_new
;
724 /* if we're updating the existing element,
725 * use per-cpu extra elems to avoid freelist_pop/push
727 pl_new
= this_cpu_ptr(htab
->extra_elems
);
731 struct pcpu_freelist_node
*l
;
733 l
= pcpu_freelist_pop(&htab
->freelist
);
735 return ERR_PTR(-E2BIG
);
736 l_new
= container_of(l
, struct htab_elem
, fnode
);
739 if (atomic_inc_return(&htab
->count
) > htab
->map
.max_entries
)
741 /* when map is full and update() is replacing
742 * old element, it's ok to allocate, since
743 * old element will be freed immediately.
744 * Otherwise return an error
746 atomic_dec(&htab
->count
);
747 return ERR_PTR(-E2BIG
);
749 l_new
= kmalloc_node(htab
->elem_size
, GFP_ATOMIC
| __GFP_NOWARN
,
750 htab
->map
.numa_node
);
752 return ERR_PTR(-ENOMEM
);
755 memcpy(l_new
->key
, key
, key_size
);
758 pptr
= htab_elem_get_ptr(l_new
, key_size
);
760 /* alloc_percpu zero-fills */
761 pptr
= __alloc_percpu_gfp(size
, 8,
762 GFP_ATOMIC
| __GFP_NOWARN
);
765 return ERR_PTR(-ENOMEM
);
769 pcpu_copy_value(htab
, pptr
, value
, onallcpus
);
772 htab_elem_set_ptr(l_new
, key_size
, pptr
);
774 memcpy(l_new
->key
+ round_up(key_size
, 8), value
, size
);
781 static int check_flags(struct bpf_htab
*htab
, struct htab_elem
*l_old
,
784 if (l_old
&& map_flags
== BPF_NOEXIST
)
785 /* elem already exists */
788 if (!l_old
&& map_flags
== BPF_EXIST
)
789 /* elem doesn't exist, cannot update it */
795 /* Called from syscall or from eBPF program */
796 static int htab_map_update_elem(struct bpf_map
*map
, void *key
, void *value
,
799 struct bpf_htab
*htab
= container_of(map
, struct bpf_htab
, map
);
800 struct htab_elem
*l_new
= NULL
, *l_old
;
801 struct hlist_nulls_head
*head
;
807 if (unlikely(map_flags
> BPF_EXIST
))
811 WARN_ON_ONCE(!rcu_read_lock_held());
813 key_size
= map
->key_size
;
815 hash
= htab_map_hash(key
, key_size
);
817 b
= __select_bucket(htab
, hash
);
820 /* bpf_map_update_elem() can be called in_irq() */
821 raw_spin_lock_irqsave(&b
->lock
, flags
);
823 l_old
= lookup_elem_raw(head
, hash
, key
, key_size
);
825 ret
= check_flags(htab
, l_old
, map_flags
);
829 l_new
= alloc_htab_elem(htab
, key
, value
, key_size
, hash
, false, false,
832 /* all pre-allocated elements are in use or memory exhausted */
833 ret
= PTR_ERR(l_new
);
837 /* add new element to the head of the list, so that
838 * concurrent search will find it before old elem
840 hlist_nulls_add_head_rcu(&l_new
->hash_node
, head
);
842 hlist_nulls_del_rcu(&l_old
->hash_node
);
843 if (!htab_is_prealloc(htab
))
844 free_htab_elem(htab
, l_old
);
848 raw_spin_unlock_irqrestore(&b
->lock
, flags
);
852 static int htab_lru_map_update_elem(struct bpf_map
*map
, void *key
, void *value
,
855 struct bpf_htab
*htab
= container_of(map
, struct bpf_htab
, map
);
856 struct htab_elem
*l_new
, *l_old
= NULL
;
857 struct hlist_nulls_head
*head
;
863 if (unlikely(map_flags
> BPF_EXIST
))
867 WARN_ON_ONCE(!rcu_read_lock_held());
869 key_size
= map
->key_size
;
871 hash
= htab_map_hash(key
, key_size
);
873 b
= __select_bucket(htab
, hash
);
876 /* For LRU, we need to alloc before taking bucket's
877 * spinlock because getting free nodes from LRU may need
878 * to remove older elements from htab and this removal
879 * operation will need a bucket lock.
881 l_new
= prealloc_lru_pop(htab
, key
, hash
);
884 memcpy(l_new
->key
+ round_up(map
->key_size
, 8), value
, map
->value_size
);
886 /* bpf_map_update_elem() can be called in_irq() */
887 raw_spin_lock_irqsave(&b
->lock
, flags
);
889 l_old
= lookup_elem_raw(head
, hash
, key
, key_size
);
891 ret
= check_flags(htab
, l_old
, map_flags
);
895 /* add new element to the head of the list, so that
896 * concurrent search will find it before old elem
898 hlist_nulls_add_head_rcu(&l_new
->hash_node
, head
);
900 bpf_lru_node_set_ref(&l_new
->lru_node
);
901 hlist_nulls_del_rcu(&l_old
->hash_node
);
906 raw_spin_unlock_irqrestore(&b
->lock
, flags
);
909 bpf_lru_push_free(&htab
->lru
, &l_new
->lru_node
);
911 bpf_lru_push_free(&htab
->lru
, &l_old
->lru_node
);
916 static int __htab_percpu_map_update_elem(struct bpf_map
*map
, void *key
,
917 void *value
, u64 map_flags
,
920 struct bpf_htab
*htab
= container_of(map
, struct bpf_htab
, map
);
921 struct htab_elem
*l_new
= NULL
, *l_old
;
922 struct hlist_nulls_head
*head
;
928 if (unlikely(map_flags
> BPF_EXIST
))
932 WARN_ON_ONCE(!rcu_read_lock_held());
934 key_size
= map
->key_size
;
936 hash
= htab_map_hash(key
, key_size
);
938 b
= __select_bucket(htab
, hash
);
941 /* bpf_map_update_elem() can be called in_irq() */
942 raw_spin_lock_irqsave(&b
->lock
, flags
);
944 l_old
= lookup_elem_raw(head
, hash
, key
, key_size
);
946 ret
= check_flags(htab
, l_old
, map_flags
);
951 /* per-cpu hash map can update value in-place */
952 pcpu_copy_value(htab
, htab_elem_get_ptr(l_old
, key_size
),
955 l_new
= alloc_htab_elem(htab
, key
, value
, key_size
,
956 hash
, true, onallcpus
, NULL
);
958 ret
= PTR_ERR(l_new
);
961 hlist_nulls_add_head_rcu(&l_new
->hash_node
, head
);
965 raw_spin_unlock_irqrestore(&b
->lock
, flags
);
969 static int __htab_lru_percpu_map_update_elem(struct bpf_map
*map
, void *key
,
970 void *value
, u64 map_flags
,
973 struct bpf_htab
*htab
= container_of(map
, struct bpf_htab
, map
);
974 struct htab_elem
*l_new
= NULL
, *l_old
;
975 struct hlist_nulls_head
*head
;
981 if (unlikely(map_flags
> BPF_EXIST
))
985 WARN_ON_ONCE(!rcu_read_lock_held());
987 key_size
= map
->key_size
;
989 hash
= htab_map_hash(key
, key_size
);
991 b
= __select_bucket(htab
, hash
);
994 /* For LRU, we need to alloc before taking bucket's
995 * spinlock because LRU's elem alloc may need
996 * to remove older elem from htab and this removal
997 * operation will need a bucket lock.
999 if (map_flags
!= BPF_EXIST
) {
1000 l_new
= prealloc_lru_pop(htab
, key
, hash
);
1005 /* bpf_map_update_elem() can be called in_irq() */
1006 raw_spin_lock_irqsave(&b
->lock
, flags
);
1008 l_old
= lookup_elem_raw(head
, hash
, key
, key_size
);
1010 ret
= check_flags(htab
, l_old
, map_flags
);
1015 bpf_lru_node_set_ref(&l_old
->lru_node
);
1017 /* per-cpu hash map can update value in-place */
1018 pcpu_copy_value(htab
, htab_elem_get_ptr(l_old
, key_size
),
1021 pcpu_copy_value(htab
, htab_elem_get_ptr(l_new
, key_size
),
1023 hlist_nulls_add_head_rcu(&l_new
->hash_node
, head
);
1028 raw_spin_unlock_irqrestore(&b
->lock
, flags
);
1030 bpf_lru_push_free(&htab
->lru
, &l_new
->lru_node
);
1034 static int htab_percpu_map_update_elem(struct bpf_map
*map
, void *key
,
1035 void *value
, u64 map_flags
)
1037 return __htab_percpu_map_update_elem(map
, key
, value
, map_flags
, false);
1040 static int htab_lru_percpu_map_update_elem(struct bpf_map
*map
, void *key
,
1041 void *value
, u64 map_flags
)
1043 return __htab_lru_percpu_map_update_elem(map
, key
, value
, map_flags
,
1047 /* Called from syscall or from eBPF program */
1048 static int htab_map_delete_elem(struct bpf_map
*map
, void *key
)
1050 struct bpf_htab
*htab
= container_of(map
, struct bpf_htab
, map
);
1051 struct hlist_nulls_head
*head
;
1053 struct htab_elem
*l
;
1054 unsigned long flags
;
1058 WARN_ON_ONCE(!rcu_read_lock_held());
1060 key_size
= map
->key_size
;
1062 hash
= htab_map_hash(key
, key_size
);
1063 b
= __select_bucket(htab
, hash
);
1066 raw_spin_lock_irqsave(&b
->lock
, flags
);
1068 l
= lookup_elem_raw(head
, hash
, key
, key_size
);
1071 hlist_nulls_del_rcu(&l
->hash_node
);
1072 free_htab_elem(htab
, l
);
1076 raw_spin_unlock_irqrestore(&b
->lock
, flags
);
1080 static int htab_lru_map_delete_elem(struct bpf_map
*map
, void *key
)
1082 struct bpf_htab
*htab
= container_of(map
, struct bpf_htab
, map
);
1083 struct hlist_nulls_head
*head
;
1085 struct htab_elem
*l
;
1086 unsigned long flags
;
1090 WARN_ON_ONCE(!rcu_read_lock_held());
1092 key_size
= map
->key_size
;
1094 hash
= htab_map_hash(key
, key_size
);
1095 b
= __select_bucket(htab
, hash
);
1098 raw_spin_lock_irqsave(&b
->lock
, flags
);
1100 l
= lookup_elem_raw(head
, hash
, key
, key_size
);
1103 hlist_nulls_del_rcu(&l
->hash_node
);
1107 raw_spin_unlock_irqrestore(&b
->lock
, flags
);
1109 bpf_lru_push_free(&htab
->lru
, &l
->lru_node
);
1113 static void delete_all_elements(struct bpf_htab
*htab
)
1117 for (i
= 0; i
< htab
->n_buckets
; i
++) {
1118 struct hlist_nulls_head
*head
= select_bucket(htab
, i
);
1119 struct hlist_nulls_node
*n
;
1120 struct htab_elem
*l
;
1122 hlist_nulls_for_each_entry_safe(l
, n
, head
, hash_node
) {
1123 hlist_nulls_del_rcu(&l
->hash_node
);
1124 htab_elem_free(htab
, l
);
1129 /* Called when map->refcnt goes to zero, either from workqueue or from syscall */
1130 static void htab_map_free(struct bpf_map
*map
)
1132 struct bpf_htab
*htab
= container_of(map
, struct bpf_htab
, map
);
1134 /* at this point bpf_prog->aux->refcnt == 0 and this map->refcnt == 0,
1135 * so the programs (can be more than one that used this map) were
1136 * disconnected from events. Wait for outstanding critical sections in
1137 * these programs to complete
1141 /* some of free_htab_elem() callbacks for elements of this map may
1142 * not have executed. Wait for them.
1145 if (!htab_is_prealloc(htab
))
1146 delete_all_elements(htab
);
1148 prealloc_destroy(htab
);
1150 free_percpu(htab
->extra_elems
);
1151 bpf_map_area_free(htab
->buckets
);
1155 const struct bpf_map_ops htab_map_ops
= {
1156 .map_alloc_check
= htab_map_alloc_check
,
1157 .map_alloc
= htab_map_alloc
,
1158 .map_free
= htab_map_free
,
1159 .map_get_next_key
= htab_map_get_next_key
,
1160 .map_lookup_elem
= htab_map_lookup_elem
,
1161 .map_update_elem
= htab_map_update_elem
,
1162 .map_delete_elem
= htab_map_delete_elem
,
1163 .map_gen_lookup
= htab_map_gen_lookup
,
1166 const struct bpf_map_ops htab_lru_map_ops
= {
1167 .map_alloc_check
= htab_map_alloc_check
,
1168 .map_alloc
= htab_map_alloc
,
1169 .map_free
= htab_map_free
,
1170 .map_get_next_key
= htab_map_get_next_key
,
1171 .map_lookup_elem
= htab_lru_map_lookup_elem
,
1172 .map_update_elem
= htab_lru_map_update_elem
,
1173 .map_delete_elem
= htab_lru_map_delete_elem
,
1174 .map_gen_lookup
= htab_lru_map_gen_lookup
,
1177 /* Called from eBPF program */
1178 static void *htab_percpu_map_lookup_elem(struct bpf_map
*map
, void *key
)
1180 struct htab_elem
*l
= __htab_map_lookup_elem(map
, key
);
1183 return this_cpu_ptr(htab_elem_get_ptr(l
, map
->key_size
));
1188 static void *htab_lru_percpu_map_lookup_elem(struct bpf_map
*map
, void *key
)
1190 struct htab_elem
*l
= __htab_map_lookup_elem(map
, key
);
1193 bpf_lru_node_set_ref(&l
->lru_node
);
1194 return this_cpu_ptr(htab_elem_get_ptr(l
, map
->key_size
));
1200 int bpf_percpu_hash_copy(struct bpf_map
*map
, void *key
, void *value
)
1202 struct bpf_htab
*htab
= container_of(map
, struct bpf_htab
, map
);
1203 struct htab_elem
*l
;
1204 void __percpu
*pptr
;
1209 /* per_cpu areas are zero-filled and bpf programs can only
1210 * access 'value_size' of them, so copying rounded areas
1211 * will not leak any kernel data
1213 size
= round_up(map
->value_size
, 8);
1215 l
= __htab_map_lookup_elem(map
, key
);
1218 if (htab_is_lru(htab
))
1219 bpf_lru_node_set_ref(&l
->lru_node
);
1220 pptr
= htab_elem_get_ptr(l
, map
->key_size
);
1221 for_each_possible_cpu(cpu
) {
1222 bpf_long_memcpy(value
+ off
,
1223 per_cpu_ptr(pptr
, cpu
), size
);
1232 int bpf_percpu_hash_update(struct bpf_map
*map
, void *key
, void *value
,
1235 struct bpf_htab
*htab
= container_of(map
, struct bpf_htab
, map
);
1239 if (htab_is_lru(htab
))
1240 ret
= __htab_lru_percpu_map_update_elem(map
, key
, value
,
1243 ret
= __htab_percpu_map_update_elem(map
, key
, value
, map_flags
,
1250 const struct bpf_map_ops htab_percpu_map_ops
= {
1251 .map_alloc_check
= htab_map_alloc_check
,
1252 .map_alloc
= htab_map_alloc
,
1253 .map_free
= htab_map_free
,
1254 .map_get_next_key
= htab_map_get_next_key
,
1255 .map_lookup_elem
= htab_percpu_map_lookup_elem
,
1256 .map_update_elem
= htab_percpu_map_update_elem
,
1257 .map_delete_elem
= htab_map_delete_elem
,
1260 const struct bpf_map_ops htab_lru_percpu_map_ops
= {
1261 .map_alloc_check
= htab_map_alloc_check
,
1262 .map_alloc
= htab_map_alloc
,
1263 .map_free
= htab_map_free
,
1264 .map_get_next_key
= htab_map_get_next_key
,
1265 .map_lookup_elem
= htab_lru_percpu_map_lookup_elem
,
1266 .map_update_elem
= htab_lru_percpu_map_update_elem
,
1267 .map_delete_elem
= htab_lru_map_delete_elem
,
1270 static int fd_htab_map_alloc_check(union bpf_attr
*attr
)
1272 if (attr
->value_size
!= sizeof(u32
))
1274 return htab_map_alloc_check(attr
);
1277 static void fd_htab_map_free(struct bpf_map
*map
)
1279 struct bpf_htab
*htab
= container_of(map
, struct bpf_htab
, map
);
1280 struct hlist_nulls_node
*n
;
1281 struct hlist_nulls_head
*head
;
1282 struct htab_elem
*l
;
1285 for (i
= 0; i
< htab
->n_buckets
; i
++) {
1286 head
= select_bucket(htab
, i
);
1288 hlist_nulls_for_each_entry_safe(l
, n
, head
, hash_node
) {
1289 void *ptr
= fd_htab_map_get_ptr(map
, l
);
1291 map
->ops
->map_fd_put_ptr(ptr
);
1298 /* only called from syscall */
1299 int bpf_fd_htab_map_lookup_elem(struct bpf_map
*map
, void *key
, u32
*value
)
1304 if (!map
->ops
->map_fd_sys_lookup_elem
)
1308 ptr
= htab_map_lookup_elem(map
, key
);
1310 *value
= map
->ops
->map_fd_sys_lookup_elem(READ_ONCE(*ptr
));
1318 /* only called from syscall */
1319 int bpf_fd_htab_map_update_elem(struct bpf_map
*map
, struct file
*map_file
,
1320 void *key
, void *value
, u64 map_flags
)
1324 u32 ufd
= *(u32
*)value
;
1326 ptr
= map
->ops
->map_fd_get_ptr(map
, map_file
, ufd
);
1328 return PTR_ERR(ptr
);
1330 ret
= htab_map_update_elem(map
, key
, &ptr
, map_flags
);
1332 map
->ops
->map_fd_put_ptr(ptr
);
1337 static struct bpf_map
*htab_of_map_alloc(union bpf_attr
*attr
)
1339 struct bpf_map
*map
, *inner_map_meta
;
1341 inner_map_meta
= bpf_map_meta_alloc(attr
->inner_map_fd
);
1342 if (IS_ERR(inner_map_meta
))
1343 return inner_map_meta
;
1345 map
= htab_map_alloc(attr
);
1347 bpf_map_meta_free(inner_map_meta
);
1351 map
->inner_map_meta
= inner_map_meta
;
1356 static void *htab_of_map_lookup_elem(struct bpf_map
*map
, void *key
)
1358 struct bpf_map
**inner_map
= htab_map_lookup_elem(map
, key
);
1363 return READ_ONCE(*inner_map
);
1366 static u32
htab_of_map_gen_lookup(struct bpf_map
*map
,
1367 struct bpf_insn
*insn_buf
)
1369 struct bpf_insn
*insn
= insn_buf
;
1370 const int ret
= BPF_REG_0
;
1372 *insn
++ = BPF_EMIT_CALL((u64 (*)(u64
, u64
, u64
, u64
, u64
))__htab_map_lookup_elem
);
1373 *insn
++ = BPF_JMP_IMM(BPF_JEQ
, ret
, 0, 2);
1374 *insn
++ = BPF_ALU64_IMM(BPF_ADD
, ret
,
1375 offsetof(struct htab_elem
, key
) +
1376 round_up(map
->key_size
, 8));
1377 *insn
++ = BPF_LDX_MEM(BPF_DW
, ret
, ret
, 0);
1379 return insn
- insn_buf
;
1382 static void htab_of_map_free(struct bpf_map
*map
)
1384 bpf_map_meta_free(map
->inner_map_meta
);
1385 fd_htab_map_free(map
);
1388 const struct bpf_map_ops htab_of_maps_map_ops
= {
1389 .map_alloc_check
= fd_htab_map_alloc_check
,
1390 .map_alloc
= htab_of_map_alloc
,
1391 .map_free
= htab_of_map_free
,
1392 .map_get_next_key
= htab_map_get_next_key
,
1393 .map_lookup_elem
= htab_of_map_lookup_elem
,
1394 .map_delete_elem
= htab_map_delete_elem
,
1395 .map_fd_get_ptr
= bpf_map_fd_get_ptr
,
1396 .map_fd_put_ptr
= bpf_map_fd_put_ptr
,
1397 .map_fd_sys_lookup_elem
= bpf_map_fd_sys_lookup_elem
,
1398 .map_gen_lookup
= htab_of_map_gen_lookup
,