sys/sys/condvar.h

   1 /*-
   2  * Copyright (c) 2000 Jake Burkholder <jake@freebsd.org>.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _SYS_CONDVAR_H_
  30 #define _SYS_CONDVAR_H_
  31
  32 #ifndef LOCORE
  33 #include <sys/queue.h>
  34
  35 struct mtx;
  36 struct proc;
  37
  38 TAILQ_HEAD(cv_waitq, proc);
  39
  40 /*
  41  * Condition variable.
  42  */
  43 struct cv {
  44         struct cv_waitq cv_waitq;       /* Queue of condition waiters. */
  45         struct mtx      *cv_mtx;        /*
  46                                          * Mutex passed in by cv_*wait*(),
  47                                          * currently only used for CV_DEBUG.
  48                                          */
  49         const char      *cv_description;
  50 };
  51
  52 #ifdef _KERNEL
  53 void    cv_init(struct cv *cvp, const char *desc);
  54 void    cv_destroy(struct cv *cvp);
  55
  56 void    cv_wait(struct cv *cvp, struct mtx *mp);
  57 int     cv_wait_sig(struct cv *cvp, struct mtx *mp);
  58 int     cv_timedwait(struct cv *cvp, struct mtx *mp, int timo);
  59 int     cv_timedwait_sig(struct cv *cvp, struct mtx *mp, int timo);
  60
  61 void    cv_signal(struct cv *cvp);
  62 void    cv_broadcast(struct cv *cvp);
  63
  64 void    cv_waitq_remove(struct proc *p);
  65
  66 #define cv_waitq_empty(cvp)     (TAILQ_EMPTY(&cvp->cv_waitq))
  67 #define cv_wmesg(cvp)           ((cvp)->cv_description)
  68
  69 #endif  /* _KERNEL */
  70 #endif  /* !LOCORE */
  71 #endif  /* _SYS_CONDVAR_H_ */