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-2007 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 #else
  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;
  35 #endif
  36 typedef ldap_int_thread_rmutex_t        ldap_pvt_thread_rmutex_t;
  37 #endif /* !LDAP_PVT_THREAD_H_DONE */
  38
  39 #define ldap_pvt_thread_equal           ldap_int_thread_equal
  40
  41 LDAP_F( int )
  42 ldap_pvt_thread_initialize LDAP_P(( void ));
  43
  44 LDAP_F( int )
  45 ldap_pvt_thread_destroy LDAP_P(( void ));
  46
  47 LDAP_F( unsigned int )
  48 ldap_pvt_thread_sleep LDAP_P(( unsigned int s ));
  49
  50 LDAP_F( int )
  51 ldap_pvt_thread_get_concurrency LDAP_P(( void ));
  52
  53 LDAP_F( int )
  54 ldap_pvt_thread_set_concurrency LDAP_P(( int ));
  55
  56 #define LDAP_PVT_THREAD_CREATE_JOINABLE 0
  57 #define LDAP_PVT_THREAD_CREATE_DETACHED 1
  58
  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
  67 #endif
  68 #endif /* !LDAP_PVT_THREAD_H_DONE */
  69
  70 LDAP_F( int )
  71 ldap_pvt_thread_create LDAP_P((
  72         ldap_pvt_thread_t * thread,
  73         int     detach,
  74         void *(*start_routine)( void * ),
  75         void *arg));
  76
  77 LDAP_F( void )
  78 ldap_pvt_thread_exit LDAP_P(( void *retval ));
  79
  80 LDAP_F( int )
  81 ldap_pvt_thread_join LDAP_P(( ldap_pvt_thread_t thread, void **status ));
  82
  83 LDAP_F( int )
  84 ldap_pvt_thread_kill LDAP_P(( ldap_pvt_thread_t thread, int signo ));
  85
  86 LDAP_F( int )
  87 ldap_pvt_thread_yield LDAP_P(( void ));
  88
  89 LDAP_F( int )
  90 ldap_pvt_thread_cond_init LDAP_P(( ldap_pvt_thread_cond_t *cond ));
  91
  92 LDAP_F( int )
  93 ldap_pvt_thread_cond_destroy LDAP_P(( ldap_pvt_thread_cond_t *cond ));
  94
  95 LDAP_F( int )
  96 ldap_pvt_thread_cond_signal LDAP_P(( ldap_pvt_thread_cond_t *cond ));
  97
  98 LDAP_F( int )
  99 ldap_pvt_thread_cond_broadcast LDAP_P(( ldap_pvt_thread_cond_t *cond ));
 100
 101 LDAP_F( int )
 102 ldap_pvt_thread_cond_wait LDAP_P((
 103         ldap_pvt_thread_cond_t *cond,
 104         ldap_pvt_thread_mutex_t *mutex ));
 105
 106 LDAP_F( int )
 107 ldap_pvt_thread_mutex_init LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 108
 109 LDAP_F( int )
 110 ldap_pvt_thread_mutex_destroy LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 111
 112 LDAP_F( int )
 113 ldap_pvt_thread_mutex_lock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 114
 115 LDAP_F( int )
 116 ldap_pvt_thread_mutex_trylock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 117
 118 LDAP_F( int )
 119 ldap_pvt_thread_mutex_unlock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 120
 121 LDAP_F( int )
 122 ldap_pvt_thread_rmutex_init LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex ));
 123
 124 LDAP_F( int )
 125 ldap_pvt_thread_rmutex_destroy LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex ));
 126
 127 LDAP_F( int )
 128 ldap_pvt_thread_rmutex_lock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex,
 129         ldap_pvt_thread_t owner));
 130
 131 LDAP_F( int )
 132 ldap_pvt_thread_rmutex_trylock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex,
 133         ldap_pvt_thread_t owner));
 134
 135 LDAP_F( int )
 136 ldap_pvt_thread_rmutex_unlock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex,
 137         ldap_pvt_thread_t owner));
 138
 139 LDAP_F( ldap_pvt_thread_t )
 140 ldap_pvt_thread_self LDAP_P(( void ));
 141
 142 #ifdef  LDAP_INT_THREAD_ASSERT_MUTEX_OWNER
 143 #define LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER LDAP_INT_THREAD_ASSERT_MUTEX_OWNER
 144 #else
 145 #define LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER(mutex) ((void) 0)
 146 #endif
 147
 148 LDAP_F( int )
 149 ldap_pvt_thread_rdwr_init LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 150
 151 LDAP_F( int )
 152 ldap_pvt_thread_rdwr_destroy LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 153
 154 LDAP_F( int )
 155 ldap_pvt_thread_rdwr_rlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 156
 157 LDAP_F( int )
 158 ldap_pvt_thread_rdwr_rtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 159
 160 LDAP_F( int )
 161 ldap_pvt_thread_rdwr_runlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 162
 163 LDAP_F( int )
 164 ldap_pvt_thread_rdwr_wlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 165
 166 LDAP_F( int )
 167 ldap_pvt_thread_rdwr_wtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 168
 169 LDAP_F( int )
 170 ldap_pvt_thread_rdwr_wunlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 171
 172 #ifdef LDAP_DEBUG
 173 LDAP_F( int )
 174 ldap_pvt_thread_rdwr_readers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 175
 176 LDAP_F( int )
 177 ldap_pvt_thread_rdwr_writers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 178
 179 LDAP_F( int )
 180 ldap_pvt_thread_rdwr_active LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 181 #endif /* LDAP_DEBUG */
 182
 183 #define LDAP_PVT_THREAD_EINVAL EINVAL
 184 #define LDAP_PVT_THREAD_EBUSY EINVAL
 185
 186 #ifndef LDAP_PVT_THREAD_H_DONE
 187 typedef ldap_int_thread_pool_t ldap_pvt_thread_pool_t;
 188
 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 */
 192
 193 LDAP_F( int )
 194 ldap_pvt_thread_pool_init LDAP_P((
 195         ldap_pvt_thread_pool_t *pool_out,
 196         int max_threads,
 197         int max_pending ));
 198
 199 LDAP_F( int )
 200 ldap_pvt_thread_pool_submit LDAP_P((
 201         ldap_pvt_thread_pool_t *pool,
 202         ldap_pvt_thread_start_t *start,
 203         void *arg ));
 204
 205 LDAP_F( int )
 206 ldap_pvt_thread_pool_maxthreads LDAP_P((
 207         ldap_pvt_thread_pool_t *pool,
 208         int max_threads ));
 209
 210 #ifndef LDAP_PVT_THREAD_H_DONE
 211 typedef enum {
 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_PAUSING,
 219         LDAP_PVT_THREAD_POOL_PARAM_PENDING,
 220         LDAP_PVT_THREAD_POOL_PARAM_BACKLOAD,
 221         LDAP_PVT_THREAD_POOL_PARAM_ACTIVE_MAX,
 222         LDAP_PVT_THREAD_POOL_PARAM_PENDING_MAX,
 223         LDAP_PVT_THREAD_POOL_PARAM_BACKLOAD_MAX,
 224         LDAP_PVT_THREAD_POOL_PARAM_STATE
 225 } ldap_pvt_thread_pool_param_t;
 226 #endif /* !LDAP_PVT_THREAD_H_DONE */
 227
 228 LDAP_F( int )
 229 ldap_pvt_thread_pool_query LDAP_P((
 230         ldap_pvt_thread_pool_t *pool,
 231         ldap_pvt_thread_pool_param_t param, void *value ));
 232
 233 LDAP_F( int )
 234 ldap_pvt_thread_pool_backload LDAP_P((
 235         ldap_pvt_thread_pool_t *pool ));
 236
 237 LDAP_F( int )
 238 ldap_pvt_thread_pool_pause LDAP_P((
 239         ldap_pvt_thread_pool_t *pool ));
 240
 241 LDAP_F( int )
 242 ldap_pvt_thread_pool_resume LDAP_P((
 243         ldap_pvt_thread_pool_t *pool ));
 244
 245 LDAP_F( int )
 246 ldap_pvt_thread_pool_destroy LDAP_P((
 247         ldap_pvt_thread_pool_t *pool,
 248         int run_pending ));
 249
 250 LDAP_F( int )
 251 ldap_pvt_thread_pool_getkey LDAP_P((
 252         void *ctx,
 253         void *key,
 254         void **data,
 255         ldap_pvt_thread_pool_keyfree_t **kfree ));
 256
 257 LDAP_F( int )
 258 ldap_pvt_thread_pool_setkey LDAP_P((
 259         void *ctx,
 260         void *key,
 261         void *data,
 262         ldap_pvt_thread_pool_keyfree_t *kfree ));
 263
 264 LDAP_F( void )
 265 ldap_pvt_thread_pool_purgekey LDAP_P(( void *key ));
 266
 267 LDAP_F( void *)
 268 ldap_pvt_thread_pool_context LDAP_P(( void ));
 269
 270 LDAP_F( void )
 271 ldap_pvt_thread_pool_context_reset LDAP_P(( void *key ));
 272
 273 LDAP_F( ldap_pvt_thread_t )
 274 ldap_pvt_thread_pool_tid LDAP_P(( void *ctx ));
 275
 276 LDAP_END_DECL
 277
 278 #define LDAP_PVT_THREAD_H_DONE
 279 #endif /* _LDAP_PVT_THREAD_H */