git.sur5r.net Git - openldap/blob - include/ldap_pvt_thread.h

   1 /* ldap_pvt_thread.h - ldap threads header file */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1998-2018 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  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>.
  15  */
  16
  17 #ifndef _LDAP_PVT_THREAD_H
  18 #define _LDAP_PVT_THREAD_H /* libldap_r/ldap_thr_debug.h #undefines this */
  19
  20 #include "ldap_cdefs.h"
  21 #include "ldap_int_thread.h"
  22
  23 LDAP_BEGIN_DECL
  24
  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
  33 #else
  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
  39 #endif
  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 */
  44
  45 #define ldap_pvt_thread_equal           ldap_int_thread_equal
  46
  47 LDAP_F( int )
  48 ldap_pvt_thread_initialize LDAP_P(( void ));
  49
  50 LDAP_F( int )
  51 ldap_pvt_thread_destroy LDAP_P(( void ));
  52
  53 LDAP_F( unsigned int )
  54 ldap_pvt_thread_sleep LDAP_P(( unsigned int s ));
  55
  56 LDAP_F( int )
  57 ldap_pvt_thread_get_concurrency LDAP_P(( void ));
  58
  59 LDAP_F( int )
  60 ldap_pvt_thread_set_concurrency LDAP_P(( int ));
  61
  62 #define LDAP_PVT_THREAD_CREATE_JOINABLE 0
  63 #define LDAP_PVT_THREAD_CREATE_DETACHED 1
  64
  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 *) )
  73 #endif
  74 #endif /* !LDAP_PVT_THREAD_H_DONE */
  75
  76 LDAP_F( int )
  77 ldap_pvt_thread_create LDAP_P((
  78         ldap_pvt_thread_t * thread,
  79         int     detach,
  80         void *(*start_routine)( void * ),
  81         void *arg));
  82
  83 LDAP_F( void )
  84 ldap_pvt_thread_exit LDAP_P(( void *retval ));
  85
  86 LDAP_F( int )
  87 ldap_pvt_thread_join LDAP_P(( ldap_pvt_thread_t thread, void **status ));
  88
  89 LDAP_F( int )
  90 ldap_pvt_thread_kill LDAP_P(( ldap_pvt_thread_t thread, int signo ));
  91
  92 LDAP_F( int )
  93 ldap_pvt_thread_yield LDAP_P(( void ));
  94
  95 LDAP_F( int )
  96 ldap_pvt_thread_cond_init LDAP_P(( ldap_pvt_thread_cond_t *cond ));
  97
  98 LDAP_F( int )
  99 ldap_pvt_thread_cond_destroy LDAP_P(( ldap_pvt_thread_cond_t *cond ));
 100
 101 LDAP_F( int )
 102 ldap_pvt_thread_cond_signal LDAP_P(( ldap_pvt_thread_cond_t *cond ));
 103
 104 LDAP_F( int )
 105 ldap_pvt_thread_cond_broadcast LDAP_P(( ldap_pvt_thread_cond_t *cond ));
 106
 107 LDAP_F( int )
 108 ldap_pvt_thread_cond_wait LDAP_P((
 109         ldap_pvt_thread_cond_t *cond,
 110         ldap_pvt_thread_mutex_t *mutex ));
 111
 112 LDAP_F( int )
 113 ldap_pvt_thread_mutex_init LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 114
 115 LDAP_F( int )
 116 ldap_pvt_thread_mutex_recursive_init LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 117
 118 LDAP_F( int )
 119 ldap_pvt_thread_mutex_destroy LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 120
 121 LDAP_F( int )
 122 ldap_pvt_thread_mutex_recursive_destroy LDAP_P(( ldap_pvt_thread_mutex_recursive_t *mutex ));
 123
 124 LDAP_F( int )
 125 ldap_pvt_thread_mutex_lock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 126
 127 LDAP_F( int )
 128 ldap_pvt_thread_mutex_trylock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 129
 130 LDAP_F( int )
 131 ldap_pvt_thread_mutex_unlock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 132
 133 LDAP_F( int )
 134 ldap_pvt_thread_mutex_recursive_lock LDAP_P(( ldap_pvt_thread_mutex_recursive_t *mutex ));
 135
 136 LDAP_F( int )
 137 ldap_pvt_thread_mutex_recursive_trylock LDAP_P(( ldap_pvt_thread_mutex_recursive_t *mutex ));
 138
 139 LDAP_F( int )
 140 ldap_pvt_thread_mutex_recursive_unlock LDAP_P(( ldap_pvt_thread_mutex_recursive_t *mutex ));
 141
 142 LDAP_F( int )
 143 ldap_pvt_thread_rmutex_init LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex ));
 144
 145 LDAP_F( int )
 146 ldap_pvt_thread_rmutex_destroy LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex ));
 147
 148 LDAP_F( int )
 149 ldap_pvt_thread_rmutex_lock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex,
 150         ldap_pvt_thread_t owner));
 151
 152 LDAP_F( int )
 153 ldap_pvt_thread_rmutex_trylock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex,
 154         ldap_pvt_thread_t owner));
 155
 156 LDAP_F( int )
 157 ldap_pvt_thread_rmutex_unlock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex,
 158         ldap_pvt_thread_t owner));
 159
 160 LDAP_F( ldap_pvt_thread_t )
 161 ldap_pvt_thread_self LDAP_P(( void ));
 162
 163 #ifdef  LDAP_INT_THREAD_ASSERT_MUTEX_OWNER
 164 #define LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER LDAP_INT_THREAD_ASSERT_MUTEX_OWNER
 165 #else
 166 #define LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER(mutex) ((void) 0)
 167 #endif
 168
 169 LDAP_F( int )
 170 ldap_pvt_thread_rdwr_init LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 171
 172 LDAP_F( int )
 173 ldap_pvt_thread_rdwr_destroy LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 174
 175 LDAP_F( int )
 176 ldap_pvt_thread_rdwr_rlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 177
 178 LDAP_F( int )
 179 ldap_pvt_thread_rdwr_rtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 180
 181 LDAP_F( int )
 182 ldap_pvt_thread_rdwr_runlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 183
 184 LDAP_F( int )
 185 ldap_pvt_thread_rdwr_wlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 186
 187 LDAP_F( int )
 188 ldap_pvt_thread_rdwr_wtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 189
 190 LDAP_F( int )
 191 ldap_pvt_thread_rdwr_wunlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 192
 193 LDAP_F( int )
 194 ldap_pvt_thread_key_create LDAP_P((ldap_pvt_thread_key_t *keyp));
 195
 196 LDAP_F( int )
 197 ldap_pvt_thread_key_destroy LDAP_P((ldap_pvt_thread_key_t key));
 198
 199 LDAP_F( int )
 200 ldap_pvt_thread_key_setdata LDAP_P((ldap_pvt_thread_key_t key, void *data));
 201
 202 LDAP_F( int )
 203 ldap_pvt_thread_key_getdata LDAP_P((ldap_pvt_thread_key_t key, void **data));
 204
 205 #ifdef LDAP_DEBUG
 206 LDAP_F( int )
 207 ldap_pvt_thread_rdwr_readers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 208
 209 LDAP_F( int )
 210 ldap_pvt_thread_rdwr_writers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 211
 212 LDAP_F( int )
 213 ldap_pvt_thread_rdwr_active LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 214 #endif /* LDAP_DEBUG */
 215
 216 #define LDAP_PVT_THREAD_EINVAL EINVAL
 217 #define LDAP_PVT_THREAD_EBUSY EINVAL
 218
 219 #ifndef LDAP_PVT_THREAD_H_DONE
 220 typedef ldap_int_thread_pool_t ldap_pvt_thread_pool_t;
 221
 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 */
 225
 226 LDAP_F( int )
 227 ldap_pvt_thread_pool_init LDAP_P((
 228         ldap_pvt_thread_pool_t *pool_out,
 229         int max_threads,
 230         int max_pending ));
 231
 232 LDAP_F( int )
 233 ldap_pvt_thread_pool_init_q LDAP_P((
 234         ldap_pvt_thread_pool_t *pool_out,
 235         int max_threads,
 236         int max_pending,
 237         int num_qs ));
 238
 239 LDAP_F( int )
 240 ldap_pvt_thread_pool_submit LDAP_P((
 241         ldap_pvt_thread_pool_t *pool,
 242         ldap_pvt_thread_start_t *start,
 243         void *arg ));
 244
 245 LDAP_F( int )
 246 ldap_pvt_thread_pool_submit2 LDAP_P((
 247         ldap_pvt_thread_pool_t *pool,
 248         ldap_pvt_thread_start_t *start,
 249         void *arg,
 250         void **cookie ));
 251
 252 LDAP_F( int )
 253 ldap_pvt_thread_pool_retract LDAP_P((
 254         void *cookie ));
 255
 256 LDAP_F( int )
 257 ldap_pvt_thread_pool_maxthreads LDAP_P((
 258         ldap_pvt_thread_pool_t *pool,
 259         int max_threads ));
 260
 261 LDAP_F( int )
 262 ldap_pvt_thread_pool_queues LDAP_P((
 263         ldap_pvt_thread_pool_t *pool,
 264         int numqs ));
 265
 266 #ifndef LDAP_PVT_THREAD_H_DONE
 267 typedef enum {
 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 */
 283
 284 LDAP_F( int )
 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 ));
 288
 289 LDAP_F( int )
 290 ldap_pvt_thread_pool_pausing LDAP_P((
 291         ldap_pvt_thread_pool_t *pool ));
 292
 293 LDAP_F( int )
 294 ldap_pvt_thread_pool_backload LDAP_P((
 295         ldap_pvt_thread_pool_t *pool ));
 296
 297 LDAP_F( void )
 298 ldap_pvt_thread_pool_idle LDAP_P((
 299         ldap_pvt_thread_pool_t *pool ));
 300
 301 LDAP_F( void )
 302 ldap_pvt_thread_pool_unidle LDAP_P((
 303         ldap_pvt_thread_pool_t *pool ));
 304
 305 LDAP_F( int )
 306 ldap_pvt_thread_pool_pausecheck LDAP_P((
 307         ldap_pvt_thread_pool_t *pool ));
 308
 309 LDAP_F( int )
 310 ldap_pvt_thread_pool_pause LDAP_P((
 311         ldap_pvt_thread_pool_t *pool ));
 312
 313 LDAP_F( int )
 314 ldap_pvt_thread_pool_resume LDAP_P((
 315         ldap_pvt_thread_pool_t *pool ));
 316
 317 LDAP_F( int )
 318 ldap_pvt_thread_pool_destroy LDAP_P((
 319         ldap_pvt_thread_pool_t *pool,
 320         int run_pending ));
 321
 322 LDAP_F( int )
 323 ldap_pvt_thread_pool_getkey LDAP_P((
 324         void *ctx,
 325         void *key,
 326         void **data,
 327         ldap_pvt_thread_pool_keyfree_t **kfree ));
 328
 329 LDAP_F( int )
 330 ldap_pvt_thread_pool_setkey LDAP_P((
 331         void *ctx,
 332         void *key,
 333         void *data,
 334         ldap_pvt_thread_pool_keyfree_t *kfree,
 335         void **olddatap,
 336         ldap_pvt_thread_pool_keyfree_t **oldkfreep ));
 337
 338 LDAP_F( void )
 339 ldap_pvt_thread_pool_purgekey LDAP_P(( void *key ));
 340
 341 LDAP_F( void *)
 342 ldap_pvt_thread_pool_context LDAP_P(( void ));
 343
 344 LDAP_F( void )
 345 ldap_pvt_thread_pool_context_reset LDAP_P(( void *key ));
 346
 347 LDAP_F( ldap_pvt_thread_t )
 348 ldap_pvt_thread_pool_tid LDAP_P(( void *ctx ));
 349
 350 LDAP_END_DECL
 351
 352 #define LDAP_PVT_THREAD_H_DONE
 353 #endif /* _LDAP_PVT_THREAD_H */