1 /* ldap_pvt_thread.h - ldap threads header file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2017 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
17 #ifndef _LDAP_PVT_THREAD_H
18 #define _LDAP_PVT_THREAD_H /* libldap_r/ldap_thr_debug.h #undefines this */
20 #include "ldap_cdefs.h"
21 #include "ldap_int_thread.h"
25 #ifndef LDAP_PVT_THREAD_H_DONE
26 typedef ldap_int_thread_t ldap_pvt_thread_t;
27 #ifdef LDAP_THREAD_DEBUG_WRAP
28 typedef ldap_debug_thread_mutex_t ldap_pvt_thread_mutex_t;
29 typedef ldap_debug_thread_cond_t ldap_pvt_thread_cond_t;
30 typedef ldap_debug_thread_rdwr_t ldap_pvt_thread_rdwr_t;
31 #define LDAP_PVT_MUTEX_FIRSTCREATE LDAP_DEBUG_MUTEX_FIRSTCREATE
32 #define LDAP_PVT_MUTEX_NULL LDAP_DEBUG_MUTEX_NULL
34 typedef ldap_int_thread_mutex_t ldap_pvt_thread_mutex_t;
35 typedef ldap_int_thread_cond_t ldap_pvt_thread_cond_t;
36 typedef ldap_int_thread_rdwr_t ldap_pvt_thread_rdwr_t;
37 #define LDAP_PVT_MUTEX_FIRSTCREATE LDAP_INT_MUTEX_FIRSTCREATE
38 #define LDAP_PVT_MUTEX_NULL LDAP_INT_MUTEX_NULL
40 typedef ldap_int_thread_mutex_recursive_t ldap_pvt_thread_mutex_recursive_t;
41 typedef ldap_int_thread_rmutex_t ldap_pvt_thread_rmutex_t;
42 typedef ldap_int_thread_key_t ldap_pvt_thread_key_t;
43 #endif /* !LDAP_PVT_THREAD_H_DONE */
45 #define ldap_pvt_thread_equal ldap_int_thread_equal
48 ldap_pvt_thread_initialize LDAP_P(( void ));
51 ldap_pvt_thread_destroy LDAP_P(( void ));
53 LDAP_F( unsigned int )
54 ldap_pvt_thread_sleep LDAP_P(( unsigned int s ));
57 ldap_pvt_thread_get_concurrency LDAP_P(( void ));
60 ldap_pvt_thread_set_concurrency LDAP_P(( int ));
62 #define LDAP_PVT_THREAD_CREATE_JOINABLE 0
63 #define LDAP_PVT_THREAD_CREATE_DETACHED 1
65 #ifndef LDAP_PVT_THREAD_H_DONE
66 #define LDAP_PVT_THREAD_SET_STACK_SIZE
67 /* The size may be explicitly #defined to zero to disable it. */
68 #if defined( LDAP_PVT_THREAD_STACK_SIZE ) && LDAP_PVT_THREAD_STACK_SIZE == 0
69 # undef LDAP_PVT_THREAD_SET_STACK_SIZE
70 #elif !defined( LDAP_PVT_THREAD_STACK_SIZE )
71 /* LARGE stack. Will be twice as large on 64 bit machine. */
72 # define LDAP_PVT_THREAD_STACK_SIZE ( 1 * 1024 * 1024 * sizeof(void *) )
74 #endif /* !LDAP_PVT_THREAD_H_DONE */
77 ldap_pvt_thread_create LDAP_P((
78 ldap_pvt_thread_t * thread,
80 void *(*start_routine)( void * ),
84 ldap_pvt_thread_exit LDAP_P(( void *retval ));
87 ldap_pvt_thread_join LDAP_P(( ldap_pvt_thread_t thread, void **status ));
90 ldap_pvt_thread_kill LDAP_P(( ldap_pvt_thread_t thread, int signo ));
93 ldap_pvt_thread_yield LDAP_P(( void ));
96 ldap_pvt_thread_cond_init LDAP_P(( ldap_pvt_thread_cond_t *cond ));
99 ldap_pvt_thread_cond_destroy LDAP_P(( ldap_pvt_thread_cond_t *cond ));
102 ldap_pvt_thread_cond_signal LDAP_P(( ldap_pvt_thread_cond_t *cond ));
105 ldap_pvt_thread_cond_broadcast LDAP_P(( ldap_pvt_thread_cond_t *cond ));
108 ldap_pvt_thread_cond_wait LDAP_P((
109 ldap_pvt_thread_cond_t *cond,
110 ldap_pvt_thread_mutex_t *mutex ));
113 ldap_pvt_thread_mutex_init LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
116 ldap_pvt_thread_mutex_recursive_init LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
119 ldap_pvt_thread_mutex_destroy LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
122 ldap_pvt_thread_mutex_recursive_destroy LDAP_P(( ldap_pvt_thread_mutex_recursive_t *mutex ));
125 ldap_pvt_thread_mutex_lock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
128 ldap_pvt_thread_mutex_trylock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
131 ldap_pvt_thread_mutex_unlock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
134 ldap_pvt_thread_mutex_recursive_lock LDAP_P(( ldap_pvt_thread_mutex_recursive_t *mutex ));
137 ldap_pvt_thread_mutex_recursive_trylock LDAP_P(( ldap_pvt_thread_mutex_recursive_t *mutex ));
140 ldap_pvt_thread_mutex_recursive_unlock LDAP_P(( ldap_pvt_thread_mutex_recursive_t *mutex ));
143 ldap_pvt_thread_rmutex_init LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex ));
146 ldap_pvt_thread_rmutex_destroy LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex ));
149 ldap_pvt_thread_rmutex_lock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex,
150 ldap_pvt_thread_t owner));
153 ldap_pvt_thread_rmutex_trylock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex,
154 ldap_pvt_thread_t owner));
157 ldap_pvt_thread_rmutex_unlock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex,
158 ldap_pvt_thread_t owner));
160 LDAP_F( ldap_pvt_thread_t )
161 ldap_pvt_thread_self LDAP_P(( void ));
163 #ifdef LDAP_INT_THREAD_ASSERT_MUTEX_OWNER
164 #define LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER LDAP_INT_THREAD_ASSERT_MUTEX_OWNER
166 #define LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER(mutex) ((void) 0)
170 ldap_pvt_thread_rdwr_init LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
173 ldap_pvt_thread_rdwr_destroy LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
176 ldap_pvt_thread_rdwr_rlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
179 ldap_pvt_thread_rdwr_rtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
182 ldap_pvt_thread_rdwr_runlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
185 ldap_pvt_thread_rdwr_wlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
188 ldap_pvt_thread_rdwr_wtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
191 ldap_pvt_thread_rdwr_wunlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
194 ldap_pvt_thread_key_create LDAP_P((ldap_pvt_thread_key_t *keyp));
197 ldap_pvt_thread_key_destroy LDAP_P((ldap_pvt_thread_key_t key));
200 ldap_pvt_thread_key_setdata LDAP_P((ldap_pvt_thread_key_t key, void *data));
203 ldap_pvt_thread_key_getdata LDAP_P((ldap_pvt_thread_key_t key, void **data));
207 ldap_pvt_thread_rdwr_readers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
210 ldap_pvt_thread_rdwr_writers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
213 ldap_pvt_thread_rdwr_active LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
214 #endif /* LDAP_DEBUG */
216 #define LDAP_PVT_THREAD_EINVAL EINVAL
217 #define LDAP_PVT_THREAD_EBUSY EINVAL
219 #ifndef LDAP_PVT_THREAD_H_DONE
220 typedef ldap_int_thread_pool_t ldap_pvt_thread_pool_t;
222 typedef void * (ldap_pvt_thread_start_t) LDAP_P((void *ctx, void *arg));
223 typedef void (ldap_pvt_thread_pool_keyfree_t) LDAP_P((void *key, void *data));
224 #endif /* !LDAP_PVT_THREAD_H_DONE */
227 ldap_pvt_thread_pool_init LDAP_P((
228 ldap_pvt_thread_pool_t *pool_out,
233 ldap_pvt_thread_pool_init_q LDAP_P((
234 ldap_pvt_thread_pool_t *pool_out,
240 ldap_pvt_thread_pool_submit LDAP_P((
241 ldap_pvt_thread_pool_t *pool,
242 ldap_pvt_thread_start_t *start,
246 ldap_pvt_thread_pool_submit2 LDAP_P((
247 ldap_pvt_thread_pool_t *pool,
248 ldap_pvt_thread_start_t *start,
253 ldap_pvt_thread_pool_retract LDAP_P((
257 ldap_pvt_thread_pool_maxthreads LDAP_P((
258 ldap_pvt_thread_pool_t *pool,
262 ldap_pvt_thread_pool_queues LDAP_P((
263 ldap_pvt_thread_pool_t *pool,
266 #ifndef LDAP_PVT_THREAD_H_DONE
268 LDAP_PVT_THREAD_POOL_PARAM_UNKNOWN = -1,
269 LDAP_PVT_THREAD_POOL_PARAM_MAX,
270 LDAP_PVT_THREAD_POOL_PARAM_MAX_PENDING,
271 LDAP_PVT_THREAD_POOL_PARAM_OPEN,
272 LDAP_PVT_THREAD_POOL_PARAM_STARTING,
273 LDAP_PVT_THREAD_POOL_PARAM_ACTIVE,
274 LDAP_PVT_THREAD_POOL_PARAM_PAUSING,
275 LDAP_PVT_THREAD_POOL_PARAM_PENDING,
276 LDAP_PVT_THREAD_POOL_PARAM_BACKLOAD,
277 LDAP_PVT_THREAD_POOL_PARAM_ACTIVE_MAX,
278 LDAP_PVT_THREAD_POOL_PARAM_PENDING_MAX,
279 LDAP_PVT_THREAD_POOL_PARAM_BACKLOAD_MAX,
280 LDAP_PVT_THREAD_POOL_PARAM_STATE
281 } ldap_pvt_thread_pool_param_t;
282 #endif /* !LDAP_PVT_THREAD_H_DONE */
285 ldap_pvt_thread_pool_query LDAP_P((
286 ldap_pvt_thread_pool_t *pool,
287 ldap_pvt_thread_pool_param_t param, void *value ));
290 ldap_pvt_thread_pool_pausing LDAP_P((
291 ldap_pvt_thread_pool_t *pool ));
294 ldap_pvt_thread_pool_backload LDAP_P((
295 ldap_pvt_thread_pool_t *pool ));
298 ldap_pvt_thread_pool_idle LDAP_P((
299 ldap_pvt_thread_pool_t *pool ));
302 ldap_pvt_thread_pool_unidle LDAP_P((
303 ldap_pvt_thread_pool_t *pool ));
306 ldap_pvt_thread_pool_pausecheck LDAP_P((
307 ldap_pvt_thread_pool_t *pool ));
310 ldap_pvt_thread_pool_pause LDAP_P((
311 ldap_pvt_thread_pool_t *pool ));
314 ldap_pvt_thread_pool_resume LDAP_P((
315 ldap_pvt_thread_pool_t *pool ));
318 ldap_pvt_thread_pool_destroy LDAP_P((
319 ldap_pvt_thread_pool_t *pool,
323 ldap_pvt_thread_pool_getkey LDAP_P((
327 ldap_pvt_thread_pool_keyfree_t **kfree ));
330 ldap_pvt_thread_pool_setkey LDAP_P((
334 ldap_pvt_thread_pool_keyfree_t *kfree,
336 ldap_pvt_thread_pool_keyfree_t **oldkfreep ));
339 ldap_pvt_thread_pool_purgekey LDAP_P(( void *key ));
342 ldap_pvt_thread_pool_context LDAP_P(( void ));
345 ldap_pvt_thread_pool_context_reset LDAP_P(( void *key ));
347 LDAP_F( ldap_pvt_thread_t )
348 ldap_pvt_thread_pool_tid LDAP_P(( void *ctx ));
352 #define LDAP_PVT_THREAD_H_DONE
353 #endif /* _LDAP_PVT_THREAD_H */