xref: /titanic_51/usr/src/lib/libc/inc/mtlib.h (revision 0cd13cbfb4270b840b4bd22ec5f673b2b6a2c02b)
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 (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2008 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	void	lmutex_lock(mutex_t *);
41 extern	void	lmutex_unlock(mutex_t *);
42 extern	int	__rwlock_init(rwlock_t *, int, void *);
43 extern	int	__rwlock_destroy(rwlock_t *);
44 extern	int	__rw_rdlock(rwlock_t *);
45 extern	int	__rw_wrlock(rwlock_t *);
46 extern	int	__rw_tryrdlock(rwlock_t *);
47 extern	int	__rw_trywrlock(rwlock_t *);
48 extern	int	__rw_unlock(rwlock_t *);
49 extern	void	lrw_rdlock(rwlock_t *);
50 extern	void	lrw_wrlock(rwlock_t *);
51 extern	void	lrw_unlock(rwlock_t *);
52 extern	void	sig_mutex_lock(mutex_t *);
53 extern	void	sig_mutex_unlock(mutex_t *);
54 extern	int	sig_mutex_trylock(mutex_t *);
55 extern	int	sig_cond_wait(cond_t *, mutex_t *);
56 extern	int	sig_cond_reltimedwait(cond_t *, mutex_t *, const timespec_t *);
57 extern	void	cancel_safe_mutex_lock(mutex_t *);
58 extern	void	cancel_safe_mutex_unlock(mutex_t *);
59 extern	int	cancel_safe_mutex_trylock(mutex_t *);
60 extern	int	cancel_active(void);
61 
62 /* the private libc thread-safe allocator */
63 extern	void	*lmalloc(size_t);
64 extern	void	lfree(void *, size_t);
65 
66 /* the rest are public functions */
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 extern	int	__mutex_init(mutex_t *, int, void *);
73 extern	int	__mutex_destroy(mutex_t *);
74 extern	int	__mutex_lock(mutex_t *);
75 extern	int	__mutex_trylock(mutex_t *);
76 extern	int	__mutex_unlock(mutex_t *);
77 
78 extern	int	_cond_init(cond_t *, int, void *);
79 extern	int	_cond_destroy(cond_t *);
80 extern	int	__cond_wait(cond_t *, mutex_t *);
81 extern	int	__cond_timedwait(cond_t *, mutex_t *, const timespec_t *);
82 extern	int	__cond_reltimedwait(cond_t *, mutex_t *, const timespec_t *);
83 extern	int	_cond_signal(cond_t *);
84 extern	int	_cond_broadcast(cond_t *);
85 
86 extern	int	_rwlock_init(rwlock_t *, int, void *);
87 extern	int	_rwlock_destroy(rwlock_t *);
88 extern	int	_rw_rdlock(rwlock_t *);
89 extern	int	_rw_wrlock(rwlock_t *);
90 extern	int	_rw_tryrdlock(rwlock_t *);
91 extern	int	_rw_trywrlock(rwlock_t *);
92 extern	int	_rw_unlock(rwlock_t *);
93 
94 extern	int	_thr_main(void);
95 extern	thread_t _thr_self(void);
96 extern	int	_thrp_cancelled(void);
97 extern	void	_thr_exit(void *);
98 extern	size_t	_thr_min_stack(void);
99 extern	int	_thr_kill(thread_t, int);
100 extern	int	_thr_create(void *, size_t, void *(*)(void *), void *, long,
101 			thread_t *);
102 extern	int	_thr_keycreate(thread_key_t *, void (*)(void *));
103 extern	int	_thr_keycreate_once(thread_key_t *, void (*)(void *));
104 extern	int	_thr_setspecific(thread_key_t, void *);
105 extern	int	_thr_getspecific(thread_key_t, void **);
106 extern	void	*_pthread_getspecific(thread_key_t);
107 
108 #if defined(THREAD_DEBUG)
109 extern	void	assert_no_libc_locks_held(void);
110 #else
111 #define	assert_no_libc_locks_held()
112 #endif
113 
114 #define	_FWRITE _fwrite_unlocked
115 #define	FILENO(s) _fileno(s)
116 #define	FERROR(s) ferror(s)
117 #define	GETC(s) _getc_unlocked(s)
118 #define	UNGETC(c, s) _ungetc_unlocked(c, s)
119 #define	PUTC(c, s) _putc_unlocked(c, s)
120 #define	GETWC(s) getwc(s)
121 #define	PUTWC(c, s) putwc(c, s)
122 
123 /*
124  * Cheap check to tell if stdio needs to lock for MT progs.
125  * Referenced directly in port/stdio/flush.c and FLOCKFILE and
126  * FUNLOCKFILE macros.  __libc_threaded gets set to 1 when the first
127  * thread (beyond the main thread) is created in _thrp_create().
128  */
129 extern	int	__libc_threaded;
130 
131 #define	FILELOCKING(iop)	(GET_IONOLOCK(iop) == 0)
132 
133 #define	FLOCKFILE(lk, iop) \
134 	{ \
135 		if (__libc_threaded && FILELOCKING(iop)) \
136 			lk = _flockget((iop)); \
137 		else \
138 			lk = NULL; \
139 	}
140 
141 #define	FUNLOCKFILE(lk) \
142 	{ \
143 		if (lk != NULL) \
144 			_flockrel(lk); \
145 	}
146 
147 #define	FLOCKRETURN(iop, ret) \
148 	{	int r; \
149 		rmutex_t *lk; \
150 		FLOCKFILE(lk, iop); \
151 		r = (ret); \
152 		FUNLOCKFILE(lk); \
153 		return (r); \
154 	}
155 
156 #ifdef	__cplusplus
157 }
158 #endif
159 
160 #endif	/* _MTLIB_H */
161