Rename cv_wait_interruptible() to cv_wait_sig()

Commit f752b46e added the cv_wait_interruptible() function to allow
condition variables to be woken by signals.  This function and its
timed wait counterpart should have been named cv_wait_sig() to match
the illumos interface which provides the same functionality.

This patch renames the symbol but leaves a #define compatibility
wrapper in place until the ZFS code can be moved to the correct
name.

This patch also makes a small number of cosmetic changes to make
the condvar source and header cstyle clean.

Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
Closes #456
This commit is contained in:
Brian Behlendorf 2015-06-10 09:35:20 -07:00
parent 86c16c59fe
commit 2345368646
2 changed files with 75 additions and 62 deletions

View File

@ -1,4 +1,4 @@
/*****************************************************************************\ /*
* Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC. * Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
* Copyright (C) 2007 The Regents of the University of California. * Copyright (C) 2007 The Regents of the University of California.
* Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). * Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
@ -20,10 +20,10 @@
* *
* You should have received a copy of the GNU General Public License along * You should have received a copy of the GNU General Public License along
* with the SPL. If not, see <http://www.gnu.org/licenses/>. * with the SPL. If not, see <http://www.gnu.org/licenses/>.
\*****************************************************************************/ */
#ifndef _SPL_CONDVAR_H #ifndef _SPL_CONDVAR_H
#define _SPL_CONDVAR_H #define _SPL_CONDVAR_H
#include <linux/module.h> #include <linux/module.h>
#include <linux/wait.h> #include <linux/wait.h>
@ -36,8 +36,8 @@
* The kcondvar_t struct is protected by mutex taken externally before * The kcondvar_t struct is protected by mutex taken externally before
* calling any of the wait/signal funs, and passed into the wait funs. * calling any of the wait/signal funs, and passed into the wait funs.
*/ */
#define CV_MAGIC 0x346545f4 #define CV_MAGIC 0x346545f4
#define CV_DESTROY 0x346545f5 #define CV_DESTROY 0x346545f5
typedef struct { typedef struct {
int cv_magic; int cv_magic;
@ -48,30 +48,30 @@ typedef struct {
kmutex_t *cv_mutex; kmutex_t *cv_mutex;
} kcondvar_t; } kcondvar_t;
typedef enum { CV_DEFAULT=0, CV_DRIVER } kcv_type_t; typedef enum { CV_DEFAULT = 0, CV_DRIVER } kcv_type_t;
extern void __cv_init(kcondvar_t *cvp, char *name, kcv_type_t type, void *arg); extern void __cv_init(kcondvar_t *, char *, kcv_type_t, void *);
extern void __cv_destroy(kcondvar_t *cvp); extern void __cv_destroy(kcondvar_t *);
extern void __cv_wait(kcondvar_t *cvp, kmutex_t *mp); extern void __cv_wait(kcondvar_t *, kmutex_t *);
extern void __cv_wait_io(kcondvar_t *cvp, kmutex_t *mp); extern void __cv_wait_io(kcondvar_t *, kmutex_t *);
extern void __cv_wait_interruptible(kcondvar_t *cvp, kmutex_t *mp); extern void __cv_wait_sig(kcondvar_t *, kmutex_t *);
extern clock_t __cv_timedwait(kcondvar_t *cvp, kmutex_t *mp, clock_t exp_time); extern clock_t __cv_timedwait(kcondvar_t *, kmutex_t *, clock_t);
extern clock_t __cv_timedwait_interruptible(kcondvar_t *cvp, kmutex_t *mp, extern clock_t __cv_timedwait_sig(kcondvar_t *, kmutex_t *, clock_t);
clock_t exp_time); extern clock_t cv_timedwait_hires(kcondvar_t *, kmutex_t *, hrtime_t,
extern clock_t cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp, hrtime_t res, int flag);
hrtime_t tim, hrtime_t res, int flag); extern void __cv_signal(kcondvar_t *);
extern void __cv_signal(kcondvar_t *cvp); extern void __cv_broadcast(kcondvar_t *c);
extern void __cv_broadcast(kcondvar_t *cvp);
#define cv_init(cvp, name, type, arg) __cv_init(cvp, name, type, arg) #define cv_init(cvp, name, type, arg) __cv_init(cvp, name, type, arg)
#define cv_destroy(cvp) __cv_destroy(cvp) #define cv_destroy(cvp) __cv_destroy(cvp)
#define cv_wait(cvp, mp) __cv_wait(cvp, mp) #define cv_wait(cvp, mp) __cv_wait(cvp, mp)
#define cv_wait_io(cvp, mp) __cv_wait_io(cvp, mp) #define cv_wait_io(cvp, mp) __cv_wait_io(cvp, mp)
#define cv_wait_interruptible(cvp, mp) __cv_wait_interruptible(cvp,mp) #define cv_wait_sig(cvp, mp) __cv_wait_sig(cvp, mp)
#define cv_timedwait(cvp, mp, t) __cv_timedwait(cvp, mp, t) #define cv_wait_interruptible(cvp, mp) cv_wait_sig(cvp, mp)
#define cv_timedwait_interruptible(cvp, mp, t) \ #define cv_timedwait(cvp, mp, t) __cv_timedwait(cvp, mp, t)
__cv_timedwait_interruptible(cvp, mp, t) #define cv_timedwait_sig(cvp, mp, t) __cv_timedwait_sig(cvp, mp, t)
#define cv_signal(cvp) __cv_signal(cvp) #define cv_timedwait_interruptible(cvp, mp, t) cv_timedwait_sig(cvp, mp, t)
#define cv_broadcast(cvp) __cv_broadcast(cvp) #define cv_signal(cvp) __cv_signal(cvp)
#define cv_broadcast(cvp) __cv_broadcast(cvp)
#endif /* _SPL_CONDVAR_H */ #endif /* _SPL_CONDVAR_H */

