mm/zsmalloc: document free_zspage helper variants

After splitting __free_zspage() into a lockless core and a wrapper that
does the class-stat bookkeeping, three similarly-named helpers coexist:
free_zspage / __free_zspage / __free_zspage_lockless.

Add a comment block above them describing what each does and where it is
used, so the names are not easy to confuse.

No functional change.

Link: https://lore.kernel.org/20260626015003.2965881-5-haowenchao22@gmail.com
Signed-off-by: Wenchao Hao <haowenchao@xiaomi.com>
Suggested-by: Nhat Pham <nphamcs@gmail.com>
Reviewed-by: Nhat Pham <nphamcs@gmail.com>
Reviewed-by: Barry Song <baohua@kernel.org>
Cc: Joshua Hahn <joshua.hahnjy@gmail.com>
Cc: Minchan Kim <minchan@kernel.org>
Cc: Sergey Senozhatsky <senozhatsky@chromium.org>
Cc: Xueyuan Chen <xueyuan.chen21@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
This commit is contained in:
Wenchao Hao 2026-06-26 09:50:03 +08:00 committed by Andrew Morton
parent 7ef28e8b81
commit 0abea609f3

View File

@ -877,6 +877,22 @@ static int trylock_zspage(struct zspage *zspage)
return 0;
}
/*
* Three free helpers, kept apart here:
*
* __free_zspage_lockless(): bare core; walks zpdescs and returns pages
* to the buddy allocator. Caller owns all zpdesc locks and has
* removed the zspage from its class list. Used by zs_free() outside
* class->lock so the buddy-side work does not stall the class.
*
* __free_zspage(): __free_zspage_lockless() + per-class accounting,
* under class->lock. Used by async_free_zspage(), the worker for
* zspages whose trylock_zspage() failed.
*
* free_zspage(): full wrapper - trylock zpdescs, remove from class
* list, call __free_zspage(); kicks deferred free on contention.
* Used by compaction.
*/
static inline void __free_zspage_lockless(struct zspage *zspage)
{
struct zpdesc *zpdesc, *next;