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