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