ldap_int_thread.h 8.06 KB
Newer Older
1
/* ldap_int_thread.h - ldap internal thread wrappers header file */
Mark Valence's avatar
Mark Valence committed
2
/* $OpenLDAP$ */
3
4
/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
 * 
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
5
 * Copyright 1998-2020 The OpenLDAP Foundation.
Mark Valence's avatar
Mark Valence committed
6
7
 * All rights reserved.
 *
8
9
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted only as authorized by the OpenLDAP
10
11
12
13
14
 * Public License.
 *
 * A copy of this license is available in file LICENSE in the
 * top-level directory of the distribution or, alternatively, at
 * <http://www.OpenLDAP.org/license.html>.
Mark Valence's avatar
Mark Valence committed
15
16
 */

17
18
19
20
21
22
23
24
25
26

LDAP_BEGIN_DECL

/* Can be done twice in libldap_r.  See libldap_r/ldap_thr_debug.h. */
LDAP_F(int) ldap_int_thread_initialize LDAP_P(( void ));
LDAP_F(int) ldap_int_thread_destroy    LDAP_P(( void ));

LDAP_END_DECL


Mark Valence's avatar
Mark Valence committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
#ifndef _LDAP_INT_THREAD_H
#define _LDAP_INT_THREAD_H

#if defined( HAVE_PTHREADS )
/**********************************
 *                                *
 * definitions for POSIX Threads  *
 *                                *
 **********************************/

#include <pthread.h>
#ifdef HAVE_SCHED_H
#include <sched.h>
#endif

LDAP_BEGIN_DECL

typedef pthread_t		ldap_int_thread_t;
typedef pthread_mutex_t		ldap_int_thread_mutex_t;
typedef pthread_cond_t		ldap_int_thread_cond_t;
47
typedef pthread_key_t		ldap_int_thread_key_t;
Mark Valence's avatar
Mark Valence committed
48

49
50
#define ldap_int_thread_equal(a, b)	pthread_equal((a), (b))

Mark Valence's avatar
Mark Valence committed
51
52
53
54
55
56
57
58
#if defined( _POSIX_REENTRANT_FUNCTIONS ) || \
	defined( _POSIX_THREAD_SAFE_FUNCTIONS ) || \
	defined( _POSIX_THREADSAFE_FUNCTIONS )
#define HAVE_REENTRANT_FUNCTIONS 1
#endif

#if defined( HAVE_PTHREAD_GETCONCURRENCY ) || \
	defined( HAVE_THR_GETCONCURRENCY )
59
#define LDAP_THREAD_HAVE_GETCONCURRENCY 1
Mark Valence's avatar
Mark Valence committed
60
61
62
63
#endif

#if defined( HAVE_PTHREAD_SETCONCURRENCY ) || \
	defined( HAVE_THR_SETCONCURRENCY )
64
#define LDAP_THREAD_HAVE_SETCONCURRENCY 1
Mark Valence's avatar
Mark Valence committed
65
66
#endif

67
#if defined( HAVE_PTHREAD_RWLOCK_DESTROY )
68
#define LDAP_THREAD_HAVE_RDWR 1
69
typedef pthread_rwlock_t ldap_int_thread_rdwr_t;
70
71
#endif

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
72
73
74
75
76
#ifndef LDAP_INT_MUTEX_NULL
#define LDAP_INT_MUTEX_NULL	PTHREAD_MUTEX_INITIALIZER
#define LDAP_INT_MUTEX_FIRSTCREATE(m)	((void) 0)
#endif

Mark Valence's avatar
Mark Valence committed
77
78
79
80
81
82
83
84
85
LDAP_END_DECL

#elif defined ( HAVE_MACH_CTHREADS )
/**********************************
 *                                *
 * definitions for Mach CThreads  *
 *                                *
 **********************************/

Kurt Zeilenga's avatar
Kurt Zeilenga committed
86
87
#if defined( HAVE_MACH_CTHREADS_H )
#	include <mach/cthreads.h>
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
88
#elif defined( HAVE_CTHREADS_H )
Kurt Zeilenga's avatar
Kurt Zeilenga committed
89
90
#	include <cthreads.h>
#endif
Mark Valence's avatar
Mark Valence committed
91
92
93
94
95
96

LDAP_BEGIN_DECL

typedef cthread_t		ldap_int_thread_t;
typedef struct mutex		ldap_int_thread_mutex_t;
typedef struct condition	ldap_int_thread_cond_t;
97
typedef cthread_key_t		ldap_int_thread_key_t;
Mark Valence's avatar
Mark Valence committed
98

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
99
100
101
102
103
#ifndef LDAP_INT_MUTEX_NULL
#define LDAP_INT_MUTEX_NULL	MUTEX_INITIALIZER
#define LDAP_INT_MUTEX_FIRSTCREATE(m)	((void) 0)
#endif

