[v3,3/3] mm: memory-failure: Enhance comments for return value of memory_failure()

Commit Message

Shuai Xue March 6, 2025, 2:10 a.m. UTC

The comments for the return value of memory_failure are not complete,
supplement the comments.

Signed-off-by: Shuai Xue <[e-mail]>
Reviewed-by: Jarkko Sakkinen <[e-mail]>
Reviewed-by: Jonathan Cameron <[e-mail]>
Reviewed-by: Yazen Ghannam <[e-mail]>
Reviewed-by: Jane Chu <[e-mail]>
Acked-by: Miaohe Lin <[e-mail]>
---
 mm/memory-failure.c | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

Patch

diff --git a/mm/memory-failure.c b/mm/memory-failure.c
index b037952565be..8649849bcdb4 100644
--- a/mm/memory-failure.c
+++ b/mm/memory-failure.c
@@ -2216,9 +2216,13 @@  static void kill_procs_now(struct page *p, unsigned long pfn, int flags,
  * Must run in process context (e.g. a work queue) with interrupts
  * enabled and no spinlocks held.
  *
- * Return: 0 for successfully handled the memory error,
- *         -EOPNOTSUPP for hwpoison_filter() filtered the error event,
- *         < 0(except -EOPNOTSUPP) on failure.
+ * Return:
+ *   0             - success,
+ *   -ENXIO        - memory not managed by the kernel
+ *   -EOPNOTSUPP   - hwpoison_filter() filtered the error event,
+ *   -EHWPOISON    - the page was already poisoned, potentially
+ *                   kill process,
+ *   other negative values - failure.
  */
 int memory_failure(unsigned long pfn, int flags)
 {