1 /* ldap_pvt_thread.h - ldap threads header file */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2007 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;
32 typedef ldap_int_thread_mutex_t ldap_pvt_thread_mutex_t;
33 typedef ldap_int_thread_cond_t ldap_pvt_thread_cond_t;
34 typedef ldap_int_thread_rdwr_t ldap_pvt_thread_rdwr_t;
36 typedef ldap_int_thread_rmutex_t ldap_pvt_thread_rmutex_t;
37 #endif /* !LDAP_PVT_THREAD_H_DONE */
39 #define ldap_pvt_thread_equal ldap_int_thread_equal
42 ldap_pvt_thread_initialize LDAP_P(( void ));
45 ldap_pvt_thread_destroy LDAP_P(( void ));
47 LDAP_F( unsigned int )
48 ldap_pvt_thread_sleep LDAP_P(( unsigned int s ));
51 ldap_pvt_thread_get_concurrency LDAP_P(( void ));
54 ldap_pvt_thread_set_concurrency LDAP_P(( int ));
56 #define LDAP_PVT_THREAD_CREATE_JOINABLE 0
57 #define LDAP_PVT_THREAD_CREATE_DETACHED 1
59 #ifndef LDAP_PVT_THREAD_H_DONE
60 #define LDAP_PVT_THREAD_SET_STACK_SIZE
61 #ifndef LDAP_PVT_THREAD_STACK_SIZE
62 /* LARGE stack. Will be twice as large on 64 bit machine. */
63 #define LDAP_PVT_THREAD_STACK_SIZE ( 1 * 1024 * 1024 * sizeof(void *) )
64 /* May be explicitly defined to zero to disable it */
65 #elif LDAP_PVT_THREAD_STACK_SIZE == 0
66 #undef LDAP_PVT_THREAD_SET_STACK_SIZE
68 #endif /* !LDAP_PVT_THREAD_H_DONE */
71 ldap_pvt_thread_create LDAP_P((
72 ldap_pvt_thread_t * thread,
74 void *(*start_routine)( void * ),
78 ldap_pvt_thread_exit LDAP_P(( void *retval ));
81 ldap_pvt_thread_join LDAP_P(( ldap_pvt_thread_t thread, void **status ));
84 ldap_pvt_thread_kill LDAP_P(( ldap_pvt_thread_t thread, int signo ));
87 ldap_pvt_thread_yield LDAP_P(( void ));
90 ldap_pvt_thread_cond_init LDAP_P(( ldap_pvt_thread_cond_t *cond ));
93 ldap_pvt_thread_cond_destroy LDAP_P(( ldap_pvt_thread_cond_t *cond ));
96 ldap_pvt_thread_cond_signal LDAP_P(( ldap_pvt_thread_cond_t *cond ));
99 ldap_pvt_thread_cond_broadcast LDAP_P(( ldap_pvt_thread_cond_t *cond ));
102 ldap_pvt_thread_cond_wait LDAP_P((
103 ldap_pvt_thread_cond_t *cond,
104 ldap_pvt_thread_mutex_t *mutex ));
107 ldap_pvt_thread_mutex_init LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
110 ldap_pvt_thread_mutex_destroy LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
113 ldap_pvt_thread_mutex_lock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
116 ldap_pvt_thread_mutex_trylock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
119 ldap_pvt_thread_mutex_unlock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
122 ldap_pvt_thread_rmutex_init LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex ));
125 ldap_pvt_thread_rmutex_destroy LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex ));
128 ldap_pvt_thread_rmutex_lock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex,
129 ldap_pvt_thread_t owner));
132 ldap_pvt_thread_rmutex_trylock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex,
133 ldap_pvt_thread_t owner));
136 ldap_pvt_thread_rmutex_unlock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex,
137 ldap_pvt_thread_t owner));
139 LDAP_F( ldap_pvt_thread_t )
140 ldap_pvt_thread_self LDAP_P(( void ));
142 #ifdef LDAP_INT_THREAD_ASSERT_MUTEX_OWNER
143 #define LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER LDAP_INT_THREAD_ASSERT_MUTEX_OWNER
145 #define LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER(mutex) ((void) 0)
149 ldap_pvt_thread_rdwr_init LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
152 ldap_pvt_thread_rdwr_destroy LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
155 ldap_pvt_thread_rdwr_rlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
158 ldap_pvt_thread_rdwr_rtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
161 ldap_pvt_thread_rdwr_runlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
164 ldap_pvt_thread_rdwr_wlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
167 ldap_pvt_thread_rdwr_wtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
170 ldap_pvt_thread_rdwr_wunlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
174 ldap_pvt_thread_rdwr_readers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
177 ldap_pvt_thread_rdwr_writers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
180 ldap_pvt_thread_rdwr_active LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
181 #endif /* LDAP_DEBUG */
183 #define LDAP_PVT_THREAD_EINVAL EINVAL
184 #define LDAP_PVT_THREAD_EBUSY EINVAL
186 #ifndef LDAP_PVT_THREAD_H_DONE
187 typedef ldap_int_thread_pool_t ldap_pvt_thread_pool_t;
189 typedef void * (ldap_pvt_thread_start_t) LDAP_P((void *ctx, void *arg));
190 typedef void (ldap_pvt_thread_pool_keyfree_t) LDAP_P((void *key, void *data));
191 #endif /* !LDAP_PVT_THREAD_H_DONE */
194 ldap_pvt_thread_pool_init LDAP_P((
195 ldap_pvt_thread_pool_t *pool_out,
200 ldap_pvt_thread_pool_submit LDAP_P((
201 ldap_pvt_thread_pool_t *pool,
202 ldap_pvt_thread_start_t *start,
206 ldap_pvt_thread_pool_maxthreads LDAP_P((
207 ldap_pvt_thread_pool_t *pool,
210 #ifndef LDAP_PVT_THREAD_H_DONE
212 LDAP_PVT_THREAD_POOL_PARAM_UNKNOWN = -1,
213 LDAP_PVT_THREAD_POOL_PARAM_MAX,
214 LDAP_PVT_THREAD_POOL_PARAM_MAX_PENDING,
215 LDAP_PVT_THREAD_POOL_PARAM_OPEN,
216 LDAP_PVT_THREAD_POOL_PARAM_STARTING,
217 LDAP_PVT_THREAD_POOL_PARAM_ACTIVE,
218 LDAP_PVT_THREAD_POOL_PARAM_PENDING,
219 LDAP_PVT_THREAD_POOL_PARAM_BACKLOAD,
220 LDAP_PVT_THREAD_POOL_PARAM_ACTIVE_MAX,
221 LDAP_PVT_THREAD_POOL_PARAM_PENDING_MAX,
222 LDAP_PVT_THREAD_POOL_PARAM_BACKLOAD_MAX,
223 LDAP_PVT_THREAD_POOL_PARAM_STATE
224 } ldap_pvt_thread_pool_param_t;
225 #endif /* !LDAP_PVT_THREAD_H_DONE */
228 ldap_pvt_thread_pool_query LDAP_P((
229 ldap_pvt_thread_pool_t *pool,
230 ldap_pvt_thread_pool_param_t param, void *value ));
233 ldap_pvt_thread_pool_backload LDAP_P((
234 ldap_pvt_thread_pool_t *pool ));
237 ldap_pvt_thread_pool_pause LDAP_P((
238 ldap_pvt_thread_pool_t *pool ));
241 ldap_pvt_thread_pool_resume LDAP_P((
242 ldap_pvt_thread_pool_t *pool ));
245 ldap_pvt_thread_pool_destroy LDAP_P((
246 ldap_pvt_thread_pool_t *pool,
250 ldap_pvt_thread_pool_getkey LDAP_P((
254 ldap_pvt_thread_pool_keyfree_t **kfree ));
257 ldap_pvt_thread_pool_setkey LDAP_P((
261 ldap_pvt_thread_pool_keyfree_t *kfree ));
264 ldap_pvt_thread_pool_purgekey LDAP_P(( void *key ));
267 ldap_pvt_thread_pool_context LDAP_P(( void ));
270 ldap_pvt_thread_pool_context_reset LDAP_P(( void *key ));
272 LDAP_F( ldap_pvt_thread_t )
273 ldap_pvt_thread_pool_tid LDAP_P(( void *ctx ));
277 #define LDAP_PVT_THREAD_H_DONE
278 #endif /* _LDAP_PVT_THREAD_H */