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 void GC_push_thread_structures GC_PROTO((void))
 560 {
 561     GC_push_all((ptr_t)(GC_threads), (ptr_t)(GC_threads)+sizeof(GC_threads));
 562 #   if defined(THREAD_LOCAL_ALLOC) && !defined(DBG_HDRS_ALL)
 563       GC_push_all((ptr_t)(&GC_thread_key),
 564           (ptr_t)(&GC_thread_key)+sizeof(&GC_thread_key));
 565 #   endif
 566 }
 567
 568 #ifdef THREAD_LOCAL_ALLOC
 569 /* We must explicitly mark ptrfree and gcj free lists, since the free   */
 570 /* list links wouldn't otherwise be found.  We also set them in the     */
 571 /* normal free lists, since that involves touching less memory than if  */
 572 /* we scanned them normally.                                            */
 573 void GC_mark_thread_local_free_lists(void)
 574 {
 575     int i, j;
 576     GC_thread p;
 577     ptr_t q;
 578
 579     for (i = 0; i < THREAD_TABLE_SZ; ++i) {
 580       for (p = GC_threads[i]; 0 != p; p = p -> next) {
 581         for (j = 1; j < NFREELISTS; ++j) {
 582           q = p -> ptrfree_freelists[j];
 583           if ((word)q > HBLKSIZE) GC_set_fl_marks(q);
 584           q = p -> normal_freelists[j];
 585           if ((word)q > HBLKSIZE) GC_set_fl_marks(q);
 586 #         ifdef GC_GCJ_SUPPORT
 587             q = p -> gcj_freelists[j];
 588             if ((word)q > HBLKSIZE) GC_set_fl_marks(q);
 589 #         endif /* GC_GCJ_SUPPORT */
 590         }
 591       }
 592     }
 593 }
 594 #endif /* THREAD_LOCAL_ALLOC */
 595
 596 static struct GC_Thread_Rep first_thread;
 597
 598 /* Add a thread to GC_threads.  We assume it wasn't already there.      */
 599 /* Caller holds allocation lock.                                        */
 600 GC_thread GC_new_thread(pthread_t id)
 601 {
 602     int hv = ((word)id) % THREAD_TABLE_SZ;
 603     GC_thread result;
 604     static GC_bool first_thread_used = FALSE;
 605
 606     if (!first_thread_used) {
 607         result = &first_thread;
 608         first_thread_used = TRUE;
 609     } else {
 610         result = (struct GC_Thread_Rep *)
 611                  GC_INTERNAL_MALLOC(sizeof(struct GC_Thread_Rep), NORMAL);
 612     }
 613     if (result == 0) return(0);
 614     result -> id = id;
 615     result -> next = GC_threads[hv];
 616     GC_threads[hv] = result;
 617     GC_ASSERT(result -> flags == 0 && result -> thread_blocked == 0);
 618     return(result);
 619 }
 620
 621 /* Delete a thread from GC_threads.  We assume it is there.     */
 622 /* (The code intentionally traps if it wasn't.)                 */
 623 /* Caller holds allocation lock.                                */
 624 void GC_delete_thread(pthread_t id)
 625 {
 626     int hv = ((word)id) % THREAD_TABLE_SZ;
 627     register GC_thread p = GC_threads[hv];
 628     register GC_thread prev = 0;
 629
 630     while (!pthread_equal(p -> id, id)) {
 631         prev = p;
 632         p = p -> next;
 633     }
 634     if (prev == 0) {
 635         GC_threads[hv] = p -> next;
 636     } else {
 637         prev -> next = p -> next;
 638     }
 639     GC_INTERNAL_FREE(p);
 640 }
 641
 642 /* If a thread has been joined, but we have not yet             */
 643 /* been notified, then there may be more than one thread        */
 644 /* in the table with the same pthread id.                       */
 645 /* This is OK, but we need a way to delete a specific one.      */
 646 void GC_delete_gc_thread(pthread_t id, GC_thread gc_id)
 647 {
 648     int hv = ((word)id) % THREAD_TABLE_SZ;
 649     register GC_thread p = GC_threads[hv];
 650     register GC_thread prev = 0;
 651
 652     while (p != gc_id) {
 653         prev = p;
 654         p = p -> next;
 655     }
 656     if (prev == 0) {
 657         GC_threads[hv] = p -> next;
 658     } else {
 659         prev -> next = p -> next;
 660     }
 661     GC_INTERNAL_FREE(p);
 662 }
 663
 664 /* Return a GC_thread corresponding to a given pthread_t.       */
 665 /* Returns 0 if it's not there.                                 */
 666 /* Caller holds  allocation lock or otherwise inhibits          */
 667 /* updates.                                                     */
 668 /* If there is more than one thread with the given id we        */
 669 /* return the most recent one.                                  */
 670 GC_thread GC_lookup_thread(pthread_t id)
 671 {
 672     int hv = ((word)id) % THREAD_TABLE_SZ;
 673     register GC_thread p = GC_threads[hv];
 674
 675     while (p != 0 && !pthread_equal(p -> id, id)) p = p -> next;
 676     return(p);
 677 }
 678
 679 #ifdef HANDLE_FORK
 680 /* Remove all entries from the GC_threads table, except the     */
 681 /* one for the current thread.  We need to do this in the child */
 682 /* process after a fork(), since only the current thread        */
 683 /* survives in the child.                                       */
 684 void GC_remove_all_threads_but_me(void)
 685 {
 686     pthread_t self = pthread_self();
 687     int hv;
 688     GC_thread p, next, me;
 689
 690     for (hv = 0; hv < THREAD_TABLE_SZ; ++hv) {
 691       me = 0;
 692       for (p = GC_threads[hv]; 0 != p; p = next) {
 693         next = p -> next;
 694         if (p -> id == self) {
 695           me = p;
 696           p -> next = 0;
 697         } else {
 698 #         ifdef THREAD_LOCAL_ALLOC
 699             if (!(p -> flags & FINISHED)) {
 700               GC_destroy_thread_local(p);
 701             }
 702 #         endif /* THREAD_LOCAL_ALLOC */
 703           if (p != &first_thread) GC_INTERNAL_FREE(p);
 704         }
 705       }
 706       GC_threads[hv] = me;
 707     }
 708 }
 709 #endif /* HANDLE_FORK */
 710
 711 #ifdef USE_PROC_FOR_LIBRARIES
 712 int GC_segment_is_thread_stack(ptr_t lo, ptr_t hi)
 713 {
 714     int i;
 715     GC_thread p;
 716
 717 #   ifdef PARALLEL_MARK
 718       for (i = 0; i < GC_markers; ++i) {
 719         if (marker_sp[i] > lo & marker_sp[i] < hi) return 1;
 720       }
 721 #   endif
 722     for (i = 0; i < THREAD_TABLE_SZ; i++) {
 723       for (p = GC_threads[i]; p != 0; p = p -> next) {
 724         if (0 != p -> stack_end) {
 725 #         ifdef STACK_GROWS_UP
 726             if (p -> stack_end >= lo && p -> stack_end < hi) return 1;
 727 #         else /* STACK_GROWS_DOWN */
 728             if (p -> stack_end > lo && p -> stack_end <= hi) return 1;
 729 #         endif
 730         }
 731       }
 732     }
 733     return 0;
 734 }
 735 #endif /* USE_PROC_FOR_LIBRARIES */
 736
 737 #ifdef GC_LINUX_THREADS
 738 /* Return the number of processors, or i<= 0 if it can't be determined. */
 739 int GC_get_nprocs()
 740 {
 741     /* Should be "return sysconf(_SC_NPROCESSORS_ONLN);" but that       */
 742     /* appears to be buggy in many cases.                               */
 743     /* We look for lines "cpu<n>" in /proc/stat.                        */
 744 #   define STAT_BUF_SIZE 4096
 745 #   define STAT_READ read
 746         /* If read is wrapped, this may need to be redefined to call    */
 747         /* the real one.                                                */
 748     char stat_buf[STAT_BUF_SIZE];
 749     int f;
 750     word result = 1;
 751         /* Some old kernels only have a single "cpu nnnn ..."   */
 752         /* entry in /proc/stat.  We identify those as           */
 753         /* uniprocessors.                                       */
 754     size_t i, len = 0;
 755
 756     f = open("/proc/stat", O_RDONLY);
 757     if (f < 0 || (len = STAT_READ(f, stat_buf, STAT_BUF_SIZE)) < 100) {
 758         WARN("Couldn't read /proc/stat\n", 0);
 759         return -1;
 760     }
 761     for (i = 0; i < len - 100; ++i) {
 762         if (stat_buf[i] == '\n' && stat_buf[i+1] == 'c'
 763             && stat_buf[i+2] == 'p' && stat_buf[i+3] == 'u') {
 764             int cpu_no = atoi(stat_buf + i + 4);
 765             if (cpu_no >= result) result = cpu_no + 1;
 766         }
 767     }
 768     close(f);
 769     return result;
 770 }
 771 #endif /* GC_LINUX_THREADS */
 772
 773 /* We hold the GC lock.  Wait until an in-progress GC has finished.     */
 774 /* Repeatedly RELEASES GC LOCK in order to wait.                        */
 775 /* If wait_for_all is true, then we exit with the GC lock held and no   */
 776 /* collection in progress; otherwise we just wait for the current GC    */
 777 /* to finish.                                                           */
 778 extern GC_bool GC_collection_in_progress();
 779 void GC_wait_for_gc_completion(GC_bool wait_for_all)
 780 {
 781     if (GC_incremental && GC_collection_in_progress()) {
 782         int old_gc_no = GC_gc_no;
 783
 784         /* Make sure that no part of our stack is still on the mark stack, */
 785         /* since it's about to be unmapped.                                */
 786         while (GC_incremental && GC_collection_in_progress()
 787                && (wait_for_all || old_gc_no == GC_gc_no)) {
 788             ENTER_GC();
 789             GC_in_thread_creation = TRUE;
 790             GC_collect_a_little_inner(1);
 791             GC_in_thread_creation = FALSE;
 792             EXIT_GC();
 793             UNLOCK();
 794             sched_yield();
 795             LOCK();
 796         }
 797     }
 798 }
 799
 800 #ifdef HANDLE_FORK
 801 /* Procedures called before and after a fork.  The goal here is to make */
 802 /* it safe to call GC_malloc() in a forked child.  It's unclear that is */
 803 /* attainable, since the single UNIX spec seems to imply that one       */
 804 /* should only call async-signal-safe functions, and we probably can't  */
 805 /* quite guarantee that.  But we give it our best shot.  (That same     */
 806 /* spec also implies that it's not safe to call the system malloc       */
 807 /* between fork() and exec().  Thus we're doing no worse than it.       */
 808
 809 /* Called before a fork()               */
 810 void GC_fork_prepare_proc(void)
 811 {
 812     /* Acquire all relevant locks, so that after releasing the locks    */
 813     /* the child will see a consistent state in which monitor           */
 814     /* invariants hold.  Unfortunately, we can't acquire libc locks     */
 815     /* we might need, and there seems to be no guarantee that libc      */
 816     /* must install a suitable fork handler.                            */
 817     /* Wait for an ongoing GC to finish, since we can't finish it in    */
 818     /* the (one remaining thread in) the child.                         */
 819       LOCK();
 820 #     if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
 821         GC_wait_for_reclaim();
 822 #     endif
 823       GC_wait_for_gc_completion(TRUE);
 824 #     if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
 825         GC_acquire_mark_lock();
 826 #     endif
 827 }
 828
 829 /* Called in parent after a fork()      */
 830 void GC_fork_parent_proc(void)
 831 {
 832 #   if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
 833       GC_release_mark_lock();
 834 #   endif
 835     UNLOCK();
 836 }
 837
 838 /* Called in child after a fork()       */
 839 void GC_fork_child_proc(void)
 840 {
 841     /* Clean up the thread table, so that just our thread is left. */
 842 #   if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
 843       GC_release_mark_lock();
 844 #   endif
 845     GC_remove_all_threads_but_me();
 846 #   ifdef PARALLEL_MARK
 847       /* Turn off parallel marking in the child, since we are probably  */
 848       /* just going to exec, and we would have to restart mark threads. */
 849         GC_markers = 1;
 850         GC_parallel = FALSE;
 851 #   endif /* PARALLEL_MARK */
 852     UNLOCK();
 853 }
 854 #endif /* HANDLE_FORK */
 855
 856 #if defined(GC_DGUX386_THREADS)
 857 /* Return the number of processors, or i<= 0 if it can't be determined. */
 858 int GC_get_nprocs()
 859 {
 860     /* <takis@XFree86.Org> */
 861     int numCpus;
 862     struct dg_sys_info_pm_info pm_sysinfo;
 863     int status =0;
 864
 865     status = dg_sys_info((long int *) &pm_sysinfo,
 866         DG_SYS_INFO_PM_INFO_TYPE, DG_SYS_INFO_PM_CURRENT_VERSION);
 867     if (status < 0)
 868        /* set -1 for error */
 869        numCpus = -1;
 870     else
 871       /* Active CPUs */
 872       numCpus = pm_sysinfo.idle_vp_count;
 873
 874 #  ifdef DEBUG_THREADS
 875     GC_printf1("Number of active CPUs in this system: %d\n", numCpus);
 876 #  endif
 877     return(numCpus);
 878 }
 879 #endif /* GC_DGUX386_THREADS */
 880
 881 /* We hold the allocation lock. */
 882 void GC_thr_init()
 883 {
 884 #       ifndef GC_DARWIN_THREADS
 885         int dummy;
 886 #       endif
 887     GC_thread t;
 888
 889     if (GC_thr_initialized) return;
 890     GC_thr_initialized = TRUE;
 891
 892 #   ifdef HANDLE_FORK
 893       /* Prepare for a possible fork.   */
 894         pthread_atfork(GC_fork_prepare_proc, GC_fork_parent_proc,
 895                        GC_fork_child_proc);
 896 #   endif /* HANDLE_FORK */
 897     /* Add the initial thread, so we can stop it.       */
 898       t = GC_new_thread(pthread_self());
 899 #     ifdef GC_DARWIN_THREADS
 900          t -> stop_info.mach_thread = mach_thread_self();
 901 #     else
 902          t -> stop_info.stack_ptr = (ptr_t)(&dummy);
 903 #     endif
 904       t -> flags = DETACHED | MAIN_THREAD;
 905
 906     GC_stop_init();
 907
 908     /* Set GC_nprocs.  */
 909       {
 910         char * nprocs_string = GETENV("GC_NPROCS");
 911         GC_nprocs = -1;
 912         if (nprocs_string != NULL) GC_nprocs = atoi(nprocs_string);
 913       }
 914       if (GC_nprocs <= 0) {
 915 #       if defined(GC_HPUX_THREADS)
 916           GC_nprocs = pthread_num_processors_np();
 917 #       endif
 918 #       if defined(GC_OSF1_THREADS)
 919           GC_nprocs = sysconf(_SC_NPROCESSORS_ONLN);
 920           if (GC_nprocs <= 0) GC_nprocs = 1;
 921 #       endif
 922 #       if defined(GC_FREEBSD_THREADS)
 923           GC_nprocs = 1;
 924 #       endif
 925 #       if defined(GC_DARWIN_THREADS)
 926           int ncpus = 1;
 927           size_t len = sizeof(ncpus);
 928           sysctl((int[2]) {CTL_HW, HW_NCPU}, 2, &ncpus, &len, NULL, 0);
 929           GC_nprocs = ncpus;
 930 #       endif
 931 #       if defined(GC_LINUX_THREADS) || defined(GC_DGUX386_THREADS)
 932           GC_nprocs = GC_get_nprocs();
 933 #       endif
 934       }
 935       if (GC_nprocs <= 0) {
 936         WARN("GC_get_nprocs() returned %ld\n", GC_nprocs);
 937         GC_nprocs = 2;
 938 #       ifdef PARALLEL_MARK
 939           GC_markers = 1;
 940 #       endif
 941       } else {
 942 #       ifdef PARALLEL_MARK
 943           {
 944             char * markers_string = GETENV("GC_MARKERS");
 945             if (markers_string != NULL) {
 946               GC_markers = atoi(markers_string);
 947             } else {
 948               GC_markers = GC_nprocs;
 949             }
 950           }
 951 #       endif
 952       }
 953 #   ifdef PARALLEL_MARK
 954 #     ifdef CONDPRINT
 955         if (GC_print_stats) {
 956           GC_printf2("Number of processors = %ld, "
 957                  "number of marker threads = %ld\n", GC_nprocs, GC_markers);
 958         }
 959 #     endif
 960       if (GC_markers == 1) {
 961         GC_parallel = FALSE;
 962 #       ifdef CONDPRINT
 963           if (GC_print_stats) {
 964             GC_printf0("Single marker thread, turning off parallel marking\n");
 965           }
 966 #       endif
 967       } else {
 968         GC_parallel = TRUE;
 969         /* Disable true incremental collection, but generational is OK. */
 970         GC_time_limit = GC_TIME_UNLIMITED;
 971       }
 972 #   endif
 973 }
 974
 975
 976 /* Perform all initializations, including those that    */
 977 /* may require allocation.                              */
 978 /* Called without allocation lock.                      */
 979 /* Must be called before a second thread is created.    */
 980 /* Called without allocation lock.                      */
 981 void GC_init_parallel()
 982 {
 983     if (parallel_initialized) return;
 984     parallel_initialized = TRUE;
 985
 986     /* GC_init() calls us back, so set flag first.      */
 987     if (!GC_is_initialized) GC_init();
 988     /* If we are using a parallel marker, start the helper threads.  */
 989 #     ifdef PARALLEL_MARK
 990         if (GC_parallel) start_mark_threads();
 991 #     endif
 992     /* Initialize thread local free lists if used.      */
 993 #   if defined(THREAD_LOCAL_ALLOC) && !defined(DBG_HDRS_ALL)
 994       LOCK();
 995       GC_init_thread_local(GC_lookup_thread(pthread_self()));
 996       UNLOCK();
 997 #   endif
 998 }
 999
