1 /* thr_debug.c - wrapper around the chosen thread wrapper, for debugging. */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2005-2006 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
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>.
18 * This package provides several types of thread operation debugging:
20 * - Check the results of operations on threads, mutexes, condition
21 * variables and read/write locks. Also check some thread pool
22 * operations, but not those for which failure can happen in normal
25 * - Wrap those types except threads and pools in structs with state
26 * information, and check that on all operations:
28 * + Check that the resources are initialized and are only used at
29 * their original address (i.e. not realloced or copied).
31 * + Check the owner (thread ID) on mutex operations.
33 * + Optionally allocate a reference to a byte of dummy memory.
34 * This lets malloc debuggers see some incorrect use as memory
35 * leaks, access to freed memory, etc.
37 * - Print an error message and by default abort() upon errors.
39 * - Print a count of leaked thread resources after cleanup.
41 * Compile-time (./configure) setup: Macros defined in CPPFLAGS.
43 * LDAP_THREAD_DEBUG or LDAP_THREAD_DEBUG=2
44 * Enables debugging, but value & 2 turns off type wrapping.
46 * LDAP_UINTPTR_T=integer type to hold pointers, preferably unsigned.
47 * Used by dummy memory option "scramble". Default = unsigned long.
49 * LDAP_DEBUG_THREAD_NONE = initializer for a "no thread" thread ID.
51 * In addition, you may need to set up an implementation-specific way
52 * to enable whatever error checking your thread library provides.
53 * Currently only implemented for Posix threads (pthreads), where
54 * you may need to define LDAP_INT_THREAD_MUTEXATTR. The default
55 * is PTHREAD_MUTEX_ERRORCHECK, or PTHREAD_MUTEX_ERRORCHECK_NP for
56 * Linux threads. See pthread_mutexattr_settype(3).
58 * Run-time configuration:
60 * Setup of memory debugging tools:
61 * Tools that report uninitialized memory accesses should disable
62 * such warnings about the function debug_already_initialized().
63 * Alternatively, include "noreinit" (below) in $LDAP_THREAD_DEBUG.
65 * Environment variable $LDAP_THREAD_DEBUG:
66 * The variable may contain a comma- or space-separated option list.
68 * off - Disable this package. (It still slows things down).
69 * tracethreads - Report create/join/exit/kill of threads.
70 * noabort - Do not abort() on errors.
71 * noerror - Do not report errors. Implies noabort.
72 * nocount - Do not report counts of unreleased resources.
73 * nosync - Disable tests that use synchronizaion and thus
74 * clearly affect thread scheduling:
75 * Implies nocount, and cancels threadID if that is set.
76 * Note that if you turn on tracethreads or malloc
77 * debugging, these also use library calls which may
78 * affect thread scheduling (fprintf and malloc).
79 * The following options do not apply if type wrapping is disabled:
80 * nomem - Do not check memory operations.
81 * Implies noreinit,noalloc.
82 * noreinit - Do not catch reinitialization of existing resources.
83 * (That test accesses uninitialized memory).
84 * threadID - Trace thread IDs. Currently mostly useless.
85 * Malloc debugging -- allocate dummy memory for initialized
86 * resources, so malloc debuggers will report them as memory leaks:
87 * noalloc - Default. Do not allocate dummy memory.
88 * alloc - Store a pointer to dummy memory. However, leak
89 * detectors might not catch unreleased resources in
91 * scramble - Store bitwise complement of dummy memory pointer.
92 * That never escapes memory leak detectors -
93 * but detection while the program is running will
94 * report active resources as leaks. Do not
95 * use this if a garbage collector is in use:-)
96 * adjptr - Point to end of dummy memory.
97 * Purify reports these as "potential leaks" (PLK).
98 * I have not checked other malloc debuggers.
101 #include "portable.h"
103 #if defined( LDAP_THREAD_DEBUG )
106 #include <ac/errno.h>
107 #include <ac/stdlib.h>
108 #include <ac/string.h>
110 #include "ldap_pvt_thread.h" /* Get the thread interface */
111 #define LDAP_THREAD_IMPLEMENTATION
112 #define LDAP_THREAD_DEBUG_IMPLEMENTATION
113 #define LDAP_THREAD_RDWR_IMPLEMENTATION
114 #define LDAP_THREAD_POOL_IMPLEMENTATION
115 #include "ldap_thr_debug.h" /* Get the underlying implementation */
117 #ifndef LDAP_THREAD_DEBUG_WRAP
118 #undef LDAP_THREAD_DEBUG_THREAD_ID
119 #elif !defined LDAP_THREAD_DEBUG_THREAD_ID
120 #define LDAP_THREAD_DEBUG_THREAD_ID 1
123 /* Use native malloc - the OpenLDAP wrappers may defeat malloc debuggers */
130 /* Options from environment variable $LDAP_THREAD_DEBUG */
131 enum { Count_no = 0, Count_yes, Count_reported, Count_reported_more };
132 static int count = Count_yes;
133 #ifdef LDAP_THREAD_DEBUG_WRAP
134 enum { Wrap_noalloc, Wrap_alloc, Wrap_scramble, Wrap_adjptr };
135 static int wraptype = Wrap_noalloc, wrap_offset, unwrap_offset;
136 static int nomem, noreinit;
138 #if LDAP_THREAD_DEBUG_THREAD_ID +0
141 enum { threadID = 0 };
143 static int nodebug, noabort, noerror, nosync, tracethreads;
144 static int wrap_threads;
145 static int options_done;
148 /* ldap_pvt_thread_initialize() called, ldap_pvt_thread_destroy() not called */
149 static int threading_enabled;
152 /* Resource counts */
154 Idx_unexited_thread, Idx_unjoined_thread, Idx_locked_mutex,
155 Idx_mutex, Idx_cond, Idx_rdwr, Idx_tpool, Idx_max
157 static int resource_counts[Idx_max];
158 static const char *const resource_names[] = {
159 "unexited threads", "unjoined threads", "locked mutexes",
160 "mutexes", "conds", "rdwrs", "thread pools"
162 static ldap_int_thread_mutex_t resource_mutexes[Idx_max];
165 /* Hide pointers from malloc debuggers. */
166 #define SCRAMBLE(ptr) (~(LDAP_UINTPTR_T) (ptr))
167 #define UNSCRAMBLE_usagep(num) ((ldap_debug_usage_info_t *) ~(num))
168 #define UNSCRAMBLE_dummyp(num) ((unsigned char *) ~(num))
171 #define WARN(var, msg) (warn (__FILE__, __LINE__, (msg), #var, (var)))
172 #define WARN_IF(rc, msg) {if (rc) warn (__FILE__, __LINE__, (msg), #rc, (rc));}
174 #define ERROR(var, msg) { \
176 errmsg(__FILE__, __LINE__, (msg), #var, (var)); \
177 if( !noabort ) abort(); \
181 #define ERROR_IF(rc, msg) { \
185 errmsg(__FILE__, __LINE__, (msg), #rc, rc_); \
186 if( !noabort ) abort(); \
191 #ifdef LDAP_THREAD_DEBUG_WRAP
192 #define MEMERROR_IF(rc, msg, mem_act) { \
196 errmsg(__FILE__, __LINE__, (msg), #rc, rc_); \
197 if( wraptype != Wrap_noalloc ) { mem_act; } \
198 if( !noabort ) abort(); \
202 #endif /* LDAP_THREAD_DEBUG_WRAP */
206 warn( const char *file, int line, const char *msg, const char *var, int val )
209 (strpbrk( var, "!=" )
210 ? "%s:%d: %s warning: %s\n"
211 : "%s:%d: %s warning: %s is %d\n"),
212 file, line, msg, var, val );
217 errmsg( const char *file, int line, const char *msg, const char *var, int val )
220 (strpbrk( var, "!=" )
221 ? "%s:%d: %s error: %s\n"
222 : "%s:%d: %s error: %s is %d\n"),
223 file, line, msg, var, val );
227 count_resource_leaks( void )
231 if( count == Count_yes ) {
232 count = Count_reported;
233 #if 0 /* Could break if there are still threads after atexit */
234 for( i = j = 0; i < Idx_max; i++ )
235 j |= ldap_int_thread_mutex_destroy( &resource_mutexes[i] );
236 WARN_IF( j, "ldap_debug_thread_destroy:mutexes" );
238 for( i = j = 0; i < Idx_max; i++ )
239 if( resource_counts[i] )
240 j += sprintf( errbuf + j, ", %d %s",
241 resource_counts[i], resource_names[i] );
243 fprintf( stderr, "== thr_debug: Leaked%s. ==\n", errbuf + 1 );
250 static const struct option_info_s {
254 { "off", &nodebug, 1 },
255 { "noabort", &noabort, 1 },
256 { "noerror", &noerror, 1 },
257 { "nocount", &count, Count_no },
258 { "nosync", &nosync, 1 },
259 #if LDAP_THREAD_DEBUG_THREAD_ID +0
260 { "threadID", &threadID, 1 },
262 #ifdef LDAP_THREAD_DEBUG_WRAP
263 { "nomem", &nomem, 1 },
264 { "noreinit", &noreinit, 1 },
265 { "noalloc", &wraptype, Wrap_noalloc },
266 { "alloc", &wraptype, Wrap_alloc },
267 { "adjptr", &wraptype, Wrap_adjptr },
268 { "scramble", &wraptype, Wrap_scramble },
270 { "tracethreads", &tracethreads, 1 },
273 const char *s = getenv( "LDAP_THREAD_DEBUG" );
275 while( *(s += strspn( s, ", \t\r\n" )) != '\0' ) {
276 size_t optlen = strcspn( s, ", \t\r\n" );
277 const struct option_info_s *oi;
278 for( oi = option_info; oi->name; oi++ ) {
279 if( strncasecmp( oi->name, s, optlen ) == 0 ) {
280 if( oi->name && oi->name[optlen] == '\0' ) {
284 "== thr_debug: Unknown $%s option '%.*s' ==\n",
285 "LDAP_THREAD_DEBUG", (int) optlen, s );
295 nosync = noerror = 1;
301 #if LDAP_THREAD_DEBUG_THREAD_ID +0
305 #ifdef LDAP_THREAD_DEBUG_WRAP
309 static const ldap_debug_usage_info_t usage;
310 if( sizeof(LDAP_UINTPTR_T) < sizeof(unsigned char *)
311 || sizeof(LDAP_UINTPTR_T) < sizeof(ldap_debug_usage_info_t *)
312 || UNSCRAMBLE_usagep( SCRAMBLE( &usage ) ) != &usage
313 || UNSCRAMBLE_dummyp( SCRAMBLE( (unsigned char *) 0 ) ) )
315 fputs( "== thr_debug: Memory checks unsupported, "
316 "adding nomem to $LDAP_THREAD_DEBUG ==\n", stderr );
322 wraptype = Wrap_noalloc;
324 unwrap_offset = -(wrap_offset = (wraptype == Wrap_adjptr));
326 wrap_threads = (tracethreads || threadID || count);
331 #ifndef LDAP_THREAD_DEBUG_WRAP
333 #define WRAPPED(ptr) (ptr)
334 #define GET_OWNER(ptr) 0
335 #define SET_OWNER(ptr, thread) ((void) 0)
336 #define RESET_OWNER(ptr) ((void) 0)
337 #define ASSERT_OWNER(ptr, msg) ((void) 0)
338 #define ASSERT_NO_OWNER(ptr, msg) ((void) 0)
340 #define init_usage(ptr, msg) ((void) 0)
341 #define check_usage(ptr, msg) ((void) 0)
342 #define destroy_usage(ptr) ((void) 0)
344 #else /* LDAP_THREAD_DEBUG_WRAP */
346 /* Specialize this if the initializer is not appropriate. */
347 /* The ASSERT_NO_OWNER() definition may also need an override. */
348 #ifndef LDAP_DEBUG_THREAD_NONE
349 #define LDAP_DEBUG_THREAD_NONE { -1 } /* "no thread" ldap_int_thread_t value */
352 static const ldap_int_thread_t ldap_debug_thread_none = LDAP_DEBUG_THREAD_NONE;
354 #define THREAD_MUTEX_OWNER(mutex) \
355 ldap_int_thread_equal( (mutex)->owner, ldap_int_thread_self() )
358 ldap_debug_thread_assert_mutex_owner(
362 ldap_pvt_thread_mutex_t *mutex )
364 if( !(noerror || THREAD_MUTEX_OWNER( mutex )) ) {
365 errmsg( file, line, msg, "ASSERT_MUTEX_OWNER", 0 );
366 if( !noabort ) abort();
370 #define WRAPPED(ptr) (&(ptr)->wrapped)
371 #define GET_OWNER(ptr) ((ptr)->owner)
372 #define SET_OWNER(ptr, thread) ((ptr)->owner = (thread))
373 #define RESET_OWNER(ptr) ((ptr)->owner = ldap_debug_thread_none)
374 #define ASSERT_OWNER(ptr, msg) ERROR_IF( !THREAD_MUTEX_OWNER( ptr ), msg )
375 #ifndef ASSERT_NO_OWNER
376 #define ASSERT_NO_OWNER(ptr, msg) ERROR_IF( \
377 !ldap_int_thread_equal( (ptr)->owner, ldap_debug_thread_none ), msg )
380 /* Try to provoke memory access error (for malloc debuggers) */
381 #define PEEK(mem) {if (-*(volatile const unsigned char *)(mem)) debug_noop();}
383 static void debug_noop( void );
384 static int debug_already_initialized( const ldap_debug_usage_info_t *usage );
386 /* Names used to give clearer error messages */
387 #define IS_COPY_OR_MOVED(usage) ((usage)->self != SCRAMBLE( usage ))
388 enum { Is_destroyed = 1 };
390 #define DUMMY_ADDR(usage) \
391 (wraptype == Wrap_scramble \
392 ? UNSCRAMBLE_dummyp( (usage)->mem.num ) \
393 : (usage)->mem.ptr + unwrap_offset)
395 /* Mark resource as initialized */
397 init_usage( ldap_debug_usage_info_t *usage, const char *msg )
403 MEMERROR_IF( debug_already_initialized( usage ), msg, {
404 /* Provoke malloc debuggers */
405 unsigned char *dummy = DUMMY_ADDR( usage );
411 usage->self = SCRAMBLE( usage );
412 if( wraptype != Wrap_noalloc ) {
413 unsigned char *dummy = malloc( 1 );
414 assert( dummy != NULL );
415 if( wraptype == Wrap_scramble ) {
416 usage->mem.num = SCRAMBLE( dummy );
417 assert( UNSCRAMBLE_dummyp( usage->mem.num ) == dummy );
419 usage->mem.ptr = dummy + wrap_offset;
423 usage->magic = ldap_debug_magic;
424 usage->state = ldap_debug_state_inited;
427 /* Check that resource is initialized and not copied/realloced */
429 check_usage( const ldap_debug_usage_info_t *usage, const char *msg )
431 if( usage->magic != ldap_debug_magic ) {
432 ERROR( usage->magic, msg );
435 switch( usage->state ) {
436 case ldap_debug_state_destroyed:
437 MEMERROR_IF( Is_destroyed, msg, {
438 PEEK( DUMMY_ADDR( usage ) );
442 ERROR( usage->state, msg );
444 case ldap_debug_state_inited:
446 MEMERROR_IF( IS_COPY_OR_MOVED( usage ), msg, {
447 PEEK( DUMMY_ADDR( usage ) );
448 PEEK( UNSCRAMBLE_usagep( usage->self ) );
455 /* Mark resource as destroyed. */
456 /* Does not check for errors, call check_usage()/init_usage() first. */
458 destroy_usage( ldap_debug_usage_info_t *usage )
460 if( usage->state == ldap_debug_state_inited ) {
461 if( wraptype != Wrap_noalloc ) {
462 free( DUMMY_ADDR( usage ) );
463 /* Do not reset the DUMMY_ADDR, leave it for malloc debuggers
464 * in case the resource is used after it is freed. */
466 usage->state = ldap_debug_state_destroyed;
470 /* Define these after they are used, so they are hopefully not inlined */
477 /* Return true if the resource is initialized and not copied/realloced. */
478 /* Valid programs access uninitialized memory here unless "noreinit". */
480 debug_already_initialized( const ldap_debug_usage_info_t *usage )
482 return (usage->state == ldap_debug_state_inited &&
483 !IS_COPY_OR_MOVED( usage ) &&
484 usage->magic == ldap_debug_magic);
487 #endif /* LDAP_THREAD_DEBUG_WRAP */
490 #if !(LDAP_THREAD_DEBUG_THREAD_ID +0)
492 typedef int ldap_debug_thread_t;
493 #define init_thread_info() {}
494 #define with_thread_info_lock(statements) { statements; }
495 #define thread_info_detached(t) 0
496 #define add_thread_info(msg, thr, det) ((void) 0)
497 #define remove_thread_info(tinfo, msg) ((void) 0)
498 #define get_thread_info(thread, msg) NULL
500 #else /* LDAP_THREAD_DEBUG_THREAD_ID */
503 * Thread ID tracking. Currently acieves little.
504 * Should be either expanded or deleted.
508 * Array of threads. Used instead of making ldap_pvt_thread_t a wrapper
509 * around ldap_int_thread_t, which would slow down ldap_pvt_thread_self().
512 ldap_pvt_thread_t wrapped;
513 ldap_debug_usage_info_t usage;
516 } ldap_debug_thread_t;
518 static ldap_debug_thread_t **thread_info;
519 static unsigned int thread_info_size, thread_info_used;
520 static ldap_int_thread_mutex_t thread_info_mutex;
522 #define init_thread_info() { \
524 int mutex_init_rc = ldap_int_thread_mutex_init( &thread_info_mutex ); \
525 assert( mutex_init_rc == 0 ); \
529 #define with_thread_info_lock(statements) { \
530 int rc_wtl_ = ldap_int_thread_mutex_lock( &thread_info_mutex ); \
531 assert( rc_wtl_ == 0 ); \
533 rc_wtl_ = ldap_int_thread_mutex_unlock( &thread_info_mutex ); \
534 assert( rc_wtl_ == 0 ); \
537 #define thread_info_detached(t) ((t)->detached)
542 const ldap_pvt_thread_t *thread,
545 ldap_debug_thread_t *t;
546 if( thread_info_used >= thread_info_size ) {
547 unsigned int more = thread_info_size + 8;
548 unsigned int new_size = thread_info_size + more;
549 t = calloc( more, sizeof(ldap_debug_thread_t) );
551 thread_info = realloc( thread_info, new_size * sizeof(*thread_info) );
552 assert( thread_info != NULL );
553 while( thread_info_size < new_size ) {
554 t->idx = thread_info_size;
555 thread_info[thread_info_size++] = t++;
558 t = thread_info[thread_info_used];
559 init_usage( &t->usage, msg );
560 t->wrapped = *thread;
561 t->detached = detached;
566 remove_thread_info( ldap_debug_thread_t *t, const char *msg )
568 ldap_debug_thread_t *last;
570 check_usage( &t->usage, msg );
571 destroy_usage( &t->usage );
573 assert( thread_info[idx] == t );
574 last = thread_info[--thread_info_used];
575 assert( last->idx == thread_info_used );
576 (thread_info[idx] = last)->idx = idx;
577 (thread_info[thread_info_used] = t )->idx = thread_info_used;
580 ldap_debug_thread_t *
581 get_thread_info( ldap_pvt_thread_t *thread, const char *msg )
584 ldap_debug_thread_t *t;
585 for( i = 0; i < thread_info_used; i++ ) {
586 if( ldap_pvt_thread_equal( *thread, thread_info[i]->wrapped ) )
589 ERROR_IF( i == thread_info_used, msg );
591 check_usage( &t->usage, msg );
595 #endif /* LDAP_THREAD_DEBUG_THREAD_ID */
599 thread_name( char *buf, int bufsize, ldap_pvt_thread_t thread )
603 if( bufsize > 2*sizeof(thread) )
604 bufsize = 2*sizeof(thread);
605 for( i = 0; i < bufsize; i += 2 )
606 snprintf( buf+i, 3, "%02x", ((unsigned char *)&thread)[i/2] );
611 /* Add <adjust> (+/-1) to resource count <which> unless "nocount". */
613 adjust_count( int which, int adjust )
620 rc = ldap_int_thread_mutex_lock( &resource_mutexes[which] );
622 resource_counts[which] += adjust;
623 rc = ldap_int_thread_mutex_unlock( &resource_mutexes[which] );
627 fputs( "== thr_debug: More thread activity after exit ==\n", stderr );
628 count = Count_reported_more;
630 case Count_reported_more:
631 /* Not used, but result might be inspected with debugger */
632 /* (Hopefully threading is disabled by now...) */
633 resource_counts[which] += adjust;
639 /* Wrappers for LDAP_THREAD_IMPLEMENTATION: */
641 /* Used instead of ldap_int_thread_initialize by ldap_pvt_thread_initialize */
643 ldap_debug_thread_initialize( void )
648 ERROR_IF( threading_enabled, "ldap_debug_thread_initialize" );
649 threading_enabled = 1;
650 rc = ldap_int_thread_initialize();
652 ERROR( rc, "ldap_debug_thread_initialize:threads" );
653 threading_enabled = 0;
656 if( count != Count_no ) {
657 for( i = rc2 = 0; i < Idx_max; i++ )
658 rc2 |= ldap_int_thread_mutex_init( &resource_mutexes[i] );
660 /* FIXME: Only for static libldap_r as in init.c? If so, why? */
661 atexit( count_resource_leaks );
667 /* Used instead of ldap_int_thread_destroy by ldap_pvt_thread_destroy */
669 ldap_debug_thread_destroy( void )
672 ERROR_IF( !threading_enabled, "ldap_debug_thread_destroy" );
673 /* sleep(1) -- need to wait for thread pool to finish? */
674 rc = ldap_int_thread_destroy();
676 ERROR( rc, "ldap_debug_thread_destroy:threads" );
678 threading_enabled = 0;
684 ldap_pvt_thread_set_concurrency( int n )
687 ERROR_IF( !threading_enabled, "ldap_pvt_thread_set_concurrency" );
688 rc = ldap_int_thread_set_concurrency( n );
689 ERROR_IF( rc, "ldap_pvt_thread_set_concurrency" );
694 ldap_pvt_thread_get_concurrency( void )
697 ERROR_IF( !threading_enabled, "ldap_pvt_thread_get_concurrency" );
698 rc = ldap_int_thread_get_concurrency();
699 ERROR_IF( rc, "ldap_pvt_thread_get_concurrency" );
704 ldap_pvt_thread_sleep( unsigned int interval )
707 ERROR_IF( !threading_enabled, "ldap_pvt_thread_sleep" );
708 rc = ldap_int_thread_sleep( interval );
709 ERROR_IF( rc, "ldap_pvt_thread_sleep" );
714 thread_exiting( const char *how, const char *msg )
716 ldap_pvt_thread_t thread;
717 ERROR_IF( !threading_enabled, msg );
718 thread = ldap_pvt_thread_self();
721 fprintf( stderr, "== thr_debug: %s thread %s ==\n",
722 how, thread_name( buf, sizeof(buf), thread ) );
725 with_thread_info_lock({
726 ldap_debug_thread_t *t = get_thread_info(
728 if( thread_info_detached( t ) )
729 remove_thread_info( t, msg );
732 adjust_count( Idx_unexited_thread, -1 );
736 ldap_pvt_thread_exit( void *retval )
738 thread_exiting( "Exiting", "ldap_pvt_thread_exit" );
739 ldap_int_thread_exit( retval );
743 void *(*start_routine)( void * );
745 } ldap_debug_thread_call_t;
748 ldap_debug_thread_wrapper( void *arg )
751 ldap_debug_thread_call_t call = *(ldap_debug_thread_call_t *)arg;
753 ret = call.start_routine( call.arg );
754 thread_exiting( "Returning from", "ldap_debug_thread_wrapper" );
759 ldap_pvt_thread_create(
760 ldap_pvt_thread_t *thread,
762 void *(*start_routine)( void * ),
768 ERROR_IF( !threading_enabled, "ldap_pvt_thread_create" );
770 ldap_debug_thread_call_t *call = malloc(
771 sizeof( ldap_debug_thread_call_t ) );
772 assert( call != NULL );
773 call->start_routine = start_routine;
775 start_routine = ldap_debug_thread_wrapper;
779 with_thread_info_lock({
780 rc = ldap_int_thread_create( thread, detach, start_routine, arg );
782 add_thread_info( "ldap_pvt_thread_create", thread, detach );
785 rc = ldap_int_thread_create( thread, detach, start_routine, arg );
788 ERROR( rc, "ldap_pvt_thread_create" );
791 char buf[40], buf2[40];
793 "== thr_debug: Created thread %s%s from thread %s ==\n",
794 thread_name( buf, sizeof(buf), *thread ),
795 detach ? " (detached)" : "",
796 thread_name( buf2, sizeof(buf2), ldap_pvt_thread_self() ) );
798 adjust_count( Idx_unexited_thread, +1 );
800 adjust_count( Idx_unjoined_thread, +1 );
806 ldap_pvt_thread_join( ldap_pvt_thread_t thread, void **thread_return )
809 ldap_debug_thread_t *t = NULL;
810 ERROR_IF( !threading_enabled, "ldap_pvt_thread_join" );
812 char buf[40], buf2[40];
813 fprintf( stderr, "== thr_debug: Joining thread %s in thread %s ==\n",
814 thread_name( buf, sizeof(buf), thread ),
815 thread_name( buf2, sizeof(buf2), ldap_pvt_thread_self() ) );
818 with_thread_info_lock( {
819 t = get_thread_info( &thread, "ldap_pvt_thread_join" );
820 ERROR_IF( thread_info_detached( t ), "ldap_pvt_thread_join" );
822 rc = ldap_int_thread_join( thread, thread_return );
824 ERROR( rc, "ldap_pvt_thread_join" );
827 with_thread_info_lock(
828 remove_thread_info( t, "ldap_pvt_thread_join" ) );
829 adjust_count( Idx_unjoined_thread, -1 );
835 ldap_pvt_thread_kill( ldap_pvt_thread_t thread, int signo )
838 ERROR_IF( !threading_enabled, "ldap_pvt_thread_kill" );
840 char buf[40], buf2[40];
842 "== thr_debug: Killing thread %s (sig %i) from thread %s ==\n",
843 thread_name( buf, sizeof(buf), thread ), signo,
844 thread_name( buf2, sizeof(buf2), ldap_pvt_thread_self() ) );
846 rc = ldap_int_thread_kill( thread, signo );
847 ERROR_IF( rc, "ldap_pvt_thread_kill" );
852 ldap_pvt_thread_yield( void )
855 ERROR_IF( !threading_enabled, "ldap_pvt_thread_yield" );
856 rc = ldap_int_thread_yield();
857 ERROR_IF( rc, "ldap_pvt_thread_yield" );
862 ldap_pvt_thread_self( void )
864 #if 0 /* Function is used by ch_free() via slap_sl_contxt() in slapd */
865 ERROR_IF( !threading_enabled, "ldap_pvt_thread_self" );
867 return ldap_int_thread_self();
871 ldap_pvt_thread_cond_init( ldap_pvt_thread_cond_t *cond )
874 init_usage( &cond->usage, "ldap_pvt_thread_cond_init" );
875 rc = ldap_int_thread_cond_init( WRAPPED( cond ) );
877 ERROR( rc, "ldap_pvt_thread_cond_init" );
878 destroy_usage( &cond->usage );
880 adjust_count( Idx_cond, +1 );
886 ldap_pvt_thread_cond_destroy( ldap_pvt_thread_cond_t *cond )
889 check_usage( &cond->usage, "ldap_pvt_thread_cond_destroy" );
890 rc = ldap_int_thread_cond_destroy( WRAPPED( cond ) );
892 ERROR( rc, "ldap_pvt_thread_cond_destroy" );
894 destroy_usage( &cond->usage );
895 adjust_count( Idx_cond, -1 );
901 ldap_pvt_thread_cond_signal( ldap_pvt_thread_cond_t *cond )
904 check_usage( &cond->usage, "ldap_pvt_thread_cond_signal" );
905 rc = ldap_int_thread_cond_signal( WRAPPED( cond ) );
906 ERROR_IF( rc, "ldap_pvt_thread_cond_signal" );
911 ldap_pvt_thread_cond_broadcast( ldap_pvt_thread_cond_t *cond )
914 check_usage( &cond->usage, "ldap_pvt_thread_cond_broadcast" );
915 rc = ldap_int_thread_cond_broadcast( WRAPPED( cond ) );
916 ERROR_IF( rc, "ldap_pvt_thread_cond_broadcast" );
921 ldap_pvt_thread_cond_wait(
922 ldap_pvt_thread_cond_t *cond,
923 ldap_pvt_thread_mutex_t *mutex )
926 ldap_int_thread_t owner;
927 check_usage( &cond->usage, "ldap_pvt_thread_cond_wait:cond" );
928 check_usage( &mutex->usage, "ldap_pvt_thread_cond_wait:mutex" );
929 adjust_count( Idx_locked_mutex, -1 );
930 owner = GET_OWNER( mutex );
931 ASSERT_OWNER( mutex, "ldap_pvt_thread_cond_wait" );
932 RESET_OWNER( mutex );
933 rc = ldap_int_thread_cond_wait( WRAPPED( cond ), WRAPPED( mutex ) );
934 ASSERT_NO_OWNER( mutex, "ldap_pvt_thread_cond_wait" );
935 SET_OWNER( mutex, rc ? owner : ldap_int_thread_self() );
936 adjust_count( Idx_locked_mutex, +1 );
937 ERROR_IF( rc, "ldap_pvt_thread_cond_wait" );
942 ldap_pvt_thread_mutex_init( ldap_pvt_thread_mutex_t *mutex )
945 init_usage( &mutex->usage, "ldap_pvt_thread_mutex_init" );
946 rc = ldap_int_thread_mutex_init( WRAPPED( mutex ) );
948 ERROR( rc, "ldap_pvt_thread_mutex_init" );
949 destroy_usage( &mutex->usage );
951 RESET_OWNER( mutex );
952 adjust_count( Idx_mutex, +1 );
958 ldap_pvt_thread_mutex_destroy( ldap_pvt_thread_mutex_t *mutex )
961 check_usage( &mutex->usage, "ldap_pvt_thread_mutex_destroy" );
962 ASSERT_NO_OWNER( mutex, "ldap_pvt_thread_mutex_destroy" );
963 rc = ldap_int_thread_mutex_destroy( WRAPPED( mutex ) );
965 ERROR( rc, "ldap_pvt_thread_mutex_destroy" );
967 destroy_usage( &mutex->usage );
968 RESET_OWNER( mutex );
969 adjust_count( Idx_mutex, -1 );
975 ldap_pvt_thread_mutex_lock( ldap_pvt_thread_mutex_t *mutex )
978 check_usage( &mutex->usage, "ldap_pvt_thread_mutex_lock" );
979 rc = ldap_int_thread_mutex_lock( WRAPPED( mutex ) );
981 ERROR_IF( rc, "ldap_pvt_thread_mutex_lock" );
983 ASSERT_NO_OWNER( mutex, "ldap_pvt_thread_mutex_lock" );
984 SET_OWNER( mutex, ldap_int_thread_self() );
985 adjust_count( Idx_locked_mutex, +1 );
991 ldap_pvt_thread_mutex_trylock( ldap_pvt_thread_mutex_t *mutex )
994 check_usage( &mutex->usage, "ldap_pvt_thread_mutex_trylock" );
995 rc = ldap_int_thread_mutex_trylock( WRAPPED( mutex ) );
997 ASSERT_NO_OWNER( mutex, "ldap_pvt_thread_mutex_trylock" );
998 SET_OWNER( mutex, ldap_int_thread_self() );
999 adjust_count( Idx_locked_mutex, +1 );
1005 ldap_pvt_thread_mutex_unlock( ldap_pvt_thread_mutex_t *mutex )
1008 check_usage( &mutex->usage, "ldap_pvt_thread_mutex_unlock" );
1009 ASSERT_OWNER( mutex, "ldap_pvt_thread_mutex_unlock" );
1010 RESET_OWNER( mutex ); /* Breaks if this thread did not own the mutex */
1011 rc = ldap_int_thread_mutex_unlock( WRAPPED( mutex ) );
1013 ERROR_IF( rc, "ldap_pvt_thread_mutex_unlock" );
1015 adjust_count( Idx_locked_mutex, -1 );
1021 /* Wrappers for LDAP_THREAD_RDWR_IMPLEMENTATION: */
1024 ldap_pvt_thread_rdwr_init( ldap_pvt_thread_rdwr_t *rwlock )
1027 init_usage( &rwlock->usage, "ldap_pvt_thread_rdwr_init" );
1028 rc = ldap_int_thread_rdwr_init( WRAPPED( rwlock ) );
1030 ERROR( rc, "ldap_pvt_thread_rdwr_init" );
1031 destroy_usage( &rwlock->usage );
1033 adjust_count( Idx_rdwr, +1 );
1039 ldap_pvt_thread_rdwr_destroy( ldap_pvt_thread_rdwr_t *rwlock )
1042 check_usage( &rwlock->usage, "ldap_pvt_thread_rdwr_destroy" );
1043 rc = ldap_int_thread_rdwr_destroy( WRAPPED( rwlock ) );
1045 ERROR( rc, "ldap_pvt_thread_rdwr_destroy" );
1047 destroy_usage( &rwlock->usage );
1048 adjust_count( Idx_rdwr, -1 );
1054 ldap_pvt_thread_rdwr_rlock( ldap_pvt_thread_rdwr_t *rwlock )
1057 check_usage( &rwlock->usage, "ldap_pvt_thread_rdwr_rlock" );
1058 rc = ldap_int_thread_rdwr_rlock( WRAPPED( rwlock ) );
1059 ERROR_IF( rc, "ldap_pvt_thread_rdwr_rlock" );
1064 ldap_pvt_thread_rdwr_rtrylock( ldap_pvt_thread_rdwr_t *rwlock )
1066 check_usage( &rwlock->usage, "ldap_pvt_thread_rdwr_rtrylock" );
1067 return ldap_int_thread_rdwr_rtrylock( WRAPPED( rwlock ) );
1071 ldap_pvt_thread_rdwr_runlock( ldap_pvt_thread_rdwr_t *rwlock )
1074 check_usage( &rwlock->usage, "ldap_pvt_thread_rdwr_runlock" );
1075 rc = ldap_int_thread_rdwr_runlock( WRAPPED( rwlock ) );
1076 ERROR_IF( rc, "ldap_pvt_thread_rdwr_runlock" );
1081 ldap_pvt_thread_rdwr_wlock( ldap_pvt_thread_rdwr_t *rwlock )
1084 check_usage( &rwlock->usage, "ldap_pvt_thread_rdwr_wlock" );
1085 rc = ldap_int_thread_rdwr_wlock( WRAPPED( rwlock ) );
1086 ERROR_IF( rc, "ldap_pvt_thread_rdwr_wlock" );
1091 ldap_pvt_thread_rdwr_wtrylock( ldap_pvt_thread_rdwr_t *rwlock )
1093 check_usage( &rwlock->usage, "ldap_pvt_thread_rdwr_wtrylock" );
1094 return ldap_int_thread_rdwr_wtrylock( WRAPPED( rwlock ) );
1098 ldap_pvt_thread_rdwr_wunlock( ldap_pvt_thread_rdwr_t *rwlock )
1101 check_usage( &rwlock->usage, "ldap_pvt_thread_rdwr_wunlock" );
1102 rc = ldap_int_thread_rdwr_wunlock( WRAPPED( rwlock ) );
1103 ERROR_IF( rc, "ldap_pvt_thread_rdwr_wunlock" );
1107 #if defined(LDAP_RDWR_DEBUG) && !defined(LDAP_THREAD_HAVE_RDWR)
1110 ldap_pvt_thread_rdwr_readers( ldap_pvt_thread_rdwr_t *rwlock )
1112 check_usage( &rwlock->usage, "ldap_pvt_thread_rdwr_readers" );
1113 return ldap_int_thread_rdwr_readers( WRAPPED( rwlock ) );
1117 ldap_pvt_thread_rdwr_writers( ldap_pvt_thread_rdwr_t *rwlock )
1119 check_usage( &rwlock->usage, "ldap_pvt_thread_rdwr_writers" );
1120 return ldap_int_thread_rdwr_writers( WRAPPED( rwlock ) );
1124 ldap_pvt_thread_rdwr_active( ldap_pvt_thread_rdwr_t *rwlock )
1126 check_usage( &rwlock->usage, "ldap_pvt_thread_rdwr_active" );
1127 return ldap_int_thread_rdwr_active( WRAPPED( rwlock ) );
1130 #endif /* LDAP_RDWR_DEBUG && !LDAP_THREAD_HAVE_RDWR */
1133 /* Some wrappers for LDAP_THREAD_POOL_IMPLEMENTATION: */
1134 #ifdef LDAP_THREAD_POOL_IMPLEMENTATION
1137 ldap_pvt_thread_pool_init(
1138 ldap_pvt_thread_pool_t *tpool,
1145 ERROR_IF( !threading_enabled, "ldap_pvt_thread_pool_init" );
1146 rc = ldap_int_thread_pool_init( tpool, max_threads, max_pending );
1148 ERROR( rc, "ldap_pvt_thread_pool_init" );
1150 adjust_count( Idx_tpool, +1 );
1156 ldap_pvt_thread_pool_submit(
1157 ldap_pvt_thread_pool_t *tpool,
1158 ldap_pvt_thread_start_t *start_routine, void *arg )
1161 ERROR_IF( !threading_enabled, "ldap_pvt_thread_pool_submit" );
1162 has_pool = (tpool != NULL && *tpool != NULL);
1163 rc = ldap_int_thread_pool_submit( tpool, start_routine, arg );
1165 ERROR_IF( rc, "ldap_pvt_thread_pool_submit" );
1170 ldap_pvt_thread_pool_maxthreads(
1171 ldap_pvt_thread_pool_t *tpool,
1174 ERROR_IF( !threading_enabled, "ldap_pvt_thread_pool_maxthreads" );
1175 return ldap_int_thread_pool_maxthreads( tpool, max_threads );
1179 ldap_pvt_thread_pool_backload( ldap_pvt_thread_pool_t *tpool )
1181 ERROR_IF( !threading_enabled, "ldap_pvt_thread_pool_backload" );
1182 return ldap_int_thread_pool_backload( tpool );
1186 ldap_pvt_thread_pool_destroy( ldap_pvt_thread_pool_t *tpool, int run_pending )
1189 ERROR_IF( !threading_enabled, "ldap_pvt_thread_pool_destroy" );
1190 has_pool = (tpool != NULL && *tpool != NULL);
1191 rc = ldap_int_thread_pool_destroy( tpool, run_pending );
1194 ERROR( rc, "ldap_pvt_thread_pool_destroy" );
1196 adjust_count( Idx_tpool, -1 );
1203 ldap_pvt_thread_pool_pause( ldap_pvt_thread_pool_t *tpool )
1205 ERROR_IF( !threading_enabled, "ldap_pvt_thread_pool_pause" );
1206 return ldap_int_thread_pool_pause( tpool );
1210 ldap_pvt_thread_pool_resume( ldap_pvt_thread_pool_t *tpool )
1212 ERROR_IF( !threading_enabled, "ldap_pvt_thread_pool_resume" );
1213 return ldap_int_thread_pool_resume( tpool );
1217 ldap_pvt_thread_pool_getkey(
1221 ldap_pvt_thread_pool_keyfree_t **kfree )
1223 #if 0 /* Function is used by ch_free() via slap_sl_contxt() in slapd */
1224 ERROR_IF( !threading_enabled, "ldap_pvt_thread_pool_getkey" );
1226 return ldap_int_thread_pool_getkey( xctx, key, data, kfree );
1230 ldap_pvt_thread_pool_setkey(
1234 ldap_pvt_thread_pool_keyfree_t *kfree )
1237 ERROR_IF( !threading_enabled, "ldap_pvt_thread_pool_setkey" );
1238 rc = ldap_int_thread_pool_setkey( xctx, key, data, kfree );
1239 ERROR_IF( rc, "ldap_pvt_thread_pool_setkey" );
1244 ldap_pvt_thread_pool_purgekey( void *key )
1246 ERROR_IF( !threading_enabled, "ldap_pvt_thread_pool_purgekey" );
1247 ldap_int_thread_pool_purgekey( key );
1251 ldap_pvt_thread_pool_context( void )
1253 #if 0 /* Function is used by ch_free() via slap_sl_contxt() in slapd */
1254 ERROR_IF( !threading_enabled, "ldap_pvt_thread_pool_context" );
1256 return ldap_int_thread_pool_context();
1260 ldap_pvt_thread_pool_context_reset( void *vctx )
1262 ERROR_IF( !threading_enabled, "ldap_pvt_thread_pool_context_reset" );
1263 ldap_int_thread_pool_context_reset( vctx );
1266 #endif /* LDAP_THREAD_POOL_IMPLEMENTATION */
1268 #endif /* LDAP_THREAD_DEBUG */