Mark Valence's avatar
Mark Valence committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
LDAP_END_DECL

#elif defined( HAVE_GNU_PTH )
/***********************************
 *                                 *
 * thread definitions for GNU Pth  *
 *                                 *
 ***********************************/

#define PTH_SYSCALL_SOFT 1
#include <pth.h>

LDAP_BEGIN_DECL

typedef pth_t		ldap_int_thread_t;
typedef pth_mutex_t	ldap_int_thread_mutex_t;
typedef pth_cond_t	ldap_int_thread_cond_t;
121
typedef pth_key_t	ldap_int_thread_key_t;
Mark Valence's avatar
Mark Valence committed
122

123
#if 0
124
#define LDAP_THREAD_HAVE_RDWR 1
125
typedef pth_rwlock_t ldap_int_thread_rdwr_t;
126
#endif
127

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
128
129
130
131
132
#ifndef LDAP_INT_MUTEX_NULL
#define LDAP_INT_MUTEX_NULL	PTH_MUTEX_INIT
#define LDAP_INT_MUTEX_FIRSTCREATE(m)	((void) 0)
#endif

Mark Valence's avatar
Mark Valence committed
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
LDAP_END_DECL

#elif defined( HAVE_THR )
/********************************************
 *                                          *
 * thread definitions for Solaris LWP (THR) *
 *                                          *
 ********************************************/

#include <thread.h>
#include <synch.h>

LDAP_BEGIN_DECL

typedef thread_t		ldap_int_thread_t;
typedef mutex_t			ldap_int_thread_mutex_t;
typedef cond_t			ldap_int_thread_cond_t;
150
typedef thread_key_t	ldap_int_thread_key_t;
Mark Valence's avatar
Mark Valence committed
151
152
153
154

#define HAVE_REENTRANT_FUNCTIONS 1

#ifdef HAVE_THR_GETCONCURRENCY
155
#define LDAP_THREAD_HAVE_GETCONCURRENCY 1
Mark Valence's avatar
Mark Valence committed
156
157
#endif
#ifdef HAVE_THR_SETCONCURRENCY
158
#define LDAP_THREAD_HAVE_SETCONCURRENCY 1
Mark Valence's avatar
Mark Valence committed
159
160
#endif

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
161
162
163
164
#ifndef LDAP_INT_MUTEX_NULL
#define LDAP_INT_MUTEX_NULL	DEFAULTMUTEX
#define LDAP_INT_MUTEX_FIRSTCREATE(m)	((void) 0)
#endif
Mark Valence's avatar
Mark Valence committed
165
166

#elif defined(HAVE_NT_THREADS)
167
168
169
170
171
/*************************************
 *                                   *
 * thread definitions for NT threads *
 *                                   *
 *************************************/
Mark Valence's avatar
Mark Valence committed
172
173
174
175

#include <process.h>
#include <windows.h>

176
177
LDAP_BEGIN_DECL

Mark Valence's avatar
Mark Valence committed
178
179
180
typedef unsigned long	ldap_int_thread_t;
typedef HANDLE	ldap_int_thread_mutex_t;
typedef HANDLE	ldap_int_thread_cond_t;
181
typedef DWORD	ldap_int_thread_key_t;
Mark Valence's avatar
Mark Valence committed
182

183
184
185
LDAP_F( int )
ldap_pvt_thread_mutex_init_first LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
186
187
188
#ifndef LDAP_INT_MUTEX_NULL
#define LDAP_INT_MUTEX_NULL		((HANDLE)0)
#define LDAP_INT_MUTEX_FIRSTCREATE(m) \
189
		ldap_pvt_thread_mutex_init_first(&(m))
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
190
191
#endif

Mark Valence's avatar
Mark Valence committed
192
193
194
195
196
197
198
199
200
201
202
203
204
205
LDAP_END_DECL

#else
/***********************************
 *                                 *
 * thread definitions for no       *
 * underlying library support      *
 *                                 *
 ***********************************/

#ifndef NO_THREADS
#define NO_THREADS 1
#endif

206
207
LDAP_BEGIN_DECL

Mark Valence's avatar
Mark Valence committed
208
209
210
typedef int			ldap_int_thread_t;
typedef int			ldap_int_thread_mutex_t;
typedef int			ldap_int_thread_cond_t;
211
typedef int			ldap_int_thread_key_t;
Mark Valence's avatar
Mark Valence committed
212