View File

@ -1,4 +1,4 @@
/*****************************************************************************\ /*
* Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC. * Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
* Copyright (C) 2007 The Regents of the University of California. * Copyright (C) 2007 The Regents of the University of California.
* Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). * Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
@ -20,9 +20,9 @@
* *
* You should have received a copy of the GNU General Public License along * You should have received a copy of the GNU General Public License along
* with the SPL. If not, see <http://www.gnu.org/licenses/>. * with the SPL. If not, see <http://www.gnu.org/licenses/>.
***************************************************************************** *
* Solaris Porting Layer (SPL) Credential Implementation. * Solaris Porting Layer (SPL) Credential Implementation.
\*****************************************************************************/ */
#include <sys/condvar.h> #include <sys/condvar.h>
#include <sys/time.h> #include <sys/time.h>
@ -50,10 +50,10 @@ cv_destroy_wakeup(kcondvar_t *cvp)
if (!atomic_read(&cvp->cv_waiters) && !atomic_read(&cvp->cv_refs)) { if (!atomic_read(&cvp->cv_waiters) && !atomic_read(&cvp->cv_refs)) {
ASSERT(cvp->cv_mutex == NULL); ASSERT(cvp->cv_mutex == NULL);
ASSERT(!waitqueue_active(&cvp->cv_event)); ASSERT(!waitqueue_active(&cvp->cv_event));
return 1; return (1);
} }
return 0; return (0);
} }
void void
@ -82,7 +82,7 @@ cv_wait_common(kcondvar_t *cvp, kmutex_t *mp, int state, int io)
DEFINE_WAIT(wait); DEFINE_WAIT(wait);
ASSERT(cvp); ASSERT(cvp);
ASSERT(mp); ASSERT(mp);
ASSERT(cvp->cv_magic == CV_MAGIC); ASSERT(cvp->cv_magic == CV_MAGIC);
ASSERT(mutex_owned(mp)); ASSERT(mutex_owned(mp));
atomic_inc(&cvp->cv_refs); atomic_inc(&cvp->cv_refs);
@ -96,9 +96,11 @@ cv_wait_common(kcondvar_t *cvp, kmutex_t *mp, int state, int io)
prepare_to_wait_exclusive(&cvp->cv_event, &wait, state); prepare_to_wait_exclusive(&cvp->cv_event, &wait, state);
atomic_inc(&cvp->cv_waiters); atomic_inc(&cvp->cv_waiters);
/* Mutex should be dropped after prepare_to_wait() this /*
* Mutex should be dropped after prepare_to_wait() this
* ensures we're linked in to the waiters list and avoids the * ensures we're linked in to the waiters list and avoids the
* race where 'cvp->cv_waiters > 0' but the list is empty. */ * race where 'cvp->cv_waiters > 0' but the list is empty.
*/
mutex_exit(mp); mutex_exit(mp);
if (io) if (io)
io_schedule(); io_schedule();
@ -124,11 +126,11 @@ __cv_wait(kcondvar_t *cvp, kmutex_t *mp)
EXPORT_SYMBOL(__cv_wait); EXPORT_SYMBOL(__cv_wait);
void void
__cv_wait_interruptible(kcondvar_t *cvp, kmutex_t *mp) __cv_wait_sig(kcondvar_t *cvp, kmutex_t *mp)
{ {
cv_wait_common(cvp, mp, TASK_INTERRUPTIBLE, 0); cv_wait_common(cvp, mp, TASK_INTERRUPTIBLE, 0);
} }
EXPORT_SYMBOL(__cv_wait_interruptible); EXPORT_SYMBOL(__cv_wait_sig);
void void
__cv_wait_io(kcondvar_t *cvp, kmutex_t *mp) __cv_wait_io(kcondvar_t *cvp, kmutex_t *mp)
@ -137,18 +139,19 @@ __cv_wait_io(kcondvar_t *cvp, kmutex_t *mp)
} }
EXPORT_SYMBOL(__cv_wait_io); EXPORT_SYMBOL(__cv_wait_io);
/* 'expire_time' argument is an absolute wall clock time in jiffies. /*
* 'expire_time' argument is an absolute wall clock time in jiffies.
* Return value is time left (expire_time - now) or -1 if timeout occurred. * Return value is time left (expire_time - now) or -1 if timeout occurred.
*/ */
static clock_t static clock_t
__cv_timedwait_common(kcondvar_t *cvp, kmutex_t *mp, __cv_timedwait_common(kcondvar_t *cvp, kmutex_t *mp, clock_t expire_time,
clock_t expire_time, int state) int state)
{ {
DEFINE_WAIT(wait); DEFINE_WAIT(wait);
clock_t time_left; clock_t time_left;
ASSERT(cvp); ASSERT(cvp);
ASSERT(mp); ASSERT(mp);
ASSERT(cvp->cv_magic == CV_MAGIC); ASSERT(cvp->cv_magic == CV_MAGIC);
ASSERT(mutex_owned(mp)); ASSERT(mutex_owned(mp));
atomic_inc(&cvp->cv_refs); atomic_inc(&cvp->cv_refs);
@ -169,9 +172,11 @@ __cv_timedwait_common(kcondvar_t *cvp, kmutex_t *mp,
prepare_to_wait_exclusive(&cvp->cv_event, &wait, state); prepare_to_wait_exclusive(&cvp->cv_event, &wait, state);
atomic_inc(&cvp->cv_waiters); atomic_inc(&cvp->cv_waiters);
/* Mutex should be dropped after prepare_to_wait() this /*
* Mutex should be dropped after prepare_to_wait() this
* ensures we're linked in to the waiters list and avoids the * ensures we're linked in to the waiters list and avoids the
* race where 'cvp->cv_waiters > 0' but the list is empty. */ * race where 'cvp->cv_waiters > 0' but the list is empty.
*/
mutex_exit(mp); mutex_exit(mp);
time_left = schedule_timeout(time_left); time_left = schedule_timeout(time_left);
mutex_enter(mp); mutex_enter(mp);
@ -191,24 +196,24 @@ __cv_timedwait_common(kcondvar_t *cvp, kmutex_t *mp,
clock_t clock_t
__cv_timedwait(kcondvar_t *cvp, kmutex_t *mp, clock_t exp_time) __cv_timedwait(kcondvar_t *cvp, kmutex_t *mp, clock_t exp_time)
{ {
return __cv_timedwait_common(cvp, mp, exp_time, TASK_UNINTERRUPTIBLE); return (__cv_timedwait_common(cvp, mp, exp_time, TASK_UNINTERRUPTIBLE));
} }
EXPORT_SYMBOL(__cv_timedwait); EXPORT_SYMBOL(__cv_timedwait);
clock_t clock_t
__cv_timedwait_interruptible(kcondvar_t *cvp, kmutex_t *mp, clock_t exp_time) __cv_timedwait_sig(kcondvar_t *cvp, kmutex_t *mp, clock_t exp_time)
{ {
return __cv_timedwait_common(cvp, mp, exp_time, TASK_INTERRUPTIBLE); return (__cv_timedwait_common(cvp, mp, exp_time, TASK_INTERRUPTIBLE));
} }
EXPORT_SYMBOL(__cv_timedwait_interruptible); EXPORT_SYMBOL(__cv_timedwait_sig);
/* /*
*'expire_time' argument is an absolute clock time in nanoseconds. * 'expire_time' argument is an absolute clock time in nanoseconds.
* Return value is time left (expire_time - now) or -1 if timeout occurred. * Return value is time left (expire_time - now) or -1 if timeout occurred.
*/ */
static clock_t static clock_t
__cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp, __cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp, hrtime_t expire_time,
hrtime_t expire_time, int state) int state)
{ {
DEFINE_WAIT(wait); DEFINE_WAIT(wait);
hrtime_t time_left, now; hrtime_t time_left, now;
@ -237,12 +242,16 @@ __cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp,
prepare_to_wait_exclusive(&cvp->cv_event, &wait, state); prepare_to_wait_exclusive(&cvp->cv_event, &wait, state);
atomic_inc(&cvp->cv_waiters); atomic_inc(&cvp->cv_waiters);
/* Mutex should be dropped after prepare_to_wait() this /*
* Mutex should be dropped after prepare_to_wait() this
* ensures we're linked in to the waiters list and avoids the * ensures we're linked in to the waiters list and avoids the
* race where 'cvp->cv_waiters > 0' but the list is empty. */ * race where 'cvp->cv_waiters > 0' but the list is empty.
*/
mutex_exit(mp); mutex_exit(mp);
/* Allow a 100 us range to give kernel an opportunity to coalesce /*
* interrupts */ * Allow a 100 us range to give kernel an opportunity to coalesce
* interrupts
*/
usleep_range(time_left_us, time_left_us + 100); usleep_range(time_left_us, time_left_us + 100);
mutex_enter(mp); mutex_enter(mp);
@ -263,8 +272,8 @@ __cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp,
* Compatibility wrapper for the cv_timedwait_hires() Illumos interface. * Compatibility wrapper for the cv_timedwait_hires() Illumos interface.
*/ */
clock_t clock_t
cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp, hrtime_t tim, cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp, hrtime_t tim, hrtime_t res,
hrtime_t res, int flag) int flag)
{ {
if (res > 1) { if (res > 1) {
/* /*
@ -278,7 +287,7 @@ cv_timedwait_hires(kcondvar_t *cvp, kmutex_t *mp, hrtime_t tim,
if (!(flag & CALLOUT_FLAG_ABSOLUTE)) if (!(flag & CALLOUT_FLAG_ABSOLUTE))
tim += gethrtime(); tim += gethrtime();
return __cv_timedwait_hires(cvp, mp, tim, TASK_UNINTERRUPTIBLE); return (__cv_timedwait_hires(cvp, mp, tim, TASK_UNINTERRUPTIBLE));
} }
EXPORT_SYMBOL(cv_timedwait_hires); EXPORT_SYMBOL(cv_timedwait_hires);
@ -289,10 +298,12 @@ __cv_signal(kcondvar_t *cvp)
ASSERT(cvp->cv_magic == CV_MAGIC); ASSERT(cvp->cv_magic == CV_MAGIC);
atomic_inc(&cvp->cv_refs); atomic_inc(&cvp->cv_refs);
/* All waiters are added with WQ_FLAG_EXCLUSIVE so only one /*
* All waiters are added with WQ_FLAG_EXCLUSIVE so only one
* waiter will be set runable with each call to wake_up(). * waiter will be set runable with each call to wake_up().
* Additionally wake_up() holds a spin_lock assoicated with * Additionally wake_up() holds a spin_lock assoicated with
* the wait queue to ensure we don't race waking up processes. */ * the wait queue to ensure we don't race waking up processes.
*/
if (atomic_read(&cvp->cv_waiters) > 0) if (atomic_read(&cvp->cv_waiters) > 0)
wake_up(&cvp->cv_event); wake_up(&cvp->cv_event);
@ -307,8 +318,10 @@ __cv_broadcast(kcondvar_t *cvp)
ASSERT(cvp->cv_magic == CV_MAGIC); ASSERT(cvp->cv_magic == CV_MAGIC);
atomic_inc(&cvp->cv_refs); atomic_inc(&cvp->cv_refs);
/* Wake_up_all() will wake up all waiters even those which /*
* have the WQ_FLAG_EXCLUSIVE flag set. */ * Wake_up_all() will wake up all waiters even those which
* have the WQ_FLAG_EXCLUSIVE flag set.
*/
if (atomic_read(&cvp->cv_waiters) > 0) if (atomic_read(&cvp->cv_waiters) > 0)
wake_up_all(&cvp->cv_event); wake_up_all(&cvp->cv_event);