[PATCH] mm/damon/core: document damos_commit_dests() failure semantics
From: Josh Law
Date: Thu Mar 19 2026 - 03:14:28 EST
Add a kernel-doc 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
attempting to reset nr_dests on failure. Make the intended usage
explicit so future readers do not repeat the confusion.
Signed-off-by: Josh Law <objecting@xxxxxxxxxxxxx>
---
mm/damon/core.c | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/mm/damon/core.c b/mm/damon/core.c
index e233eb84a2d5..c884bb31c9b8 100644
--- a/mm/damon/core.c
+++ b/mm/damon/core.c
@@ -1054,6 +1054,23 @@ static void damos_set_filters_default_reject(struct damos *s)
damos_filters_default_reject(&s->ops_filters);
}
+/**
+ * damos_commit_dests() - Copy migration destinations from @src to @dst.
+ * @dst: Destination structure to update.
+ * @src: Source structure to copy from.
+ *
+ * If the number of destinations has changed, the old arrays in @dst are freed
+ * and new ones are allocated. On success, @dst contains a full copy of
+ * @src's arrays and count.
+ *
+ * On allocation failure, @dst is left in a partially torn-down state: its
+ * arrays may be NULL and @nr_dests may not reflect the actual allocation
+ * sizes. The structure remains safe to deallocate via damon_destroy_scheme(),
+ * but callers must not reuse @dst for further commits — it should be
+ * discarded.
+ *
+ * Return: 0 on success, -ENOMEM on allocation failure.
+ */
static int damos_commit_dests(struct damos_migrate_dests *dst,
struct damos_migrate_dests *src)
{
--
2.34.1