xref: /onnv-gate/usr/src/uts/common/sys/condvar.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate /*
28*0Sstevel@tonic-gate  * condvar.h:
29*0Sstevel@tonic-gate  *
30*0Sstevel@tonic-gate  * definitions for thread synchronization primitives: condition variables
31*0Sstevel@tonic-gate  * This is the public part of the interface to condition variables. The
32*0Sstevel@tonic-gate  * private (implementation-specific) part is in <arch>/sys/condvar_impl.h.
33*0Sstevel@tonic-gate  */
34*0Sstevel@tonic-gate 
35*0Sstevel@tonic-gate #ifndef _SYS_CONDVAR_H
36*0Sstevel@tonic-gate #define	_SYS_CONDVAR_H
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate #ifndef	_ASM
41*0Sstevel@tonic-gate #include <sys/types.h>
42*0Sstevel@tonic-gate #include <sys/time.h>
43*0Sstevel@tonic-gate #ifdef _KERNEL
44*0Sstevel@tonic-gate #include <sys/mutex.h>
45*0Sstevel@tonic-gate #endif	/* _KERNEL */
46*0Sstevel@tonic-gate #endif	/* _ASM */
47*0Sstevel@tonic-gate 
48*0Sstevel@tonic-gate #ifdef	__cplusplus
49*0Sstevel@tonic-gate extern "C" {
50*0Sstevel@tonic-gate #endif
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate #ifndef	_ASM
53*0Sstevel@tonic-gate 
54*0Sstevel@tonic-gate /*
55*0Sstevel@tonic-gate  * Condtion variables.
56*0Sstevel@tonic-gate  */
57*0Sstevel@tonic-gate 
58*0Sstevel@tonic-gate typedef struct _kcondvar {
59*0Sstevel@tonic-gate 	ushort_t	_opaque;
60*0Sstevel@tonic-gate } kcondvar_t;
61*0Sstevel@tonic-gate 
62*0Sstevel@tonic-gate typedef	enum {
63*0Sstevel@tonic-gate 	CV_DEFAULT,
64*0Sstevel@tonic-gate 	CV_DRIVER
65*0Sstevel@tonic-gate } kcv_type_t;
66*0Sstevel@tonic-gate 
67*0Sstevel@tonic-gate 
68*0Sstevel@tonic-gate #if defined(_KERNEL)
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate /*
71*0Sstevel@tonic-gate  * condition variable function prototypes
72*0Sstevel@tonic-gate  */
73*0Sstevel@tonic-gate 
74*0Sstevel@tonic-gate extern	void	cv_init(kcondvar_t *, char *, kcv_type_t, void *);
75*0Sstevel@tonic-gate extern  void	cv_destroy(kcondvar_t *);
76*0Sstevel@tonic-gate extern	void	cv_wait(kcondvar_t *, kmutex_t *);
77*0Sstevel@tonic-gate extern	void	cv_wait_stop(kcondvar_t *, kmutex_t *, int);
78*0Sstevel@tonic-gate extern	clock_t	cv_timedwait(kcondvar_t *, kmutex_t *, clock_t);
79*0Sstevel@tonic-gate extern	int	cv_wait_sig(kcondvar_t *, kmutex_t *);
80*0Sstevel@tonic-gate extern	clock_t	cv_timedwait_sig(kcondvar_t *, kmutex_t *, clock_t);
81*0Sstevel@tonic-gate extern	int	cv_wait_sig_swap(kcondvar_t *, kmutex_t *);
82*0Sstevel@tonic-gate extern	int	cv_wait_sig_swap_core(kcondvar_t *, kmutex_t *, int *);
83*0Sstevel@tonic-gate extern	void	cv_signal(kcondvar_t *);
84*0Sstevel@tonic-gate extern	void	cv_broadcast(kcondvar_t *);
85*0Sstevel@tonic-gate extern	int	cv_waituntil_sig(kcondvar_t *, kmutex_t *, timestruc_t *, int);
86*0Sstevel@tonic-gate 
87*0Sstevel@tonic-gate #endif	/* defined(_KERNEL) */
88*0Sstevel@tonic-gate 
89*0Sstevel@tonic-gate #endif	/* _ASM */
90*0Sstevel@tonic-gate 
91*0Sstevel@tonic-gate #ifdef	__cplusplus
92*0Sstevel@tonic-gate }
93*0Sstevel@tonic-gate #endif
94*0Sstevel@tonic-gate 
95*0Sstevel@tonic-gate #endif	/* _SYS_CONDVAR_H */
96