xref: /illumos-gate/usr/src/lib/libc/inc/mtlib.h (revision bdfc6d18da790deeec2e0eb09c625902defe2498)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_MTLIB_H
28 #define	_MTLIB_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <thread.h>
33 
34 #ifdef	__cplusplus
35 extern "C" {
36 #endif
37 
38 /* these are private to the library */
39 extern	int	primary_link_map;
40 extern	int	_private_mutex_init(mutex_t *, int, void *);
41 extern	int	_private_mutex_destroy(mutex_t *);
42 extern	int	_private_mutex_lock(mutex_t *);
43 extern	int	_private_mutex_trylock(mutex_t *);
44 extern	int	_private_mutex_unlock(mutex_t *);
45 #define	rmutex_lock	_private_mutex_lock
46 #define	rmutex_trylock	_private_mutex_trylock
47 #define	rmutex_unlock	_private_mutex_unlock
48 extern	void	lmutex_lock(mutex_t *);
49 extern	void	lmutex_unlock(mutex_t *);
50 extern	int	__rwlock_init(rwlock_t *, int, void *);
51 extern	int	__rwlock_destroy(rwlock_t *);
52 extern	int	__rw_rdlock(rwlock_t *);
53 extern	int	__rw_wrlock(rwlock_t *);
54 extern	int	__rw_tryrdlock(rwlock_t *);
55 extern	int	__rw_trywrlock(rwlock_t *);
56 extern	int	__rw_unlock(rwlock_t *);
57 extern	void	lrw_rdlock(rwlock_t *);
58 extern	void	lrw_wrlock(rwlock_t *);
59 extern	void	lrw_unlock(rwlock_t *);
60 
61 /* the rest are public functions */
62 extern	int	_mutex_init(mutex_t *, int, void *);
63 extern	int	_mutex_destroy(mutex_t *);
64 extern	int	_mutex_lock(mutex_t *);
65 extern	int	_mutex_trylock(mutex_t *);
66 extern	int	_mutex_unlock(mutex_t *);
67 extern	int	__mutex_init(mutex_t *, int, void *);
68 extern	int	__mutex_destroy(mutex_t *);
69 extern	int	__mutex_lock(mutex_t *);
70 extern	int	__mutex_trylock(mutex_t *);
71 extern	int	__mutex_unlock(mutex_t *);
72 
73 extern	int	_cond_init(cond_t *, int, void *);
74 extern	int	_cond_destroy(cond_t *);
75 extern	int	_cond_wait(cond_t *, mutex_t *);
76 extern	int	_cond_timedwait(cond_t *, mutex_t *, const timespec_t *);
77 extern	int	_cond_reltimedwait(cond_t *, mutex_t *, const timespec_t *);
78 extern	int	_cond_signal(cond_t *);
79 extern	int	_cond_broadcast(cond_t *);
80 
81 extern	int	_rwlock_init(rwlock_t *, int, void *);
82 extern	int	_rwlock_destroy(rwlock_t *);
83 extern	int	_rw_rdlock(rwlock_t *);
84 extern	int	_rw_wrlock(rwlock_t *);
85 extern	int	_rw_tryrdlock(rwlock_t *);
86 extern	int	_rw_trywrlock(rwlock_t *);
87 extern	int	_rw_unlock(rwlock_t *);
88 
89 extern	int	_thr_main(void);
90 extern	thread_t _thr_self(void);
91 extern	void	_thr_exit(void *);
92 extern	size_t	_thr_min_stack(void);
93 extern	int	_thr_kill(thread_t, int);
94 extern	int	_thr_keycreate(thread_key_t *, void (*)(void *));
95 extern	int	_thr_setspecific(thread_key_t, void *);
96 extern	int	_thr_getspecific(thread_key_t, void **);
97 extern	void	*_pthread_getspecific(thread_key_t);
98 
99 #if defined(THREAD_DEBUG)
100 extern	void	assert_no_libc_locks_held(void);
101 #else
102 #define	assert_no_libc_locks_held()
103 #endif
104 
105 #define	_FWRITE _fwrite_unlocked
106 #define	FILENO(s) _fileno_unlocked(s)
107 #define	FEOF(s) _feof_unlocked(s)
108 #define	FERROR(s) _ferror_unlocked(s)
109 #define	CLEARERR(s) _clearerr_unlocked(s)
110 #define	GETC(s) _getc_unlocked(s)
111 #define	UNGETC(c, s) _ungetc_unlocked(c, s)
112 #define	PUTC(c, s) _putc_unlocked(c, s)
113 #define	GETWC(s) getwc(s)
114 #define	PUTWC(c, s) putwc(c, s)
115 
116 /*
117  * Cheap check to tell if stdio needs to lock for MT progs.
118  * Referenced directly in port/stdio/flush.c and FLOCKFILE and
119  * FUNLOCKFILE macros.  __threaded gets set to 1 when the first
120  * thread (beyond the main thread) is created in _thrp_create().
121  */
122 extern	int	__threaded;
123 
124 #define	FILELOCKING(iop)	(GET_IONOLOCK(iop) == 0)
125 
126 #define	FLOCKFILE(lk, iop) \
127 	{ \
128 		if (__threaded && FILELOCKING(iop)) \
129 			lk = _flockget((iop)); \
130 		else \
131 			lk = NULL; \
132 	}
133 
134 #define	FUNLOCKFILE(lk) \
135 	{ \
136 		if (lk != NULL) \
137 			_flockrel(lk); \
138 	}
139 
140 #define	FLOCKRETURN(iop, ret) \
141 	{	int r; \
142 		rmutex_t *lk; \
143 		FLOCKFILE(lk, iop); \
144 		r = (ret); \
145 		FUNLOCKFILE(lk); \
146 		return (r); \
147 	}
148 
149 #ifdef	__cplusplus
150 }
151 #endif
152 
153 #endif	/* _MTLIB_H */
154