diff options
| author |   Eric Biggers <ebiggers@google.com> | 2016-12-03 15:55:01 -0500 |
|---|---|---|
| committer |   Theodore Ts'o <tytso@mit.edu> | 2016-12-03 15:55:01 -0500 |
| commit | b649668c0bb3f54523cd932490a3f637859fdeb0 (patch) | |
| tree | 6a6520043604f036ef9b56c3965ba8e350e1eb69 /fs/mbcache.c | |
| parent | mbcache: use consistent type for entry count (diff) | |
| download | wireguard-linux-b649668c0bb3f54523cd932490a3f637859fdeb0.tar.xz wireguard-linux-b649668c0bb3f54523cd932490a3f637859fdeb0.zip | |
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>
Diffstat (limited to 'fs/mbcache.c')
| -rw-r--r-- | fs/mbcache.c | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/fs/mbcache.c b/fs/mbcache.c index bf659061a9a8..b19be429d655 100644 --- a/fs/mbcache.c +++ b/fs/mbcache.c @@ -155,12 +155,12 @@ out: } /* - * 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 * @key: key to look for * - * Search in @cache for entry with key @key. Grabs reference to the first - * entry found and returns the entry. + * Search in @cache for a reusable entry with key @key. Grabs reference to the + * first reusable entry found and returns the entry. */ struct mb_cache_entry *mb_cache_entry_find_first(struct mb_cache *cache, 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); /* - * 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 * @entry: entry to start search from * - * Finds next entry in the hash chain which has the same key as @entry. - * If @entry is unhashed (which can happen when deletion of entry races - * with the search), finds the first entry in the hash chain. The function - * drops reference to @entry and returns with a reference to the found 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 with the + * search), finds the first reusable entry in the hash chain. The function drops + * 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 *entry) |