]> git.sur5r.net Git - openldap/blob - include/ldap_pvt_thread.h
a runqueue for periodic thread execution (for syncrepl)
[openldap] / include / ldap_pvt_thread.h
1 /* $OpenLDAP$ */
2 /*
3  * Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted only as authorized by the OpenLDAP
8  * Public License.  A copy of this license is available at
9  * http://www.OpenLDAP.org/license.html or in file LICENSE in the
10  * top-level directory of the distribution.
11  */
12 /* ldap_pvt_thread.h - ldap threads header file NG */
13
14 #ifndef _LDAP_PVT_THREAD_H
15 #define _LDAP_PVT_THREAD_H
16
17 #include "ldap_cdefs.h"
18 #include "ldap_int_thread.h"
19
20 LDAP_BEGIN_DECL
21
22 typedef ldap_int_thread_t ldap_pvt_thread_t;
23 typedef ldap_int_thread_mutex_t ldap_pvt_thread_mutex_t;
24 typedef ldap_int_thread_cond_t ldap_pvt_thread_cond_t;
25
26 LDAP_F( int )
27 ldap_pvt_thread_initialize LDAP_P(( void ));
28
29 LDAP_F( int )
30 ldap_pvt_thread_destroy LDAP_P(( void ));
31
32 LDAP_F( unsigned int )
33 ldap_pvt_thread_sleep LDAP_P(( unsigned int s ));
34
35 LDAP_F( int )
36 ldap_pvt_thread_get_concurrency LDAP_P(( void ));
37
38 LDAP_F( int )
39 ldap_pvt_thread_set_concurrency LDAP_P(( int ));
40
41 #define LDAP_PVT_THREAD_CREATE_JOINABLE 0
42 #define LDAP_PVT_THREAD_CREATE_DETACHED 1
43
44 #ifndef LDAP_PVT_THREAD_STACK_SIZE
45         /* LARGE stack */
46 #define LDAP_PVT_THREAD_STACK_SIZE      (4*1024*1024)
47 #endif
48
49 LDAP_F( int )
50 ldap_pvt_thread_create LDAP_P((
51         ldap_pvt_thread_t * thread,
52         int     detach,
53         void *(*start_routine)( void * ),
54         void *arg));
55
56 LDAP_F( void )
57 ldap_pvt_thread_exit LDAP_P(( void *retval ));
58
59 LDAP_F( int )
60 ldap_pvt_thread_join LDAP_P(( ldap_pvt_thread_t thread, void **status ));
61
62 LDAP_F( int )
63 ldap_pvt_thread_kill LDAP_P(( ldap_pvt_thread_t thread, int signo ));
64
65 LDAP_F( int )
66 ldap_pvt_thread_yield LDAP_P(( void ));
67
68 LDAP_F( int )
69 ldap_pvt_thread_cond_init LDAP_P(( ldap_pvt_thread_cond_t *cond ));
70
71 LDAP_F( int )
72 ldap_pvt_thread_cond_destroy LDAP_P(( ldap_pvt_thread_cond_t *cond ));
73
74 LDAP_F( int )
75 ldap_pvt_thread_cond_signal LDAP_P(( ldap_pvt_thread_cond_t *cond ));
76
77 LDAP_F( int )
78 ldap_pvt_thread_cond_broadcast LDAP_P(( ldap_pvt_thread_cond_t *cond ));
79
80 LDAP_F( int )
81 ldap_pvt_thread_cond_wait LDAP_P((
82         ldap_pvt_thread_cond_t *cond,
83         ldap_pvt_thread_mutex_t *mutex ));
84
85 LDAP_F( int )
86 ldap_pvt_thread_mutex_init LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
87
88 LDAP_F( int )
89 ldap_pvt_thread_mutex_destroy LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
90
91 LDAP_F( int )
92 ldap_pvt_thread_mutex_lock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
93
94 LDAP_F( int )
95 ldap_pvt_thread_mutex_trylock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
96
97 LDAP_F( int )
98 ldap_pvt_thread_mutex_unlock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
99
100 LDAP_F( ldap_pvt_thread_t )
101 ldap_pvt_thread_self LDAP_P(( void ));
102
103 #ifndef LDAP_THREAD_HAVE_RDWR
104 typedef struct ldap_int_thread_rdwr_s * ldap_pvt_thread_rdwr_t;
105 #endif
106
107 LDAP_F( int )
108 ldap_pvt_thread_rdwr_init LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
109
110 LDAP_F( int )
111 ldap_pvt_thread_rdwr_destroy LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
112
113 LDAP_F( int )
114 ldap_pvt_thread_rdwr_rlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
115
116 LDAP_F( int )
117 ldap_pvt_thread_rdwr_rtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
118
119 LDAP_F( int )
120 ldap_pvt_thread_rdwr_runlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
121
122 LDAP_F( int )
123 ldap_pvt_thread_rdwr_wlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
124
125 LDAP_F( int )
126 ldap_pvt_thread_rdwr_wtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
127
128 LDAP_F( int )
129 ldap_pvt_thread_rdwr_wunlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
130
131 #ifdef LDAP_DEBUG
132 LDAP_F( int )
133 ldap_pvt_thread_rdwr_readers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
134
135 LDAP_F( int )
136 ldap_pvt_thread_rdwr_writers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
137
138 LDAP_F( int )
139 ldap_pvt_thread_rdwr_active LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
140 #endif /* LDAP_DEBUG */
141
142 #define LDAP_PVT_THREAD_EINVAL EINVAL
143 #define LDAP_PVT_THREAD_EBUSY EINVAL
144
145 typedef ldap_int_thread_pool_t ldap_pvt_thread_pool_t;
146
147 typedef void * (ldap_pvt_thread_start_t) LDAP_P((void *ctx, void *arg));
148 typedef void (ldap_pvt_thread_pool_keyfree_t) LDAP_P((void *key, void *data));
149
150 LDAP_F( int )
151 ldap_pvt_thread_pool_init LDAP_P((
152         ldap_pvt_thread_pool_t *pool_out,
153         int max_threads,
154         int max_pending ));
155
156 LDAP_F( int )
157 ldap_pvt_thread_pool_submit LDAP_P((
158         ldap_pvt_thread_pool_t *pool,
159         ldap_pvt_thread_start_t *start,
160         void *arg ));
161
162 LDAP_F( int )
163 ldap_pvt_thread_pool_maxthreads LDAP_P((
164         ldap_pvt_thread_pool_t *pool,
165         int max_threads ));
166
167 LDAP_F( int )
168 ldap_pvt_thread_pool_backload LDAP_P((
169         ldap_pvt_thread_pool_t *pool ));
170
171 LDAP_F( int )
172 ldap_pvt_thread_pool_destroy LDAP_P((
173         ldap_pvt_thread_pool_t *pool,
174         int run_pending ));
175
176 LDAP_F( int )
177 ldap_pvt_thread_pool_getkey LDAP_P((
178         void *ctx,
179         void *key,
180         void **data,
181         ldap_pvt_thread_pool_keyfree_t **kfree ));
182
183 LDAP_F( int )
184 ldap_pvt_thread_pool_setkey LDAP_P((
185         void *ctx,
186         void *key,
187         void *data,
188         ldap_pvt_thread_pool_keyfree_t *kfree ));
189
190 LDAP_F( void *)
191 ldap_pvt_thread_pool_context LDAP_P(( void ));
192
193 LDAP_END_DECL
194
195 #endif /* _LDAP_THREAD_H */