Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 1 | /* |
Sven Eckelmann | 567db7b | 2012-01-01 00:41:38 +0100 | [diff] [blame] | 2 | * Copyright (C) 2006-2012 B.A.T.M.A.N. contributors: |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 3 | * |
| 4 | * Simon Wunderlich, Marek Lindner |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or |
| 7 | * modify it under the terms of version 2 of the GNU General Public |
| 8 | * License as published by the Free Software Foundation. |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, but |
| 11 | * WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 13 | * General Public License for more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU General Public License |
| 16 | * along with this program; if not, write to the Free Software |
| 17 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
| 18 | * 02110-1301, USA |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | #ifndef _NET_BATMAN_ADV_HASH_H_ |
| 23 | #define _NET_BATMAN_ADV_HASH_H_ |
| 24 | |
| 25 | #include <linux/list.h> |
| 26 | |
| 27 | /* callback to a compare function. should |
| 28 | * compare 2 element datas for their keys, |
| 29 | * return 0 if same and not 0 if not |
| 30 | * same */ |
Sven Eckelmann | 747e422 | 2011-05-14 23:14:50 +0200 | [diff] [blame] | 31 | typedef int (*hashdata_compare_cb)(const struct hlist_node *, const void *); |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 32 | |
| 33 | /* the hashfunction, should return an index |
| 34 | * based on the key in the data of the first |
| 35 | * argument and the size the second */ |
Antonio Quartulli | c90681b | 2011-10-05 17:05:25 +0200 | [diff] [blame] | 36 | typedef uint32_t (*hashdata_choose_cb)(const void *, uint32_t); |
Marek Lindner | 7aadf88 | 2011-02-18 12:28:09 +0000 | [diff] [blame] | 37 | typedef void (*hashdata_free_cb)(struct hlist_node *, void *); |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 38 | |
| 39 | struct hashtable_t { |
Marek Lindner | fb778ea | 2011-01-19 20:01:40 +0000 | [diff] [blame] | 40 | struct hlist_head *table; /* the hashtable itself with the buckets */ |
| 41 | spinlock_t *list_locks; /* spinlock for each hash list entry */ |
Antonio Quartulli | c90681b | 2011-10-05 17:05:25 +0200 | [diff] [blame] | 42 | uint32_t size; /* size of hashtable */ |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 43 | }; |
| 44 | |
| 45 | /* allocates and clears the hash */ |
Sven Eckelmann | 1a8eaf0 | 2012-05-12 02:09:32 +0200 | [diff] [blame] | 46 | struct hashtable_t *batadv_hash_new(uint32_t size); |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 47 | |
Sven Eckelmann | 5d52dad | 2012-03-29 12:38:20 +0200 | [diff] [blame] | 48 | /* set class key for all locks */ |
| 49 | void batadv_hash_set_lock_class(struct hashtable_t *hash, |
| 50 | struct lock_class_key *key); |
| 51 | |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 52 | /* free only the hashtable and the hash itself. */ |
Sven Eckelmann | 1a8eaf0 | 2012-05-12 02:09:32 +0200 | [diff] [blame] | 53 | void batadv_hash_destroy(struct hashtable_t *hash); |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 54 | |
| 55 | /* remove the hash structure. if hashdata_free_cb != NULL, this function will be |
| 56 | * called to remove the elements inside of the hash. if you don't remove the |
| 57 | * elements, memory might be leaked. */ |
| 58 | static inline void hash_delete(struct hashtable_t *hash, |
| 59 | hashdata_free_cb free_cb, void *arg) |
| 60 | { |
| 61 | struct hlist_head *head; |
Marek Lindner | 7aadf88 | 2011-02-18 12:28:09 +0000 | [diff] [blame] | 62 | struct hlist_node *node, *node_tmp; |
Marek Lindner | fb778ea | 2011-01-19 20:01:40 +0000 | [diff] [blame] | 63 | spinlock_t *list_lock; /* spinlock to protect write access */ |
Antonio Quartulli | c90681b | 2011-10-05 17:05:25 +0200 | [diff] [blame] | 64 | uint32_t i; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 65 | |
| 66 | for (i = 0; i < hash->size; i++) { |
| 67 | head = &hash->table[i]; |
Marek Lindner | fb778ea | 2011-01-19 20:01:40 +0000 | [diff] [blame] | 68 | list_lock = &hash->list_locks[i]; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 69 | |
Marek Lindner | fb778ea | 2011-01-19 20:01:40 +0000 | [diff] [blame] | 70 | spin_lock_bh(list_lock); |
Marek Lindner | 7aadf88 | 2011-02-18 12:28:09 +0000 | [diff] [blame] | 71 | hlist_for_each_safe(node, node_tmp, head) { |
| 72 | hlist_del_rcu(node); |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 73 | |
Marek Lindner | 7aadf88 | 2011-02-18 12:28:09 +0000 | [diff] [blame] | 74 | if (free_cb) |
| 75 | free_cb(node, arg); |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 76 | } |
Marek Lindner | fb778ea | 2011-01-19 20:01:40 +0000 | [diff] [blame] | 77 | spin_unlock_bh(list_lock); |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 78 | } |
| 79 | |
Sven Eckelmann | 1a8eaf0 | 2012-05-12 02:09:32 +0200 | [diff] [blame] | 80 | batadv_hash_destroy(hash); |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 81 | } |
| 82 | |
Antonio Quartulli | 1a1f37d | 2011-07-10 00:36:36 +0200 | [diff] [blame] | 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 | |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 95 | static inline int hash_add(struct hashtable_t *hash, |
| 96 | hashdata_compare_cb compare, |
Marek Lindner | 7aadf88 | 2011-02-18 12:28:09 +0000 | [diff] [blame] | 97 | hashdata_choose_cb choose, |
Sven Eckelmann | 747e422 | 2011-05-14 23:14:50 +0200 | [diff] [blame] | 98 | const void *data, struct hlist_node *data_node) |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 99 | { |
Antonio Quartulli | c90681b | 2011-10-05 17:05:25 +0200 | [diff] [blame] | 100 | uint32_t index; |
| 101 | int ret = -1; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 102 | struct hlist_head *head; |
Marek Lindner | 7aadf88 | 2011-02-18 12:28:09 +0000 | [diff] [blame] | 103 | struct hlist_node *node; |
Marek Lindner | fb778ea | 2011-01-19 20:01:40 +0000 | [diff] [blame] | 104 | spinlock_t *list_lock; /* spinlock to protect write access */ |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 105 | |
| 106 | if (!hash) |
Antonio Quartulli | 1a1f37d | 2011-07-10 00:36:36 +0200 | [diff] [blame] | 107 | goto out; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 108 | |
| 109 | index = choose(data, hash->size); |
| 110 | head = &hash->table[index]; |
Marek Lindner | fb778ea | 2011-01-19 20:01:40 +0000 | [diff] [blame] | 111 | list_lock = &hash->list_locks[index]; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 112 | |
Matthias Schiffer | 75c5a2e | 2012-05-08 22:31:57 +0200 | [diff] [blame] | 113 | spin_lock_bh(list_lock); |
| 114 | |
| 115 | hlist_for_each(node, head) { |
Marek Lindner | 7aadf88 | 2011-02-18 12:28:09 +0000 | [diff] [blame] | 116 | if (!compare(node, data)) |
| 117 | continue; |
| 118 | |
Antonio Quartulli | 1a1f37d | 2011-07-10 00:36:36 +0200 | [diff] [blame] | 119 | ret = 1; |
Matthias Schiffer | 75c5a2e | 2012-05-08 22:31:57 +0200 | [diff] [blame] | 120 | goto unlock; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 121 | } |
| 122 | |
| 123 | /* no duplicate found in list, add new element */ |
Marek Lindner | 7aadf88 | 2011-02-18 12:28:09 +0000 | [diff] [blame] | 124 | hlist_add_head_rcu(data_node, head); |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 125 | |
Antonio Quartulli | 1a1f37d | 2011-07-10 00:36:36 +0200 | [diff] [blame] | 126 | ret = 0; |
Marek Lindner | fb778ea | 2011-01-19 20:01:40 +0000 | [diff] [blame] | 127 | |
Matthias Schiffer | 75c5a2e | 2012-05-08 22:31:57 +0200 | [diff] [blame] | 128 | unlock: |
| 129 | spin_unlock_bh(list_lock); |
Antonio Quartulli | 1a1f37d | 2011-07-10 00:36:36 +0200 | [diff] [blame] | 130 | out: |
| 131 | return ret; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 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 | static inline void *hash_remove(struct hashtable_t *hash, |
| 139 | hashdata_compare_cb compare, |
| 140 | hashdata_choose_cb choose, void *data) |
| 141 | { |
Antonio Quartulli | c90681b | 2011-10-05 17:05:25 +0200 | [diff] [blame] | 142 | uint32_t index; |
Marek Lindner | 7aadf88 | 2011-02-18 12:28:09 +0000 | [diff] [blame] | 143 | struct hlist_node *node; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 144 | struct hlist_head *head; |
Marek Lindner | fb778ea | 2011-01-19 20:01:40 +0000 | [diff] [blame] | 145 | void *data_save = NULL; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 146 | |
| 147 | index = choose(data, hash->size); |
| 148 | head = &hash->table[index]; |
| 149 | |
Marek Lindner | fb778ea | 2011-01-19 20:01:40 +0000 | [diff] [blame] | 150 | spin_lock_bh(&hash->list_locks[index]); |
Marek Lindner | 7aadf88 | 2011-02-18 12:28:09 +0000 | [diff] [blame] | 151 | hlist_for_each(node, head) { |
| 152 | if (!compare(node, data)) |
| 153 | continue; |
| 154 | |
| 155 | data_save = node; |
| 156 | hlist_del_rcu(node); |
| 157 | break; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 158 | } |
Marek Lindner | fb778ea | 2011-01-19 20:01:40 +0000 | [diff] [blame] | 159 | spin_unlock_bh(&hash->list_locks[index]); |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 160 | |
Marek Lindner | fb778ea | 2011-01-19 20:01:40 +0000 | [diff] [blame] | 161 | return data_save; |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 162 | } |
| 163 | |
Sven Eckelmann | c6c8fea | 2010-12-13 11:19:28 +0000 | [diff] [blame] | 164 | #endif /* _NET_BATMAN_ADV_HASH_H_ */ |