libgc/pthread_support.c

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