libgc/pthread_support.c

   1 /*
   2  * Copyright (c) 1994 by Xerox Corporation.  All rights reserved.
   3  * Copyright (c) 1996 by Silicon Graphics.  All rights reserved.
   4  * Copyright (c) 1998 by Fergus Henderson.  All rights reserved.
   5  * Copyright (c) 2000-2004 by Hewlett-Packard Company.  All rights reserved.
   6  *
   7  * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
   8  * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
   9  *
  10  * Permission is hereby granted to use or copy this program
  11  * for any purpose,  provided the above notices are retained on all copies.
  12  * Permission to modify the code and to distribute modified code is granted,
  13  * provided the above notices are retained, and a notice that the code was
  14  * modified is included with the above copyright notice.
  15  */
  16 /*
  17  * Support code for LinuxThreads, the clone()-based kernel
  18  * thread package for Linux which is included in libc6.
  19  *
  20  * This code relies on implementation details of LinuxThreads,
  21  * (i.e. properties not guaranteed by the Pthread standard),
  22  * though this version now does less of that than the other Pthreads
  23  * support code.
  24  *
  25  * Note that there is a lot of code duplication between linux_threads.c
  26  * and thread support for some of the other Posix platforms; any changes
  27  * made here may need to be reflected there too.
  28  */
  29  /* DG/UX ix86 support <takis@xfree86.org> */
  30 /*
  31  * Linux_threads.c now also includes some code to support HPUX and
  32  * OSF1 (Compaq Tru64 Unix, really).  The OSF1 support is based on Eric Benson's
  33  * patch.
  34  *
  35  * Eric also suggested an alternate basis for a lock implementation in
  36  * his code:
  37  * + #elif defined(OSF1)
  38  * +    unsigned long GC_allocate_lock = 0;
  39  * +    msemaphore GC_allocate_semaphore;
  40  * + #  define GC_TRY_LOCK() \
  41  * +    ((msem_lock(&GC_allocate_semaphore, MSEM_IF_NOWAIT) == 0) \
  42  * +     ? (GC_allocate_lock = 1) \
  43  * +     : 0)
  44  * + #  define GC_LOCK_TAKEN GC_allocate_lock
  45  */
  46
  47 /*#define DEBUG_THREADS 1*/
  48 /*#define GC_ASSERTIONS*/
  49
  50 # include "private/pthread_support.h"
  51
  52 # if defined(GC_PTHREADS) && !defined(GC_SOLARIS_THREADS) \
  53      && !defined(GC_WIN32_THREADS)
  54
  55 # if defined(GC_HPUX_THREADS) && !defined(USE_PTHREAD_SPECIFIC) \
  56      && !defined(USE_COMPILER_TLS)
  57 #   ifdef __GNUC__
  58 #     define USE_PTHREAD_SPECIFIC
  59       /* Empirically, as of gcc 3.3, USE_COMPILER_TLS doesn't work.     */
  60 #   else
  61 #     define USE_COMPILER_TLS
  62 #   endif
  63 # endif
  64
  65 # if defined USE_HPUX_TLS
  66     --> Macro replaced by USE_COMPILER_TLS
  67 # endif
  68
  69 # if (defined(GC_DGUX386_THREADS) || defined(GC_OSF1_THREADS) || \
  70       defined(GC_DARWIN_THREADS) || defined(GC_AIX_THREADS)) \
  71       && !defined(USE_PTHREAD_SPECIFIC)
  72 #   define USE_PTHREAD_SPECIFIC
  73 # endif
  74
  75 # if defined(GC_DGUX386_THREADS) && !defined(_POSIX4A_DRAFT10_SOURCE)
  76 #   define _POSIX4A_DRAFT10_SOURCE 1
  77 # endif
  78
  79 # if defined(GC_DGUX386_THREADS) && !defined(_USING_POSIX4A_DRAFT10)
  80 #   define _USING_POSIX4A_DRAFT10 1
  81 # endif
  82
  83 # ifdef THREAD_LOCAL_ALLOC
  84 #   if !defined(USE_PTHREAD_SPECIFIC) && !defined(USE_COMPILER_TLS)
  85 #     include "private/specific.h"
  86 #   endif
  87
  88 /* Note that these macros should be used only to get/set the GC_thread pointer.
  89  * We need to use both tls and pthread because we use the pthread_create function hook to
  90  * free the data for foreign threads. When that doesn't happen, libgc could have old
  91  * pthread_t that get reused...
  92  */
  93 #   if defined(USE_PTHREAD_SPECIFIC)
  94 #     define GC_getspecific pthread_getspecific
  95 #     define GC_setspecific pthread_setspecific
  96 #     define GC_key_create pthread_key_create
  97       typedef pthread_key_t GC_key_t;
  98 #   endif
  99 #   if defined(USE_COMPILER_TLS)
 100 #     define GC_getspecific(x) (GC_thread_tls)
 101 #     define GC_setspecific(key, v) (GC_thread_tls = (v), pthread_setspecific ((key), (v)))
 102 #     define GC_key_create pthread_key_create
 103       typedef pthread_key_t GC_key_t;
 104 #   endif
 105 # endif
 106 # include <stdlib.h>
 107 # include <pthread.h>
 108 # include <sched.h>
 109 # include <time.h>
 110 # include <errno.h>
 111 # include <unistd.h>
 112 # include <sys/mman.h>
 113 # include <sys/time.h>
 114 # include <sys/types.h>
 115 # include <sys/stat.h>
 116 # include <fcntl.h>
 117 # include <signal.h>
 118
 119 #if defined(GC_DARWIN_THREADS)
 120 # include "private/darwin_semaphore.h"
 121 #else
 122 # include <semaphore.h>
 123 #endif /* !GC_DARWIN_THREADS */
 124
 125 #if defined(GC_DARWIN_THREADS) || defined(GC_FREEBSD_THREADS)
 126 # include <sys/sysctl.h>
 127 #endif /* GC_DARWIN_THREADS */
 128
 129
 130
 131 #if defined(GC_DGUX386_THREADS)
 132 # include <sys/dg_sys_info.h>
 133 # include <sys/_int_psem.h>
 134   /* sem_t is an uint in DG/UX */
 135   typedef unsigned int  sem_t;
 136 #endif /* GC_DGUX386_THREADS */
 137
 138 #ifndef __GNUC__
 139 #   define __inline__
 140 #endif
 141
 142 #ifdef GC_USE_LD_WRAP
 143 #   define WRAP_FUNC(f) __wrap_##f
 144 #   define REAL_FUNC(f) __real_##f
 145 #else
 146 #   define WRAP_FUNC(f) GC_##f
 147 #   if !defined(GC_DGUX386_THREADS)
 148 #     define REAL_FUNC(f) f
 149 #   else /* GC_DGUX386_THREADS */
 150 #     define REAL_FUNC(f) __d10_##f
 151 #   endif /* GC_DGUX386_THREADS */
 152 #   undef pthread_create
 153 #   if !defined(GC_DARWIN_THREADS)
 154 #     undef pthread_sigmask
 155 #   endif
 156 #   undef pthread_join
 157 #   undef pthread_detach
 158 #   if defined(GC_OSF1_THREADS) && defined(_PTHREAD_USE_MANGLED_NAMES_) \
 159        && !defined(_PTHREAD_USE_PTDNAM_)
 160 /* Restore the original mangled names on Tru64 UNIX.  */
 161 #     define pthread_create __pthread_create
 162 #     define pthread_join __pthread_join
 163 #     define pthread_detach __pthread_detach
 164 #   endif
 165 #endif
 166
 167 void GC_thr_init();
 168
 169 static GC_bool parallel_initialized = FALSE;
 170
 171 void GC_init_parallel();
 172
 173 # if defined(THREAD_LOCAL_ALLOC) && !defined(DBG_HDRS_ALL)
 174
 175 /* We don't really support thread-local allocation with DBG_HDRS_ALL */
 176
 177 /* work around a dlopen issue (bug #75390), undefs to avoid warnings with redefinitions */
 178 #undef PACKAGE_BUGREPORT
 179 #undef PACKAGE_NAME
 180 #undef PACKAGE_STRING
 181 #undef PACKAGE_TARNAME
 182 #undef PACKAGE_VERSION
 183 #include "mono/utils/mono-compiler.h"
 184
 185 static
 186 GC_key_t GC_thread_key;
 187
 188 #ifdef USE_COMPILER_TLS
 189 static __thread MONO_TLS_FAST void* GC_thread_tls;
 190 #endif
 191
 192 static GC_bool keys_initialized;
 193
 194 /* Recover the contents of the freelist array fl into the global one gfl.*/
 195 /* Note that the indexing scheme differs, in that gfl has finer size    */
 196 /* resolution, even if not all entries are used.                        */
 197 /* We hold the allocator lock.                                          */
 198 static void return_freelists(ptr_t *fl, ptr_t *gfl)
 199 {
 200     int i;
 201     ptr_t q, *qptr;
 202     size_t nwords;
 203
 204     for (i = 1; i < NFREELISTS; ++i) {
 205         nwords = i * (GRANULARITY/sizeof(word));
 206         qptr = fl + i;
 207         q = *qptr;
 208         if ((word)q >= HBLKSIZE) {
 209           if (gfl[nwords] == 0) {
 210             gfl[nwords] = q;
 211           } else {
 212             /* Concatenate: */
 213             for (; (word)q >= HBLKSIZE; qptr = &(obj_link(q)), q = *qptr);
 214             GC_ASSERT(0 == q);
 215             *qptr = gfl[nwords];
 216             gfl[nwords] = fl[i];
 217           }
 218         }
 219         /* Clear fl[i], since the thread structure may hang around.     */
 220         /* Do it in a way that is likely to trap if we access it.       */
 221         fl[i] = (ptr_t)HBLKSIZE;
 222     }
 223 }
 224
 225 /* We statically allocate a single "size 0" object. It is linked to     */
 226 /* itself, and is thus repeatedly reused for all size 0 allocation      */
 227 /* requests.  (Size 0 gcj allocation requests are incorrect, and        */
 228 /* we arrange for those to fault asap.)                                 */
 229 static ptr_t size_zero_object = (ptr_t)(&size_zero_object);
 230
 231 void GC_delete_gc_thread(pthread_t id, GC_thread gct);
 232 void GC_destroy_thread_local(GC_thread p);
 233
 234 void GC_thread_deregister_foreign (void *data)
 235 {
 236     GC_thread me = (GC_thread)data;
 237  /*   GC_fprintf1( "\n\n\n\n --- Deregister %x ---\n\n\n\n\n", me->flags ); */
 238     if (me -> flags & FOREIGN_THREAD) {
 239         LOCK();
 240  /*     GC_fprintf0( "\n\n\n\n --- FOO ---\n\n\n\n\n" ); */
 241 #if defined(THREAD_LOCAL_ALLOC) && !defined(DBG_HDRS_ALL)
 242         GC_destroy_thread_local (me);
 243 #endif
 244         GC_delete_gc_thread(me->id, me);
 245         UNLOCK();
 246     }
 247 }
 248
 249 /* Each thread structure must be initialized.   */
 250 /* This call must be made from the new thread.  */
 251 /* Caller holds allocation lock.                */
 252 void GC_init_thread_local(GC_thread p)
 253 {
 254     int i;
 255
 256     if (!keys_initialized) {
 257         if (0 != GC_key_create(&GC_thread_key, GC_thread_deregister_foreign)) {
 258             ABORT("Failed to create key for local allocator");
 259         }
 260         keys_initialized = TRUE;
 261     }
 262     if (0 != GC_setspecific(GC_thread_key, p)) {
 263         ABORT("Failed to set thread specific allocation pointers");
 264     }
 265     for (i = 1; i < NFREELISTS; ++i) {
 266         p -> ptrfree_freelists[i] = (ptr_t)1;
 267         p -> normal_freelists[i] = (ptr_t)1;
 268 #       ifdef GC_GCJ_SUPPORT
 269           p -> gcj_freelists[i] = (ptr_t)1;
 270 #       endif
 271     }
 272     /* Set up the size 0 free lists.    */
 273     p -> ptrfree_freelists[0] = (ptr_t)(&size_zero_object);
 274     p -> normal_freelists[0] = (ptr_t)(&size_zero_object);
 275 #   ifdef GC_GCJ_SUPPORT
 276         p -> gcj_freelists[0] = (ptr_t)(-1);
 277 #   endif
 278 }
 279
 280 #ifdef GC_GCJ_SUPPORT
 281   extern ptr_t * GC_gcjobjfreelist;
 282 #endif
 283
 284 /* We hold the allocator lock.  */
 285 void GC_destroy_thread_local(GC_thread p)
 286 {
 287     /* We currently only do this from the thread itself or from */
 288     /* the fork handler for a child process.                    */
 289 #   ifndef HANDLE_FORK
 290       GC_ASSERT(GC_getspecific(GC_thread_key) == (void *)p);
 291 #   endif
 292     return_freelists(p -> ptrfree_freelists, GC_aobjfreelist);
 293     return_freelists(p -> normal_freelists, GC_objfreelist);
 294 #   ifdef GC_GCJ_SUPPORT
 295         return_freelists(p -> gcj_freelists, GC_gcjobjfreelist);
 296 #   endif
 297 }
 298
 299 extern GC_PTR GC_generic_malloc_many();
 300
 301 GC_PTR GC_local_malloc(size_t bytes)
 302 {
 303     if (EXPECT(!SMALL_ENOUGH(bytes),0)) {
 304         return(GC_malloc(bytes));
 305     } else {
 306         int index = INDEX_FROM_BYTES(bytes);
 307         ptr_t * my_fl;
 308         ptr_t my_entry;
 309 #       if defined(REDIRECT_MALLOC) && !defined(USE_PTHREAD_SPECIFIC)
 310         GC_key_t k = GC_thread_key;
 311 #       endif
 312         void * tsd;
 313
 314 #       if defined(REDIRECT_MALLOC) && !defined(USE_PTHREAD_SPECIFIC)
 315             if (EXPECT(0 == k, 0)) {
 316                 /* This can happen if we get called when the world is   */
 317                 /* being initialized.  Whether we can actually complete */
 318                 /* the initialization then is unclear.                  */
 319                 GC_init_parallel();
 320                 k = GC_thread_key;
 321             }
 322 #       endif
 323         tsd = GC_getspecific(GC_thread_key);
 324 #       ifdef GC_ASSERTIONS
 325           LOCK();
 326           GC_ASSERT(tsd == (void *)GC_lookup_thread(pthread_self()));
 327           UNLOCK();
 328 #       endif
 329         my_fl = ((GC_thread)tsd) -> normal_freelists + index;
 330         my_entry = *my_fl;
 331         if (EXPECT((word)my_entry >= HBLKSIZE, 1)) {
 332             ptr_t next = obj_link(my_entry);
 333             GC_PTR result = (GC_PTR)my_entry;
 334             *my_fl = next;
 335             obj_link(my_entry) = 0;
 336             PREFETCH_FOR_WRITE(next);
 337             return result;
 338         } else if ((word)my_entry - 1 < DIRECT_GRANULES) {
 339             *my_fl = my_entry + index + 1;
 340             return GC_malloc(bytes);
 341         } else {
 342             GC_generic_malloc_many(BYTES_FROM_INDEX(index), NORMAL, my_fl);
 343             if (*my_fl == 0) return GC_oom_fn(bytes);
 344             return GC_local_malloc(bytes);
 345         }
 346     }
 347 }
 348
 349 GC_PTR GC_local_malloc_atomic(size_t bytes)
 350 {
 351     if (EXPECT(!SMALL_ENOUGH(bytes), 0)) {
 352         return(GC_malloc_atomic(bytes));
 353     } else {
 354         int index = INDEX_FROM_BYTES(bytes);
 355         ptr_t * my_fl = ((GC_thread)GC_getspecific(GC_thread_key))
 356                         -> ptrfree_freelists + index;
 357         ptr_t my_entry = *my_fl;
 358
 359         if (EXPECT((word)my_entry >= HBLKSIZE, 1)) {
 360             GC_PTR result = (GC_PTR)my_entry;
 361             *my_fl = obj_link(my_entry);
 362             return result;
 363         } else if ((word)my_entry - 1 < DIRECT_GRANULES) {
 364             *my_fl = my_entry + index + 1;
 365         return GC_malloc_atomic(bytes);
 366         } else {
 367             GC_generic_malloc_many(BYTES_FROM_INDEX(index), PTRFREE, my_fl);
 368             /* *my_fl is updated while the collector is excluded;       */
 369             /* the free list is always visible to the collector as      */
 370             /* such.                                                    */
 371             if (*my_fl == 0) return GC_oom_fn(bytes);
 372             return GC_local_malloc_atomic(bytes);
 373         }
 374     }
 375 }
 376
 377 #ifdef GC_GCJ_SUPPORT
 378
 379 #include "include/gc_gcj.h"
 380
 381 #ifdef GC_ASSERTIONS
 382   extern GC_bool GC_gcj_malloc_initialized;
 383 #endif
 384
 385 extern int GC_gcj_kind;
 386
 387 GC_PTR GC_local_gcj_malloc(size_t bytes,
 388                            void * ptr_to_struct_containing_descr)
 389 {
 390     GC_ASSERT(GC_gcj_malloc_initialized);
 391     if (EXPECT(!SMALL_ENOUGH(bytes), 0)) {
 392         return GC_gcj_malloc(bytes, ptr_to_struct_containing_descr);
 393     } else {
 394         int index = INDEX_FROM_BYTES(bytes);
 395         ptr_t * my_fl = ((GC_thread)GC_getspecific(GC_thread_key))
 396                         -> gcj_freelists + index;
 397         ptr_t my_entry = *my_fl;
 398         if (EXPECT((word)my_entry >= HBLKSIZE, 1)) {
 399             GC_PTR result = (GC_PTR)my_entry;
 400             GC_ASSERT(!GC_incremental);
 401             /* We assert that any concurrent marker will stop us.       */
 402             /* Thus it is impossible for a mark procedure to see the    */
 403             /* allocation of the next object, but to see this object    */
 404             /* still containing a free list pointer.  Otherwise the     */
 405             /* marker might find a random "mark descriptor".            */
 406             *(volatile ptr_t *)my_fl = obj_link(my_entry);
 407             /* We must update the freelist before we store the pointer. */
 408             /* Otherwise a GC at this point would see a corrupted       */
 409             /* free list.                                               */
 410             /* A memory barrier is probably never needed, since the     */
 411             /* action of stopping this thread will cause prior writes   */
 412             /* to complete.                                             */
 413             GC_ASSERT(((void * volatile *)result)[1] == 0);
 414             *(void * volatile *)result = ptr_to_struct_containing_descr;
 415             return result;
 416         } else if ((word)my_entry - 1 < DIRECT_GRANULES) {
 417             if (!GC_incremental) *my_fl = my_entry + index + 1;
 418                 /* In the incremental case, we always have to take this */
 419                 /* path.  Thus we leave the counter alone.              */
 420             return GC_gcj_malloc(bytes, ptr_to_struct_containing_descr);
 421         } else {
 422             GC_generic_malloc_many(BYTES_FROM_INDEX(index), GC_gcj_kind, my_fl);
 423             if (*my_fl == 0) return GC_oom_fn(bytes);
 424             return GC_local_gcj_malloc(bytes, ptr_to_struct_containing_descr);
 425         }
 426     }
 427 }
 428
 429 /* Similar to GC_local_gcj_malloc, but the size is in words, and we don't       */
 430 /* adjust it.  The size is assumed to be such that it can be    */
 431 /* allocated as a small object.                                 */
 432 void * GC_local_gcj_fast_malloc(size_t lw, void * ptr_to_struct_containing_descr)
 433 {
 434         ptr_t * my_fl = ((GC_thread)GC_getspecific(GC_thread_key))
 435                 -> gcj_freelists + lw;
 436         ptr_t my_entry = *my_fl;
 437
 438     GC_ASSERT(GC_gcj_malloc_initialized);
 439
 440         if (EXPECT((word)my_entry >= HBLKSIZE, 1)) {
 441             GC_PTR result = (GC_PTR)my_entry;
 442             GC_ASSERT(!GC_incremental);
 443             /* We assert that any concurrent marker will stop us.       */
 444             /* Thus it is impossible for a mark procedure to see the    */
 445             /* allocation of the next object, but to see this object    */
 446             /* still containing a free list pointer.  Otherwise the     */
 447             /* marker might find a random "mark descriptor".            */
 448             *(volatile ptr_t *)my_fl = obj_link(my_entry);
 449             /* We must update the freelist before we store the pointer. */
 450             /* Otherwise a GC at this point would see a corrupted       */
 451             /* free list.                                               */
 452             /* A memory barrier is probably never needed, since the     */
 453             /* action of stopping this thread will cause prior writes   */
 454             /* to complete.                                             */
 455             GC_ASSERT(((void * volatile *)result)[1] == 0);
 456             *(void * volatile *)result = ptr_to_struct_containing_descr;
 457             return result;
 458         } else if ((word)my_entry - 1 < DIRECT_GRANULES) {
 459             if (!GC_incremental) *my_fl = my_entry + lw + 1;
 460                 /* In the incremental case, we always have to take this */
 461                 /* path.  Thus we leave the counter alone.              */
 462             return GC_gcj_fast_malloc(lw, ptr_to_struct_containing_descr);
 463         } else {
 464             GC_generic_malloc_many(BYTES_FROM_INDEX(lw), GC_gcj_kind, my_fl);
 465             if (*my_fl == 0) return GC_oom_fn(BYTES_FROM_INDEX(lw));
 466             return GC_local_gcj_fast_malloc(lw, ptr_to_struct_containing_descr);
 467         }
 468 }
 469
 470 #endif /* GC_GCJ_SUPPORT */
 471
 472 # else  /* !THREAD_LOCAL_ALLOC  && !DBG_HDRS_ALL */
 473
 474 #   define GC_destroy_thread_local(t)
 475
 476 # endif /* !THREAD_LOCAL_ALLOC */
 477
 478 #if 0
 479 /*
 480 To make sure that we're using LinuxThreads and not some other thread
 481 package, we generate a dummy reference to `pthread_kill_other_threads_np'
 482 (was `__pthread_initial_thread_bos' but that disappeared),
 483 which is a symbol defined in LinuxThreads, but (hopefully) not in other
 484 thread packages.
 485
 486 We no longer do this, since this code is now portable enough that it might
 487 actually work for something else.
 488 */
 489 void (*dummy_var_to_force_linux_threads)() = pthread_kill_other_threads_np;
 490 #endif /* 0 */
 491
 492 long GC_nprocs = 1;     /* Number of processors.  We may not have       */
 493                         /* access to all of them, but this is as good   */
 494                         /* a guess as any ...                           */
 495
 496 #ifdef PARALLEL_MARK
 497
 498 # ifndef MAX_MARKERS
 499 #   define MAX_MARKERS 16
 500 # endif
 501
 502 static ptr_t marker_sp[MAX_MARKERS] = {0};
 503
 504 void * GC_mark_thread(void * id)
 505 {
 506   word my_mark_no = 0;
 507
 508   marker_sp[(word)id] = GC_approx_sp();
 509   for (;; ++my_mark_no) {
 510     /* GC_mark_no is passed only to allow GC_help_marker to terminate   */
 511     /* promptly.  This is important if it were called from the signal   */
 512     /* handler or from the GC lock acquisition code.  Under Linux, it's */
 513     /* not safe to call it from a signal handler, since it uses mutexes */
 514     /* and condition variables.  Since it is called only here, the      */
 515     /* argument is unnecessary.                                         */
 516     if (my_mark_no < GC_mark_no || my_mark_no > GC_mark_no + 2) {
 517         /* resynchronize if we get far off, e.g. because GC_mark_no     */
 518         /* wrapped.                                                     */
 519         my_mark_no = GC_mark_no;
 520     }
 521 #   ifdef DEBUG_THREADS
 522         GC_printf1("Starting mark helper for mark number %ld\n", my_mark_no);
 523 #   endif
 524     GC_help_marker(my_mark_no);
 525   }
 526 }
 527
 528 extern long GC_markers;         /* Number of mark threads we would      */
 529                                 /* like to have.  Includes the          */
 530                                 /* initiating thread.                   */
 531
 532 pthread_t GC_mark_threads[MAX_MARKERS];
 533
 534 #define PTHREAD_CREATE REAL_FUNC(pthread_create)
 535
 536 static void start_mark_threads()
 537 {
 538     unsigned i;
 539     pthread_attr_t attr;
 540
 541     if (GC_markers > MAX_MARKERS) {
 542         WARN("Limiting number of mark threads\n", 0);
 543         GC_markers = MAX_MARKERS;
 544     }
 545     if (0 != pthread_attr_init(&attr)) ABORT("pthread_attr_init failed");
 546
 547     if (0 != pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED))
 548         ABORT("pthread_attr_setdetachstate failed");
 549
 550 #   if defined(HPUX) || defined(GC_DGUX386_THREADS)
 551       /* Default stack size is usually too small: fix it. */
 552       /* Otherwise marker threads or GC may run out of    */
 553       /* space.                                           */
 554 #     define MIN_STACK_SIZE (8*HBLKSIZE*sizeof(word))
 555       {
 556         size_t old_size;
 557         int code;
 558
 559         if (pthread_attr_getstacksize(&attr, &old_size) != 0)
 560           ABORT("pthread_attr_getstacksize failed\n");
 561         if (old_size < MIN_STACK_SIZE) {
 562           if (pthread_attr_setstacksize(&attr, MIN_STACK_SIZE) != 0)
 563                   ABORT("pthread_attr_setstacksize failed\n");
 564         }
 565       }
 566 #   endif /* HPUX || GC_DGUX386_THREADS */
 567 #   ifdef CONDPRINT
 568       if (GC_print_stats) {
 569         GC_printf1("Starting %ld marker threads\n", GC_markers - 1);
 570       }
 571 #   endif
 572     for (i = 0; i < GC_markers - 1; ++i) {
 573       if (0 != PTHREAD_CREATE(GC_mark_threads + i, &attr,
 574                               GC_mark_thread, (void *)(word)i)) {
 575         WARN("Marker thread creation failed, errno = %ld.\n", errno);
 576       }
 577     }
 578 }
 579
 580 #else  /* !PARALLEL_MARK */
 581
 582 static __inline__ void start_mark_threads()
 583 {
 584 }
 585
 586 #endif /* !PARALLEL_MARK */
 587
 588 GC_bool GC_thr_initialized = FALSE;
 589
 590 volatile GC_thread GC_threads[THREAD_TABLE_SZ];
 591
 592 /*
 593  * gcc-3.3.6 miscompiles the &GC_thread_key+sizeof(&GC_thread_key) expression so
 594  * put it into a separate function.
 595  */
 596 #   if defined(__GNUC__) && defined(THREAD_LOCAL_ALLOC) && !defined(DBG_HDRS_ALL)
 597 static __attribute__((noinline)) unsigned char* get_gc_thread_key_addr GC_PROTO((void))
 598 {
 599         return (unsigned char*)&GC_thread_key;
 600 }
 601
 602 void GC_push_thread_structures GC_PROTO((void))
 603 {
 604     GC_push_all((ptr_t)(GC_threads), (ptr_t)(GC_threads)+sizeof(GC_threads));
 605 #   if defined(THREAD_LOCAL_ALLOC) && !defined(DBG_HDRS_ALL)
 606       GC_push_all((ptr_t)get_gc_thread_key_addr(),
 607           (ptr_t)(get_gc_thread_key_addr())+sizeof(&GC_thread_key));
 608 #   endif
 609 }
 610
 611 #else
 612
 613 void GC_push_thread_structures GC_PROTO((void))
 614 {
 615     GC_push_all((ptr_t)(GC_threads), (ptr_t)(GC_threads)+sizeof(GC_threads));
 616 #   if defined(THREAD_LOCAL_ALLOC) && !defined(DBG_HDRS_ALL)
 617       GC_push_all((ptr_t)(&GC_thread_key),
 618           (ptr_t)(&GC_thread_key)+sizeof(&GC_thread_key));
 619 #   endif
 620 }
 621
 622 #endif
 623
 624 #ifdef THREAD_LOCAL_ALLOC
 625 /* We must explicitly mark ptrfree and gcj free lists, since the free   */
 626 /* list links wouldn't otherwise be found.  We also set them in the     */
 627 /* normal free lists, since that involves touching less memory than if  */
 628 /* we scanned them normally.                                            */
 629 void GC_mark_thread_local_free_lists(void)
 630 {
 631     int i, j;
 632     GC_thread p;
 633     ptr_t q;
 634
 635     for (i = 0; i < THREAD_TABLE_SZ; ++i) {
 636       for (p = GC_threads[i]; 0 != p; p = p -> next) {
 637         for (j = 1; j < NFREELISTS; ++j) {
 638           q = p -> ptrfree_freelists[j];
 639           if ((word)q > HBLKSIZE) GC_set_fl_marks(q);
 640           q = p -> normal_freelists[j];
 641           if ((word)q > HBLKSIZE) GC_set_fl_marks(q);
 642 #         ifdef GC_GCJ_SUPPORT
 643             q = p -> gcj_freelists[j];
 644             if ((word)q > HBLKSIZE) GC_set_fl_marks(q);
 645 #         endif /* GC_GCJ_SUPPORT */
 646         }
 647       }
 648     }
 649 }
 650 #endif /* THREAD_LOCAL_ALLOC */
 651
 652 static struct GC_Thread_Rep first_thread;
 653
 654 /* Add a thread to GC_threads.  We assume it wasn't already there.      */
 655 /* Caller holds allocation lock.                                        */
 656 GC_thread GC_new_thread(pthread_t id)
 657 {
 658     int hv = ((word)id) % THREAD_TABLE_SZ;
 659     GC_thread result;
 660     static GC_bool first_thread_used = FALSE;
 661
 662     if (!first_thread_used) {
 663         result = &first_thread;
 664         first_thread_used = TRUE;
 665     } else {
 666         result = calloc (1, sizeof (struct GC_Thread_Rep));
 667     }
 668     if (result == 0) return(0);
 669     result -> id = id;
 670     result -> next = GC_threads[hv];
 671     GC_threads[hv] = result;
 672     GC_ASSERT(result -> flags == 0 && result -> thread_blocked == 0);
 673     return(result);
 674 }
 675
 676 /* Delete a thread from GC_threads.  We assume it is there.     */
 677 /* (The code intentionally traps if it wasn't.)                 */
 678 /* Caller holds allocation lock.                                */
 679 void GC_delete_thread(pthread_t id)
 680 {
 681     int hv = ((word)id) % THREAD_TABLE_SZ;
 682     register GC_thread p = GC_threads[hv];
 683     register GC_thread prev = 0;
 684
 685     while (!pthread_equal(p -> id, id)) {
 686         prev = p;
 687         p = p -> next;
 688     }
 689     if (prev == 0) {
 690         GC_threads[hv] = p -> next;
 691     } else {
 692         prev -> next = p -> next;
 693     }
 694     if (gc_thread_vtable && gc_thread_vtable->thread_exited)
 695         gc_thread_vtable->thread_exited (id, &p->stop_info.stack_ptr);
 696     free(p);
 697 }
 698
 699 /* If a thread has been joined, but we have not yet             */
 700 /* been notified, then there may be more than one thread        */
 701 /* in the table with the same pthread id.                       */
 702 /* This is OK, but we need a way to delete a specific one.      */
 703 void GC_delete_gc_thread(pthread_t id, GC_thread gc_id)
 704 {
 705     int hv = ((word)id) % THREAD_TABLE_SZ;
 706     register GC_thread p = GC_threads[hv];
 707     register GC_thread prev = 0;
 708
 709     while (p != gc_id) {
 710         prev = p;
 711         p = p -> next;
 712     }
 713     if (prev == 0) {
 714         GC_threads[hv] = p -> next;
 715     } else {
 716         prev -> next = p -> next;
 717     }
 718     free(p);
 719 }
 720
 721 /* Return a GC_thread corresponding to a given pthread_t.       */
 722 /* Returns 0 if it's not there.                                 */
 723 /* Caller holds  allocation lock or otherwise inhibits          */
 724 /* updates.                                                     */
 725 /* If there is more than one thread with the given id we        */
 726 /* return the most recent one.                                  */
 727 GC_thread GC_lookup_thread(pthread_t id)
 728 {
 729     int hv = ((word)id) % THREAD_TABLE_SZ;
 730     register GC_thread p = GC_threads[hv];
 731
 732     while (p != 0 && !pthread_equal(p -> id, id)) p = p -> next;
 733     return(p);
 734 }
 735
 736 int GC_thread_is_registered (void)
 737 {
 738         void *ptr;
 739
 740         LOCK();
 741         ptr = (void *)GC_lookup_thread(pthread_self());
 742         UNLOCK();
 743
 744         return ptr ? 1 : 0;
 745 }
 746
 747 #ifdef HANDLE_FORK
 748 /* Remove all entries from the GC_threads table, except the     */
 749 /* one for the current thread.  We need to do this in the child */
 750 /* process after a fork(), since only the current thread        */
 751 /* survives in the child.                                       */
 752 void GC_remove_all_threads_but_me(void)
 753 {
 754     pthread_t self = pthread_self();
 755     int hv;
 756     GC_thread p, next, me;
 757
 758     for (hv = 0; hv < THREAD_TABLE_SZ; ++hv) {
 759       me = 0;
 760       for (p = GC_threads[hv]; 0 != p; p = next) {
 761         next = p -> next;
 762         if (p -> id == self) {
 763           me = p;
 764           p -> next = 0;
 765         } else {
 766 #         ifdef THREAD_LOCAL_ALLOC
 767             if (!(p -> flags & FINISHED)) {
 768               GC_destroy_thread_local(p);
 769             }
 770 #         endif /* THREAD_LOCAL_ALLOC */
 771             if (p != &first_thread) free(p);
 772         }
 773       }
 774       GC_threads[hv] = me;
 775     }
 776 }
 777 #endif /* HANDLE_FORK */
 778
 779 #ifdef USE_PROC_FOR_LIBRARIES
 780 int GC_segment_is_thread_stack(ptr_t lo, ptr_t hi)
 781 {
 782     int i;
 783     GC_thread p;
 784
 785 #   ifdef PARALLEL_MARK
 786       for (i = 0; i < GC_markers; ++i) {
 787         if (marker_sp[i] > lo & marker_sp[i] < hi) return 1;
 788       }
 789 #   endif
 790     for (i = 0; i < THREAD_TABLE_SZ; i++) {
 791       for (p = GC_threads[i]; p != 0; p = p -> next) {
 792         if (0 != p -> stack_end) {
 793 #         ifdef STACK_GROWS_UP
 794             if (p -> stack_end >= lo && p -> stack_end < hi) return 1;
 795 #         else /* STACK_GROWS_DOWN */
 796             if (p -> stack_end > lo && p -> stack_end <= hi) return 1;
 797 #         endif
 798         }
 799       }
 800     }
 801     return 0;
 802 }
 803 #endif /* USE_PROC_FOR_LIBRARIES */
 804
 805 #ifdef GC_LINUX_THREADS
 806 /* Return the number of processors, or i<= 0 if it can't be determined. */
 807 int GC_get_nprocs()
 808 {
 809     /* Should be "return sysconf(_SC_NPROCESSORS_ONLN);" but that       */
 810     /* appears to be buggy in many cases.                               */
 811     /* We look for lines "cpu<n>" in /proc/stat.                        */
 812 #   define STAT_BUF_SIZE 4096
 813 #   define STAT_READ read
 814         /* If read is wrapped, this may need to be redefined to call    */
 815         /* the real one.                                                */
 816     char stat_buf[STAT_BUF_SIZE];
 817     int f;
 818     word result = 1;
 819         /* Some old kernels only have a single "cpu nnnn ..."   */
 820         /* entry in /proc/stat.  We identify those as           */
 821         /* uniprocessors.                                       */
 822     size_t i, len = 0;
 823
 824     f = open("/proc/stat", O_RDONLY);
 825     if (f < 0 || (len = STAT_READ(f, stat_buf, STAT_BUF_SIZE)) < 100) {
 826         WARN("Couldn't read /proc/stat\n", 0);
 827         return -1;
 828     }
 829     for (i = 0; i < len - 100; ++i) {
 830         if (stat_buf[i] == '\n' && stat_buf[i+1] == 'c'
 831             && stat_buf[i+2] == 'p' && stat_buf[i+3] == 'u') {
 832             int cpu_no = atoi(stat_buf + i + 4);
 833             if (cpu_no >= result) result = cpu_no + 1;
 834         }
 835     }
 836     close(f);
 837     return result;
 838 }
 839 #endif /* GC_LINUX_THREADS */
 840
 841 /* We hold the GC lock.  Wait until an in-progress GC has finished.     */
 842 /* Repeatedly RELEASES GC LOCK in order to wait.                        */
 843 /* If wait_for_all is true, then we exit with the GC lock held and no   */
 844 /* collection in progress; otherwise we just wait for the current GC    */
 845 /* to finish.                                                           */
 846 extern GC_bool GC_collection_in_progress();
 847 void GC_wait_for_gc_completion(GC_bool wait_for_all)
 848 {
 849     if (GC_incremental && GC_collection_in_progress()) {
 850         int old_gc_no = GC_gc_no;
 851
 852         /* Make sure that no part of our stack is still on the mark stack, */
 853         /* since it's about to be unmapped.                                */
 854         while (GC_incremental && GC_collection_in_progress()
 855                && (wait_for_all || old_gc_no == GC_gc_no)) {
 856             ENTER_GC();
 857             GC_in_thread_creation = TRUE;
 858             GC_collect_a_little_inner(1);
 859             GC_in_thread_creation = FALSE;
 860             EXIT_GC();
 861             UNLOCK();
 862             sched_yield();
 863             LOCK();
 864         }
 865     }
 866 }
 867
 868 #ifdef HANDLE_FORK
 869 /* Procedures called before and after a fork.  The goal here is to make */
 870 /* it safe to call GC_malloc() in a forked child.  It's unclear that is */
 871 /* attainable, since the single UNIX spec seems to imply that one       */
 872 /* should only call async-signal-safe functions, and we probably can't  */
 873 /* quite guarantee that.  But we give it our best shot.  (That same     */
 874 /* spec also implies that it's not safe to call the system malloc       */
 875 /* between fork() and exec().  Thus we're doing no worse than it.       */
 876
 877 /* Called before a fork()               */
 878 void GC_fork_prepare_proc(void)
 879 {
 880     /* Acquire all relevant locks, so that after releasing the locks    */
 881     /* the child will see a consistent state in which monitor           */
 882     /* invariants hold.  Unfortunately, we can't acquire libc locks     */
 883     /* we might need, and there seems to be no guarantee that libc      */
 884     /* must install a suitable fork handler.                            */
 885     /* Wait for an ongoing GC to finish, since we can't finish it in    */
 886     /* the (one remaining thread in) the child.                         */
 887       LOCK();
 888 #     if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
 889         GC_wait_for_reclaim();
 890 #     endif
 891       GC_wait_for_gc_completion(TRUE);
 892 #     if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
 893         GC_acquire_mark_lock();
 894 #     endif
 895 }
 896
 897 /* Called in parent after a fork()      */
 898 void GC_fork_parent_proc(void)
 899 {
 900 #   if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
 901       GC_release_mark_lock();
 902 #   endif
 903     UNLOCK();
 904 }
 905
 906 /* Called in child after a fork()       */
 907 void GC_fork_child_proc(void)
 908 {
 909     /* Clean up the thread table, so that just our thread is left. */
 910 #   if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
 911       GC_release_mark_lock();
 912 #   endif
 913     GC_remove_all_threads_but_me();
 914 #   ifdef PARALLEL_MARK
 915       /* Turn off parallel marking in the child, since we are probably  */
 916       /* just going to exec, and we would have to restart mark threads. */
 917         GC_markers = 1;
 918         GC_parallel = FALSE;
 919 #   endif /* PARALLEL_MARK */
 920     UNLOCK();
 921 }
 922 #endif /* HANDLE_FORK */
 923
 924 #if defined(GC_DGUX386_THREADS)
 925 /* Return the number of processors, or i<= 0 if it can't be determined. */
 926 int GC_get_nprocs()
 927 {
 928     /* <takis@XFree86.Org> */
 929     int numCpus;
 930     struct dg_sys_info_pm_info pm_sysinfo;
 931     int status =0;
 932
 933     status = dg_sys_info((long int *) &pm_sysinfo,
 934         DG_SYS_INFO_PM_INFO_TYPE, DG_SYS_INFO_PM_CURRENT_VERSION);
 935     if (status < 0)
 936        /* set -1 for error */
 937        numCpus = -1;
 938     else
 939       /* Active CPUs */
 940       numCpus = pm_sysinfo.idle_vp_count;
 941
 942 #  ifdef DEBUG_THREADS
 943     GC_printf1("Number of active CPUs in this system: %d\n", numCpus);
 944 #  endif
 945     return(numCpus);
 946 }
 947 #endif /* GC_DGUX386_THREADS */
 948
 949 /* We hold the allocation lock. */
 950 void GC_thr_init()
 951 {
 952 #   ifndef GC_DARWIN_THREADS
 953       int dummy;
 954 #   endif
 955     GC_thread t;
 956
 957     if (GC_thr_initialized) return;
 958     GC_thr_initialized = TRUE;
 959
 960 #   ifdef HANDLE_FORK
 961       /* Prepare for a possible fork.   */
 962         pthread_atfork(GC_fork_prepare_proc, GC_fork_parent_proc,
 963                        GC_fork_child_proc);
 964 #   endif /* HANDLE_FORK */
 965     /* Add the initial thread, so we can stop it.       */
 966       t = GC_new_thread(pthread_self());
 967 #     ifdef GC_DARWIN_THREADS
 968          t -> stop_info.mach_thread = mach_thread_self();
 969 #     else
 970          t -> stop_info.stack_ptr = (ptr_t)(&dummy);
 971 #     endif
 972       t -> flags = DETACHED | MAIN_THREAD;
 973       if (gc_thread_vtable && gc_thread_vtable->thread_created)
 974         gc_thread_vtable->thread_created (pthread_self (), &t->stop_info.stack_ptr);
 975
 976     GC_stop_init();
 977
 978     /* Set GC_nprocs.  */
 979       {
 980         char * nprocs_string = GETENV("GC_NPROCS");
 981         GC_nprocs = -1;
 982         if (nprocs_string != NULL) GC_nprocs = atoi(nprocs_string);
 983       }
 984       if (GC_nprocs <= 0) {
 985 #       if defined(GC_HPUX_THREADS)
 986           GC_nprocs = pthread_num_processors_np();
 987 #       endif
 988 #       if defined(GC_OSF1_THREADS) || defined(GC_AIX_THREADS)
 989           GC_nprocs = sysconf(_SC_NPROCESSORS_ONLN);
 990           if (GC_nprocs <= 0) GC_nprocs = 1;
 991 #       endif
 992 #       if defined(GC_IRIX_THREADS)
 993           GC_nprocs = sysconf(_SC_NPROC_ONLN);
 994           if (GC_nprocs <= 0) GC_nprocs = 1;
 995 #       endif
 996 #       if defined(GC_DARWIN_THREADS) || defined(GC_FREEBSD_THREADS)
 997           int ncpus = 1;
 998           size_t len = sizeof(ncpus);
 999           sysctl((int[2]) {CTL_HW, HW_NCPU}, 2, &ncpus, &len, NULL, 0);
1000           GC_nprocs = ncpus;
1001 #       endif
1002 #       if defined(GC_LINUX_THREADS) || defined(GC_DGUX386_THREADS)
1003           GC_nprocs = GC_get_nprocs();
1004 #       endif
1005       }
1006       if (GC_nprocs <= 0) {
1007         WARN("GC_get_nprocs() returned %ld\n", GC_nprocs);
1008         GC_nprocs = 2;
1009 #       ifdef PARALLEL_MARK
1010           GC_markers = 1;
1011 #       endif
1012       } else {
1013 #       ifdef PARALLEL_MARK
1014           {
1015             char * markers_string = GETENV("GC_MARKERS");
1016             if (markers_string != NULL) {
1017               GC_markers = atoi(markers_string);
1018             } else {
1019               GC_markers = GC_nprocs;
1020             }
1021           }
1022 #       endif
1023       }
1024 #   ifdef PARALLEL_MARK
1025 #     ifdef CONDPRINT
1026         if (GC_print_stats) {
1027           GC_printf2("Number of processors = %ld, "
1028                  "number of marker threads = %ld\n", GC_nprocs, GC_markers);
1029         }
1030 #     endif
1031       if (GC_markers == 1) {
1032         GC_parallel = FALSE;
1033 #       ifdef CONDPRINT
1034           if (GC_print_stats) {
1035             GC_printf0("Single marker thread, turning off parallel marking\n");
1036           }
1037 #       endif
1038       } else {
1039         GC_parallel = TRUE;
1040         /* Disable true incremental collection, but generational is OK. */
1041         GC_time_limit = GC_TIME_UNLIMITED;
1042       }
1043       /* If we are using a parallel marker, actually start helper threads.  */
1044         if (GC_parallel) start_mark_threads();
1045 #   endif
1046 }
1047
1048
1049 /* Perform all initializations, including those that    */
1050 /* may require allocation.                              */
1051 /* Called without allocation lock.                      */
1052 /* Must be called before a second thread is created.    */
1053 /* Called without allocation lock.                      */
1054 void GC_init_parallel()
1055 {
1056     if (parallel_initialized) return;
1057     parallel_initialized = TRUE;
1058
1059     /* GC_init() calls us back, so set flag first.      */
1060     if (!GC_is_initialized) GC_init();
1061     /* Initialize thread local free lists if used.      */
1062 #   if defined(THREAD_LOCAL_ALLOC) && !defined(DBG_HDRS_ALL)
1063       LOCK();
1064       GC_init_thread_local(GC_lookup_thread(pthread_self()));
1065       UNLOCK();
1066 #   endif
1067 }
1068
1069
1070 #if !defined(GC_DARWIN_THREADS)
1071 int WRAP_FUNC(pthread_sigmask)(int how, const sigset_t *set, sigset_t *oset)
1072 {
1073     sigset_t fudged_set;
1074
1075     if (set != NULL && (how == SIG_BLOCK || how == SIG_SETMASK)) {
1076         fudged_set = *set;
1077         sigdelset(&fudged_set, SIG_SUSPEND);
1078         set = &fudged_set;
1079     }
1080     return(REAL_FUNC(pthread_sigmask)(how, set, oset));
1081 }
1082 #endif /* !GC_DARWIN_THREADS */
1083
1084 /* Wrappers for functions that are likely to block for an appreciable   */
1085 /* length of time.  Must be called in pairs, if at all.                 */
1086 /* Nothing much beyond the system call itself should be executed        */
1087 /* between these.                                                       */
1088
1089 void GC_start_blocking(void) {
1090 #   define SP_SLOP 128
1091     GC_thread me;
1092     LOCK();
1093     me = GC_lookup_thread(pthread_self());
1094     GC_ASSERT(!(me -> thread_blocked));
1095 #   ifdef SPARC
1096         me -> stop_info.stack_ptr = (ptr_t)GC_save_regs_in_stack();
1097 #   else
1098 #   ifndef GC_DARWIN_THREADS
1099         me -> stop_info.stack_ptr = (ptr_t)GC_approx_sp();
1100 #   endif
1101 #   endif
1102 #   ifdef IA64
1103         me -> backing_store_ptr = (ptr_t)GC_save_regs_in_stack() + SP_SLOP;
1104 #   endif
1105     /* Add some slop to the stack pointer, since the wrapped call may   */
1106     /* end up pushing more callee-save registers.                       */
1107 #   ifndef GC_DARWIN_THREADS
1108 #   ifdef STACK_GROWS_UP
1109         me -> stop_info.stack_ptr += SP_SLOP;
1110 #   else
1111         me -> stop_info.stack_ptr -= SP_SLOP;
1112 #   endif
1113 #   endif
1114     me -> thread_blocked = TRUE;
1115     UNLOCK();
1116 }
1117
1118 void GC_end_blocking(void) {
1119     GC_thread me;
1120     LOCK();   /* This will block if the world is stopped.       */
1121     me = GC_lookup_thread(pthread_self());
1122     GC_ASSERT(me -> thread_blocked);
1123     me -> thread_blocked = FALSE;
1124     UNLOCK();
1125 }
1126
1127 #if defined(GC_DGUX386_THREADS)
1128 #define __d10_sleep sleep
1129 #endif /* GC_DGUX386_THREADS */
1130
1131 /* A wrapper for the standard C sleep function  */
1132 int WRAP_FUNC(sleep) (unsigned int seconds)
1133 {
1134     int result;
1135
1136     GC_start_blocking();
1137     result = REAL_FUNC(sleep)(seconds);
1138     GC_end_blocking();
1139     return result;
1140 }
1141
1142 struct start_info {
1143     void *(*start_routine)(void *);
1144     void *arg;
1145     word flags;
1146     sem_t registered;           /* 1 ==> in our thread table, but       */
1147                                 /* parent hasn't yet noticed.           */
1148 };
1149
1150 /* Called at thread exit.                               */
1151 /* Never called for main thread.  That's OK, since it   */
1152 /* results in at most a tiny one-time leak.  And        */
1153 /* linuxthreads doesn't reclaim the main threads        */
1154 /* resources or id anyway.                              */
1155 void GC_thread_exit_proc(void *arg)
1156 {
1157     GC_thread me;
1158
1159     LOCK();
1160     me = GC_lookup_thread(pthread_self());
1161     GC_destroy_thread_local(me);
1162     if (me -> flags & DETACHED) {
1163         GC_delete_thread(pthread_self());
1164     } else {
1165         me -> flags |= FINISHED;
1166     }
1167 #   if defined(THREAD_LOCAL_ALLOC) && !defined(USE_PTHREAD_SPECIFIC) \
1168        && !defined(USE_COMPILER_TLS) && !defined(DBG_HDRS_ALL)
1169       GC_remove_specific(GC_thread_key);
1170 #   endif
1171     /* The following may run the GC from "nonexistent" thread.  */
1172     GC_wait_for_gc_completion(FALSE);
1173     UNLOCK();
1174 }
1175
1176 int WRAP_FUNC(pthread_join)(pthread_t thread, void **retval)
1177 {
1178     int result;
1179     GC_thread thread_gc_id;
1180
1181     LOCK();
1182     thread_gc_id = GC_lookup_thread(thread);
1183     /* This is guaranteed to be the intended one, since the thread id   */
1184     /* cant have been recycled by pthreads.                             */
1185     UNLOCK();
1186     result = REAL_FUNC(pthread_join)(thread, retval);
1187 # if defined (GC_FREEBSD_THREADS)
1188     /* On FreeBSD, the wrapped pthread_join() sometimes returns (what
1189        appears to be) a spurious EINTR which caused the test and real code
1190        to gratuitously fail.  Having looked at system pthread library source
1191        code, I see how this return code may be generated.  In one path of
1192        code, pthread_join() just returns the errno setting of the thread
1193        being joined.  This does not match the POSIX specification or the
1194        local man pages thus I have taken the liberty to catch this one
1195        spurious return value properly conditionalized on GC_FREEBSD_THREADS. */
1196     if (result == EINTR) result = 0;
1197 # endif
1198     if (result == 0) {
1199         LOCK();
1200         /* Here the pthread thread id may have been recycled. */
1201         GC_delete_gc_thread(thread, thread_gc_id);
1202         UNLOCK();
1203     }
1204     return result;
1205 }
1206
1207 int
1208 WRAP_FUNC(pthread_detach)(pthread_t thread)
1209 {
1210     int result;
1211     GC_thread thread_gc_id;
1212
1213     LOCK();
1214     thread_gc_id = GC_lookup_thread(thread);
1215     UNLOCK();
1216     result = REAL_FUNC(pthread_detach)(thread);
1217     if (result == 0) {
1218       LOCK();
1219       thread_gc_id -> flags |= DETACHED;
1220       /* Here the pthread thread id may have been recycled. */
1221       if (thread_gc_id -> flags & FINISHED) {
1222         GC_delete_gc_thread(thread, thread_gc_id);
1223       }
1224       UNLOCK();
1225     }
1226     return result;
1227 }
1228
1229 GC_bool GC_in_thread_creation = FALSE;
1230
1231 typedef void *(*ThreadStartFn)(void *);
1232 void * GC_start_routine_head(void * arg, void *base_addr,
1233                              ThreadStartFn *start, void **start_arg )
1234 {
1235     struct start_info * si = arg;
1236     void * result;
1237     GC_thread me;
1238     pthread_t my_pthread;
1239
1240     my_pthread = pthread_self();
1241 #   ifdef DEBUG_THREADS
1242         GC_printf1("Starting thread 0x%lx\n", my_pthread);
1243         GC_printf1("pid = %ld\n", (long) getpid());
1244         GC_printf1("sp = 0x%lx\n", (long) &arg);
1245 #   endif
1246     LOCK();
1247     GC_in_thread_creation = TRUE;
1248     me = GC_new_thread(my_pthread);
1249     GC_in_thread_creation = FALSE;
1250 #ifdef GC_DARWIN_THREADS
1251     me -> stop_info.mach_thread = mach_thread_self();
1252 #else
1253     me -> stop_info.stack_ptr = 0;
1254 #endif
1255     me -> flags = si -> flags;
1256     /* me -> stack_end = GC_linux_stack_base(); -- currently (11/99)    */
1257     /* doesn't work because the stack base in /proc/self/stat is the    */
1258     /* one for the main thread.  There is a strong argument that that's */
1259     /* a kernel bug, but a pervasive one.                               */
1260 #   ifdef STACK_GROWS_DOWN
1261       me -> stack_end = (ptr_t)(((word)(base_addr) + (GC_page_size - 1))
1262                                 & ~(GC_page_size - 1));
1263 #         ifndef GC_DARWIN_THREADS
1264         me -> stop_info.stack_ptr = me -> stack_end - 0x10;
1265 #         endif
1266         /* Needs to be plausible, since an asynchronous stack mark      */
1267         /* should not crash.                                            */
1268 #   else
1269       me -> stack_end = (ptr_t)((word)(base_addr) & ~(GC_page_size - 1));
1270       me -> stop_info.stack_ptr = me -> stack_end + 0x10;
1271 #   endif
1272     /* This is dubious, since we may be more than a page into the stack, */
1273     /* and hence skip some of it, though it's not clear that matters.    */
1274 #   ifdef IA64
1275       me -> backing_store_end = (ptr_t)
1276                         (GC_save_regs_in_stack() & ~(GC_page_size - 1));
1277       /* This is also < 100% convincing.  We should also read this      */
1278       /* from /proc, but the hook to do so isn't there yet.             */
1279 #   endif /* IA64 */
1280     if (gc_thread_vtable && gc_thread_vtable->thread_created)
1281         gc_thread_vtable->thread_created (my_pthread, &me->stop_info.stack_ptr);
1282     UNLOCK();
1283
1284     if (start) *start = si -> start_routine;
1285     if (start_arg) *start_arg = si -> arg;
1286
1287     sem_post(&(si -> registered));      /* Last action on si.   */
1288                                         /* OK to deallocate.    */
1289 #   if defined(THREAD_LOCAL_ALLOC) && !defined(DBG_HDRS_ALL)
1290         LOCK();
1291         GC_init_thread_local(me);
1292         UNLOCK();
1293 #   endif
1294
1295     return me;
1296 }
1297
1298 int GC_thread_register_foreign (void *base_addr)
1299 {
1300     struct start_info si = { 0, }; /* stacked for legibility & locking */
1301     GC_thread me;
1302
1303 #   ifdef DEBUG_THREADS
1304         GC_printf1( "GC_thread_register_foreign %p\n", &si );
1305 #   endif
1306
1307     si.flags = FOREIGN_THREAD;
1308
1309     if (!parallel_initialized) GC_init_parallel();
1310     LOCK();
1311     if (!GC_thr_initialized) GC_thr_init();
1312
1313     UNLOCK();
1314
1315     me = GC_start_routine_head(&si, base_addr, NULL, NULL);
1316
1317     return me != NULL;
1318 }
1319
1320 void * GC_start_routine(void * arg)
1321 {
1322     int dummy;
1323     struct start_info * si = arg;
1324     void * result;
1325     GC_thread me;
1326     ThreadStartFn start;
1327     void *start_arg;
1328
1329     me = GC_start_routine_head (arg, &dummy, &start, &start_arg);
1330
1331     pthread_cleanup_push(GC_thread_exit_proc, 0);
1332 #   ifdef DEBUG_THREADS
1333         GC_printf1("start_routine = 0x%lx\n", start);
1334 #   endif
1335     result = (*start)(start_arg);
1336 #if DEBUG_THREADS
1337         GC_printf1("Finishing thread 0x%x\n", pthread_self());
1338 #endif
1339     me -> status = result;
1340     pthread_cleanup_pop(1);
1341     /* Cleanup acquires lock, ensuring that we can't exit               */
1342     /* while a collection that thinks we're alive is trying to stop     */
1343     /* us.                                                              */
1344     return(result);
1345 }
1346
1347 int
1348 WRAP_FUNC(pthread_create)(pthread_t *new_thread,
1349                   const pthread_attr_t *attr,
1350                   void *(*start_routine)(void *), void *arg)
1351 {
1352     int result;
1353     int detachstate;
1354     word my_flags = 0;
1355     struct start_info * si;
1356         /* This is otherwise saved only in an area mmapped by the thread */
1357         /* library, which isn't visible to the collector.                */
1358
1359     /* We resist the temptation to muck with the stack size here,       */
1360     /* even if the default is unreasonably small.  That's the client's  */
1361     /* responsibility.                                                  */
1362
1363     LOCK();
1364     si = calloc (1, sizeof (struct start_info));
1365     UNLOCK();
1366     if (!parallel_initialized) GC_init_parallel();
1367     if (0 == si) return(ENOMEM);
1368     sem_init(&(si -> registered), 0, 0);
1369     si -> start_routine = start_routine;
1370     si -> arg = arg;
1371     LOCK();
1372     if (!GC_thr_initialized) GC_thr_init();
1373 #   ifdef GC_ASSERTIONS
1374       {
1375         size_t stack_size;
1376         if (NULL == attr) {
1377            pthread_attr_t my_attr;
1378            pthread_attr_init(&my_attr);
1379            pthread_attr_getstacksize(&my_attr, &stack_size);
1380         } else {
1381            pthread_attr_getstacksize(attr, &stack_size);
1382         }
1383 #       ifdef PARALLEL_MARK
1384           GC_ASSERT(stack_size >= (8*HBLKSIZE*sizeof(word)));
1385 #       else
1386           /* FreeBSD-5.3/Alpha: default pthread stack is 64K,   */
1387           /* HBLKSIZE=8192, sizeof(word)=8                      */
1388           GC_ASSERT(stack_size >= 65536);
1389 #       endif
1390         /* Our threads may need to do some work for the GC.     */
1391         /* Ridiculously small threads won't work, and they      */
1392         /* probably wouldn't work anyway.                       */
1393       }
1394 #   endif
1395     if (NULL == attr) {
1396         detachstate = PTHREAD_CREATE_JOINABLE;
1397     } else {
1398         pthread_attr_getdetachstate(attr, &detachstate);
1399     }
1400     if (PTHREAD_CREATE_DETACHED == detachstate) my_flags |= DETACHED;
1401     si -> flags = my_flags;
1402     UNLOCK();
1403 #   ifdef DEBUG_THREADS
1404         GC_printf1("About to start new thread from thread 0x%X\n",
1405                    pthread_self());
1406 #   endif
1407
1408     result = REAL_FUNC(pthread_create)(new_thread, attr, GC_start_routine, si);
1409
1410 #   ifdef DEBUG_THREADS
1411         GC_printf1("Started thread 0x%X\n", *new_thread);
1412 #   endif
1413     /* Wait until child has been added to the thread table.             */
1414     /* This also ensures that we hold onto si until the child is done   */
1415     /* with it.  Thus it doesn't matter whether it is otherwise         */
1416     /* visible to the collector.                                        */
1417     if (0 == result) {
1418         while (0 != sem_wait(&(si -> registered))) {
1419             if (EINTR != errno) ABORT("sem_wait failed");
1420         }
1421     }
1422     sem_destroy(&(si -> registered));
1423     LOCK();
1424     free(si);
1425     UNLOCK();
1426
1427     return(result);
1428 }
1429
1430 #ifdef GENERIC_COMPARE_AND_SWAP
1431   pthread_mutex_t GC_compare_and_swap_lock = PTHREAD_MUTEX_INITIALIZER;
1432
1433   GC_bool GC_compare_and_exchange(volatile GC_word *addr,
1434                                   GC_word old, GC_word new_val)
1435   {
1436     GC_bool result;
1437     pthread_mutex_lock(&GC_compare_and_swap_lock);
1438     if (*addr == old) {
1439       *addr = new_val;
1440       result = TRUE;
1441     } else {
1442       result = FALSE;
1443     }
1444     pthread_mutex_unlock(&GC_compare_and_swap_lock);
1445     return result;
1446   }
1447
1448   GC_word GC_atomic_add(volatile GC_word *addr, GC_word how_much)
1449   {
1450     GC_word old;
1451     pthread_mutex_lock(&GC_compare_and_swap_lock);
1452     old = *addr;
1453     *addr = old + how_much;
1454     pthread_mutex_unlock(&GC_compare_and_swap_lock);
1455     return old;
1456   }
1457
1458 #endif /* GENERIC_COMPARE_AND_SWAP */
1459 /* Spend a few cycles in a way that can't introduce contention with     */
1460 /* othre threads.                                                       */
1461 void GC_pause()
1462 {
1463     int i;
1464 #   if !defined(__GNUC__) || defined(__INTEL_COMPILER)
1465       volatile word dummy = 0;
1466 #   endif
1467
1468     for (i = 0; i < 10; ++i) {
1469 #     if defined(__GNUC__) && !defined(__INTEL_COMPILER)
1470         __asm__ __volatile__ (" " : : : "memory");
1471 #     else
1472         /* Something that's unlikely to be optimized away. */
1473         GC_noop(++dummy);
1474 #     endif
1475     }
1476 }
1477
1478 #define SPIN_MAX 128    /* Maximum number of calls to GC_pause before   */
1479                         /* give up.                                     */
1480
1481 VOLATILE GC_bool GC_collecting = 0;
1482                         /* A hint that we're in the collector and       */
1483                         /* holding the allocation lock for an           */
1484                         /* extended period.                             */
1485
1486 #if !defined(USE_SPIN_LOCK) || defined(PARALLEL_MARK)
1487 /* If we don't want to use the below spinlock implementation, either    */
1488 /* because we don't have a GC_test_and_set implementation, or because   */
1489 /* we don't want to risk sleeping, we can still try spinning on         */
1490 /* pthread_mutex_trylock for a while.  This appears to be very          */
1491 /* beneficial in many cases.                                            */
1492 /* I suspect that under high contention this is nearly always better    */
1493 /* than the spin lock.  But it's a bit slower on a uniprocessor.        */
1494 /* Hence we still default to the spin lock.                             */
1495 /* This is also used to acquire the mark lock for the parallel          */
1496 /* marker.                                                              */
1497
1498 /* Here we use a strict exponential backoff scheme.  I don't know       */
1499 /* whether that's better or worse than the above.  We eventually        */
1500 /* yield by calling pthread_mutex_lock(); it never makes sense to       */
1501 /* explicitly sleep.                                                    */
1502
1503 #define LOCK_STATS
1504 #ifdef LOCK_STATS
1505   unsigned long GC_spin_count = 0;
1506   unsigned long GC_block_count = 0;
1507   unsigned long GC_unlocked_count = 0;
1508 #endif
1509
1510 void GC_generic_lock(pthread_mutex_t * lock)
1511 {
1512 #ifndef NO_PTHREAD_TRYLOCK
1513     unsigned pause_length = 1;
1514     unsigned i;
1515
1516     if (0 == pthread_mutex_trylock(lock)) {
1517 #       ifdef LOCK_STATS
1518             ++GC_unlocked_count;
1519 #       endif
1520         return;
1521     }
1522     for (; pause_length <= SPIN_MAX; pause_length <<= 1) {
1523         for (i = 0; i < pause_length; ++i) {
1524             GC_pause();
1525         }
1526         switch(pthread_mutex_trylock(lock)) {
1527             case 0:
1528 #               ifdef LOCK_STATS
1529                     ++GC_spin_count;
1530 #               endif
1531                 return;
1532             case EBUSY:
1533                 break;
1534             default:
1535                 ABORT("Unexpected error from pthread_mutex_trylock");
1536         }
1537     }
1538 #endif /* !NO_PTHREAD_TRYLOCK */
1539 #   ifdef LOCK_STATS
1540         ++GC_block_count;
1541 #   endif
1542     pthread_mutex_lock(lock);
1543 }
1544
1545 #endif /* !USE_SPIN_LOCK || PARALLEL_MARK */
1546
1547 #if defined(USE_SPIN_LOCK)
1548
1549 /* Reasonably fast spin locks.  Basically the same implementation */
1550 /* as STL alloc.h.  This isn't really the right way to do this.   */
1551 /* but until the POSIX scheduling mess gets straightened out ...  */
1552
1553 volatile unsigned int GC_allocate_lock = 0;
1554
1555
1556 void GC_lock()
1557 {
1558 #   define low_spin_max 30  /* spin cycles if we suspect uniprocessor */
1559 #   define high_spin_max SPIN_MAX /* spin cycles for multiprocessor */
1560     static unsigned spin_max = low_spin_max;
1561     unsigned my_spin_max;
1562     static unsigned last_spins = 0;
1563     unsigned my_last_spins;
1564     int i;
1565
1566     if (!GC_test_and_set(&GC_allocate_lock)) {
1567         return;
1568     }
1569     my_spin_max = spin_max;
1570     my_last_spins = last_spins;
1571     for (i = 0; i < my_spin_max; i++) {
1572         if (GC_collecting || GC_nprocs == 1) goto yield;
1573         if (i < my_last_spins/2 || GC_allocate_lock) {
1574             GC_pause();
1575             continue;
1576         }
1577         if (!GC_test_and_set(&GC_allocate_lock)) {
1578             /*
1579              * got it!
1580              * Spinning worked.  Thus we're probably not being scheduled
1581              * against the other process with which we were contending.
1582              * Thus it makes sense to spin longer the next time.
1583              */
1584             last_spins = i;
1585             spin_max = high_spin_max;
1586             return;
1587         }
1588     }
1589     /* We are probably being scheduled against the other process.  Sleep. */
1590     spin_max = low_spin_max;
1591 yield:
1592     for (i = 0;; ++i) {
1593         if (!GC_test_and_set(&GC_allocate_lock)) {
1594             return;
1595         }
1596 #       define SLEEP_THRESHOLD 12
1597                 /* Under Linux very short sleeps tend to wait until     */
1598                 /* the current time quantum expires.  On old Linux      */
1599                 /* kernels nanosleep(<= 2ms) just spins under Linux.    */
1600                 /* (Under 2.4, this happens only for real-time          */
1601                 /* processes.)  We want to minimize both behaviors      */
1602                 /* here.                                                */
1603         if (i < SLEEP_THRESHOLD) {
1604             sched_yield();
1605         } else {
1606             struct timespec ts;
1607
1608             if (i > 24) i = 24;
1609                         /* Don't wait for more than about 15msecs, even */
1610                         /* under extreme contention.                    */
1611             ts.tv_sec = 0;
1612             ts.tv_nsec = 1 << i;
1613             nanosleep(&ts, 0);
1614         }
1615     }
1616 }
1617
1618 #else  /* !USE_SPINLOCK */
1619 void GC_lock()
1620 {
1621 #ifndef NO_PTHREAD_TRYLOCK
1622     if (1 == GC_nprocs || GC_collecting) {
1623         pthread_mutex_lock(&GC_allocate_ml);
1624     } else {
1625         GC_generic_lock(&GC_allocate_ml);
1626     }
1627 #else  /* !NO_PTHREAD_TRYLOCK */
1628     pthread_mutex_lock(&GC_allocate_ml);
1629 #endif /* !NO_PTHREAD_TRYLOCK */
1630 }
1631
1632 #endif /* !USE_SPINLOCK */
1633
1634 #if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
1635
1636 #ifdef GC_ASSERTIONS
1637   pthread_t GC_mark_lock_holder = NO_THREAD;
1638 #endif
1639
1640 #if 0
1641   /* Ugly workaround for a linux threads bug in the final versions      */
1642   /* of glibc2.1.  Pthread_mutex_trylock sets the mutex owner           */
1643   /* field even when it fails to acquire the mutex.  This causes        */
1644   /* pthread_cond_wait to die.  Remove for glibc2.2.                    */
1645   /* According to the man page, we should use                           */
1646   /* PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP, but that isn't actually   */
1647   /* defined.                                                           */
1648   static pthread_mutex_t mark_mutex =
1649         {0, 0, 0, PTHREAD_MUTEX_ERRORCHECK_NP, {0, 0}};
1650 #else
1651   static pthread_mutex_t mark_mutex = PTHREAD_MUTEX_INITIALIZER;
1652 #endif
1653
1654 static pthread_cond_t builder_cv = PTHREAD_COND_INITIALIZER;
1655
1656 void GC_acquire_mark_lock()
1657 {
1658 /*
1659     if (pthread_mutex_lock(&mark_mutex) != 0) {
1660         ABORT("pthread_mutex_lock failed");
1661     }
1662 */
1663     GC_generic_lock(&mark_mutex);
1664 #   ifdef GC_ASSERTIONS
1665         GC_mark_lock_holder = pthread_self();
1666 #   endif
1667 }
1668
1669 void GC_release_mark_lock()
1670 {
1671     GC_ASSERT(GC_mark_lock_holder == pthread_self());
1672 #   ifdef GC_ASSERTIONS
1673         GC_mark_lock_holder = NO_THREAD;
1674 #   endif
1675     if (pthread_mutex_unlock(&mark_mutex) != 0) {
1676         ABORT("pthread_mutex_unlock failed");
1677     }
1678 }
1679
1680 /* Collector must wait for a freelist builders for 2 reasons:           */
1681 /* 1) Mark bits may still be getting examined without lock.             */
1682 /* 2) Partial free lists referenced only by locals may not be scanned   */
1683 /*    correctly, e.g. if they contain "pointer-free" objects, since the */
1684 /*    free-list link may be ignored.                                    */
1685 void GC_wait_builder()
1686 {
1687     GC_ASSERT(GC_mark_lock_holder == pthread_self());
1688 #   ifdef GC_ASSERTIONS
1689         GC_mark_lock_holder = NO_THREAD;
1690 #   endif
1691     if (pthread_cond_wait(&builder_cv, &mark_mutex) != 0) {
1692         ABORT("pthread_cond_wait failed");
1693     }
1694     GC_ASSERT(GC_mark_lock_holder == NO_THREAD);
1695 #   ifdef GC_ASSERTIONS
1696         GC_mark_lock_holder = pthread_self();
1697 #   endif
1698 }
1699
1700 void GC_wait_for_reclaim()
1701 {
1702     GC_acquire_mark_lock();
1703     while (GC_fl_builder_count > 0) {
1704         GC_wait_builder();
1705     }
1706     GC_release_mark_lock();
1707 }
1708
1709 void GC_notify_all_builder()
1710 {
1711     GC_ASSERT(GC_mark_lock_holder == pthread_self());
1712     if (pthread_cond_broadcast(&builder_cv) != 0) {
1713         ABORT("pthread_cond_broadcast failed");
1714     }
1715 }
1716
1717 #endif /* PARALLEL_MARK || THREAD_LOCAL_ALLOC */
1718
1719 #ifdef PARALLEL_MARK
1720
1721 static pthread_cond_t mark_cv = PTHREAD_COND_INITIALIZER;
1722
1723 void GC_wait_marker()
1724 {
1725     GC_ASSERT(GC_mark_lock_holder == pthread_self());
1726 #   ifdef GC_ASSERTIONS
1727         GC_mark_lock_holder = NO_THREAD;
1728 #   endif
1729     if (pthread_cond_wait(&mark_cv, &mark_mutex) != 0) {
1730         ABORT("pthread_cond_wait failed");
1731     }
1732     GC_ASSERT(GC_mark_lock_holder == NO_THREAD);
1733 #   ifdef GC_ASSERTIONS
1734         GC_mark_lock_holder = pthread_self();
1735 #   endif
1736 }
1737
1738 void GC_notify_all_marker()
1739 {
1740     if (pthread_cond_broadcast(&mark_cv) != 0) {
1741         ABORT("pthread_cond_broadcast failed");
1742     }
1743 }
1744
1745 #endif /* PARALLEL_MARK */
1746
1747 # endif /* GC_LINUX_THREADS and friends */
1748