1 // SPDX-License-Identifier: GPL-2.0-only
2 #include <linux/spinlock.h>
3 #include <linux/slab.h>
4 #include <linux/list.h>
5 #include <linux/list_bl.h>
6 #include <linux/module.h>
7 #include <linux/sched.h>
8 #include <linux/workqueue.h>
9 #include <linux/mbcache.h>
12 * Mbcache is a simple key-value store. Keys need not be unique, however
13 * key-value pairs are expected to be unique (we use this fact in
14 * mb_cache_entry_delete_or_get()).
16 * Ext2 and ext4 use this cache for deduplication of extended attribute blocks.
17 * Ext4 also uses it for deduplication of xattr values stored in inodes.
18 * They use hash of data as a key and provide a value that may represent a
19 * block or inode number. That's why keys need not be unique (hash of different
20 * data may be the same). However user provided value always uniquely
21 * identifies a cache entry.
23 * We provide functions for creation and removal of entries, search by key,
24 * and a special "delete entry with given key-value pair" operation. Fixed
25 * size hash table is used for fast key lookups.
29 /* Hash table of entries */
30 struct hlist_bl_head *c_hash;
31 /* log2 of hash table size */
33 /* Maximum entries in cache to avoid degrading hash too much */
34 unsigned long c_max_entries;
35 /* Protects c_list, c_entry_count */
36 spinlock_t c_list_lock;
37 struct list_head c_list;
38 /* Number of entries in cache */
39 unsigned long c_entry_count;
40 struct shrinker c_shrink;
41 /* Work for shrinking when the cache has too many entries */
42 struct work_struct c_shrink_work;
45 static struct kmem_cache *mb_entry_cache;
47 static unsigned long mb_cache_shrink(struct mb_cache *cache,
48 unsigned long nr_to_scan);
50 static inline struct hlist_bl_head *mb_cache_entry_head(struct mb_cache *cache,
53 return &cache->c_hash[hash_32(key, cache->c_bucket_bits)];
57 * Number of entries to reclaim synchronously when there are too many entries
60 #define SYNC_SHRINK_BATCH 64
63 * mb_cache_entry_create - create entry in cache
64 * @cache - cache where the entry should be created
65 * @mask - gfp mask with which the entry should be allocated
66 * @key - key of the entry
67 * @value - value of the entry
68 * @reusable - is the entry reusable by others?
70 * Creates entry in @cache with key @key and value @value. The function returns
71 * -EBUSY if entry with the same key and value already exists in cache.
72 * Otherwise 0 is returned.
74 int mb_cache_entry_create(struct mb_cache *cache, gfp_t mask, u32 key,
75 u64 value, bool reusable)
77 struct mb_cache_entry *entry, *dup;
78 struct hlist_bl_node *dup_node;
79 struct hlist_bl_head *head;
81 /* Schedule background reclaim if there are too many entries */
82 if (cache->c_entry_count >= cache->c_max_entries)
83 schedule_work(&cache->c_shrink_work);
84 /* Do some sync reclaim if background reclaim cannot keep up */
85 if (cache->c_entry_count >= 2*cache->c_max_entries)
86 mb_cache_shrink(cache, SYNC_SHRINK_BATCH);
88 entry = kmem_cache_alloc(mb_entry_cache, mask);
92 INIT_LIST_HEAD(&entry->e_list);
94 * We create entry with two references. One reference is kept by the
95 * hash table, the other reference is used to protect us from
96 * mb_cache_entry_delete_or_get() until the entry is fully setup. This
97 * avoids nesting of cache->c_list_lock into hash table bit locks which
98 * is problematic for RT.
100 atomic_set(&entry->e_refcnt, 2);
102 entry->e_value = value;
105 set_bit(MBE_REUSABLE_B, &entry->e_flags);
106 head = mb_cache_entry_head(cache, key);
108 hlist_bl_for_each_entry(dup, dup_node, head, e_hash_list) {
109 if (dup->e_key == key && dup->e_value == value) {
110 hlist_bl_unlock(head);
111 kmem_cache_free(mb_entry_cache, entry);
115 hlist_bl_add_head(&entry->e_hash_list, head);
116 hlist_bl_unlock(head);
117 spin_lock(&cache->c_list_lock);
118 list_add_tail(&entry->e_list, &cache->c_list);
119 cache->c_entry_count++;
120 spin_unlock(&cache->c_list_lock);
121 mb_cache_entry_put(cache, entry);
125 EXPORT_SYMBOL(mb_cache_entry_create);
127 void __mb_cache_entry_free(struct mb_cache *cache, struct mb_cache_entry *entry)
129 struct hlist_bl_head *head;
131 head = mb_cache_entry_head(cache, entry->e_key);
133 hlist_bl_del(&entry->e_hash_list);
134 hlist_bl_unlock(head);
135 kmem_cache_free(mb_entry_cache, entry);
137 EXPORT_SYMBOL(__mb_cache_entry_free);
140 * mb_cache_entry_wait_unused - wait to be the last user of the entry
142 * @entry - entry to work on
144 * Wait to be the last user of the entry.
146 void mb_cache_entry_wait_unused(struct mb_cache_entry *entry)
148 wait_var_event(&entry->e_refcnt, atomic_read(&entry->e_refcnt) <= 2);
150 EXPORT_SYMBOL(mb_cache_entry_wait_unused);
152 static struct mb_cache_entry *__entry_find(struct mb_cache *cache,
153 struct mb_cache_entry *entry,
156 struct mb_cache_entry *old_entry = entry;
157 struct hlist_bl_node *node;
158 struct hlist_bl_head *head;
160 head = mb_cache_entry_head(cache, key);
162 if (entry && !hlist_bl_unhashed(&entry->e_hash_list))
163 node = entry->e_hash_list.next;
165 node = hlist_bl_first(head);
167 entry = hlist_bl_entry(node, struct mb_cache_entry,
169 if (entry->e_key == key &&
170 test_bit(MBE_REUSABLE_B, &entry->e_flags) &&
171 atomic_inc_not_zero(&entry->e_refcnt))
177 hlist_bl_unlock(head);
179 mb_cache_entry_put(cache, old_entry);
185 * mb_cache_entry_find_first - find the first reusable entry with the given key
186 * @cache: cache where we should search
187 * @key: key to look for
189 * Search in @cache for a reusable entry with key @key. Grabs reference to the
190 * first reusable entry found and returns the entry.
192 struct mb_cache_entry *mb_cache_entry_find_first(struct mb_cache *cache,
195 return __entry_find(cache, NULL, key);
197 EXPORT_SYMBOL(mb_cache_entry_find_first);
200 * mb_cache_entry_find_next - find next reusable entry with the same key
201 * @cache: cache where we should search
202 * @entry: entry to start search from
204 * Finds next reusable entry in the hash chain which has the same key as @entry.
205 * If @entry is unhashed (which can happen when deletion of entry races with the
206 * search), finds the first reusable entry in the hash chain. The function drops
207 * reference to @entry and returns with a reference to the found entry.
209 struct mb_cache_entry *mb_cache_entry_find_next(struct mb_cache *cache,
210 struct mb_cache_entry *entry)
212 return __entry_find(cache, entry, entry->e_key);
214 EXPORT_SYMBOL(mb_cache_entry_find_next);
217 * mb_cache_entry_get - get a cache entry by value (and key)
218 * @cache - cache we work with
222 struct mb_cache_entry *mb_cache_entry_get(struct mb_cache *cache, u32 key,
225 struct hlist_bl_node *node;
226 struct hlist_bl_head *head;
227 struct mb_cache_entry *entry;
229 head = mb_cache_entry_head(cache, key);
231 hlist_bl_for_each_entry(entry, node, head, e_hash_list) {
232 if (entry->e_key == key && entry->e_value == value &&
233 atomic_inc_not_zero(&entry->e_refcnt))
238 hlist_bl_unlock(head);
241 EXPORT_SYMBOL(mb_cache_entry_get);
243 /* mb_cache_entry_delete - try to remove a cache entry
244 * @cache - cache we work with
248 * Remove entry from cache @cache with key @key and value @value.
250 void mb_cache_entry_delete(struct mb_cache *cache, u32 key, u64 value)
252 struct hlist_bl_node *node;
253 struct hlist_bl_head *head;
254 struct mb_cache_entry *entry;
256 head = mb_cache_entry_head(cache, key);
258 hlist_bl_for_each_entry(entry, node, head, e_hash_list) {
259 if (entry->e_key == key && entry->e_value == value) {
260 /* We keep hash list reference to keep entry alive */
261 hlist_bl_del_init(&entry->e_hash_list);
262 hlist_bl_unlock(head);
263 spin_lock(&cache->c_list_lock);
264 if (!list_empty(&entry->e_list)) {
265 list_del_init(&entry->e_list);
266 if (!WARN_ONCE(cache->c_entry_count == 0,
267 "mbcache: attempt to decrement c_entry_count past zero"))
268 cache->c_entry_count--;
269 atomic_dec(&entry->e_refcnt);
271 spin_unlock(&cache->c_list_lock);
272 mb_cache_entry_put(cache, entry);
276 hlist_bl_unlock(head);
278 EXPORT_SYMBOL(mb_cache_entry_delete);
280 /* mb_cache_entry_delete_or_get - remove a cache entry if it has no users
281 * @cache - cache we work with
285 * Remove entry from cache @cache with key @key and value @value. The removal
286 * happens only if the entry is unused. The function returns NULL in case the
287 * entry was successfully removed or there's no entry in cache. Otherwise the
288 * function grabs reference of the entry that we failed to delete because it
289 * still has users and return it.
291 struct mb_cache_entry *mb_cache_entry_delete_or_get(struct mb_cache *cache,
294 struct mb_cache_entry *entry;
296 entry = mb_cache_entry_get(cache, key, value);
301 * Drop the ref we got from mb_cache_entry_get() and the initial hash
302 * ref if we are the last user
304 if (atomic_cmpxchg(&entry->e_refcnt, 2, 0) != 2)
307 spin_lock(&cache->c_list_lock);
308 if (!list_empty(&entry->e_list))
309 list_del_init(&entry->e_list);
310 cache->c_entry_count--;
311 spin_unlock(&cache->c_list_lock);
312 __mb_cache_entry_free(cache, entry);
315 EXPORT_SYMBOL(mb_cache_entry_delete_or_get);
317 /* mb_cache_entry_touch - cache entry got used
318 * @cache - cache the entry belongs to
319 * @entry - entry that got used
321 * Marks entry as used to give hit higher chances of surviving in cache.
323 void mb_cache_entry_touch(struct mb_cache *cache,
324 struct mb_cache_entry *entry)
326 set_bit(MBE_REFERENCED_B, &entry->e_flags);
328 EXPORT_SYMBOL(mb_cache_entry_touch);
330 static unsigned long mb_cache_count(struct shrinker *shrink,
331 struct shrink_control *sc)
333 struct mb_cache *cache = container_of(shrink, struct mb_cache,
336 return cache->c_entry_count;
339 /* Shrink number of entries in cache */
340 static unsigned long mb_cache_shrink(struct mb_cache *cache,
341 unsigned long nr_to_scan)
343 struct mb_cache_entry *entry;
344 unsigned long shrunk = 0;
346 spin_lock(&cache->c_list_lock);
347 while (nr_to_scan-- && !list_empty(&cache->c_list)) {
348 entry = list_first_entry(&cache->c_list,
349 struct mb_cache_entry, e_list);
350 /* Drop initial hash reference if there is no user */
351 if (test_bit(MBE_REFERENCED_B, &entry->e_flags) ||
352 atomic_cmpxchg(&entry->e_refcnt, 1, 0) != 1) {
353 clear_bit(MBE_REFERENCED_B, &entry->e_flags);
354 list_move_tail(&entry->e_list, &cache->c_list);
357 list_del_init(&entry->e_list);
358 cache->c_entry_count--;
359 spin_unlock(&cache->c_list_lock);
360 __mb_cache_entry_free(cache, entry);
363 spin_lock(&cache->c_list_lock);
365 spin_unlock(&cache->c_list_lock);
370 static unsigned long mb_cache_scan(struct shrinker *shrink,
371 struct shrink_control *sc)
373 struct mb_cache *cache = container_of(shrink, struct mb_cache,
375 return mb_cache_shrink(cache, sc->nr_to_scan);
378 /* We shrink 1/X of the cache when we have too many entries in it */
379 #define SHRINK_DIVISOR 16
381 static void mb_cache_shrink_worker(struct work_struct *work)
383 struct mb_cache *cache = container_of(work, struct mb_cache,
385 mb_cache_shrink(cache, cache->c_max_entries / SHRINK_DIVISOR);
389 * mb_cache_create - create cache
390 * @bucket_bits: log2 of the hash table size
392 * Create cache for keys with 2^bucket_bits hash entries.
394 struct mb_cache *mb_cache_create(int bucket_bits)
396 struct mb_cache *cache;
397 unsigned long bucket_count = 1UL << bucket_bits;
400 cache = kzalloc(sizeof(struct mb_cache), GFP_KERNEL);
403 cache->c_bucket_bits = bucket_bits;
404 cache->c_max_entries = bucket_count << 4;
405 INIT_LIST_HEAD(&cache->c_list);
406 spin_lock_init(&cache->c_list_lock);
407 cache->c_hash = kmalloc_array(bucket_count,
408 sizeof(struct hlist_bl_head),
410 if (!cache->c_hash) {
414 for (i = 0; i < bucket_count; i++)
415 INIT_HLIST_BL_HEAD(&cache->c_hash[i]);
417 cache->c_shrink.count_objects = mb_cache_count;
418 cache->c_shrink.scan_objects = mb_cache_scan;
419 cache->c_shrink.seeks = DEFAULT_SEEKS;
420 if (register_shrinker(&cache->c_shrink)) {
421 kfree(cache->c_hash);
426 INIT_WORK(&cache->c_shrink_work, mb_cache_shrink_worker);
433 EXPORT_SYMBOL(mb_cache_create);
436 * mb_cache_destroy - destroy cache
437 * @cache: the cache to destroy
439 * Free all entries in cache and cache itself. Caller must make sure nobody
440 * (except shrinker) can reach @cache when calling this.
442 void mb_cache_destroy(struct mb_cache *cache)
444 struct mb_cache_entry *entry, *next;
446 unregister_shrinker(&cache->c_shrink);
449 * We don't bother with any locking. Cache must not be used at this
452 list_for_each_entry_safe(entry, next, &cache->c_list, e_list) {
453 list_del(&entry->e_list);
454 WARN_ON(atomic_read(&entry->e_refcnt) != 1);
455 mb_cache_entry_put(cache, entry);
457 kfree(cache->c_hash);
460 EXPORT_SYMBOL(mb_cache_destroy);
462 static int __init mbcache_init(void)
464 mb_entry_cache = kmem_cache_create("mbcache",
465 sizeof(struct mb_cache_entry), 0,
466 SLAB_RECLAIM_ACCOUNT|SLAB_MEM_SPREAD, NULL);
472 static void __exit mbcache_exit(void)
474 kmem_cache_destroy(mb_entry_cache);
477 module_init(mbcache_init)
478 module_exit(mbcache_exit)
480 MODULE_AUTHOR("Jan Kara <jack@suse.cz>");
481 MODULE_DESCRIPTION("Meta block cache (for extended attributes)");
482 MODULE_LICENSE("GPL");