mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-08-28 20:02:17 +00:00
![Davidlohr Bueso](/assets/img/avatar_default.png)
The rcuwait utility provides an efficient and safe single wait/wake mechanism. It is used in situations where queued wait is the wrong semantics, and often too bulky. For example, cases where the wait is already done under a lock. In the past, rcuwait has been extended to support beyond only uninterruptible sleep, and similarly, there are users that can benefit for the addition of timeouts. As such, tntroduce rcuwait_wait_event_timeout(), with semantics equivalent to calls for queued wait counterparts. Acked-by: Peter Zijlstra (Intel) <peterz@infradead.org> Signed-off-by: Davidlohr Bueso <dave@stgolabs.net> Link: https://lore.kernel.org/r/20230523170927.20685-2-dave@stgolabs.net Signed-off-by: Dan Williams <dan.j.williams@intel.com>
93 lines
2.3 KiB
C
93 lines
2.3 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef _LINUX_RCUWAIT_H_
|
|
#define _LINUX_RCUWAIT_H_
|
|
|
|
#include <linux/rcupdate.h>
|
|
#include <linux/sched/signal.h>
|
|
|
|
/*
|
|
* rcuwait provides a way of blocking and waking up a single
|
|
* task in an rcu-safe manner.
|
|
*
|
|
* The only time @task is non-nil is when a user is blocked (or
|
|
* checking if it needs to) on a condition, and reset as soon as we
|
|
* know that the condition has succeeded and are awoken.
|
|
*/
|
|
struct rcuwait {
|
|
struct task_struct __rcu *task;
|
|
};
|
|
|
|
#define __RCUWAIT_INITIALIZER(name) \
|
|
{ .task = NULL, }
|
|
|
|
static inline void rcuwait_init(struct rcuwait *w)
|
|
{
|
|
w->task = NULL;
|
|
}
|
|
|
|
/*
|
|
* Note: this provides no serialization and, just as with waitqueues,
|
|
* requires care to estimate as to whether or not the wait is active.
|
|
*/
|
|
static inline int rcuwait_active(struct rcuwait *w)
|
|
{
|
|
return !!rcu_access_pointer(w->task);
|
|
}
|
|
|
|
extern int rcuwait_wake_up(struct rcuwait *w);
|
|
|
|
/*
|
|
* The caller is responsible for locking around rcuwait_wait_event(),
|
|
* and [prepare_to/finish]_rcuwait() such that writes to @task are
|
|
* properly serialized.
|
|
*/
|
|
|
|
static inline void prepare_to_rcuwait(struct rcuwait *w)
|
|
{
|
|
rcu_assign_pointer(w->task, current);
|
|
}
|
|
|
|
extern void finish_rcuwait(struct rcuwait *w);
|
|
|
|
#define ___rcuwait_wait_event(w, condition, state, ret, cmd) \
|
|
({ \
|
|
long __ret = ret; \
|
|
prepare_to_rcuwait(w); \
|
|
for (;;) { \
|
|
/* \
|
|
* Implicit barrier (A) pairs with (B) in \
|
|
* rcuwait_wake_up(). \
|
|
*/ \
|
|
set_current_state(state); \
|
|
if (condition) \
|
|
break; \
|
|
\
|
|
if (signal_pending_state(state, current)) { \
|
|
__ret = -EINTR; \
|
|
break; \
|
|
} \
|
|
\
|
|
cmd; \
|
|
} \
|
|
finish_rcuwait(w); \
|
|
__ret; \
|
|
})
|
|
|
|
#define rcuwait_wait_event(w, condition, state) \
|
|
___rcuwait_wait_event(w, condition, state, 0, schedule())
|
|
|
|
#define __rcuwait_wait_event_timeout(w, condition, state, timeout) \
|
|
___rcuwait_wait_event(w, ___wait_cond_timeout(condition), \
|
|
state, timeout, \
|
|
__ret = schedule_timeout(__ret))
|
|
|
|
#define rcuwait_wait_event_timeout(w, condition, state, timeout) \
|
|
({ \
|
|
long __ret = timeout; \
|
|
if (!___wait_cond_timeout(condition)) \
|
|
__ret = __rcuwait_wait_event_timeout(w, condition, \
|
|
state, timeout); \
|
|
__ret; \
|
|
})
|
|
|
|
#endif /* _LINUX_RCUWAIT_H_ */
|