Received-SPF: pass (google.com: domain of linux-kernel+bounces-53291-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
Date: Mon, 5 Feb 2024 11:02:47 -0800
From: Dan Williams <dan.j.williams@intel.com>
To: "Fabio M. De Francesco" <fabio.maria.de.francesco@linux.intel.com>, "Peter
 Zijlstra" <peterz@infradead.org>, Dan Williams <dan.j.williams@intel.com>,
	<linux-kernel@vger.kernel.org>
CC: <linux-cxl@vger.kernel.org>, Ingo Molnar <mingo@kernel.org>, "Jonathan
 Cameron" <Jonathan.Cameron@huawei.com>, "Fabio M. De Francesco"
	<fabio.maria.de.francesco@linux.intel.com>, Ira Weiny <ira.weiny@intel.com>
Subject: RE: [PATCH 1/2 v2] cleanup: Add cond_guard() to conditional guards
Message-ID: <65c130d7c4c52_4e7f5294d3@dwillia2-xfh.jf.intel.com.notmuch>
References: <20240205142613.23914-1-fabio.maria.de.francesco@linux.intel.com>
 <20240205142613.23914-2-fabio.maria.de.francesco@linux.intel.com>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <20240205142613.23914-2-fabio.maria.de.francesco@linux.intel.com>
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?06eEKrimz0dISoiQzINoQGIU1jlgiCk0g5QmKSe419Jb5ZspxhCl6l8QAuVl?=
 =?us-ascii?Q?PUMq8IGAic3LQ0D2iW8OBYJXXaFCAaEbQw9okV55rvv2lVIh7zrni1MKb8dB?=
 =?us-ascii?Q?HT2zOjrS5MLTBN90TqtfBhdXirVaNF0og6Zisa/bmcHPp/W/Cfhmsm392P6Y?=
 =?us-ascii?Q?8HagNYYySubnxSyoEVUCkzIC5xbZrqacPBak2b1bcSvyH/91RruHO7lOEuyg?=
 =?us-ascii?Q?FvuR4M6kiJpBt8WAU2oVnDpXzirCMGvxeWwrRtWFjCKaNTK8VJZBASyRhUFZ?=
 =?us-ascii?Q?BweUIpFgQVmYHN800hKcSXtsxiBs4Uv821r/HxP8tKAct+0zr53Z1cUiFCH4?=
 =?us-ascii?Q?h3jS4p/glssQrALLCEl1dS0f8+1SPb2vqhp/VwZ8g0WToQQ5C1fr/u2PkZle?=
 =?us-ascii?Q?R1cYRDdUPs9DGiLMl5hClG1ruTRFQ/dxayI/dWQTw45Kw/dyeumkHYabxtd4?=
 =?us-ascii?Q?LepHgP5BCQ8McgzwMQYrRuDziDhlqGa+0U8vrN7yzPL5Lt19/zYXsrepW6tN?=
 =?us-ascii?Q?MVarYgbTpagfRGVt8+rUDClCocL8b3OxWVicO/zYglIV+nDd5B/LfASUPPCh?=
 =?us-ascii?Q?1SyWZo4YZ0cK9smc9utszo5gbR10isMWYhAU8g6KwqwZgbjfExCYswh316Gc?=
 =?us-ascii?Q?wpDGIr9g3RiIaCXnqo5uMMDLH3/2TLsosdUsp2PBKbF3YCEVm8RunZmKhyBC?=
 =?us-ascii?Q?RxO1S+5W1KJ5o7HnN1sIA5WzYadlwIs1f5lMrdEd33E+selfZ7WafLf7QBmo?=
 =?us-ascii?Q?TnY7M1U8OLdKgaRYfKwLW21+z5+rCijly/3Mf0iY52cmGzH1y9pj0iukGMrT?=
 =?us-ascii?Q?iicy83TnJYxkSXNXnWDNXjX0R2SiG83xvHSW9ugmQjrWRl4fS/NTLYUKb+i0?=
 =?us-ascii?Q?7284KOxI+J+ivLiQWWtWF2WaLwT51i7D1Kyb/sZdQmrb8loxztH9g/s00LpH?=
 =?us-ascii?Q?/rvrWzHnjHFBFGeg1mnVBY3/pUokgWM9rad51OZvLE4GzBPTLCx/Gld1foiq?=
 =?us-ascii?Q?w/EneYiRxsTMsbs+x/JXTF0OrgJOYqtop6klbmxFeHZJnK4WG5C/ezM+oglP?=
 =?us-ascii?Q?q3MHWP4rRrfq61R7ps+dtKKLzaBjpx71iypWGkO3z9gJtjLneJyYnkm5eL0x?=
 =?us-ascii?Q?C7uO3n0CLURuhSETdACB/jgnmmvoAgKyx+ACcmrMjuviqWpYC6mqds4DpAi+?=
 =?us-ascii?Q?Q+O8c/aHMgScmUOM4bIPZQgKUQFktAJ6jlANfSC52BAO7THe5Jj3KKZN4hxj?=
 =?us-ascii?Q?GfiPTtGz+L6eETGqTy2S8J7J9WeEyDkdRuE60Ek+uNRG2GRHqKLK1qYHHYuy?=
 =?us-ascii?Q?RdWTy/FHDQHvVMyVjaNjxKqj8F8agnKQaE/XXqj23YLgVi5jYvuCnReXUfpd?=
 =?us-ascii?Q?NoJZhdy7fF9YGeCews4i6gDKjvcOPxqFfBXJgRTnCFc9uVfPgecNGKBqlgXY?=
 =?us-ascii?Q?FwrWQ0928vvHsUfqlO8rBPr5iYDZEZJJq36RY1clcUl8MLhMC++BzOHumxJj?=
 =?us-ascii?Q?sm2oEQb1OVgJdwgMs5fa9vJEhKT1slbEKV2uMccxezIpHjUm2kSjYs2gkkPg?=
 =?us-ascii?Q?xOeRSraXT/c1TumT21cfEMI5iUFDTD4c2pI5nB1JMS5UGMQUB/CwGEbf86cQ?=
 =?us-ascii?Q?lA=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: c46559cc-b4b1-40d0-f283-08dc267d0c4c
X-MS-Exchange-CrossTenant-AuthSource: PH8PR11MB8107.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Feb 2024 19:02:50.0625
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: M7s5QKhq+NXbYKP9gotrBjzhIo8dVoXlPtGoUo7K/KG9dWve9/xZAf+3jbop7skZLdzszQcmHciS4YIabtvKcaa+O1MfBghaiVtH2epIM+c=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: LV2PR11MB5997
X-OriginatorOrg: intel.com

Fabio M. De Francesco wrote:
> Add cond_guard() macro to conditional guards.
> 
> cond_guard() is a guard to be used with the conditional variants of locks,
> like down_read_trylock() or mutex_lock_interruptible().
> 
> It takes a statement (or more statements in a block) that is passed to its
> second argument. That statement (or block) is executed if waiting for a
> lock is interrupted or if a _trylock() fails in case of contention.
> 
> Usage example:
> 
> 	cond_guard(rwsem_read_try, { printk(...); return 0; }, &semaphore);
> 
> Consistently with the other guards, locks are unlocked at the exit of the
> scope where cond_guard() is called.
> 
> Cc: Peter Zijlstra <peterz@infradead.org>
> Suggested-by: Dan Williams <dan.j.williams@intel.com>
> Suggested-by: Ira Weiny <ira.weiny@intel.com>
> Signed-off-by: Fabio M. De Francesco <fabio.maria.de.francesco@linux.intel.com>
> ---
>  include/linux/cleanup.h | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
> 
> diff --git a/include/linux/cleanup.h b/include/linux/cleanup.h
> index c2d09bc4f976..88af56600325 100644
> --- a/include/linux/cleanup.h
> +++ b/include/linux/cleanup.h
> @@ -134,6 +134,16 @@ static inline class_##_name##_t class_##_name##ext##_constructor(_init_args) \
>   *	an anonymous instance of the (guard) class, not recommended for
>   *	conditional locks.
>   *
> + * cond_guard(name, fail, args...):
> + *	a guard to be used with the conditional variants of locks, like
> + *	down_read_trylock() or mutex_lock_interruptible. 'fail' are one or more
> + *	statements that are executed when waiting for a lock is interrupted or
> + *	when a _trylock() fails in case of contention.
> + *
> + *	Example:
> + *
> + *		cond_guard(rwsem_read_try, { printk(...); return 0; }, &semaphore);

That _fail argument likely needs to be a statement expression for the
multi-statement case.

> + *
>   * scoped_guard (name, args...) { }:
>   *	similar to CLASS(name, scope)(args), except the variable (with the
>   *	explicit name 'scope') is declard in a for-loop such that its scope is
> @@ -165,6 +175,10 @@ static inline class_##_name##_t class_##_name##ext##_constructor(_init_args) \
>  
>  #define __guard_ptr(_name) class_##_name##_lock_ptr
>  
> +#define cond_guard(_name, _fail, args...) \
> +	CLASS(_name, scope)(args); \
> +	if (!__guard_ptr(_name)(&scope)) _fail

No, as I stated before this is broken for usages of:

    if () cond_guard() else if ()

The 'else' in the definition is critical, this builds for me (untested):

diff --git a/include/linux/cleanup.h b/include/linux/cleanup.h
index 88af56600325..665407498781 100644
--- a/include/linux/cleanup.h
+++ b/include/linux/cleanup.h
@@ -142,7 +142,7 @@ static inline class_##_name##_t class_##_name##ext##_constructor(_init_args) \
  *
  *	Example:
  *
- *		cond_guard(rwsem_read_try, { printk(...); return 0; }, &semaphore);
+ *		cond_guard(rwsem_read_try, ({ printk(...); return 0; }), &semaphore);
  *
  * scoped_guard (name, args...) { }:
  *	similar to CLASS(name, scope)(args), except the variable (with the
@@ -177,7 +177,8 @@ static inline class_##_name##_t class_##_name##ext##_constructor(_init_args) \
 
 #define cond_guard(_name, _fail, args...) \
 	CLASS(_name, scope)(args); \
-	if (!__guard_ptr(_name)(&scope)) _fail
+	if (!__guard_ptr(_name)(&scope)) _fail; \
+	else
 
 #define scoped_guard(_name, args...)					\
 	for (CLASS(_name, scope)(args),					\