213
214
215
#define LDAP_THREAD_HAVE_TPOOL 1
typedef int			ldap_int_thread_pool_t;

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
216
217
218
219
220
#ifndef LDAP_INT_MUTEX_NULL
#define LDAP_INT_MUTEX_NULL				0
#define LDAP_INT_MUTEX_FIRSTCREATE(m)	((void) 0)
#endif

Mark Valence's avatar
Mark Valence committed
221
222
223
224
LDAP_END_DECL

#endif /* no threads support */

225

Mark Valence's avatar
Mark Valence committed
226
227
LDAP_BEGIN_DECL

228
229
230
231
232
233
234
235
#ifndef ldap_int_thread_equal
#define ldap_int_thread_equal(a, b)	((a) == (b))
#endif

#ifndef LDAP_THREAD_HAVE_RDWR
typedef struct ldap_int_thread_rdwr_s * ldap_int_thread_rdwr_t;
#endif

236
237
LDAP_F(int) ldap_int_thread_pool_startup ( void );
LDAP_F(int) ldap_int_thread_pool_shutdown ( void );
Mark Valence's avatar
Mark Valence committed
238

239
240
#ifndef LDAP_THREAD_HAVE_TPOOL
typedef struct ldap_int_thread_pool_s * ldap_int_thread_pool_t;
Mark Valence's avatar
Mark Valence committed
241
242
#endif

243
typedef struct ldap_int_thread_rmutex_s * ldap_int_thread_rmutex_t;
Mark Valence's avatar
Mark Valence committed
244
245
LDAP_END_DECL

246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263

#if defined(LDAP_THREAD_DEBUG) && !((LDAP_THREAD_DEBUG +0) & 2U)
#define LDAP_THREAD_DEBUG_WRAP 1
#endif

#ifdef LDAP_THREAD_DEBUG_WRAP
/**************************************
 *                                    *
 * definitions for type-wrapped debug *
 *                                    *
 **************************************/

LDAP_BEGIN_DECL

#ifndef LDAP_UINTPTR_T	/* May be configured in CPPFLAGS */
#define LDAP_UINTPTR_T	unsigned long
#endif

264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
typedef enum {
	ldap_debug_magic =	-(int) (((unsigned)-1)/19)
} ldap_debug_magic_t;

typedef enum {
	/* Could fill in "locked" etc here later */
	ldap_debug_state_inited = (int) (((unsigned)-1)/11),
	ldap_debug_state_destroyed
} ldap_debug_state_t;

typedef struct {
	/* Enclosed in magic numbers in the hope of catching overwrites */
	ldap_debug_magic_t	magic;	/* bit pattern to recognize usages  */
	LDAP_UINTPTR_T		self;	/* ~(LDAP_UINTPTR_T)&(this struct) */
	union ldap_debug_mem_u {	/* Dummy memory reference */
		unsigned char	*ptr;
		LDAP_UINTPTR_T	num;
	} mem;
	ldap_debug_state_t	state;	/* doubles as another magic number */
283
284
285
286
287
} ldap_debug_usage_info_t;

typedef struct {
	ldap_int_thread_mutex_t	wrapped;
	ldap_debug_usage_info_t	usage;
288
	ldap_int_thread_t	owner;
289
290
} ldap_debug_thread_mutex_t;

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
291
292
293
294
#define	LDAP_DEBUG_MUTEX_NULL	{LDAP_INT_MUTEX_NULL, {0,0,{0},0} /*,owner*/}
#define	LDAP_DEBUG_MUTEX_FIRSTCREATE(m) \
	((void) ((m).usage.state || ldap_pvt_thread_mutex_init(&(m))))

295
296
297
298
299
300
301
302
303
304
typedef struct {
	ldap_int_thread_cond_t	wrapped;
	ldap_debug_usage_info_t	usage;
} ldap_debug_thread_cond_t;

typedef struct {
	ldap_int_thread_rdwr_t	wrapped;
	ldap_debug_usage_info_t	usage;
} ldap_debug_thread_rdwr_t;

305
#ifndef NDEBUG
306
#define	LDAP_INT_THREAD_ASSERT_MUTEX_OWNER(mutex) \
307
	ldap_debug_thread_assert_mutex_owner( \
Pierangelo Masarati's avatar
Pierangelo Masarati committed
308
		__FILE__, __LINE__, "owns(" #mutex ")", mutex )
309
310
311
312
313
314
LDAP_F(void) ldap_debug_thread_assert_mutex_owner LDAP_P((
	LDAP_CONST char *file,
	int line,
	LDAP_CONST char *msg,
	ldap_debug_thread_mutex_t *mutex ));
#endif /* NDEBUG */
315

316
317
318
319
LDAP_END_DECL

#endif /* LDAP_THREAD_DEBUG_WRAP */

Mark Valence's avatar
Mark Valence committed
320
#endif /* _LDAP_INT_THREAD_H */