1000
1001 #if !defined(GC_DARWIN_THREADS)
1002 int WRAP_FUNC(pthread_sigmask)(int how, const sigset_t *set, sigset_t *oset)
1003 {
1004     sigset_t fudged_set;
1005
1006     if (set != NULL && (how == SIG_BLOCK || how == SIG_SETMASK)) {
1007         fudged_set = *set;
1008         sigdelset(&fudged_set, SIG_SUSPEND);
1009         set = &fudged_set;
1010     }
1011     return(REAL_FUNC(pthread_sigmask)(how, set, oset));
1012 }
1013 #endif /* !GC_DARWIN_THREADS */
1014
1015 /* Wrappers for functions that are likely to block for an appreciable   */
1016 /* length of time.  Must be called in pairs, if at all.                 */
1017 /* Nothing much beyond the system call itself should be executed        */
1018 /* between these.                                                       */
1019
1020 void GC_start_blocking(void) {
1021 #   define SP_SLOP 128
1022     GC_thread me;
1023     LOCK();
1024     me = GC_lookup_thread(pthread_self());
1025     GC_ASSERT(!(me -> thread_blocked));
1026 #   ifdef SPARC
1027         me -> stop_info.stack_ptr = (ptr_t)GC_save_regs_in_stack();
1028 #   else
1029 #   ifndef GC_DARWIN_THREADS
1030         me -> stop_info.stack_ptr = (ptr_t)GC_approx_sp();
1031 #   endif
1032 #   endif
1033 #   ifdef IA64
1034         me -> backing_store_ptr = (ptr_t)GC_save_regs_in_stack() + SP_SLOP;
1035 #   endif
1036     /* Add some slop to the stack pointer, since the wrapped call may   */
1037     /* end up pushing more callee-save registers.                       */
1038 #   ifndef GC_DARWIN_THREADS
1039 #   ifdef STACK_GROWS_UP
1040         me -> stop_info.stack_ptr += SP_SLOP;
1041 #   else
1042         me -> stop_info.stack_ptr -= SP_SLOP;
1043 #   endif
1044 #   endif
1045     me -> thread_blocked = TRUE;
1046     UNLOCK();
1047 }
1048
1049 void GC_end_blocking(void) {
1050     GC_thread me;
1051     LOCK();   /* This will block if the world is stopped.       */
1052     me = GC_lookup_thread(pthread_self());
1053     GC_ASSERT(me -> thread_blocked);
1054     me -> thread_blocked = FALSE;
1055     UNLOCK();
1056 }
1057
1058 #if defined(GC_DGUX386_THREADS)
1059 #define __d10_sleep sleep
1060 #endif /* GC_DGUX386_THREADS */
1061
1062 /* A wrapper for the standard C sleep function  */
1063 int WRAP_FUNC(sleep) (unsigned int seconds)
1064 {
1065     int result;
1066
1067     GC_start_blocking();
1068     result = REAL_FUNC(sleep)(seconds);
1069     GC_end_blocking();
1070     return result;
1071 }
1072
1073 struct start_info {
1074     void *(*start_routine)(void *);
1075     void *arg;
1076     word flags;
1077     sem_t registered;           /* 1 ==> in our thread table, but       */
1078                                 /* parent hasn't yet noticed.           */
1079 };
1080
1081 /* Called at thread exit.                               */
1082 /* Never called for main thread.  That's OK, since it   */
1083 /* results in at most a tiny one-time leak.  And        */
1084 /* linuxthreads doesn't reclaim the main threads        */
1085 /* resources or id anyway.                              */
1086 void GC_thread_exit_proc(void *arg)
1087 {
1088     GC_thread me;
1089
1090     LOCK();
1091     me = GC_lookup_thread(pthread_self());
1092     GC_destroy_thread_local(me);
1093     if (me -> flags & DETACHED) {
1094         GC_delete_thread(pthread_self());
1095     } else {
1096         me -> flags |= FINISHED;
1097     }
1098 #   if defined(THREAD_LOCAL_ALLOC) && !defined(USE_PTHREAD_SPECIFIC) \
1099        && !defined(USE_COMPILER_TLS) && !defined(DBG_HDRS_ALL)
1100       GC_remove_specific(GC_thread_key);
1101 #   endif
1102     /* The following may run the GC from "nonexistent" thread.  */
1103     GC_wait_for_gc_completion(FALSE);
1104     UNLOCK();
1105 }
1106
1107 int WRAP_FUNC(pthread_join)(pthread_t thread, void **retval)
1108 {
1109     int result;
1110     GC_thread thread_gc_id;
1111
1112     LOCK();
1113     thread_gc_id = GC_lookup_thread(thread);
1114     /* This is guaranteed to be the intended one, since the thread id   */
1115     /* cant have been recycled by pthreads.                             */
1116     UNLOCK();
1117     result = REAL_FUNC(pthread_join)(thread, retval);
1118 # if defined (GC_FREEBSD_THREADS)
1119     /* On FreeBSD, the wrapped pthread_join() sometimes returns (what
1120        appears to be) a spurious EINTR which caused the test and real code
1121        to gratuitously fail.  Having looked at system pthread library source
1122        code, I see how this return code may be generated.  In one path of
1123        code, pthread_join() just returns the errno setting of the thread
1124        being joined.  This does not match the POSIX specification or the
1125        local man pages thus I have taken the liberty to catch this one
1126        spurious return value properly conditionalized on GC_FREEBSD_THREADS. */
1127     if (result == EINTR) result = 0;
1128 # endif
1129     if (result == 0) {
1130         LOCK();
1131         /* Here the pthread thread id may have been recycled. */
1132         GC_delete_gc_thread(thread, thread_gc_id);
1133         UNLOCK();
1134     }
1135     return result;
1136 }
1137
1138 int
1139 WRAP_FUNC(pthread_detach)(pthread_t thread)
1140 {
1141     int result;
1142     GC_thread thread_gc_id;
1143
1144     LOCK();
1145     thread_gc_id = GC_lookup_thread(thread);
1146     UNLOCK();
1147     result = REAL_FUNC(pthread_detach)(thread);
1148     if (result == 0) {
1149       LOCK();
1150       thread_gc_id -> flags |= DETACHED;
1151       /* Here the pthread thread id may have been recycled. */
1152       if (thread_gc_id -> flags & FINISHED) {
1153         GC_delete_gc_thread(thread, thread_gc_id);
1154       }
1155       UNLOCK();
1156     }
1157     return result;
1158 }
1159
1160 GC_bool GC_in_thread_creation = FALSE;
1161
1162 void * GC_start_routine(void * arg)
1163 {
1164     int dummy;
1165     struct start_info * si = arg;
1166     void * result;
1167     GC_thread me;
1168     pthread_t my_pthread;
1169     void *(*start)(void *);
1170     void *start_arg;
1171
1172     my_pthread = pthread_self();
1173 #   ifdef DEBUG_THREADS
1174         GC_printf1("Starting thread 0x%lx\n", my_pthread);
1175         GC_printf1("pid = %ld\n", (long) getpid());
1176         GC_printf1("sp = 0x%lx\n", (long) &arg);
1177 #   endif
1178     LOCK();
1179     GC_in_thread_creation = TRUE;
1180     me = GC_new_thread(my_pthread);
1181     GC_in_thread_creation = FALSE;
1182 #ifdef GC_DARWIN_THREADS
1183     me -> stop_info.mach_thread = mach_thread_self();
1184 #else
1185     me -> stop_info.stack_ptr = 0;
1186 #endif
1187     me -> flags = si -> flags;
1188     /* me -> stack_end = GC_linux_stack_base(); -- currently (11/99)    */
1189     /* doesn't work because the stack base in /proc/self/stat is the    */
1190     /* one for the main thread.  There is a strong argument that that's */
1191     /* a kernel bug, but a pervasive one.                               */
1192 #   ifdef STACK_GROWS_DOWN
1193       me -> stack_end = (ptr_t)(((word)(&dummy) + (GC_page_size - 1))
1194                                 & ~(GC_page_size - 1));
1195 #         ifndef GC_DARWIN_THREADS
1196         me -> stop_info.stack_ptr = me -> stack_end - 0x10;
1197 #         endif
1198         /* Needs to be plausible, since an asynchronous stack mark      */
1199         /* should not crash.                                            */
1200 #   else
1201       me -> stack_end = (ptr_t)((word)(&dummy) & ~(GC_page_size - 1));
1202       me -> stop_info.stack_ptr = me -> stack_end + 0x10;
1203 #   endif
1204     /* This is dubious, since we may be more than a page into the stack, */
1205     /* and hence skip some of it, though it's not clear that matters.    */
1206 #   ifdef IA64
1207       me -> backing_store_end = (ptr_t)
1208                         (GC_save_regs_in_stack() & ~(GC_page_size - 1));
1209       /* This is also < 100% convincing.  We should also read this      */
1210       /* from /proc, but the hook to do so isn't there yet.             */
1211 #   endif /* IA64 */
1212     UNLOCK();
1213     start = si -> start_routine;
1214 #   ifdef DEBUG_THREADS
1215         GC_printf1("start_routine = 0x%lx\n", start);
1216 #   endif
1217     start_arg = si -> arg;
1218     sem_post(&(si -> registered));      /* Last action on si.   */
1219                                         /* OK to deallocate.    */
1220     pthread_cleanup_push(GC_thread_exit_proc, 0);
1221 #   if defined(THREAD_LOCAL_ALLOC) && !defined(DBG_HDRS_ALL)
1222         LOCK();
1223         GC_init_thread_local(me);
1224         UNLOCK();
1225 #   endif
1226     result = (*start)(start_arg);
1227 #if DEBUG_THREADS
1228         GC_printf1("Finishing thread 0x%x\n", pthread_self());
1229 #endif
1230     me -> status = result;
1231     pthread_cleanup_pop(1);
1232     /* Cleanup acquires lock, ensuring that we can't exit               */
1233     /* while a collection that thinks we're alive is trying to stop     */
1234     /* us.                                                              */
1235     return(result);
1236 }
1237
1238 int
1239 WRAP_FUNC(pthread_create)(pthread_t *new_thread,
1240                   const pthread_attr_t *attr,
1241                   void *(*start_routine)(void *), void *arg)
1242 {
1243     int result;
1244     int detachstate;
1245     word my_flags = 0;
1246     struct start_info * si;
1247         /* This is otherwise saved only in an area mmapped by the thread */
1248         /* library, which isn't visible to the collector.                */
1249
1250     /* We resist the temptation to muck with the stack size here,       */
1251     /* even if the default is unreasonably small.  That's the client's  */
1252     /* responsibility.                                                  */
1253
1254     LOCK();
1255     si = (struct start_info *)GC_INTERNAL_MALLOC(sizeof(struct start_info),
1256                                                  NORMAL);
1257     UNLOCK();
1258     if (!parallel_initialized) GC_init_parallel();
1259     if (0 == si) return(ENOMEM);
1260     sem_init(&(si -> registered), 0, 0);
1261     si -> start_routine = start_routine;
1262     si -> arg = arg;
1263     LOCK();
1264     if (!GC_thr_initialized) GC_thr_init();
1265 #   ifdef GC_ASSERTIONS
1266       {
1267         int stack_size;
1268         if (NULL == attr) {
1269            pthread_attr_t my_attr;
1270            pthread_attr_init(&my_attr);
1271            pthread_attr_getstacksize(&my_attr, &stack_size);
1272         } else {
1273            pthread_attr_getstacksize(attr, &stack_size);
1274         }
1275         GC_ASSERT(stack_size >= (8*HBLKSIZE*sizeof(word)));
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 = REAL_FUNC(pthread_create)(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