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 #endif /* !LDAP_PVT_THREAD_H_DONE */
  37
  38 #define ldap_pvt_thread_equal           ldap_int_thread_equal
  39
  40 LDAP_F( int )
  41 ldap_pvt_thread_initialize LDAP_P(( void ));
  42
  43 LDAP_F( int )
  44 ldap_pvt_thread_destroy LDAP_P(( void ));
  45
  46 LDAP_F( unsigned int )
  47 ldap_pvt_thread_sleep LDAP_P(( unsigned int s ));
  48
  49 LDAP_F( int )
  50 ldap_pvt_thread_get_concurrency LDAP_P(( void ));
  51
  52 LDAP_F( int )
  53 ldap_pvt_thread_set_concurrency LDAP_P(( int ));
  54
  55 #define LDAP_PVT_THREAD_CREATE_JOINABLE 0
  56 #define LDAP_PVT_THREAD_CREATE_DETACHED 1
  57
  58 #ifndef LDAP_PVT_THREAD_H_DONE
  59 #define LDAP_PVT_THREAD_SET_STACK_SIZE
  60 #ifndef LDAP_PVT_THREAD_STACK_SIZE
  61         /* LARGE stack. Will be twice as large on 64 bit machine. */
  62 #define LDAP_PVT_THREAD_STACK_SIZE      ( 1 * 1024 * 1024 * sizeof(void *) )
  63 /* May be explicitly defined to zero to disable it */
  64 #elif LDAP_PVT_THREAD_STACK_SIZE == 0
  65 #undef LDAP_PVT_THREAD_SET_STACK_SIZE
  66 #endif
  67 #endif /* !LDAP_PVT_THREAD_H_DONE */
  68
  69 LDAP_F( int )
  70 ldap_pvt_thread_create LDAP_P((
  71         ldap_pvt_thread_t * thread,
  72         int     detach,
  73         void *(*start_routine)( void * ),
  74         void *arg));
  75
  76 LDAP_F( void )
  77 ldap_pvt_thread_exit LDAP_P(( void *retval ));
  78
  79 LDAP_F( int )
  80 ldap_pvt_thread_join LDAP_P(( ldap_pvt_thread_t thread, void **status ));
  81
  82 LDAP_F( int )
  83 ldap_pvt_thread_kill LDAP_P(( ldap_pvt_thread_t thread, int signo ));
  84
  85 LDAP_F( int )
  86 ldap_pvt_thread_yield LDAP_P(( void ));
  87
  88 LDAP_F( int )
  89 ldap_pvt_thread_cond_init LDAP_P(( ldap_pvt_thread_cond_t *cond ));
  90
  91 LDAP_F( int )
  92 ldap_pvt_thread_cond_destroy LDAP_P(( ldap_pvt_thread_cond_t *cond ));
  93
  94 LDAP_F( int )
  95 ldap_pvt_thread_cond_signal LDAP_P(( ldap_pvt_thread_cond_t *cond ));
  96
  97 LDAP_F( int )
  98 ldap_pvt_thread_cond_broadcast LDAP_P(( ldap_pvt_thread_cond_t *cond ));
  99
 100 LDAP_F( int )
 101 ldap_pvt_thread_cond_wait LDAP_P((
 102         ldap_pvt_thread_cond_t *cond,
 103         ldap_pvt_thread_mutex_t *mutex ));
 104
 105 LDAP_F( int )
 106 ldap_pvt_thread_mutex_init LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 107
 108 LDAP_F( int )
 109 ldap_pvt_thread_mutex_destroy LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 110
 111 LDAP_F( int )
 112 ldap_pvt_thread_mutex_lock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 113
 114 LDAP_F( int )
 115 ldap_pvt_thread_mutex_trylock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 116
 117 LDAP_F( int )
 118 ldap_pvt_thread_mutex_unlock LDAP_P(( ldap_pvt_thread_mutex_t *mutex ));
 119
 120 LDAP_F( ldap_pvt_thread_t )
 121 ldap_pvt_thread_self LDAP_P(( void ));
 122
 123 LDAP_F( int )
 124 ldap_pvt_thread_rdwr_init LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 125
 126 LDAP_F( int )
 127 ldap_pvt_thread_rdwr_destroy LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 128
 129 LDAP_F( int )
 130 ldap_pvt_thread_rdwr_rlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 131
 132 LDAP_F( int )
 133 ldap_pvt_thread_rdwr_rtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 134
 135 LDAP_F( int )
 136 ldap_pvt_thread_rdwr_runlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 137
 138 LDAP_F( int )
 139 ldap_pvt_thread_rdwr_wlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 140
 141 LDAP_F( int )
 142 ldap_pvt_thread_rdwr_wtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 143
 144 LDAP_F( int )
 145 ldap_pvt_thread_rdwr_wunlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 146
 147 #ifdef LDAP_DEBUG
 148 LDAP_F( int )
 149 ldap_pvt_thread_rdwr_readers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 150
 151 LDAP_F( int )
 152 ldap_pvt_thread_rdwr_writers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 153
 154 LDAP_F( int )
 155 ldap_pvt_thread_rdwr_active LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp));
 156 #endif /* LDAP_DEBUG */
 157
 158 #define LDAP_PVT_THREAD_EINVAL EINVAL
 159 #define LDAP_PVT_THREAD_EBUSY EINVAL
 160
 161 #ifndef LDAP_PVT_THREAD_H_DONE
 162 typedef ldap_int_thread_pool_t ldap_pvt_thread_pool_t;
 163
 164 typedef void * (ldap_pvt_thread_start_t) LDAP_P((void *ctx, void *arg));
 165 typedef void (ldap_pvt_thread_pool_keyfree_t) LDAP_P((void *key, void *data));
 166 #endif /* !LDAP_PVT_THREAD_H_DONE */
 167
 168 LDAP_F( int )
 169 ldap_pvt_thread_pool_init LDAP_P((
 170         ldap_pvt_thread_pool_t *pool_out,
 171         int max_threads,
 172         int max_pending ));
 173
 174 LDAP_F( int )
 175 ldap_pvt_thread_pool_submit LDAP_P((
 176         ldap_pvt_thread_pool_t *pool,
 177         ldap_pvt_thread_start_t *start,
 178         void *arg ));
 179
 180 LDAP_F( int )
 181 ldap_pvt_thread_pool_maxthreads LDAP_P((
 182         ldap_pvt_thread_pool_t *pool,
 183         int max_threads ));
 184
 185 LDAP_F( int )
 186 ldap_pvt_thread_pool_backload LDAP_P((
 187         ldap_pvt_thread_pool_t *pool ));
 188
 189 LDAP_F( int )
 190 ldap_pvt_thread_pool_pause LDAP_P((
 191         ldap_pvt_thread_pool_t *pool ));
 192
 193 LDAP_F( int )
 194 ldap_pvt_thread_pool_resume LDAP_P((
 195         ldap_pvt_thread_pool_t *pool ));
 196
 197 LDAP_F( int )
 198 ldap_pvt_thread_pool_destroy LDAP_P((
 199         ldap_pvt_thread_pool_t *pool,
 200         int run_pending ));
 201
 202 LDAP_F( int )
 203 ldap_pvt_thread_pool_getkey LDAP_P((
 204         void *ctx,
 205         void *key,
 206         void **data,
 207         ldap_pvt_thread_pool_keyfree_t **kfree ));
 208
 209 LDAP_F( int )
 210 ldap_pvt_thread_pool_setkey LDAP_P((
 211         void *ctx,
 212         void *key,
 213         void *data,
 214         ldap_pvt_thread_pool_keyfree_t *kfree ));
 215
 216 LDAP_F( void )
 217 ldap_pvt_thread_pool_purgekey LDAP_P(( void *key ));
 218
 219 LDAP_F( void *)
 220 ldap_pvt_thread_pool_context LDAP_P(( void ));
 221
 222 LDAP_F( void )
 223 ldap_pvt_thread_pool_context_reset LDAP_P(( void *key ));
 224
 225 LDAP_END_DECL
 226
 227 #define LDAP_PVT_THREAD_H_DONE
 228 #endif /* _LDAP_THREAD_H */