]> www.infradead.org Git - users/jedix/linux-maple.git/commit
cleanup: Provide retain_ptr()
authorThomas Gleixner <tglx@linutronix.de>
Thu, 13 Mar 2025 13:03:38 +0000 (14:03 +0100)
committerThomas Gleixner <tglx@linutronix.de>
Thu, 13 Mar 2025 17:57:59 +0000 (18:57 +0100)
commit08549ff3e53b9c7bc55724d660ca733041a8bd5f
tree327e786a661fca148da577c405993def2467f4a7
parent537625233537179cb2e8293b2c0dc9c989363f41
cleanup: Provide retain_ptr()

In cases where an allocation is consumed by another function, the
allocation needs to be retained on success or freed on failure. The code
pattern is usually:

struct foo *f = kzalloc(sizeof(*f), GFP_KERNEL);
struct bar *b;

,,,
// Initialize f
...
if (ret)
goto free;
        ...
bar = bar_create(f);
if (!bar) {
ret = -ENOMEM;
    goto free;
}
...
return 0;
free:
kfree(f);
return ret;

This prevents using __free(kfree) on @f because there is no canonical way
to tell the cleanup code that the allocation should not be freed.

Abusing no_free_ptr() by force ignoring the return value is not really a
sensible option either.

Provide an explicit macro retain_ptr(), which NULLs the cleanup
pointer. That makes it easy to analyze and reason about.

Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Link: https://lore.kernel.org/all/20250313130321.442025758@linutronix.de
include/linux/cleanup.h