Home | History | Annotate | Line # | Download | only in sys 
      1 /*	$NetBSD: condvar.h,v 1.19 2023/11/02 10:31:55 martin Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2006, 2007, 2008, 2020 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Andrew Doran.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #ifndef _SYS_CONDVAR_H_
     33 #define	_SYS_CONDVAR_H_
     34 
     35 typedef struct kcondvar {
     36 	void		*cv_opaque[2];
     37 } kcondvar_t;
     38 
     39 #ifdef _KERNEL
     40 
     41 struct bintime;
     42 struct kmutex;
     43 struct timespec;
     44 
     45 void	cv_init(kcondvar_t *, const char *);
     46 void	cv_destroy(kcondvar_t *);
     47 
     48 void	cv_wait(kcondvar_t *, struct kmutex *);
     49 int	cv_wait_sig(kcondvar_t *, struct kmutex *);
     50 int	cv_timedwait(kcondvar_t *, struct kmutex *, int);
     51 int	cv_timedwait_sig(kcondvar_t *, struct kmutex *, int);
     52 int	cv_timedwaitbt(kcondvar_t *, struct kmutex *, struct bintime *,
     53 	    const struct bintime *);
     54 int	cv_timedwaitbt_sig(kcondvar_t *, struct kmutex *, struct bintime *,
     55 	    const struct bintime *);
     56 
     57 void	cv_signal(kcondvar_t *);
     58 void	cv_broadcast(kcondvar_t *);
     59 
     60 bool	cv_has_waiters(kcondvar_t *);
     61 bool	cv_is_valid(kcondvar_t *);
     62 
     63 /* The "lightning bolt", awoken once per second by the clock interrupt. */
     64 extern kcondvar_t lbolt;
     65 
     66 #endif	/* _KERNEL */
     67 
     68 #endif /* _SYS_CONDVAR_H_ */
     69