]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
mm/damon/core: document damos_commit_dests() failure semantics
authorJosh Law <objecting@objecting.org>
Fri, 20 Mar 2026 14:36:45 +0000 (07:36 -0700)
committerAndrew Morton <akpm@linux-foundation.org>
Sun, 5 Apr 2026 20:53:34 +0000 (13:53 -0700)
commitcc4555fc6d8f8585ae05f3e117cfdd60e4673281
tree22d05faca86461e211a4cff19a8b1a435db5937a
parenta6a8c087dce00eac0c6d03e560b0fa3d529afa5f
mm/damon/core: document damos_commit_dests() failure semantics

Add a kernel-doc-like comment to damos_commit_dests() documenting its
allocation failure contract: on -ENOMEM, the destination structure is left
in a partially torn-down state that is safe to deallocate via
damon_destroy_scheme(), but must not be reused for further commits.

This was unclear from the code alone and led to a separate patch [1]
attempting to reset nr_dests on failure.  Make the intended usage explicit
so future readers do not repeat the confusion.

Link: https://lkml.kernel.org/r/20260320143648.91673-1-sj@kernel.org
Link: https://lore.kernel.org/20260318214939.36100-1-objecting@objecting.org
Signed-off-by: Josh Law <objecting@objecting.org>
Reviewed-by: SeongJae Park <sj@kernel.org>
Signed-off-by: SeongJae Park <sj@kernel.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
mm/damon/core.c