mbcache: document that "find" functions only return reusable entries

mb_cache_entry_find_first() and mb_cache_entry_find_next() only return
cache entries with the 'e_reusable' bit set.  This should be documented.

Signed-off-by: Eric Biggers <ebiggers@google.com>
Signed-off-by: Theodore Ts'o <tytso@mit.edu>
Reviewed-by: Jan Kara <jack@suse.cz>
This commit is contained in:
Eric Biggers 2016-12-03 15:55:01 -05:00 committed by Theodore Ts'o
parent 132d4e2d55
commit b649668c0b

View file

@ -155,12 +155,12 @@ static struct mb_cache_entry *__entry_find(struct mb_cache *cache,
} }
/* /*
* mb_cache_entry_find_first - find the first entry in cache with given key * mb_cache_entry_find_first - find the first reusable entry with the given key
* @cache: cache where we should search * @cache: cache where we should search
* @key: key to look for * @key: key to look for
* *
* Search in @cache for entry with key @key. Grabs reference to the first * Search in @cache for a reusable entry with key @key. Grabs reference to the
* entry found and returns the entry. * first reusable entry found and returns the entry.
*/ */
struct mb_cache_entry *mb_cache_entry_find_first(struct mb_cache *cache, struct mb_cache_entry *mb_cache_entry_find_first(struct mb_cache *cache,
u32 key) u32 key)
@ -170,14 +170,14 @@ struct mb_cache_entry *mb_cache_entry_find_first(struct mb_cache *cache,
EXPORT_SYMBOL(mb_cache_entry_find_first); EXPORT_SYMBOL(mb_cache_entry_find_first);
/* /*
* mb_cache_entry_find_next - find next entry in cache with the same * mb_cache_entry_find_next - find next reusable entry with the same key
* @cache: cache where we should search * @cache: cache where we should search
* @entry: entry to start search from * @entry: entry to start search from
* *
* Finds next entry in the hash chain which has the same key as @entry. * Finds next reusable entry in the hash chain which has the same key as @entry.
* If @entry is unhashed (which can happen when deletion of entry races * If @entry is unhashed (which can happen when deletion of entry races with the
* with the search), finds the first entry in the hash chain. The function * search), finds the first reusable entry in the hash chain. The function drops
* drops reference to @entry and returns with a reference to the found entry. * reference to @entry and returns with a reference to the found entry.
*/ */
struct mb_cache_entry *mb_cache_entry_find_next(struct mb_cache *cache, struct mb_cache_entry *mb_cache_entry_find_next(struct mb_cache *cache,
struct mb_cache_entry *entry) struct mb_cache_entry *entry)