include/sys/condvar.h

   1 /*****************************************************************************\
   2  *  Copyright (C) 2007-2010 Lawrence Livermore National Security, LLC.
   3  *  Copyright (C) 2007 The Regents of the University of California.
   4  *  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
   5  *  Written by Brian Behlendorf <behlendorf1@llnl.gov>.
   6  *  UCRL-CODE-235197
   7  *
   8  *  This file is part of the SPL, Solaris Porting Layer.
   9  *  For details, see <http://github.com/behlendorf/spl/>.
  10  *
  11  *  The SPL is free software; you can redistribute it and/or modify it
  12  *  under the terms of the GNU General Public License as published by the
  13  *  Free Software Foundation; either version 2 of the License, or (at your
  14  *  option) any later version.
  15  *
  16  *  The SPL is distributed in the hope that it will be useful, but WITHOUT
  17  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18  *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19  *  for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License along
  22  *  with the SPL.  If not, see <http://www.gnu.org/licenses/>.
  23 \*****************************************************************************/
  24
  25 #ifndef _SPL_CONDVAR_H
  26 #define _SPL_CONDVAR_H
  27
  28 #include <linux/module.h>
  29 #include <linux/wait.h>
  30 #include <sys/kmem.h>
  31 #include <sys/mutex.h>
  32
  33 /*
  34  * The kcondvar_t struct is protected by mutex taken externally before
  35  * calling any of the wait/signal funs, and passed into the wait funs.
  36  */
  37 #define CV_MAGIC                        0x346545f4
  38 #define CV_POISON                       0x95
  39
  40 typedef struct {
  41         int cv_magic;
  42         char *cv_name;
  43         int cv_name_size;
  44         wait_queue_head_t cv_event;
  45         atomic_t cv_waiters;
  46         kmutex_t *cv_mutex;
  47         spinlock_t cv_lock;
  48 } kcondvar_t;
  49
  50 typedef enum { CV_DEFAULT=0, CV_DRIVER } kcv_type_t;
  51
  52 extern void __cv_init(kcondvar_t *cvp, char *name, kcv_type_t type, void *arg);
  53 extern void __cv_destroy(kcondvar_t *cvp);
  54 extern void __cv_wait(kcondvar_t *cvp, kmutex_t *mp);
  55 extern void __cv_wait_interruptible(kcondvar_t *cvp, kmutex_t *mp);
  56 extern clock_t __cv_timedwait(kcondvar_t *cvp, kmutex_t *mp, clock_t exp_time);
  57 extern void __cv_signal(kcondvar_t *cvp);
  58 extern void __cv_broadcast(kcondvar_t *cvp);
  59
  60 #define cv_init(cvp, name, type, arg)                                 \
  61 ({                                                                    \
  62         if ((name) == NULL)                                           \
  63                 __cv_init(cvp, #cvp, type, arg);                      \
  64         else                                                          \
  65                 __cv_init(cvp, name, type, arg);                      \
  66 })
  67 #define cv_destroy(cvp)                 __cv_destroy(cvp)
  68 #define cv_wait(cvp, mp)                __cv_wait(cvp, mp)
  69 #define cv_wait_interruptible(cvp, mp)  __cv_wait_interruptible(cvp, mp)
  70 #define cv_timedwait(cvp, mp, t)        __cv_timedwait(cvp, mp, t)
  71 #define cv_signal(cvp)                  __cv_signal(cvp)
  72 #define cv_broadcast(cvp)               __cv_broadcast(cvp)
  73
  74 #endif /* _SPL_CONDVAR_H */