kernel/bpf/hashtab.c

   1 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
   2  *
   3  * This program is free software; you can redistribute it and/or
   4  * modify it under the terms of version 2 of the GNU General Public
   5  * License as published by the Free Software Foundation.
   6  *
   7  * This program is distributed in the hope that it will be useful, but
   8  * WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  10  * General Public License for more details.
  11  */
  12 #include <linux/bpf.h>
  13 #include <linux/jhash.h>
  14 #include <linux/filter.h>
  15 #include <linux/vmalloc.h>
  16
  17 struct bpf_htab {
  18         struct bpf_map map;
  19         struct hlist_head *buckets;
  20         raw_spinlock_t lock;
  21         u32 count;      /* number of elements in this hashtable */
  22         u32 n_buckets;  /* number of hash buckets */
  23         u32 elem_size;  /* size of each element in bytes */
  24 };
  25
  26 /* each htab element is struct htab_elem + key + value */
  27 struct htab_elem {
  28         struct hlist_node hash_node;
  29         struct rcu_head rcu;
  30         u32 hash;
  31         char key[0] __aligned(8);
  32 };
  33
  34 /* Called from syscall */
  35 static struct bpf_map *htab_map_alloc(union bpf_attr *attr)
  36 {
  37         struct bpf_htab *htab;
  38         int err, i;
  39
  40         htab = kzalloc(sizeof(*htab), GFP_USER);
  41         if (!htab)
  42                 return ERR_PTR(-ENOMEM);
  43
  44         /* mandatory map attributes */
  45         htab->map.key_size = attr->key_size;
  46         htab->map.value_size = attr->value_size;
  47         htab->map.max_entries = attr->max_entries;
  48
  49         /* check sanity of attributes.
  50          * value_size == 0 may be allowed in the future to use map as a set
  51          */
  52         err = -EINVAL;
  53         if (htab->map.max_entries == 0 || htab->map.key_size == 0 ||
  54             htab->map.value_size == 0)
  55                 goto free_htab;
  56
  57         /* hash table size must be power of 2 */
  58         htab->n_buckets = roundup_pow_of_two(htab->map.max_entries);
  59
  60         err = -E2BIG;
  61         if (htab->map.key_size > MAX_BPF_STACK)
  62                 /* eBPF programs initialize keys on stack, so they cannot be
  63                  * larger than max stack size
  64                  */
  65                 goto free_htab;
  66
  67         if (htab->map.value_size >= (1 << (KMALLOC_SHIFT_MAX - 1)) -
  68             MAX_BPF_STACK - sizeof(struct htab_elem))
  69                 /* if value_size is bigger, the user space won't be able to
  70                  * access the elements via bpf syscall. This check also makes
  71                  * sure that the elem_size doesn't overflow and it's
  72                  * kmalloc-able later in htab_map_update_elem()
  73                  */
  74                 goto free_htab;
  75
  76         htab->elem_size = sizeof(struct htab_elem) +
  77                           round_up(htab->map.key_size, 8) +
  78                           htab->map.value_size;
  79
  80         /* prevent zero size kmalloc and check for u32 overflow */
  81         if (htab->n_buckets == 0 ||
  82             htab->n_buckets > U32_MAX / sizeof(struct hlist_head))
  83                 goto free_htab;
  84
  85         if ((u64) htab->n_buckets * sizeof(struct hlist_head) +
  86             (u64) htab->elem_size * htab->map.max_entries >=
  87             U32_MAX - PAGE_SIZE)
  88                 /* make sure page count doesn't overflow */
  89                 goto free_htab;
  90
  91         htab->map.pages = round_up(htab->n_buckets * sizeof(struct hlist_head) +
  92                                    htab->elem_size * htab->map.max_entries,
  93                                    PAGE_SIZE) >> PAGE_SHIFT;
  94
  95         err = -ENOMEM;
  96         htab->buckets = kmalloc_array(htab->n_buckets, sizeof(struct hlist_head),
  97                                       GFP_USER | __GFP_NOWARN);
  98
  99         if (!htab->buckets) {
 100                 htab->buckets = vmalloc(htab->n_buckets * sizeof(struct hlist_head));
 101                 if (!htab->buckets)
 102                         goto free_htab;
 103         }
 104
 105         for (i = 0; i < htab->n_buckets; i++)
 106                 INIT_HLIST_HEAD(&htab->buckets[i]);
 107
 108         raw_spin_lock_init(&htab->lock);
 109         htab->count = 0;
 110
 111         return &htab->map;
 112
 113 free_htab:
 114         kfree(htab);
 115         return ERR_PTR(err);
 116 }
 117
 118 static inline u32 htab_map_hash(const void *key, u32 key_len)
 119 {
 120         return jhash(key, key_len, 0);
 121 }
 122
 123 static inline struct hlist_head *select_bucket(struct bpf_htab *htab, u32 hash)
 124 {
 125         return &htab->buckets[hash & (htab->n_buckets - 1)];
 126 }
 127
 128 static struct htab_elem *lookup_elem_raw(struct hlist_head *head, u32 hash,
 129                                          void *key, u32 key_size)
 130 {
 131         struct htab_elem *l;
 132
 133         hlist_for_each_entry_rcu(l, head, hash_node)
 134                 if (l->hash == hash && !memcmp(&l->key, key, key_size))
 135                         return l;
 136
 137         return NULL;
 138 }
 139
 140 /* Called from syscall or from eBPF program */
 141 static void *htab_map_lookup_elem(struct bpf_map *map, void *key)
 142 {
 143         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
 144         struct hlist_head *head;
 145         struct htab_elem *l;
 146         u32 hash, key_size;
 147
 148         /* Must be called with rcu_read_lock. */
 149         WARN_ON_ONCE(!rcu_read_lock_held());
 150
 151         key_size = map->key_size;
 152
 153         hash = htab_map_hash(key, key_size);
 154
 155         head = select_bucket(htab, hash);
 156
 157         l = lookup_elem_raw(head, hash, key, key_size);
 158
 159         if (l)
 160                 return l->key + round_up(map->key_size, 8);
 161
 162         return NULL;
 163 }
 164
 165 /* Called from syscall */
 166 static int htab_map_get_next_key(struct bpf_map *map, void *key, void *next_key)
 167 {
 168         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
 169         struct hlist_head *head;
 170         struct htab_elem *l, *next_l;
 171         u32 hash, key_size;
 172         int i = 0;
 173
 174         WARN_ON_ONCE(!rcu_read_lock_held());
 175
 176         key_size = map->key_size;
 177
 178         if (!key)
 179                 goto find_first_elem;
 180
 181         hash = htab_map_hash(key, key_size);
 182
 183         head = select_bucket(htab, hash);
 184
 185         /* lookup the key */
 186         l = lookup_elem_raw(head, hash, key, key_size);
 187
 188         if (!l)
 189                 goto find_first_elem;
 190
 191         /* key was found, get next key in the same bucket */
 192         next_l = hlist_entry_safe(rcu_dereference_raw(hlist_next_rcu(&l->hash_node)),
 193                                   struct htab_elem, hash_node);
 194
 195         if (next_l) {
 196                 /* if next elem in this hash list is non-zero, just return it */
 197                 memcpy(next_key, next_l->key, key_size);
 198                 return 0;
 199         }
 200
 201         /* no more elements in this hash list, go to the next bucket */
 202         i = hash & (htab->n_buckets - 1);
 203         i++;
 204
 205 find_first_elem:
 206         /* iterate over buckets */
 207         for (; i < htab->n_buckets; i++) {
 208                 head = select_bucket(htab, i);
 209
 210                 /* pick first element in the bucket */
 211                 next_l = hlist_entry_safe(rcu_dereference_raw(hlist_first_rcu(head)),
 212                                           struct htab_elem, hash_node);
 213                 if (next_l) {
 214                         /* if it's not empty, just return it */
 215                         memcpy(next_key, next_l->key, key_size);
 216                         return 0;
 217                 }
 218         }
 219
 220         /* itereated over all buckets and all elements */
 221         return -ENOENT;
 222 }
 223
 224 /* Called from syscall or from eBPF program */
 225 static int htab_map_update_elem(struct bpf_map *map, void *key, void *value,
 226                                 u64 map_flags)
 227 {
 228         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
 229         struct htab_elem *l_new, *l_old;
 230         struct hlist_head *head;
 231         unsigned long flags;
 232         u32 key_size;
 233         int ret;
 234
 235         if (map_flags > BPF_EXIST)
 236                 /* unknown flags */
 237                 return -EINVAL;
 238
 239         WARN_ON_ONCE(!rcu_read_lock_held());
 240
 241         /* allocate new element outside of lock */
 242         l_new = kmalloc(htab->elem_size, GFP_ATOMIC | __GFP_NOWARN);
 243         if (!l_new)
 244                 return -ENOMEM;
 245
 246         key_size = map->key_size;
 247
 248         memcpy(l_new->key, key, key_size);
 249         memcpy(l_new->key + round_up(key_size, 8), value, map->value_size);
 250
 251         l_new->hash = htab_map_hash(l_new->key, key_size);
 252
 253         /* bpf_map_update_elem() can be called in_irq() */
 254         raw_spin_lock_irqsave(&htab->lock, flags);
 255
 256         head = select_bucket(htab, l_new->hash);
 257
 258         l_old = lookup_elem_raw(head, l_new->hash, key, key_size);
 259
 260         if (!l_old && unlikely(htab->count >= map->max_entries)) {
 261                 /* if elem with this 'key' doesn't exist and we've reached
 262                  * max_entries limit, fail insertion of new elem
 263                  */
 264                 ret = -E2BIG;
 265                 goto err;
 266         }
 267
 268         if (l_old && map_flags == BPF_NOEXIST) {
 269                 /* elem already exists */
 270                 ret = -EEXIST;
 271                 goto err;
 272         }
 273
 274         if (!l_old && map_flags == BPF_EXIST) {
 275                 /* elem doesn't exist, cannot update it */
 276                 ret = -ENOENT;
 277                 goto err;
 278         }
 279
 280         /* add new element to the head of the list, so that concurrent
 281          * search will find it before old elem
 282          */
 283         hlist_add_head_rcu(&l_new->hash_node, head);
 284         if (l_old) {
 285                 hlist_del_rcu(&l_old->hash_node);
 286                 kfree_rcu(l_old, rcu);
 287         } else {
 288                 htab->count++;
 289         }
 290         raw_spin_unlock_irqrestore(&htab->lock, flags);
 291
 292         return 0;
 293 err:
 294         raw_spin_unlock_irqrestore(&htab->lock, flags);
 295         kfree(l_new);
 296         return ret;
 297 }
 298
 299 /* Called from syscall or from eBPF program */
 300 static int htab_map_delete_elem(struct bpf_map *map, void *key)
 301 {
 302         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
 303         struct hlist_head *head;
 304         struct htab_elem *l;
 305         unsigned long flags;
 306         u32 hash, key_size;
 307         int ret = -ENOENT;
 308
 309         WARN_ON_ONCE(!rcu_read_lock_held());
 310
 311         key_size = map->key_size;
 312
 313         hash = htab_map_hash(key, key_size);
 314
 315         raw_spin_lock_irqsave(&htab->lock, flags);
 316
 317         head = select_bucket(htab, hash);
 318
 319         l = lookup_elem_raw(head, hash, key, key_size);
 320
 321         if (l) {
 322                 hlist_del_rcu(&l->hash_node);
 323                 htab->count--;
 324                 kfree_rcu(l, rcu);
 325                 ret = 0;
 326         }
 327
 328         raw_spin_unlock_irqrestore(&htab->lock, flags);
 329         return ret;
 330 }
 331
 332 static void delete_all_elements(struct bpf_htab *htab)
 333 {
 334         int i;
 335
 336         for (i = 0; i < htab->n_buckets; i++) {
 337                 struct hlist_head *head = select_bucket(htab, i);
 338                 struct hlist_node *n;
 339                 struct htab_elem *l;
 340
 341                 hlist_for_each_entry_safe(l, n, head, hash_node) {
 342                         hlist_del_rcu(&l->hash_node);
 343                         htab->count--;
 344                         kfree(l);
 345                 }
 346         }
 347 }
 348
 349 /* Called when map->refcnt goes to zero, either from workqueue or from syscall */
 350 static void htab_map_free(struct bpf_map *map)
 351 {
 352         struct bpf_htab *htab = container_of(map, struct bpf_htab, map);
 353
 354         /* at this point bpf_prog->aux->refcnt == 0 and this map->refcnt == 0,
 355          * so the programs (can be more than one that used this map) were
 356          * disconnected from events. Wait for outstanding critical sections in
 357          * these programs to complete
 358          */
 359         synchronize_rcu();
 360
 361         /* some of kfree_rcu() callbacks for elements of this map may not have
 362          * executed. It's ok. Proceed to free residual elements and map itself
 363          */
 364         delete_all_elements(htab);
 365         kvfree(htab->buckets);
 366         kfree(htab);
 367 }
 368
 369 static const struct bpf_map_ops htab_ops = {
 370         .map_alloc = htab_map_alloc,
 371         .map_free = htab_map_free,
 372         .map_get_next_key = htab_map_get_next_key,
 373         .map_lookup_elem = htab_map_lookup_elem,
 374         .map_update_elem = htab_map_update_elem,
 375         .map_delete_elem = htab_map_delete_elem,
 376 };
 377
 378 static struct bpf_map_type_list htab_type __read_mostly = {
 379         .ops = &htab_ops,
 380         .type = BPF_MAP_TYPE_HASH,
 381 };
 382
 383 static int __init register_htab_map(void)
 384 {
 385         bpf_register_map_type(&htab_type);
 386         return 0;
 387 }
 388 late_initcall(register_htab_map);