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