include/os/linux/spl/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://zfsonlinux.org/>.
  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 <sys/kmem.h>
  30 #include <sys/mutex.h>
  31 #include <sys/callo.h>
  32 #include <sys/wait.h>
  33 #include <sys/time.h>
  34
  35 /*
  36  * The kcondvar_t struct is protected by mutex taken externally before
  37  * calling any of the wait/signal funs, and passed into the wait funs.
  38  */
  39 #define CV_MAGIC                        0x346545f4
  40 #define CV_DESTROY                      0x346545f5
  41
  42 typedef struct {
  43         int cv_magic;
  44         spl_wait_queue_head_t cv_event;
  45         spl_wait_queue_head_t cv_destroy;
  46         atomic_t cv_refs;
  47         atomic_t cv_waiters;
  48         kmutex_t *cv_mutex;
  49 } kcondvar_t;
  50
  51 typedef enum { CV_DEFAULT = 0, CV_DRIVER } kcv_type_t;
  52
  53 extern void __cv_init(kcondvar_t *, char *, kcv_type_t, void *);
  54 extern void __cv_destroy(kcondvar_t *);
  55 extern void __cv_wait(kcondvar_t *, kmutex_t *);
  56 extern void __cv_wait_io(kcondvar_t *, kmutex_t *);
  57 extern int __cv_wait_io_sig(kcondvar_t *, kmutex_t *);
  58 extern int __cv_wait_sig(kcondvar_t *, kmutex_t *);
  59 extern clock_t __cv_timedwait(kcondvar_t *, kmutex_t *, clock_t);
  60 extern clock_t __cv_timedwait_io(kcondvar_t *, kmutex_t *, clock_t);
  61 extern clock_t __cv_timedwait_sig(kcondvar_t *, kmutex_t *, clock_t);
  62 extern clock_t cv_timedwait_hires(kcondvar_t *, kmutex_t *, hrtime_t,
  63     hrtime_t res, int flag);
  64 extern clock_t cv_timedwait_sig_hires(kcondvar_t *, kmutex_t *, hrtime_t,
  65     hrtime_t res, int flag);
  66 extern void __cv_signal(kcondvar_t *);
  67 extern void __cv_broadcast(kcondvar_t *c);
  68
  69 #define cv_init(cvp, name, type, arg)           __cv_init(cvp, name, type, arg)
  70 #define cv_destroy(cvp)                         __cv_destroy(cvp)
  71 #define cv_wait(cvp, mp)                        __cv_wait(cvp, mp)
  72 #define cv_wait_io(cvp, mp)                     __cv_wait_io(cvp, mp)
  73 #define cv_wait_io_sig(cvp, mp)                 __cv_wait_io_sig(cvp, mp)
  74 #define cv_wait_sig(cvp, mp)                    __cv_wait_sig(cvp, mp)
  75 #define cv_wait_interruptible(cvp, mp)          cv_wait_sig(cvp, mp)
  76 #define cv_timedwait(cvp, mp, t)                __cv_timedwait(cvp, mp, t)
  77 #define cv_timedwait_io(cvp, mp, t)             __cv_timedwait_io(cvp, mp, t)
  78 #define cv_timedwait_sig(cvp, mp, t)            __cv_timedwait_sig(cvp, mp, t)
  79 #define cv_timedwait_interruptible(cvp, mp, t)  cv_timedwait_sig(cvp, mp, t)
  80 #define cv_signal(cvp)                          __cv_signal(cvp)
  81 #define cv_broadcast(cvp)                       __cv_broadcast(cvp)
  82
  83 #endif /* _SPL_CONDVAR_H */