Re: [PATCH v0] [RFC] cleanup: Unify DEFINE_LOCK_GUARD_0 and DEFINE_LOCK_GUARD_1

From: Dan Williams
Date: Mon Jun 16 2025 - 14:54:59 EST


Jemmy Wong wrote:
> Hi,
>
> This patch consolidates the DEFINE_LOCK_GUARD_0 and DEFINE_LOCK_GUARD_1
> macros into a single, unified 'DEFINE_LOCK_GUARD' macro to provide
> a consistent and simplified API for lock guard definitions.
>
> API changes:
> From DEFINE_LOCK_GUARD_0(name, lock, unlock, ...)
> to DEFINE_LOCK_GUARD(name, *void*, lock, unlock, ...)
>
> From DEFINE_LOCK_GUARD_1(name, type, lock, unlock, ...)
> to DEFINE_LOCK_GUARD(name, type, lock, unlock, ...)
>
> From CLASS(name, var)(args...)
> to CLASS(name, var, args...)
>
> From guard(name)(args)
> to guard(name, args)

No, I think this organization is instructive for understanding how these
helpers work. I.e. that the macro is instantiating a function with an
automatic variable result, and the arguments to that function arrive in
@args. This becomes even more important to understand with the ACQUIRE()
and ACQUIRE_ERR() proposal that instantiate different functions to
retrieve other properties of the automatic variable result.

> No change:
> scoped_guard(name, args...)
> scoped_cond_guard(name, fail, args...)

Effectively these are not returning an automatic variable result to the
current scope and the different calling convention is consistent with
that difference.

> ---
>
> Deailted changes:
>
> - DEFINE_CLASS(_name, _type, _exit, _init, _init_args...)
> The void type for _init_args is not required when the constructor takes no arguments,
> as an int argc is implicitly inserted as the first argument. (int argc, void) is an error.
>
> This patch includes only the core changes.
> Follow-up patches will be submitted once the approach is accepted.

Appreciate the RFC first to avoid the thrash while deciding on the
format change, but it is a nak from me.