Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net
[linux-2.6-block.git] / kernel / bpf / hashtab.c
1 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
2  * Copyright (c) 2016 Facebook
3  *
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.
7  *
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.
12  */
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"
20
21 struct bucket {
22         struct hlist_nulls_head head;
23         raw_spinlock_t lock;
24 };
25
26 struct bpf_htab {
27         struct bpf_map map;
28         struct bucket *buckets;
29         void *elems;
30         union {
31                 struct pcpu_freelist freelist;
32                 struct bpf_lru lru;
33         };
34         struct htab_elem *__percpu *extra_elems;
35         atomic_t count; /* number of elements in this hashtable */
36         u32 n_buckets;  /* number of hash buckets */
37         u32 elem_size;  /* size of each element in bytes */
38 };
39
40 /* each htab element is struct htab_elem + key + value */
41 struct htab_elem {
42         union {
43                 struct hlist_nulls_node hash_node;
44                 struct {
45                         void *padding;
46                         union {
47                                 struct bpf_htab *htab;
48                                 struct pcpu_freelist_node fnode;
49                         };
50                 };
51         };
52         union {
53                 struct rcu_head rcu;
54                 struct bpf_lru_node lru_node;
55         };
56         u32 hash;
57         char key[0] __aligned(8);
58 };
59
60 static bool htab_lru_map_delete_node(void *arg, struct bpf_lru_node *node);
61
62 static bool htab_is_lru(const struct bpf_htab *htab)
63 {
64         return htab->map.map_type == BPF_MAP_TYPE_LRU_HASH ||
65                 htab->map.map_type == BPF_MAP_TYPE_LRU_PERCPU_HASH;
66 }
67
68 static bool htab_is_percpu(const struct bpf_htab *htab)
69 {
70         return htab->map.map_type == BPF_MAP_TYPE_PERCPU_HASH ||
71                 htab->map.map_type == BPF_MAP_TYPE_LRU_PERCPU_HASH;
72 }
73
74 static bool htab_is_prealloc(const struct bpf_htab *htab)
75 {
76         return !(htab->map.map_flags & BPF_F_NO_PREALLOC);
77 }
78
79 static inline void htab_elem_set_ptr(struct htab_elem *l, u32 key_size,
80                                      void __percpu *pptr)
81 {
82         *(void __percpu **)(l->key + key_size) = pptr;
83 }
84
85 static inline void __percpu *htab_elem_get_ptr(struct htab_elem *l, u32 key_size)
86 {
87         return *(void __percpu **)(l->key + key_size);
88 }
89
90 static void *fd_htab_map_get_ptr(const struct bpf_map *map, struct htab_elem *l)
91 {
92         return *(void **)(l->key + roundup(map->key_size, 8));
93 }
94
95 static struct htab_elem *get_htab_elem(struct bpf_htab *htab, int i)
96 {
97         return (struct htab_elem *) (htab->elems + i * htab->elem_size);
98 }
99
100 static void htab_free_elems(struct bpf_htab *htab)
101 {
102         int i;
103
104         if (!htab_is_percpu(htab))
105                 goto free_elems;
106
107         for (i = 0; i < htab->map.max_entries; i++) {
108                 void __percpu *pptr;
109
110                 pptr = htab_elem_get_ptr(get_htab_elem(htab, i),
111                                          htab->map.key_size);
112                 free_percpu(pptr);
113         }
114 free_elems:
115         bpf_map_area_free(htab->elems);
116 }
117
118 static struct htab_elem *prealloc_lru_pop(struct bpf_htab *htab, void *key,
119                                           u32 hash)
120 {
121         struct bpf_lru_node *node = bpf_lru_pop_free(&htab->lru, hash);
122         struct htab_elem *l;
123
124         if (node) {
125                 l = container_of(node, struct htab_elem, lru_node);
126                 memcpy(l->key, key, htab->map.key_size);
127                 return l;
128         }
129
130         return NULL;
131 }
132
133 static int prealloc_init(struct bpf_htab *htab)
134 {
135         u32 num_entries = htab->map.max_entries;
136         int err = -ENOMEM, i;
137
138         if (!htab_is_percpu(htab) && !htab_is_lru(htab))
139                 num_entries += num_possible_cpus();
140
141         htab->elems = bpf_map_area_alloc(htab->elem_size * num_entries);
142         if (!htab->elems)
143                 return -ENOMEM;
144
145         if (!htab_is_percpu(htab))
146                 goto skip_percpu_elems;
147
148         for (i = 0; i < num_entries; i++) {
149                 u32 size = round_up(htab->map.value_size, 8);
150                 void __percpu *pptr;
151
152                 pptr = __alloc_percpu_gfp(size, 8, GFP_USER | __GFP_NOWARN);
153                 if (!pptr)
154                         goto free_elems;
155                 htab_elem_set_ptr(get_htab_elem(htab, i), htab->map.key_size,
156                                   pptr);
157         }
158
159 skip_percpu_elems:
160         if (htab_is_lru(htab))
161                 err = bpf_lru_init(&htab->lru,
162                                    htab->map.map_flags & BPF_F_NO_COMMON_LRU,
163                                    offsetof(struct htab_elem, hash) -
164                                    offsetof(struct htab_elem, lru_node),
165                                    htab_lru_map_delete_node,
166                                    htab);
167         else
168                 err = pcpu_freelist_init(&htab->freelist);
169
170         if (err)
171                 goto free_elems;
172
173         if (htab_is_lru(htab))
174                 bpf_lru_populate(&htab->lru, htab->elems,
175                                  offsetof(struct htab_elem, lru_node),
176                                  htab->elem_size, num_entries);
177         else
178                 pcpu_freelist_populate(&htab->freelist,
179                                        htab->elems + offsetof(struct htab_elem, fnode),
180                                        htab->elem_size, num_entries);
181
182         return 0;
183
184 free_elems:
185         htab_free_elems(htab);
186         return err;
187 }
188
189 static void prealloc_destroy(struct bpf_htab *htab)
190 {
191         htab_free_elems(htab);
192
193         if (htab_is_lru(htab))
194                 bpf_lru_destroy(&htab->lru);
195         else
196                 pcpu_freelist_destroy(&htab->freelist);
197 }
198
199 static int alloc_extra_elems(struct bpf_htab *htab)
200 {
201         struct htab_elem *__percpu *pptr, *l_new;
202         struct pcpu_freelist_node *l;
203         int cpu;
204
205         pptr = __alloc_percpu_gfp(sizeof(struct htab_elem *), 8,
206                                   GFP_USER | __GFP_NOWARN);
207         if (!pptr)
208                 return -ENOMEM;
209
210         for_each_possible_cpu(cpu) {
211                 l = pcpu_freelist_pop(&htab->freelist);
212                 /* pop will succeed, since prealloc_init()
213                  * preallocated extra num_possible_cpus elements
214                  */
215                 l_new = container_of(l, struct htab_elem, fnode);
216                 *per_cpu_ptr(pptr, cpu) = l_new;
217         }
218         htab->extra_elems = pptr;
219         return 0;
220 }
221
222 /* Called from syscall */
223 static struct bpf_map *htab_map_alloc(union bpf_attr *attr)
224 {
225         bool percpu = (attr->map_type == BPF_MAP_TYPE_PERCPU_HASH ||
226                        attr->map_type == BPF_MAP_TYPE_LRU_PERCPU_HASH);
227         bool lru = (attr->map_type == BPF_MAP_TYPE_LRU_HASH ||
228                     attr->map_type == BPF_MAP_TYPE_LRU_PERCPU_HASH);
229         /* percpu_lru means each cpu has its own LRU list.
230          * it is different from BPF_MAP_TYPE_PERCPU_HASH where
231          * the map's value itself is percpu.  percpu_lru has
232          * nothing to do with the map's value.
233          */
234         bool percpu_lru = (attr->map_flags & BPF_F_NO_COMMON_LRU);
235         bool prealloc = !(attr->map_flags & BPF_F_NO_PREALLOC);
236         struct bpf_htab *htab;
237         int err, i;
238         u64 cost;
239
240         BUILD_BUG_ON(offsetof(struct htab_elem, htab) !=
241                      offsetof(struct htab_elem, hash_node.pprev));
242         BUILD_BUG_ON(offsetof(struct htab_elem, fnode.next) !=
243                      offsetof(struct htab_elem, hash_node.pprev));
244
245         if (lru && !capable(CAP_SYS_ADMIN))
246                 /* LRU implementation is much complicated than other
247                  * maps.  Hence, limit to CAP_SYS_ADMIN for now.
248                  */
249                 return ERR_PTR(-EPERM);
250
251         if (attr->map_flags & ~(BPF_F_NO_PREALLOC | BPF_F_NO_COMMON_LRU))
252                 /* reserved bits should not be used */
253                 return ERR_PTR(-EINVAL);
254
255         if (!lru && percpu_lru)
256                 return ERR_PTR(-EINVAL);
257
258         if (lru && !prealloc)
259                 return ERR_PTR(-ENOTSUPP);
260
261         htab = kzalloc(sizeof(*htab), GFP_USER);
262         if (!htab)
263                 return ERR_PTR(-ENOMEM);
264
265         /* mandatory map attributes */
266         htab->map.map_type = attr->map_type;
267         htab->map.key_size = attr->key_size;
268         htab->map.value_size = attr->value_size;
269         htab->map.max_entries = attr->max_entries;
270         htab->map.map_flags = attr->map_flags;
271
272         /* check sanity of attributes.
273          * value_size == 0 may be allowed in the future to use map as a set
274          */
275         err = -EINVAL;
276         if (htab->map.max_entries == 0 || htab->map.key_size == 0 ||
277             htab->map.value_size == 0)
278                 goto free_htab;
279
280         if (percpu_lru) {
281                 /* ensure each CPU's lru list has >=1 elements.
282                  * since we are at it, make each lru list has the same
283                  * number of elements.
284                  */
285                 htab->map.max_entries = roundup(attr->max_entries,
286                                                 num_possible_cpus());
287                 if (htab->map.max_entries < attr->max_entries)
288                         htab->map.max_entries = rounddown(attr->max_entries,
289                                                           num_possible_cpus());
290         }
291
292         /* hash table size must be power of 2 */
293         htab->n_buckets = roundup_pow_of_two(htab->map.max_entries);
294
295         err = -E2BIG;
296         if (htab->map.key_size > MAX_BPF_STACK)
297                 /* eBPF programs initialize keys on stack, so they cannot be
298                  * larger than max stack size
299                  */
300                 goto free_htab;
301
302         if (htab->map.value_size >= KMALLOC_MAX_SIZE -
303             MAX_BPF_STACK - sizeof(struct htab_elem))
304                 /* if value_size is bigger, the user space won't be able to
305                  * access the elements via bpf syscall. This check also makes
306                  * sure that the elem_size doesn't overflow and it's
307                  * kmalloc-able later in htab_map_update_elem()
308                  */
309                 goto free_htab;
310
311         if (percpu && round_up(htab->map.value_size, 8) > PCPU_MIN_UNIT_SIZE)
312                 /* make sure the size for pcpu_alloc() is reasonable */
313                 goto free_htab;
314
315         htab->elem_size = sizeof(struct htab_elem) +
316                           round_up(htab->map.key_size, 8);
317         if (percpu)
318                 htab->elem_size += sizeof(void *);
319         else
320                 htab->elem_size += round_up(htab->map.value_size, 8);
321
322         /* prevent zero size kmalloc and check for u32 overflow */
323         if (htab->n_buckets == 0 ||
324             htab->n_buckets > U32_MAX / sizeof(struct bucket))
325                 goto free_htab;
326
327         cost = (u64) htab->n_buckets * sizeof(struct bucket) +
328                (u64) htab->elem_size * htab->map.max_entries;
329
330         if (percpu)
331                 cost += (u64) round_up(htab->map.value_size, 8) *
332                         num_possible_cpus() * htab->map.max_entries;
333         else
334                cost += (u64) htab->elem_size * num_possible_cpus();
335
336         if (cost >= U32_MAX - PAGE_SIZE)
337                 /* make sure page count doesn't overflow */
338                 goto free_htab;
339
340         htab->map.pages = round_up(cost, PAGE_SIZE) >> PAGE_SHIFT;
341
342         /* if map size is larger than memlock limit, reject it early */
343         err = bpf_map_precharge_memlock(htab->map.pages);
344         if (err)
345                 goto free_htab;
346
347         err = -ENOMEM;
348         htab->buckets = bpf_map_area_alloc(htab->n_buckets *
349                                            sizeof(struct bucket));
350         if (!htab->buckets)
351                 goto free_htab;
352
353         for (i = 0; i < htab->n_buckets; i++) {
354                 INIT_HLIST_NULLS_HEAD(&htab->buckets[i].head, i);
355                 raw_spin_lock_init(&htab->buckets[i].lock);
356         }
357
358         if (prealloc) {
359                 err = prealloc_init(htab);
360                 if (err)
361                         goto free_buckets;
362
363                 if (!percpu && !lru) {
364                         /* lru itself can remove the least used element, so
365                          * there is no need for an extra elem during map_update.
366                          */
367                         err = alloc_extra_elems(htab);
368                         if (err)
369                                 goto free_prealloc;
370                 }
371         }
372
373         return &htab->map;
374
375 free_prealloc:
376         prealloc_destroy(htab);
377 free_buckets:
378         bpf_map_area_free(htab->buckets);
379 free_htab:
380         kfree(htab);
381         return ERR_PTR(err);
382 }
383
384 static inline u32 htab_map_hash(const void *key, u32 key_len)
385 {
386         return jhash(key, key_len, 0);
387 }
388
389 static inline struct bucket *__select_bucket(struct bpf_htab *htab, u32 hash)
390 {
391         return &htab->buckets[hash & (htab->n_buckets - 1)];
392 }
393
394 static inline struct hlist_nulls_head *select_bucket(struct bpf_htab *htab, u32 hash)
395 {
396         return &__select_bucket(htab, hash)->head;
397 }
398
399 /* this lookup function can only be called with bucket lock taken */
400 static struct htab_elem *lookup_elem_raw(struct hlist_nulls_head *head, u32 hash,
401                                          void *key, u32 key_size)
402 {
403         struct hlist_nulls_node *n;
404         struct htab_elem *l;
405
406         hlist_nulls_for_each_entry_rcu(l, n, head, hash_node)
407                 if (l->hash == hash && !memcmp(&l->key, key, key_size))
408                         return l;
409
410         return NULL;
411 }
412
413 /* can be called without bucket lock. it will repeat the loop in
414  * the unlikely event when elements moved from one bucket into another
415  * while link list is being walked
416  */
417 static struct htab_elem *lookup_nulls_elem_raw(struct hlist_nulls_head *head,
418                                                u32 hash, void *key,
419                                                u32 key_size, u32 n_buckets)
420 {
421         struct hlist_nulls_node *n;
422         struct htab_elem *l;
423
424 again:
425         hlist_nulls_for_each_entry_rcu(l, n, head, hash_node)
426                 if (l->hash == hash && !memcmp(&l->key, key, key_size))
427                         return l;
428
429         if (unlikely(get_nulls_value(n) != (hash & (n_buckets - 1))))
430                 goto again;
431
432         return NULL;
433 }
434
435 /* Called from syscall or from eBPF program directly, so
436  * arguments have to match bpf_map_lookup_elem() exactly.
437  * The return value is adjusted by BPF instructions
438  * in htab_map_gen_lookup().
439  */
440 static void *__htab_map_lookup_elem(struct bpf_map *map, void *key)
441 {
442         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
443         struct hlist_nulls_head *head;
444         struct htab_elem *l;
445         u32 hash, key_size;
446
447         /* Must be called with rcu_read_lock. */
448         WARN_ON_ONCE(!rcu_read_lock_held());
449
450         key_size = map->key_size;
451
452         hash = htab_map_hash(key, key_size);
453
454         head = select_bucket(htab, hash);
455
456         l = lookup_nulls_elem_raw(head, hash, key, key_size, htab->n_buckets);
457
458         return l;
459 }
460
461 static void *htab_map_lookup_elem(struct bpf_map *map, void *key)
462 {
463         struct htab_elem *l = __htab_map_lookup_elem(map, key);
464
465         if (l)
466                 return l->key + round_up(map->key_size, 8);
467
468         return NULL;
469 }
470
471 /* inline bpf_map_lookup_elem() call.
472  * Instead of:
473  * bpf_prog
474  *   bpf_map_lookup_elem
475  *     map->ops->map_lookup_elem
476  *       htab_map_lookup_elem
477  *         __htab_map_lookup_elem
478  * do:
479  * bpf_prog
480  *   __htab_map_lookup_elem
481  */
482 static u32 htab_map_gen_lookup(struct bpf_map *map, struct bpf_insn *insn_buf)
483 {
484         struct bpf_insn *insn = insn_buf;
485         const int ret = BPF_REG_0;
486
487         *insn++ = BPF_EMIT_CALL((u64 (*)(u64, u64, u64, u64, u64))__htab_map_lookup_elem);
488         *insn++ = BPF_JMP_IMM(BPF_JEQ, ret, 0, 1);
489         *insn++ = BPF_ALU64_IMM(BPF_ADD, ret,
490                                 offsetof(struct htab_elem, key) +
491                                 round_up(map->key_size, 8));
492         return insn - insn_buf;
493 }
494
495 static void *htab_lru_map_lookup_elem(struct bpf_map *map, void *key)
496 {
497         struct htab_elem *l = __htab_map_lookup_elem(map, key);
498
499         if (l) {
500                 bpf_lru_node_set_ref(&l->lru_node);
501                 return l->key + round_up(map->key_size, 8);
502         }
503
504         return NULL;
505 }
506
507 /* It is called from the bpf_lru_list when the LRU needs to delete
508  * older elements from the htab.
509  */
510 static bool htab_lru_map_delete_node(void *arg, struct bpf_lru_node *node)
511 {
512         struct bpf_htab *htab = (struct bpf_htab *)arg;
513         struct htab_elem *l = NULL, *tgt_l;
514         struct hlist_nulls_head *head;
515         struct hlist_nulls_node *n;
516         unsigned long flags;
517         struct bucket *b;
518
519         tgt_l = container_of(node, struct htab_elem, lru_node);
520         b = __select_bucket(htab, tgt_l->hash);
521         head = &b->head;
522
523         raw_spin_lock_irqsave(&b->lock, flags);
524
525         hlist_nulls_for_each_entry_rcu(l, n, head, hash_node)
526                 if (l == tgt_l) {
527                         hlist_nulls_del_rcu(&l->hash_node);
528                         break;
529                 }
530
531         raw_spin_unlock_irqrestore(&b->lock, flags);
532
533         return l == tgt_l;
534 }
535
536 /* Called from syscall */
537 static int htab_map_get_next_key(struct bpf_map *map, void *key, void *next_key)
538 {
539         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
540         struct hlist_nulls_head *head;
541         struct htab_elem *l, *next_l;
542         u32 hash, key_size;
543         int i;
544
545         WARN_ON_ONCE(!rcu_read_lock_held());
546
547         key_size = map->key_size;
548
549         hash = htab_map_hash(key, key_size);
550
551         head = select_bucket(htab, hash);
552
553         /* lookup the key */
554         l = lookup_nulls_elem_raw(head, hash, key, key_size, htab->n_buckets);
555
556         if (!l) {
557                 i = 0;
558                 goto find_first_elem;
559         }
560
561         /* key was found, get next key in the same bucket */
562         next_l = hlist_nulls_entry_safe(rcu_dereference_raw(hlist_nulls_next_rcu(&l->hash_node)),
563                                   struct htab_elem, hash_node);
564
565         if (next_l) {
566                 /* if next elem in this hash list is non-zero, just return it */
567                 memcpy(next_key, next_l->key, key_size);
568                 return 0;
569         }
570
571         /* no more elements in this hash list, go to the next bucket */
572         i = hash & (htab->n_buckets - 1);
573         i++;
574
575 find_first_elem:
576         /* iterate over buckets */
577         for (; i < htab->n_buckets; i++) {
578                 head = select_bucket(htab, i);
579
580                 /* pick first element in the bucket */
581                 next_l = hlist_nulls_entry_safe(rcu_dereference_raw(hlist_nulls_first_rcu(head)),
582                                           struct htab_elem, hash_node);
583                 if (next_l) {
584                         /* if it's not empty, just return it */
585                         memcpy(next_key, next_l->key, key_size);
586                         return 0;
587                 }
588         }
589
590         /* iterated over all buckets and all elements */
591         return -ENOENT;
592 }
593
594 static void htab_elem_free(struct bpf_htab *htab, struct htab_elem *l)
595 {
596         if (htab->map.map_type == BPF_MAP_TYPE_PERCPU_HASH)
597                 free_percpu(htab_elem_get_ptr(l, htab->map.key_size));
598         kfree(l);
599 }
600
601 static void htab_elem_free_rcu(struct rcu_head *head)
602 {
603         struct htab_elem *l = container_of(head, struct htab_elem, rcu);
604         struct bpf_htab *htab = l->htab;
605
606         /* must increment bpf_prog_active to avoid kprobe+bpf triggering while
607          * we're calling kfree, otherwise deadlock is possible if kprobes
608          * are placed somewhere inside of slub
609          */
610         preempt_disable();
611         __this_cpu_inc(bpf_prog_active);
612         htab_elem_free(htab, l);
613         __this_cpu_dec(bpf_prog_active);
614         preempt_enable();
615 }
616
617 static void free_htab_elem(struct bpf_htab *htab, struct htab_elem *l)
618 {
619         struct bpf_map *map = &htab->map;
620
621         if (map->ops->map_fd_put_ptr) {
622                 void *ptr = fd_htab_map_get_ptr(map, l);
623
624                 map->ops->map_fd_put_ptr(ptr);
625         }
626
627         if (htab_is_prealloc(htab)) {
628                 pcpu_freelist_push(&htab->freelist, &l->fnode);
629         } else {
630                 atomic_dec(&htab->count);
631                 l->htab = htab;
632                 call_rcu(&l->rcu, htab_elem_free_rcu);
633         }
634 }
635
636 static void pcpu_copy_value(struct bpf_htab *htab, void __percpu *pptr,
637                             void *value, bool onallcpus)
638 {
639         if (!onallcpus) {
640                 /* copy true value_size bytes */
641                 memcpy(this_cpu_ptr(pptr), value, htab->map.value_size);
642         } else {
643                 u32 size = round_up(htab->map.value_size, 8);
644                 int off = 0, cpu;
645
646                 for_each_possible_cpu(cpu) {
647                         bpf_long_memcpy(per_cpu_ptr(pptr, cpu),
648                                         value + off, size);
649                         off += size;
650                 }
651         }
652 }
653
654 static struct htab_elem *alloc_htab_elem(struct bpf_htab *htab, void *key,
655                                          void *value, u32 key_size, u32 hash,
656                                          bool percpu, bool onallcpus,
657                                          struct htab_elem *old_elem)
658 {
659         u32 size = htab->map.value_size;
660         bool prealloc = htab_is_prealloc(htab);
661         struct htab_elem *l_new, **pl_new;
662         void __percpu *pptr;
663
664         if (prealloc) {
665                 if (old_elem) {
666                         /* if we're updating the existing element,
667                          * use per-cpu extra elems to avoid freelist_pop/push
668                          */
669                         pl_new = this_cpu_ptr(htab->extra_elems);
670                         l_new = *pl_new;
671                         *pl_new = old_elem;
672                 } else {
673                         struct pcpu_freelist_node *l;
674
675                         l = pcpu_freelist_pop(&htab->freelist);
676                         if (!l)
677                                 return ERR_PTR(-E2BIG);
678                         l_new = container_of(l, struct htab_elem, fnode);
679                 }
680         } else {
681                 if (atomic_inc_return(&htab->count) > htab->map.max_entries)
682                         if (!old_elem) {
683                                 /* when map is full and update() is replacing
684                                  * old element, it's ok to allocate, since
685                                  * old element will be freed immediately.
686                                  * Otherwise return an error
687                                  */
688                                 atomic_dec(&htab->count);
689                                 return ERR_PTR(-E2BIG);
690                         }
691                 l_new = kmalloc(htab->elem_size, GFP_ATOMIC | __GFP_NOWARN);
692                 if (!l_new)
693                         return ERR_PTR(-ENOMEM);
694         }
695
696         memcpy(l_new->key, key, key_size);
697         if (percpu) {
698                 /* round up value_size to 8 bytes */
699                 size = round_up(size, 8);
700
701                 if (prealloc) {
702                         pptr = htab_elem_get_ptr(l_new, key_size);
703                 } else {
704                         /* alloc_percpu zero-fills */
705                         pptr = __alloc_percpu_gfp(size, 8,
706                                                   GFP_ATOMIC | __GFP_NOWARN);
707                         if (!pptr) {
708                                 kfree(l_new);
709                                 return ERR_PTR(-ENOMEM);
710                         }
711                 }
712
713                 pcpu_copy_value(htab, pptr, value, onallcpus);
714
715                 if (!prealloc)
716                         htab_elem_set_ptr(l_new, key_size, pptr);
717         } else {
718                 memcpy(l_new->key + round_up(key_size, 8), value, size);
719         }
720
721         l_new->hash = hash;
722         return l_new;
723 }
724
725 static int check_flags(struct bpf_htab *htab, struct htab_elem *l_old,
726                        u64 map_flags)
727 {
728         if (l_old && map_flags == BPF_NOEXIST)
729                 /* elem already exists */
730                 return -EEXIST;
731
732         if (!l_old && map_flags == BPF_EXIST)
733                 /* elem doesn't exist, cannot update it */
734                 return -ENOENT;
735
736         return 0;
737 }
738
739 /* Called from syscall or from eBPF program */
740 static int htab_map_update_elem(struct bpf_map *map, void *key, void *value,
741                                 u64 map_flags)
742 {
743         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
744         struct htab_elem *l_new = NULL, *l_old;
745         struct hlist_nulls_head *head;
746         unsigned long flags;
747         struct bucket *b;
748         u32 key_size, hash;
749         int ret;
750
751         if (unlikely(map_flags > BPF_EXIST))
752                 /* unknown flags */
753                 return -EINVAL;
754
755         WARN_ON_ONCE(!rcu_read_lock_held());
756
757         key_size = map->key_size;
758
759         hash = htab_map_hash(key, key_size);
760
761         b = __select_bucket(htab, hash);
762         head = &b->head;
763
764         /* bpf_map_update_elem() can be called in_irq() */
765         raw_spin_lock_irqsave(&b->lock, flags);
766
767         l_old = lookup_elem_raw(head, hash, key, key_size);
768
769         ret = check_flags(htab, l_old, map_flags);
770         if (ret)
771                 goto err;
772
773         l_new = alloc_htab_elem(htab, key, value, key_size, hash, false, false,
774                                 l_old);
775         if (IS_ERR(l_new)) {
776                 /* all pre-allocated elements are in use or memory exhausted */
777                 ret = PTR_ERR(l_new);
778                 goto err;
779         }
780
781         /* add new element to the head of the list, so that
782          * concurrent search will find it before old elem
783          */
784         hlist_nulls_add_head_rcu(&l_new->hash_node, head);
785         if (l_old) {
786                 hlist_nulls_del_rcu(&l_old->hash_node);
787                 if (!htab_is_prealloc(htab))
788                         free_htab_elem(htab, l_old);
789         }
790         ret = 0;
791 err:
792         raw_spin_unlock_irqrestore(&b->lock, flags);
793         return ret;
794 }
795
796 static int htab_lru_map_update_elem(struct bpf_map *map, void *key, void *value,
797                                     u64 map_flags)
798 {
799         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
800         struct htab_elem *l_new, *l_old = NULL;
801         struct hlist_nulls_head *head;
802         unsigned long flags;
803         struct bucket *b;
804         u32 key_size, hash;
805         int ret;
806
807         if (unlikely(map_flags > BPF_EXIST))
808                 /* unknown flags */
809                 return -EINVAL;
810
811         WARN_ON_ONCE(!rcu_read_lock_held());
812
813         key_size = map->key_size;
814
815         hash = htab_map_hash(key, key_size);
816
817         b = __select_bucket(htab, hash);
818         head = &b->head;
819
820         /* For LRU, we need to alloc before taking bucket's
821          * spinlock because getting free nodes from LRU may need
822          * to remove older elements from htab and this removal
823          * operation will need a bucket lock.
824          */
825         l_new = prealloc_lru_pop(htab, key, hash);
826         if (!l_new)
827                 return -ENOMEM;
828         memcpy(l_new->key + round_up(map->key_size, 8), value, map->value_size);
829
830         /* bpf_map_update_elem() can be called in_irq() */
831         raw_spin_lock_irqsave(&b->lock, flags);
832
833         l_old = lookup_elem_raw(head, hash, key, key_size);
834
835         ret = check_flags(htab, l_old, map_flags);
836         if (ret)
837                 goto err;
838
839         /* add new element to the head of the list, so that
840          * concurrent search will find it before old elem
841          */
842         hlist_nulls_add_head_rcu(&l_new->hash_node, head);
843         if (l_old) {
844                 bpf_lru_node_set_ref(&l_new->lru_node);
845                 hlist_nulls_del_rcu(&l_old->hash_node);
846         }
847         ret = 0;
848
849 err:
850         raw_spin_unlock_irqrestore(&b->lock, flags);
851
852         if (ret)
853                 bpf_lru_push_free(&htab->lru, &l_new->lru_node);
854         else if (l_old)
855                 bpf_lru_push_free(&htab->lru, &l_old->lru_node);
856
857         return ret;
858 }
859
860 static int __htab_percpu_map_update_elem(struct bpf_map *map, void *key,
861                                          void *value, u64 map_flags,
862                                          bool onallcpus)
863 {
864         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
865         struct htab_elem *l_new = NULL, *l_old;
866         struct hlist_nulls_head *head;
867         unsigned long flags;
868         struct bucket *b;
869         u32 key_size, hash;
870         int ret;
871
872         if (unlikely(map_flags > BPF_EXIST))
873                 /* unknown flags */
874                 return -EINVAL;
875
876         WARN_ON_ONCE(!rcu_read_lock_held());
877
878         key_size = map->key_size;
879
880         hash = htab_map_hash(key, key_size);
881
882         b = __select_bucket(htab, hash);
883         head = &b->head;
884
885         /* bpf_map_update_elem() can be called in_irq() */
886         raw_spin_lock_irqsave(&b->lock, flags);
887
888         l_old = lookup_elem_raw(head, hash, key, key_size);
889
890         ret = check_flags(htab, l_old, map_flags);
891         if (ret)
892                 goto err;
893
894         if (l_old) {
895                 /* per-cpu hash map can update value in-place */
896                 pcpu_copy_value(htab, htab_elem_get_ptr(l_old, key_size),
897                                 value, onallcpus);
898         } else {
899                 l_new = alloc_htab_elem(htab, key, value, key_size,
900                                         hash, true, onallcpus, NULL);
901                 if (IS_ERR(l_new)) {
902                         ret = PTR_ERR(l_new);
903                         goto err;
904                 }
905                 hlist_nulls_add_head_rcu(&l_new->hash_node, head);
906         }
907         ret = 0;
908 err:
909         raw_spin_unlock_irqrestore(&b->lock, flags);
910         return ret;
911 }
912
913 static int __htab_lru_percpu_map_update_elem(struct bpf_map *map, void *key,
914                                              void *value, u64 map_flags,
915                                              bool onallcpus)
916 {
917         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
918         struct htab_elem *l_new = NULL, *l_old;
919         struct hlist_nulls_head *head;
920         unsigned long flags;
921         struct bucket *b;
922         u32 key_size, hash;
923         int ret;
924
925         if (unlikely(map_flags > BPF_EXIST))
926                 /* unknown flags */
927                 return -EINVAL;
928
929         WARN_ON_ONCE(!rcu_read_lock_held());
930
931         key_size = map->key_size;
932
933         hash = htab_map_hash(key, key_size);
934
935         b = __select_bucket(htab, hash);
936         head = &b->head;
937
938         /* For LRU, we need to alloc before taking bucket's
939          * spinlock because LRU's elem alloc may need
940          * to remove older elem from htab and this removal
941          * operation will need a bucket lock.
942          */
943         if (map_flags != BPF_EXIST) {
944                 l_new = prealloc_lru_pop(htab, key, hash);
945                 if (!l_new)
946                         return -ENOMEM;
947         }
948
949         /* bpf_map_update_elem() can be called in_irq() */
950         raw_spin_lock_irqsave(&b->lock, flags);
951
952         l_old = lookup_elem_raw(head, hash, key, key_size);
953
954         ret = check_flags(htab, l_old, map_flags);
955         if (ret)
956                 goto err;
957
958         if (l_old) {
959                 bpf_lru_node_set_ref(&l_old->lru_node);
960
961                 /* per-cpu hash map can update value in-place */
962                 pcpu_copy_value(htab, htab_elem_get_ptr(l_old, key_size),
963                                 value, onallcpus);
964         } else {
965                 pcpu_copy_value(htab, htab_elem_get_ptr(l_new, key_size),
966                                 value, onallcpus);
967                 hlist_nulls_add_head_rcu(&l_new->hash_node, head);
968                 l_new = NULL;
969         }
970         ret = 0;
971 err:
972         raw_spin_unlock_irqrestore(&b->lock, flags);
973         if (l_new)
974                 bpf_lru_push_free(&htab->lru, &l_new->lru_node);
975         return ret;
976 }
977
978 static int htab_percpu_map_update_elem(struct bpf_map *map, void *key,
979                                        void *value, u64 map_flags)
980 {
981         return __htab_percpu_map_update_elem(map, key, value, map_flags, false);
982 }
983
984 static int htab_lru_percpu_map_update_elem(struct bpf_map *map, void *key,
985                                            void *value, u64 map_flags)
986 {
987         return __htab_lru_percpu_map_update_elem(map, key, value, map_flags,
988                                                  false);
989 }
990
991 /* Called from syscall or from eBPF program */
992 static int htab_map_delete_elem(struct bpf_map *map, void *key)
993 {
994         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
995         struct hlist_nulls_head *head;
996         struct bucket *b;
997         struct htab_elem *l;
998         unsigned long flags;
999         u32 hash, key_size;
1000         int ret = -ENOENT;
1001
1002         WARN_ON_ONCE(!rcu_read_lock_held());
1003
1004         key_size = map->key_size;
1005
1006         hash = htab_map_hash(key, key_size);
1007         b = __select_bucket(htab, hash);
1008         head = &b->head;
1009
1010         raw_spin_lock_irqsave(&b->lock, flags);
1011
1012         l = lookup_elem_raw(head, hash, key, key_size);
1013
1014         if (l) {
1015                 hlist_nulls_del_rcu(&l->hash_node);
1016                 free_htab_elem(htab, l);
1017                 ret = 0;
1018         }
1019
1020         raw_spin_unlock_irqrestore(&b->lock, flags);
1021         return ret;
1022 }
1023
1024 static int htab_lru_map_delete_elem(struct bpf_map *map, void *key)
1025 {
1026         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
1027         struct hlist_nulls_head *head;
1028         struct bucket *b;
1029         struct htab_elem *l;
1030         unsigned long flags;
1031         u32 hash, key_size;
1032         int ret = -ENOENT;
1033
1034         WARN_ON_ONCE(!rcu_read_lock_held());
1035
1036         key_size = map->key_size;
1037
1038         hash = htab_map_hash(key, key_size);
1039         b = __select_bucket(htab, hash);
1040         head = &b->head;
1041
1042         raw_spin_lock_irqsave(&b->lock, flags);
1043
1044         l = lookup_elem_raw(head, hash, key, key_size);
1045
1046         if (l) {
1047                 hlist_nulls_del_rcu(&l->hash_node);
1048                 ret = 0;
1049         }
1050
1051         raw_spin_unlock_irqrestore(&b->lock, flags);
1052         if (l)
1053                 bpf_lru_push_free(&htab->lru, &l->lru_node);
1054         return ret;
1055 }
1056
1057 static void delete_all_elements(struct bpf_htab *htab)
1058 {
1059         int i;
1060
1061         for (i = 0; i < htab->n_buckets; i++) {
1062                 struct hlist_nulls_head *head = select_bucket(htab, i);
1063                 struct hlist_nulls_node *n;
1064                 struct htab_elem *l;
1065
1066                 hlist_nulls_for_each_entry_safe(l, n, head, hash_node) {
1067                         hlist_nulls_del_rcu(&l->hash_node);
1068                         htab_elem_free(htab, l);
1069                 }
1070         }
1071 }
1072
1073 /* Called when map->refcnt goes to zero, either from workqueue or from syscall */
1074 static void htab_map_free(struct bpf_map *map)
1075 {
1076         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
1077
1078         /* at this point bpf_prog->aux->refcnt == 0 and this map->refcnt == 0,
1079          * so the programs (can be more than one that used this map) were
1080          * disconnected from events. Wait for outstanding critical sections in
1081          * these programs to complete
1082          */
1083         synchronize_rcu();
1084
1085         /* some of free_htab_elem() callbacks for elements of this map may
1086          * not have executed. Wait for them.
1087          */
1088         rcu_barrier();
1089         if (!htab_is_prealloc(htab))
1090                 delete_all_elements(htab);
1091         else
1092                 prealloc_destroy(htab);
1093
1094         free_percpu(htab->extra_elems);
1095         bpf_map_area_free(htab->buckets);
1096         kfree(htab);
1097 }
1098
1099 static const struct bpf_map_ops htab_ops = {
1100         .map_alloc = htab_map_alloc,
1101         .map_free = htab_map_free,
1102         .map_get_next_key = htab_map_get_next_key,
1103         .map_lookup_elem = htab_map_lookup_elem,
1104         .map_update_elem = htab_map_update_elem,
1105         .map_delete_elem = htab_map_delete_elem,
1106         .map_gen_lookup = htab_map_gen_lookup,
1107 };
1108
1109 static struct bpf_map_type_list htab_type __ro_after_init = {
1110         .ops = &htab_ops,
1111         .type = BPF_MAP_TYPE_HASH,
1112 };
1113
1114 static const struct bpf_map_ops htab_lru_ops = {
1115         .map_alloc = htab_map_alloc,
1116         .map_free = htab_map_free,
1117         .map_get_next_key = htab_map_get_next_key,
1118         .map_lookup_elem = htab_lru_map_lookup_elem,
1119         .map_update_elem = htab_lru_map_update_elem,
1120         .map_delete_elem = htab_lru_map_delete_elem,
1121 };
1122
1123 static struct bpf_map_type_list htab_lru_type __ro_after_init = {
1124         .ops = &htab_lru_ops,
1125         .type = BPF_MAP_TYPE_LRU_HASH,
1126 };
1127
1128 /* Called from eBPF program */
1129 static void *htab_percpu_map_lookup_elem(struct bpf_map *map, void *key)
1130 {
1131         struct htab_elem *l = __htab_map_lookup_elem(map, key);
1132
1133         if (l)
1134                 return this_cpu_ptr(htab_elem_get_ptr(l, map->key_size));
1135         else
1136                 return NULL;
1137 }
1138
1139 static void *htab_lru_percpu_map_lookup_elem(struct bpf_map *map, void *key)
1140 {
1141         struct htab_elem *l = __htab_map_lookup_elem(map, key);
1142
1143         if (l) {
1144                 bpf_lru_node_set_ref(&l->lru_node);
1145                 return this_cpu_ptr(htab_elem_get_ptr(l, map->key_size));
1146         }
1147
1148         return NULL;
1149 }
1150
1151 int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value)
1152 {
1153         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
1154         struct htab_elem *l;
1155         void __percpu *pptr;
1156         int ret = -ENOENT;
1157         int cpu, off = 0;
1158         u32 size;
1159
1160         /* per_cpu areas are zero-filled and bpf programs can only
1161          * access 'value_size' of them, so copying rounded areas
1162          * will not leak any kernel data
1163          */
1164         size = round_up(map->value_size, 8);
1165         rcu_read_lock();
1166         l = __htab_map_lookup_elem(map, key);
1167         if (!l)
1168                 goto out;
1169         if (htab_is_lru(htab))
1170                 bpf_lru_node_set_ref(&l->lru_node);
1171         pptr = htab_elem_get_ptr(l, map->key_size);
1172         for_each_possible_cpu(cpu) {
1173                 bpf_long_memcpy(value + off,
1174                                 per_cpu_ptr(pptr, cpu), size);
1175                 off += size;
1176         }
1177         ret = 0;
1178 out:
1179         rcu_read_unlock();
1180         return ret;
1181 }
1182
1183 int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
1184                            u64 map_flags)
1185 {
1186         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
1187         int ret;
1188
1189         rcu_read_lock();
1190         if (htab_is_lru(htab))
1191                 ret = __htab_lru_percpu_map_update_elem(map, key, value,
1192                                                         map_flags, true);
1193         else
1194                 ret = __htab_percpu_map_update_elem(map, key, value, map_flags,
1195                                                     true);
1196         rcu_read_unlock();
1197
1198         return ret;
1199 }
1200
1201 static const struct bpf_map_ops htab_percpu_ops = {
1202         .map_alloc = htab_map_alloc,
1203         .map_free = htab_map_free,
1204         .map_get_next_key = htab_map_get_next_key,
1205         .map_lookup_elem = htab_percpu_map_lookup_elem,
1206         .map_update_elem = htab_percpu_map_update_elem,
1207         .map_delete_elem = htab_map_delete_elem,
1208 };
1209
1210 static struct bpf_map_type_list htab_percpu_type __ro_after_init = {
1211         .ops = &htab_percpu_ops,
1212         .type = BPF_MAP_TYPE_PERCPU_HASH,
1213 };
1214
1215 static const struct bpf_map_ops htab_lru_percpu_ops = {
1216         .map_alloc = htab_map_alloc,
1217         .map_free = htab_map_free,
1218         .map_get_next_key = htab_map_get_next_key,
1219         .map_lookup_elem = htab_lru_percpu_map_lookup_elem,
1220         .map_update_elem = htab_lru_percpu_map_update_elem,
1221         .map_delete_elem = htab_lru_map_delete_elem,
1222 };
1223
1224 static struct bpf_map_type_list htab_lru_percpu_type __ro_after_init = {
1225         .ops = &htab_lru_percpu_ops,
1226         .type = BPF_MAP_TYPE_LRU_PERCPU_HASH,
1227 };
1228
1229 static struct bpf_map *fd_htab_map_alloc(union bpf_attr *attr)
1230 {
1231         struct bpf_map *map;
1232
1233         if (attr->value_size != sizeof(u32))
1234                 return ERR_PTR(-EINVAL);
1235
1236         /* pointer is stored internally */
1237         attr->value_size = sizeof(void *);
1238         map = htab_map_alloc(attr);
1239         attr->value_size = sizeof(u32);
1240
1241         return map;
1242 }
1243
1244 static void fd_htab_map_free(struct bpf_map *map)
1245 {
1246         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
1247         struct hlist_nulls_node *n;
1248         struct hlist_nulls_head *head;
1249         struct htab_elem *l;
1250         int i;
1251
1252         for (i = 0; i < htab->n_buckets; i++) {
1253                 head = select_bucket(htab, i);
1254
1255                 hlist_nulls_for_each_entry_safe(l, n, head, hash_node) {
1256                         void *ptr = fd_htab_map_get_ptr(map, l);
1257
1258                         map->ops->map_fd_put_ptr(ptr);
1259                 }
1260         }
1261
1262         htab_map_free(map);
1263 }
1264
1265 /* only called from syscall */
1266 int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
1267                                 void *key, void *value, u64 map_flags)
1268 {
1269         void *ptr;
1270         int ret;
1271         u32 ufd = *(u32 *)value;
1272
1273         ptr = map->ops->map_fd_get_ptr(map, map_file, ufd);
1274         if (IS_ERR(ptr))
1275                 return PTR_ERR(ptr);
1276
1277         ret = htab_map_update_elem(map, key, &ptr, map_flags);
1278         if (ret)
1279                 map->ops->map_fd_put_ptr(ptr);
1280
1281         return ret;
1282 }
1283
1284 static struct bpf_map *htab_of_map_alloc(union bpf_attr *attr)
1285 {
1286         struct bpf_map *map, *inner_map_meta;
1287
1288         inner_map_meta = bpf_map_meta_alloc(attr->inner_map_fd);
1289         if (IS_ERR(inner_map_meta))
1290                 return inner_map_meta;
1291
1292         map = fd_htab_map_alloc(attr);
1293         if (IS_ERR(map)) {
1294                 bpf_map_meta_free(inner_map_meta);
1295                 return map;
1296         }
1297
1298         map->inner_map_meta = inner_map_meta;
1299
1300         return map;
1301 }
1302
1303 static void *htab_of_map_lookup_elem(struct bpf_map *map, void *key)
1304 {
1305         struct bpf_map **inner_map  = htab_map_lookup_elem(map, key);
1306
1307         if (!inner_map)
1308                 return NULL;
1309
1310         return READ_ONCE(*inner_map);
1311 }
1312
1313 static void htab_of_map_free(struct bpf_map *map)
1314 {
1315         bpf_map_meta_free(map->inner_map_meta);
1316         fd_htab_map_free(map);
1317 }
1318
1319 static const struct bpf_map_ops htab_of_map_ops = {
1320         .map_alloc = htab_of_map_alloc,
1321         .map_free = htab_of_map_free,
1322         .map_get_next_key = htab_map_get_next_key,
1323         .map_lookup_elem = htab_of_map_lookup_elem,
1324         .map_delete_elem = htab_map_delete_elem,
1325         .map_fd_get_ptr = bpf_map_fd_get_ptr,
1326         .map_fd_put_ptr = bpf_map_fd_put_ptr,
1327 };
1328
1329 static struct bpf_map_type_list htab_of_map_type __ro_after_init = {
1330         .ops = &htab_of_map_ops,
1331         .type = BPF_MAP_TYPE_HASH_OF_MAPS,
1332 };
1333
1334 static int __init register_htab_map(void)
1335 {
1336         bpf_register_map_type(&htab_type);
1337         bpf_register_map_type(&htab_percpu_type);
1338         bpf_register_map_type(&htab_lru_type);
1339         bpf_register_map_type(&htab_lru_percpu_type);
1340         bpf_register_map_type(&htab_of_map_type);
1341         return 0;
1342 }
1343 late_initcall(register_htab_map);