Received-SPF: pass (google.com: domain of linux-kernel+bounces-53059-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Date: Mon, 5 Feb 2024 09:04:39 -0800
From: Ira Weiny <ira.weiny@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: Ingo Molnar <mingo@kernel.org>, <linux-cxl@vger.kernel.org>, "Fabio M. De
 Francesco" <fabio.maria.de.francesco@linux.intel.com>, Ira Weiny
	<ira.weiny@intel.com>
Subject: Re: [PATCH 1/2] cleanup: Add cond_guard() to conditional guards
Message-ID: <65c11527210a9_36bf7d2947a@iweiny-mobl.notmuch>
References: <20240204173105.935612-1-fabio.maria.de.francesco@linux.intel.com>
 <20240204173105.935612-2-fabio.maria.de.francesco@linux.intel.com>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <20240204173105.935612-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?qAoS1Nck8UJMPjDEd/qRPDc3kSaKg5klLuY4/oqwdfADsraeZIiACfDku1eV?=
 =?us-ascii?Q?XpxMp1aApDIt2mIczNAByoc9qrb4zLnu4cZpwnUtqQ0zYgsLNpYeK3irqU1y?=
 =?us-ascii?Q?JvoUDw5onYC2+Tos9/fgp6e9y/Bu84FaTS9kQ10W31CQBhB7gzfSk8uRRD8r?=
 =?us-ascii?Q?hdODMqFFwR0EW5OJiRrmZpY1jbpbIJfpEc4MiuKvjaDs1+Q8SmClVI5WHCYx?=
 =?us-ascii?Q?xigP2MOm3mswwaJHsHlAXcfraU74KhoMmjOD8kAOhKE3FknvwsQl20pdW7fA?=
 =?us-ascii?Q?sHVFsoql4tl8V+xHBYRfBv3UJNabyUAt9lhKMpXzmrV9Jh3/nw86wpFIE2l/?=
 =?us-ascii?Q?4wLndA336ndZitDW6fcZ8r+gIw5O1mxC77xr7FzQ3os0meUXPk0T8HD5RLAr?=
 =?us-ascii?Q?eETOhT1wFJsu4UZm7FabvfHnTs/QFIy6LlDqiIZdiMZ+S9mFIliygRMU/3uV?=
 =?us-ascii?Q?kxzLz7W4TMlN7HRyX2t7qaSD6r0YLkdYk6598Qol5FsKobp0UqhVsh7zQh+6?=
 =?us-ascii?Q?gnMmDjhbjrVooNb48pJdZ9/x/A3C0SjmXIdFZEKKmjoqbfz5WGMxnWCtXIGk?=
 =?us-ascii?Q?0+wF+gYYVCV9QEe0syaiw7HFlb9izrAN69iR2NKAm7ZTc/wi+DUys8Eb0xRL?=
 =?us-ascii?Q?tCEJEmhumyLEcw2MbuAk3fC2afO+s8FfJODJahbsQx6Dop/qP7aY0UreRN7/?=
 =?us-ascii?Q?cx8s0wASFyR/Rx4+LkdIyOvafboBrSTsFD1pSn0Pcmr7EWclF4jKeGfwDBvS?=
 =?us-ascii?Q?lX9J5mt1MolDPmJlhlfbRbuj/MLWe9vJVHlZ7Gj4++NpldwByibcsEv6YEzY?=
 =?us-ascii?Q?+j02QEHvp8RunIR8F3LIdjKwhhNrldlZEXcTpHngCJO4v8Th2r8amlEfS84a?=
 =?us-ascii?Q?cUcYRbYzpgv7SxUvM03IIVRt+pFreRXMvMrUuyPNN27rc10SGURABtNKK8lC?=
 =?us-ascii?Q?bMKSV8pYjlgcO38vKiPfEnXiOdwhJoBuDqXmCwf2ahLBoNvu/24aPO5H6OJ3?=
 =?us-ascii?Q?Gp6HSyyy4R9kqbVqO7p0FHWSintPwXyODzC+HD1APR/HMZnbsP+Koj+IBrq+?=
 =?us-ascii?Q?xEGId5vNCrmwWrJ5tUibOTexGvO18UksDJCX0ywKfWAtu7pHee7ufF5JkVeR?=
 =?us-ascii?Q?ALyg5mDScafYjzzpVF83hXoxmzefMoRBLdg4G57YNIECqtWyobpLwEps1nAM?=
 =?us-ascii?Q?UGgdqPVdpICMma3cKACTGzS2cUetWx3lqGHFwGxeb2D0gzyZ6XWLcc8aGUc0?=
 =?us-ascii?Q?P+RWZ088Ej2H57UZVjQ4U/5Wg64V8TWvfWEP21J/9vmHKg0Qn9F4jXaaUkxh?=
 =?us-ascii?Q?UPyUArlKb2O/n7b7xJZO9mNr4aKz6/Y2kUzjrA2Kt1J3AMAmROzAvn3BtA+G?=
 =?us-ascii?Q?IaMb67hnjAyUY74n96w+uXmXjB/9Z3QbR+cFvsuzA2lWCtojjThYkkaIbYib?=
 =?us-ascii?Q?GWE8fz4wMlYawLKyn5dhplR5QWRcH9bT8g55Ds5PqjLR3vKM30iQPnMjOQkd?=
 =?us-ascii?Q?JcbGS5+uiO90etJKSwTUmOi/1gpQkR1TUnDRmMvNZSKNBrEETeEkwXtb9e3e?=
 =?us-ascii?Q?3JNvpjPJGFkCRPkgpb53Tp3gHc68aDmvmTVxI4SU?=
X-MS-Exchange-CrossTenant-Network-Message-Id: b4643dd5-4bdc-467c-3253-08dc266c8cec
X-MS-Exchange-CrossTenant-AuthSource: SA1PR11MB6733.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Feb 2024 17:04:44.4984
 (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: LlcwHk2UC55KwxQ57O2YnIcRqkBDSG0sj4PSEjyzBw7lpySrr4HOgMLsafVFlxneovK1x3yYHfyKuKowHdcAyA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: LV3PR11MB8578
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);
> 
> Consistenly with the other guards, locks are unlocked at the exit of the

Consistently

Reviewed-by: Ira Weiny <ira.weiny@intel.com>

> 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..3826e8ed4e09 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 if waiting for a lock is interrupted or
> + *	if a _trylock() fails in case of contention.
> + *
> + *	Example:
> + *
> + *		cond_guard(rwsem_read_try, { printk(...); return 0; }, &semaphore);
> + *
>   * 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, _ret, args...) \
> +	CLASS(_name, scope)(args); \
> +	if (!__guard_ptr(_name)(&scope)) _ret
> +
>  #define scoped_guard(_name, args...)					\
>  	for (CLASS(_name, scope)(args),					\
>  	     *done = NULL; __guard_ptr(_name)(&scope) && !done; done = (void *)1)
> -- 
> 2.43.0
>