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-2011 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 23LDAP_BEGIN_DECL 24 25#ifndef LDAP_PVT_THREAD_H_DONE 26typedef ldap_int_thread_t ldap_pvt_thread_t; 27#ifdef LDAP_THREAD_DEBUG_WRAP 28typedef ldap_debug_thread_mutex_t ldap_pvt_thread_mutex_t; 29typedef ldap_debug_thread_cond_t ldap_pvt_thread_cond_t; 30typedef 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 34typedef ldap_int_thread_mutex_t ldap_pvt_thread_mutex_t; 35typedef ldap_int_thread_cond_t ldap_pvt_thread_cond_t; 36typedef 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 40typedef ldap_int_thread_rmutex_t ldap_pvt_thread_rmutex_t; 41typedef ldap_int_thread_key_t ldap_pvt_thread_key_t; 42#endif /* !LDAP_PVT_THREAD_H_DONE */ 43 44#define ldap_pvt_thread_equal ldap_int_thread_equal 45 46LDAP_F( int ) 47ldap_pvt_thread_initialize LDAP_P(( void )); 48 49LDAP_F( int ) 50ldap_pvt_thread_destroy LDAP_P(( void )); 51 52LDAP_F( unsigned int ) 53ldap_pvt_thread_sleep LDAP_P(( unsigned int s )); 54 55LDAP_F( int ) 56ldap_pvt_thread_get_concurrency LDAP_P(( void )); 57 58LDAP_F( int ) 59ldap_pvt_thread_set_concurrency LDAP_P(( int )); 60 61#define LDAP_PVT_THREAD_CREATE_JOINABLE 0 62#define LDAP_PVT_THREAD_CREATE_DETACHED 1 63 64#ifndef LDAP_PVT_THREAD_H_DONE 65#define LDAP_PVT_THREAD_SET_STACK_SIZE 66/* The size may be explicitly #defined to zero to disable it. */ 67#if defined( LDAP_PVT_THREAD_STACK_SIZE ) && LDAP_PVT_THREAD_STACK_SIZE == 0 68# undef LDAP_PVT_THREAD_SET_STACK_SIZE 69#elif !defined( LDAP_PVT_THREAD_STACK_SIZE ) 70 /* LARGE stack. Will be twice as large on 64 bit machine. */ 71# define LDAP_PVT_THREAD_STACK_SIZE ( 1 * 1024 * 1024 * sizeof(void *) ) 72#endif 73#endif /* !LDAP_PVT_THREAD_H_DONE */ 74 75LDAP_F( int ) 76ldap_pvt_thread_create LDAP_P(( 77 ldap_pvt_thread_t * thread, 78 int detach, 79 void *(*start_routine)( void * ), 80 void *arg)); 81 82LDAP_F( void ) 83ldap_pvt_thread_exit LDAP_P(( void *retval )); 84 85LDAP_F( int ) 86ldap_pvt_thread_join LDAP_P(( ldap_pvt_thread_t thread, void **status )); 87 88LDAP_F( int ) 89ldap_pvt_thread_kill LDAP_P(( ldap_pvt_thread_t thread, int signo )); 90 91LDAP_F( int ) 92ldap_pvt_thread_yield LDAP_P(( void )); 93 94LDAP_F( int ) 95ldap_pvt_thread_cond_init LDAP_P(( ldap_pvt_thread_cond_t *cond )); 96 97LDAP_F( int ) 98ldap_pvt_thread_cond_destroy LDAP_P(( ldap_pvt_thread_cond_t *cond )); 99 100LDAP_F( int ) 101ldap_pvt_thread_cond_signal LDAP_P(( ldap_pvt_thread_cond_t *cond )); 102 103LDAP_F( int ) 104ldap_pvt_thread_cond_broadcast LDAP_P(( ldap_pvt_thread_cond_t *cond )); 105 106LDAP_F( int ) 107ldap_pvt_thread_cond_wait LDAP_P(( 108 ldap_pvt_thread_cond_t *cond, 109 ldap_pvt_thread_mutex_t *mutex )); 110 111LDAP_F( int ) 112ldap_pvt_thread_mutex_init LDAP_P(( ldap_pvt_thread_mutex_t *mutex )); 113 114LDAP_F( int ) 115ldap_pvt_thread_mutex_destroy LDAP_P(( ldap_pvt_thread_mutex_t *mutex )); 116 117LDAP_F( int ) 118ldap_pvt_thread_mutex_lock LDAP_P(( ldap_pvt_thread_mutex_t *mutex )); 119 120LDAP_F( int ) 121ldap_pvt_thread_mutex_trylock LDAP_P(( ldap_pvt_thread_mutex_t *mutex )); 122 123LDAP_F( int ) 124ldap_pvt_thread_mutex_unlock LDAP_P(( ldap_pvt_thread_mutex_t *mutex )); 125 126LDAP_F( int ) 127ldap_pvt_thread_rmutex_init LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex )); 128 129LDAP_F( int ) 130ldap_pvt_thread_rmutex_destroy LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex )); 131 132LDAP_F( int ) 133ldap_pvt_thread_rmutex_lock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex, 134 ldap_pvt_thread_t owner)); 135 136LDAP_F( int ) 137ldap_pvt_thread_rmutex_trylock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex, 138 ldap_pvt_thread_t owner)); 139 140LDAP_F( int ) 141ldap_pvt_thread_rmutex_unlock LDAP_P(( ldap_pvt_thread_rmutex_t *rmutex, 142 ldap_pvt_thread_t owner)); 143 144LDAP_F( ldap_pvt_thread_t ) 145ldap_pvt_thread_self LDAP_P(( void )); 146 147#ifdef LDAP_INT_THREAD_ASSERT_MUTEX_OWNER 148#define LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER LDAP_INT_THREAD_ASSERT_MUTEX_OWNER 149#else 150#define LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER(mutex) ((void) 0) 151#endif 152 153LDAP_F( int ) 154ldap_pvt_thread_rdwr_init LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp)); 155 156LDAP_F( int ) 157ldap_pvt_thread_rdwr_destroy LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp)); 158 159LDAP_F( int ) 160ldap_pvt_thread_rdwr_rlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp)); 161 162LDAP_F( int ) 163ldap_pvt_thread_rdwr_rtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp)); 164 165LDAP_F( int ) 166ldap_pvt_thread_rdwr_runlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp)); 167 168LDAP_F( int ) 169ldap_pvt_thread_rdwr_wlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp)); 170 171LDAP_F( int ) 172ldap_pvt_thread_rdwr_wtrylock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp)); 173 174LDAP_F( int ) 175ldap_pvt_thread_rdwr_wunlock LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp)); 176 177LDAP_F( int ) 178ldap_pvt_thread_key_create LDAP_P((ldap_pvt_thread_key_t *keyp)); 179 180LDAP_F( int ) 181ldap_pvt_thread_key_destroy LDAP_P((ldap_pvt_thread_key_t key)); 182 183LDAP_F( int ) 184ldap_pvt_thread_key_setdata LDAP_P((ldap_pvt_thread_key_t key, void *data)); 185 186LDAP_F( int ) 187ldap_pvt_thread_key_getdata LDAP_P((ldap_pvt_thread_key_t key, void **data)); 188 189#ifdef LDAP_DEBUG 190LDAP_F( int ) 191ldap_pvt_thread_rdwr_readers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp)); 192 193LDAP_F( int ) 194ldap_pvt_thread_rdwr_writers LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp)); 195 196LDAP_F( int ) 197ldap_pvt_thread_rdwr_active LDAP_P((ldap_pvt_thread_rdwr_t *rdwrp)); 198#endif /* LDAP_DEBUG */ 199 200#define LDAP_PVT_THREAD_EINVAL EINVAL 201#define LDAP_PVT_THREAD_EBUSY EINVAL 202 203#ifndef LDAP_PVT_THREAD_H_DONE 204typedef ldap_int_thread_pool_t ldap_pvt_thread_pool_t; 205 206typedef void * (ldap_pvt_thread_start_t) LDAP_P((void *ctx, void *arg)); 207typedef void (ldap_pvt_thread_pool_keyfree_t) LDAP_P((void *key, void *data)); 208#endif /* !LDAP_PVT_THREAD_H_DONE */ 209 210LDAP_F( int ) 211ldap_pvt_thread_pool_init LDAP_P(( 212 ldap_pvt_thread_pool_t *pool_out, 213 int max_threads, 214 int max_pending )); 215 216LDAP_F( int ) 217ldap_pvt_thread_pool_submit LDAP_P(( 218 ldap_pvt_thread_pool_t *pool, 219 ldap_pvt_thread_start_t *start, 220 void *arg )); 221 222LDAP_F( int ) 223ldap_pvt_thread_pool_retract LDAP_P(( 224 ldap_pvt_thread_pool_t *pool, 225 ldap_pvt_thread_start_t *start, 226 void *arg )); 227 228LDAP_F( int ) 229ldap_pvt_thread_pool_maxthreads LDAP_P(( 230 ldap_pvt_thread_pool_t *pool, 231 int max_threads )); 232 233#ifndef LDAP_PVT_THREAD_H_DONE 234typedef enum { 235 LDAP_PVT_THREAD_POOL_PARAM_UNKNOWN = -1, 236 LDAP_PVT_THREAD_POOL_PARAM_MAX, 237 LDAP_PVT_THREAD_POOL_PARAM_MAX_PENDING, 238 LDAP_PVT_THREAD_POOL_PARAM_OPEN, 239 LDAP_PVT_THREAD_POOL_PARAM_STARTING, 240 LDAP_PVT_THREAD_POOL_PARAM_ACTIVE, 241 LDAP_PVT_THREAD_POOL_PARAM_PAUSING, 242 LDAP_PVT_THREAD_POOL_PARAM_PENDING, 243 LDAP_PVT_THREAD_POOL_PARAM_BACKLOAD, 244 LDAP_PVT_THREAD_POOL_PARAM_ACTIVE_MAX, 245 LDAP_PVT_THREAD_POOL_PARAM_PENDING_MAX, 246 LDAP_PVT_THREAD_POOL_PARAM_BACKLOAD_MAX, 247 LDAP_PVT_THREAD_POOL_PARAM_STATE 248} ldap_pvt_thread_pool_param_t; 249#endif /* !LDAP_PVT_THREAD_H_DONE */ 250 251LDAP_F( int ) 252ldap_pvt_thread_pool_query LDAP_P(( 253 ldap_pvt_thread_pool_t *pool, 254 ldap_pvt_thread_pool_param_t param, void *value )); 255 256LDAP_F( int ) 257ldap_pvt_thread_pool_pausing LDAP_P(( 258 ldap_pvt_thread_pool_t *pool )); 259 260LDAP_F( int ) 261ldap_pvt_thread_pool_backload LDAP_P(( 262 ldap_pvt_thread_pool_t *pool )); 263 264LDAP_F( int ) 265ldap_pvt_thread_pool_pausecheck LDAP_P(( 266 ldap_pvt_thread_pool_t *pool )); 267 268LDAP_F( int ) 269ldap_pvt_thread_pool_pause LDAP_P(( 270 ldap_pvt_thread_pool_t *pool )); 271 272LDAP_F( int ) 273ldap_pvt_thread_pool_resume LDAP_P(( 274 ldap_pvt_thread_pool_t *pool )); 275 276LDAP_F( int ) 277ldap_pvt_thread_pool_destroy LDAP_P(( 278 ldap_pvt_thread_pool_t *pool, 279 int run_pending )); 280 281LDAP_F( int ) 282ldap_pvt_thread_pool_getkey LDAP_P(( 283 void *ctx, 284 void *key, 285 void **data, 286 ldap_pvt_thread_pool_keyfree_t **kfree )); 287 288LDAP_F( int ) 289ldap_pvt_thread_pool_setkey LDAP_P(( 290 void *ctx, 291 void *key, 292 void *data, 293 ldap_pvt_thread_pool_keyfree_t *kfree, 294 void **olddatap, 295 ldap_pvt_thread_pool_keyfree_t **oldkfreep )); 296 297LDAP_F( void ) 298ldap_pvt_thread_pool_purgekey LDAP_P(( void *key )); 299 300LDAP_F( void *) 301ldap_pvt_thread_pool_context LDAP_P(( void )); 302 303LDAP_F( void ) 304ldap_pvt_thread_pool_context_reset LDAP_P(( void *key )); 305 306LDAP_F( ldap_pvt_thread_t ) 307ldap_pvt_thread_pool_tid LDAP_P(( void *ctx )); 308 309LDAP_END_DECL 310 311#define LDAP_PVT_THREAD_H_DONE 312#endif /* _LDAP_PVT_THREAD_H */ 313