net/batman-adv/hash.h

   1 /* Copyright (C) 2006-2012 B.A.T.M.A.N. contributors:
   2  *
   3  * Simon Wunderlich, Marek Lindner
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of version 2 of the GNU General Public
   7  * License as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17  * 02110-1301, USA
  18  */
  19
  20 #ifndef _NET_BATMAN_ADV_HASH_H_
  21 #define _NET_BATMAN_ADV_HASH_H_
  22
  23 #include <linux/list.h>
  24
  25 /* callback to a compare function.  should compare 2 element datas for their
  26  * keys, return 0 if same and not 0 if not same
  27  */
  28 typedef int (*batadv_hashdata_compare_cb)(const struct hlist_node *,
  29                                           const void *);
  30
  31 /* the hashfunction, should return an index
  32  * based on the key in the data of the first
  33  * argument and the size the second
  34  */
  35 typedef uint32_t (*batadv_hashdata_choose_cb)(const void *, uint32_t);
  36 typedef void (*batadv_hashdata_free_cb)(struct hlist_node *, void *);
  37
  38 struct batadv_hashtable {
  39         struct hlist_head *table;   /* the hashtable itself with the buckets */
  40         spinlock_t *list_locks;     /* spinlock for each hash list entry */
  41         uint32_t size;              /* size of hashtable */
  42 };
  43
  44 /* allocates and clears the hash */
  45 struct batadv_hashtable *batadv_hash_new(uint32_t size);
  46
  47 /* set class key for all locks */
  48 void batadv_hash_set_lock_class(struct batadv_hashtable *hash,
  49                                 struct lock_class_key *key);
  50
  51 /* free only the hashtable and the hash itself. */
  52 void batadv_hash_destroy(struct batadv_hashtable *hash);
  53
  54 /* remove the hash structure. if hashdata_free_cb != NULL, this function will be
  55  * called to remove the elements inside of the hash.  if you don't remove the
  56  * elements, memory might be leaked.
  57  */
  58 static inline void batadv_hash_delete(struct batadv_hashtable *hash,
  59                                       batadv_hashdata_free_cb free_cb,
  60                                       void *arg)
  61 {
  62         struct hlist_head *head;
  63         struct hlist_node *node, *node_tmp;
  64         spinlock_t *list_lock; /* spinlock to protect write access */
  65         uint32_t i;
  66
  67         for (i = 0; i < hash->size; i++) {
  68                 head = &hash->table[i];
  69                 list_lock = &hash->list_locks[i];
  70
  71                 spin_lock_bh(list_lock);
  72                 hlist_for_each_safe(node, node_tmp, head) {
  73                         hlist_del_rcu(node);
  74
  75                         if (free_cb)
  76                                 free_cb(node, arg);
  77                 }
  78                 spin_unlock_bh(list_lock);
  79         }
  80
  81         batadv_hash_destroy(hash);
  82 }
  83
  84 /*      hash_add - adds data to the hashtable
  85  *      @hash: storage hash table
  86  *      @compare: callback to determine if 2 hash elements are identical
  87  *      @choose: callback calculating the hash index
  88  *      @data: data passed to the aforementioned callbacks as argument
  89  *      @data_node: to be added element
  90  *
  91  *      Returns 0 on success, 1 if the element already is in the hash
  92  *      and -1 on error.
  93  */
  94 static inline int batadv_hash_add(struct batadv_hashtable *hash,
  95                                   batadv_hashdata_compare_cb compare,
  96                                   batadv_hashdata_choose_cb choose,
  97                                   const void *data,
  98                                   struct hlist_node *data_node)
  99 {
 100         uint32_t index;
 101         int ret = -1;
 102         struct hlist_head *head;
 103         struct hlist_node *node;
 104         spinlock_t *list_lock; /* spinlock to protect write access */
 105
 106         if (!hash)
 107                 goto out;
 108
 109         index = choose(data, hash->size);
 110         head = &hash->table[index];
 111         list_lock = &hash->list_locks[index];
 112
 113         spin_lock_bh(list_lock);
 114
 115         hlist_for_each(node, head) {
 116                 if (!compare(node, data))
 117                         continue;
 118
 119                 ret = 1;
 120                 goto unlock;
 121         }
 122
 123         /* no duplicate found in list, add new element */
 124         hlist_add_head_rcu(data_node, head);
 125
 126         ret = 0;
 127
 128 unlock:
 129         spin_unlock_bh(list_lock);
 130 out:
 131         return ret;
 132 }
 133
 134 /* removes data from hash, if found. returns pointer do data on success, so you
 135  * can remove the used structure yourself, or NULL on error .  data could be the
 136  * structure you use with just the key filled, we just need the key for
 137  * comparing.
 138  */
 139 static inline void *batadv_hash_remove(struct batadv_hashtable *hash,
 140                                        batadv_hashdata_compare_cb compare,
 141                                        batadv_hashdata_choose_cb choose,
 142                                        void *data)
 143 {
 144         uint32_t index;
 145         struct hlist_node *node;
 146         struct hlist_head *head;
 147         void *data_save = NULL;
 148
 149         index = choose(data, hash->size);
 150         head = &hash->table[index];
 151
 152         spin_lock_bh(&hash->list_locks[index]);
 153         hlist_for_each(node, head) {
 154                 if (!compare(node, data))
 155                         continue;
 156
 157                 data_save = node;
 158                 hlist_del_rcu(node);
 159                 break;
 160         }
 161         spin_unlock_bh(&hash->list_locks[index]);
 162
 163         return data_save;
 164 }
 165
 166 #endif /* _NET_BATMAN_ADV_HASH_H_ */