New test.
[mono.git] / 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         
704 #ifdef GC_DARWIN_THREADS
705         mach_port_deallocate(mach_task_self(), p->stop_info.mach_thread);
706 #endif
707         
708     GC_INTERNAL_FREE(p);
709 }
710
711 /* If a thread has been joined, but we have not yet             */
712 /* been notified, then there may be more than one thread        */
713 /* in the table with the same pthread id.                       */
714 /* This is OK, but we need a way to delete a specific one.      */
715 void GC_delete_gc_thread(pthread_t id, GC_thread gc_id)
716 {
717     int hv = ((word)id) % THREAD_TABLE_SZ;
718     register GC_thread p = GC_threads[hv];
719     register GC_thread prev = 0;
720
721     while (p != gc_id) {
722         prev = p;
723         p = p -> next;
724     }
725     if (prev == 0) {
726         GC_threads[hv] = p -> next;
727     } else {
728         prev -> next = p -> next;
729     }
730         
731 #ifdef GC_DARWIN_THREADS
732         mach_port_deallocate(mach_task_self(), p->stop_info.mach_thread);
733 #endif
734         
735     GC_INTERNAL_FREE(p);
736 }
737
738 /* Return a GC_thread corresponding to a given pthread_t.       */
739 /* Returns 0 if it's not there.                                 */
740 /* Caller holds  allocation lock or otherwise inhibits          */
741 /* updates.                                                     */
742 /* If there is more than one thread with the given id we        */
743 /* return the most recent one.                                  */
744 GC_thread GC_lookup_thread(pthread_t id)
745 {
746     int hv = ((word)id) % THREAD_TABLE_SZ;
747     register GC_thread p = GC_threads[hv];
748     
749     while (p != 0 && !pthread_equal(p -> id, id)) p = p -> next;
750     return(p);
751 }
752
753 int GC_thread_is_registered (void)
754 {
755         void *ptr;
756
757         LOCK();
758         ptr = (void *)GC_lookup_thread(pthread_self());
759         UNLOCK();
760
761         return ptr ? 1 : 0;
762 }
763
764 #ifdef HANDLE_FORK
765 /* Remove all entries from the GC_threads table, except the     */
766 /* one for the current thread.  We need to do this in the child */
767 /* process after a fork(), since only the current thread        */
768 /* survives in the child.                                       */
769 void GC_remove_all_threads_but_me(void)
770 {
771     pthread_t self = pthread_self();
772     int hv;
773     GC_thread p, next, me;
774
775     for (hv = 0; hv < THREAD_TABLE_SZ; ++hv) {
776       me = 0;
777       for (p = GC_threads[hv]; 0 != p; p = next) {
778         next = p -> next;
779         if (p -> id == self) {
780           me = p;
781           p -> next = 0;
782         } else {
783 #         ifdef THREAD_LOCAL_ALLOC
784             if (!(p -> flags & FINISHED)) {
785               GC_destroy_thread_local(p);
786             }
787 #         endif /* THREAD_LOCAL_ALLOC */
788             if (p != &first_thread) GC_INTERNAL_FREE(p);
789         }
790       }
791       GC_threads[hv] = me;
792     }
793     GC_INTERNAL_FREE(p);
794 }
795 #endif /* HANDLE_FORK */
796
797 #ifdef USE_PROC_FOR_LIBRARIES
798 int GC_segment_is_thread_stack(ptr_t lo, ptr_t hi)
799 {
800     int i;
801     GC_thread p;
802     
803 #   ifdef PARALLEL_MARK
804       for (i = 0; i < GC_markers; ++i) {
805         if (marker_sp[i] > lo & marker_sp[i] < hi) return 1;
806       }
807 #   endif
808     for (i = 0; i < THREAD_TABLE_SZ; i++) {
809       for (p = GC_threads[i]; p != 0; p = p -> next) {
810         if (0 != p -> stack_end) {
811 #         ifdef STACK_GROWS_UP
812             if (p -> stack_end >= lo && p -> stack_end < hi) return 1;
813 #         else /* STACK_GROWS_DOWN */
814             if (p -> stack_end > lo && p -> stack_end <= hi) return 1;
815 #         endif
816         }
817       }
818     }
819     return 0;
820 }
821 #endif /* USE_PROC_FOR_LIBRARIES */
822
823 #ifdef GC_LINUX_THREADS
824 /* Return the number of processors, or i<= 0 if it can't be determined. */
825 int GC_get_nprocs()
826 {
827     /* Should be "return sysconf(_SC_NPROCESSORS_ONLN);" but that       */
828     /* appears to be buggy in many cases.                               */
829     /* We look for lines "cpu<n>" in /proc/stat.                        */
830 #   define STAT_BUF_SIZE 4096
831 #   define STAT_READ read
832         /* If read is wrapped, this may need to be redefined to call    */
833         /* the real one.                                                */
834     char stat_buf[STAT_BUF_SIZE];
835     int f;
836     word result = 1;
837         /* Some old kernels only have a single "cpu nnnn ..."   */
838         /* entry in /proc/stat.  We identify those as           */
839         /* uniprocessors.                                       */
840     size_t i, len = 0;
841
842     f = open("/proc/stat", O_RDONLY);
843     if (f < 0 || (len = STAT_READ(f, stat_buf, STAT_BUF_SIZE)) < 100) {
844         WARN("Couldn't read /proc/stat\n", 0);
845         return -1;
846     }
847     for (i = 0; i < len - 100; ++i) {
848         if (stat_buf[i] == '\n' && stat_buf[i+1] == 'c'
849             && stat_buf[i+2] == 'p' && stat_buf[i+3] == 'u') {
850             int cpu_no = atoi(stat_buf + i + 4);
851             if (cpu_no >= result) result = cpu_no + 1;
852         }
853     }
854     close(f);
855     return result;
856 }
857 #endif /* GC_LINUX_THREADS */
858
859 /* We hold the GC lock.  Wait until an in-progress GC has finished.     */
860 /* Repeatedly RELEASES GC LOCK in order to wait.                        */
861 /* If wait_for_all is true, then we exit with the GC lock held and no   */
862 /* collection in progress; otherwise we just wait for the current GC    */
863 /* to finish.                                                           */
864 extern GC_bool GC_collection_in_progress();
865 void GC_wait_for_gc_completion(GC_bool wait_for_all)
866 {
867     if (GC_incremental && GC_collection_in_progress()) {
868         int old_gc_no = GC_gc_no;
869
870         /* Make sure that no part of our stack is still on the mark stack, */
871         /* since it's about to be unmapped.                                */
872         while (GC_incremental && GC_collection_in_progress()
873                && (wait_for_all || old_gc_no == GC_gc_no)) {
874             ENTER_GC();
875             GC_in_thread_creation = TRUE;
876             GC_collect_a_little_inner(1);
877             GC_in_thread_creation = FALSE;
878             EXIT_GC();
879             UNLOCK();
880             sched_yield();
881             LOCK();
882         }
883     }
884 }
885
886 #ifdef HANDLE_FORK
887 /* Procedures called before and after a fork.  The goal here is to make */
888 /* it safe to call GC_malloc() in a forked child.  It's unclear that is */
889 /* attainable, since the single UNIX spec seems to imply that one       */
890 /* should only call async-signal-safe functions, and we probably can't  */
891 /* quite guarantee that.  But we give it our best shot.  (That same     */
892 /* spec also implies that it's not safe to call the system malloc       */
893 /* between fork() and exec().  Thus we're doing no worse than it.       */
894
895 /* Called before a fork()               */
896 void GC_fork_prepare_proc(void)
897 {
898     /* Acquire all relevant locks, so that after releasing the locks    */
899     /* the child will see a consistent state in which monitor           */
900     /* invariants hold.  Unfortunately, we can't acquire libc locks     */
901     /* we might need, and there seems to be no guarantee that libc      */
902     /* must install a suitable fork handler.                            */
903     /* Wait for an ongoing GC to finish, since we can't finish it in    */
904     /* the (one remaining thread in) the child.                         */
905       LOCK();
906 #     if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
907         GC_wait_for_reclaim();
908 #     endif
909       GC_wait_for_gc_completion(TRUE);
910 #     if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
911         GC_acquire_mark_lock();
912 #     endif
913 }
914
915 /* Called in parent after a fork()      */
916 void GC_fork_parent_proc(void)
917 {
918 #   if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
919       GC_release_mark_lock();
920 #   endif
921     UNLOCK();
922 }
923
924 /* Called in child after a fork()       */
925 void GC_fork_child_proc(void)
926 {
927     /* Clean up the thread table, so that just our thread is left. */
928 #   if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
929       GC_release_mark_lock();
930 #   endif
931     GC_remove_all_threads_but_me();
932 #   ifdef PARALLEL_MARK
933       /* Turn off parallel marking in the child, since we are probably  */
934       /* just going to exec, and we would have to restart mark threads. */
935         GC_markers = 1;
936         GC_parallel = FALSE;
937 #   endif /* PARALLEL_MARK */
938     UNLOCK();
939 }
940 #endif /* HANDLE_FORK */
941
942 #if defined(GC_DGUX386_THREADS)
943 /* Return the number of processors, or i<= 0 if it can't be determined. */
944 int GC_get_nprocs()
945 {
946     /* <takis@XFree86.Org> */
947     int numCpus;
948     struct dg_sys_info_pm_info pm_sysinfo;
949     int status =0;
950
951     status = dg_sys_info((long int *) &pm_sysinfo,
952         DG_SYS_INFO_PM_INFO_TYPE, DG_SYS_INFO_PM_CURRENT_VERSION);
953     if (status < 0)
954        /* set -1 for error */
955        numCpus = -1;
956     else
957       /* Active CPUs */
958       numCpus = pm_sysinfo.idle_vp_count;
959
960 #  ifdef DEBUG_THREADS
961     GC_printf1("Number of active CPUs in this system: %d\n", numCpus);
962 #  endif
963     return(numCpus);
964 }
965 #endif /* GC_DGUX386_THREADS */
966
967 /* We hold the allocation lock. */
968 void GC_thr_init()
969 {
970 #   ifndef GC_DARWIN_THREADS
971       int dummy;
972 #   endif
973     GC_thread t;
974
975     if (GC_thr_initialized) return;
976     GC_thr_initialized = TRUE;
977     
978 #   ifdef HANDLE_FORK
979       /* Prepare for a possible fork.   */
980         pthread_atfork(GC_fork_prepare_proc, GC_fork_parent_proc,
981                        GC_fork_child_proc);
982 #   endif /* HANDLE_FORK */
983     /* Add the initial thread, so we can stop it.       */
984       t = GC_new_thread(pthread_self());
985 #     ifdef GC_DARWIN_THREADS
986          t -> stop_info.mach_thread = mach_thread_self();
987 #     else
988          t -> stop_info.stack_ptr = (ptr_t)(&dummy);
989 #     endif
990       t -> flags = DETACHED | MAIN_THREAD;
991 #ifdef MONO_DEBUGGER_SUPPORTED
992       if (gc_thread_vtable && gc_thread_vtable->thread_created)
993         gc_thread_vtable->thread_created (pthread_self (), &t->stop_info.stack_ptr);
994 #endif
995
996     GC_stop_init();
997
998     /* Set GC_nprocs.  */
999       {
1000         char * nprocs_string = GETENV("GC_NPROCS");
1001         GC_nprocs = -1;
1002         if (nprocs_string != NULL) GC_nprocs = atoi(nprocs_string);
1003       }
1004       if (GC_nprocs <= 0) {
1005 #       if defined(GC_HPUX_THREADS)
1006           GC_nprocs = pthread_num_processors_np();
1007 #       endif
1008 #       if defined(GC_OSF1_THREADS) || defined(GC_AIX_THREADS)
1009           GC_nprocs = sysconf(_SC_NPROCESSORS_ONLN);
1010           if (GC_nprocs <= 0) GC_nprocs = 1;
1011 #       endif
1012 #       if defined(GC_IRIX_THREADS)
1013           GC_nprocs = sysconf(_SC_NPROC_ONLN);
1014           if (GC_nprocs <= 0) GC_nprocs = 1;
1015 #       endif
1016 #       if defined(GC_DARWIN_THREADS) || defined(GC_FREEBSD_THREADS)
1017           int ncpus = 1;
1018           size_t len = sizeof(ncpus);
1019           sysctl((int[2]) {CTL_HW, HW_NCPU}, 2, &ncpus, &len, NULL, 0);
1020           GC_nprocs = ncpus;
1021 #       endif
1022 #       if defined(GC_LINUX_THREADS) || defined(GC_DGUX386_THREADS)
1023           GC_nprocs = GC_get_nprocs();
1024 #       endif
1025       }
1026       if (GC_nprocs <= 0) {
1027         WARN("GC_get_nprocs() returned %ld\n", GC_nprocs);
1028         GC_nprocs = 2;
1029 #       ifdef PARALLEL_MARK
1030           GC_markers = 1;
1031 #       endif
1032       } else {
1033 #       ifdef PARALLEL_MARK
1034           {
1035             char * markers_string = GETENV("GC_MARKERS");
1036             if (markers_string != NULL) {
1037               GC_markers = atoi(markers_string);
1038             } else {
1039               GC_markers = GC_nprocs;
1040             }
1041           }
1042 #       endif
1043       }
1044 #   ifdef PARALLEL_MARK
1045 #     ifdef CONDPRINT
1046         if (GC_print_stats) {
1047           GC_printf2("Number of processors = %ld, "
1048                  "number of marker threads = %ld\n", GC_nprocs, GC_markers);
1049         }
1050 #     endif
1051       if (GC_markers == 1) {
1052         GC_parallel = FALSE;
1053 #       ifdef CONDPRINT
1054           if (GC_print_stats) {
1055             GC_printf0("Single marker thread, turning off parallel marking\n");
1056           }
1057 #       endif
1058       } else {
1059         GC_parallel = TRUE;
1060         /* Disable true incremental collection, but generational is OK. */
1061         GC_time_limit = GC_TIME_UNLIMITED;
1062       }
1063       /* If we are using a parallel marker, actually start helper threads.  */
1064         if (GC_parallel) start_mark_threads();
1065 #   endif
1066 }
1067
1068
1069 /* Perform all initializations, including those that    */
1070 /* may require allocation.                              */
1071 /* Called without allocation lock.                      */
1072 /* Must be called before a second thread is created.    */
1073 /* Called without allocation lock.                      */
1074 void GC_init_parallel()
1075 {
1076     if (parallel_initialized) return;
1077     parallel_initialized = TRUE;
1078
1079     /* GC_init() calls us back, so set flag first.      */
1080     if (!GC_is_initialized) GC_init();
1081     /* Initialize thread local free lists if used.      */
1082 #   if defined(THREAD_LOCAL_ALLOC) && !defined(DBG_HDRS_ALL)
1083       LOCK();
1084       GC_init_thread_local(GC_lookup_thread(pthread_self()));
1085       UNLOCK();
1086 #   endif
1087 }
1088
1089
1090 #if !defined(GC_DARWIN_THREADS)
1091 int WRAP_FUNC(pthread_sigmask)(int how, const sigset_t *set, sigset_t *oset)
1092 {
1093     sigset_t fudged_set;
1094     
1095     if (set != NULL && (how == SIG_BLOCK || how == SIG_SETMASK)) {
1096         fudged_set = *set;
1097         sigdelset(&fudged_set, SIG_SUSPEND);
1098         set = &fudged_set;
1099     }
1100     return(REAL_FUNC(pthread_sigmask)(how, set, oset));
1101 }
1102 #endif /* !GC_DARWIN_THREADS */
1103
1104 /* Wrappers for functions that are likely to block for an appreciable   */
1105 /* length of time.  Must be called in pairs, if at all.                 */
1106 /* Nothing much beyond the system call itself should be executed        */
1107 /* between these.                                                       */
1108
1109 void GC_start_blocking(void) {
1110 #   define SP_SLOP 128
1111     GC_thread me;
1112     LOCK();
1113     me = GC_lookup_thread(pthread_self());
1114     GC_ASSERT(!(me -> thread_blocked));
1115 #   ifdef SPARC
1116         me -> stop_info.stack_ptr = (ptr_t)GC_save_regs_in_stack();
1117 #   else
1118 #   ifndef GC_DARWIN_THREADS
1119         me -> stop_info.stack_ptr = (ptr_t)GC_approx_sp();
1120 #   endif
1121 #   endif
1122 #   ifdef IA64
1123         me -> backing_store_ptr = (ptr_t)GC_save_regs_in_stack() + SP_SLOP;
1124 #   endif
1125     /* Add some slop to the stack pointer, since the wrapped call may   */
1126     /* end up pushing more callee-save registers.                       */
1127 #   ifndef GC_DARWIN_THREADS
1128 #   ifdef STACK_GROWS_UP
1129         me -> stop_info.stack_ptr += SP_SLOP;
1130 #   else
1131         me -> stop_info.stack_ptr -= SP_SLOP;
1132 #   endif
1133 #   endif
1134     me -> thread_blocked = TRUE;
1135     UNLOCK();
1136 }
1137
1138 void GC_end_blocking(void) {
1139     GC_thread me;
1140     LOCK();   /* This will block if the world is stopped.       */
1141     me = GC_lookup_thread(pthread_self());
1142     GC_ASSERT(me -> thread_blocked);
1143     me -> thread_blocked = FALSE;
1144     UNLOCK();
1145 }
1146     
1147 #if defined(GC_DGUX386_THREADS)
1148 #define __d10_sleep sleep
1149 #endif /* GC_DGUX386_THREADS */
1150
1151 /* A wrapper for the standard C sleep function  */
1152 int WRAP_FUNC(sleep) (unsigned int seconds)
1153 {
1154     int result;
1155
1156     GC_start_blocking();
1157     result = REAL_FUNC(sleep)(seconds);
1158     GC_end_blocking();
1159     return result;
1160 }
1161
1162 struct start_info {
1163     void *(*start_routine)(void *);
1164     void *arg;
1165     word flags;
1166     sem_t registered;           /* 1 ==> in our thread table, but       */
1167                                 /* parent hasn't yet noticed.           */
1168 };
1169
1170 /* Called at thread exit.                               */
1171 /* Never called for main thread.  That's OK, since it   */
1172 /* results in at most a tiny one-time leak.  And        */
1173 /* linuxthreads doesn't reclaim the main threads        */
1174 /* resources or id anyway.                              */
1175 void GC_thread_exit_proc(void *arg)
1176 {
1177     GC_thread me;
1178
1179     LOCK();
1180     me = GC_lookup_thread(pthread_self());
1181     GC_destroy_thread_local(me);
1182     if (me -> flags & DETACHED) {
1183         GC_delete_thread(pthread_self());
1184     } else {
1185         me -> flags |= FINISHED;
1186     }
1187 #   if defined(THREAD_LOCAL_ALLOC) && !defined(USE_PTHREAD_SPECIFIC) \
1188        && !defined(USE_COMPILER_TLS) && !defined(DBG_HDRS_ALL)
1189       GC_remove_specific(GC_thread_key);
1190 #   endif
1191     /* The following may run the GC from "nonexistent" thread.  */
1192     GC_wait_for_gc_completion(FALSE);
1193     UNLOCK();
1194 }
1195
1196 int WRAP_FUNC(pthread_join)(pthread_t thread, void **retval)
1197 {
1198     int result;
1199     GC_thread thread_gc_id;
1200     
1201     LOCK();
1202     thread_gc_id = GC_lookup_thread(thread);
1203     /* This is guaranteed to be the intended one, since the thread id   */
1204     /* cant have been recycled by pthreads.                             */
1205     UNLOCK();
1206     result = REAL_FUNC(pthread_join)(thread, retval);
1207 # if defined (GC_FREEBSD_THREADS)
1208     /* On FreeBSD, the wrapped pthread_join() sometimes returns (what
1209        appears to be) a spurious EINTR which caused the test and real code
1210        to gratuitously fail.  Having looked at system pthread library source
1211        code, I see how this return code may be generated.  In one path of
1212        code, pthread_join() just returns the errno setting of the thread
1213        being joined.  This does not match the POSIX specification or the
1214        local man pages thus I have taken the liberty to catch this one
1215        spurious return value properly conditionalized on GC_FREEBSD_THREADS. */
1216     if (result == EINTR) result = 0;
1217 # endif
1218     if (result == 0) {
1219         LOCK();
1220         /* Here the pthread thread id may have been recycled. */
1221         GC_delete_gc_thread(thread, thread_gc_id);
1222         UNLOCK();
1223     }
1224     return result;
1225 }
1226
1227 int
1228 WRAP_FUNC(pthread_detach)(pthread_t thread)
1229 {
1230     int result;
1231     GC_thread thread_gc_id;
1232     
1233     LOCK();
1234     thread_gc_id = GC_lookup_thread(thread);
1235     UNLOCK();
1236     result = REAL_FUNC(pthread_detach)(thread);
1237     if (result == 0) {
1238       LOCK();
1239       thread_gc_id -> flags |= DETACHED;
1240       /* Here the pthread thread id may have been recycled. */
1241       if (thread_gc_id -> flags & FINISHED) {
1242         GC_delete_gc_thread(thread, thread_gc_id);
1243       }
1244       UNLOCK();
1245     }
1246     return result;
1247 }
1248
1249 GC_bool GC_in_thread_creation = FALSE;
1250
1251 typedef void *(*ThreadStartFn)(void *);
1252 void * GC_start_routine_head(void * arg, void *base_addr,
1253                              ThreadStartFn *start, void **start_arg )
1254 {
1255     struct start_info * si = arg;
1256     void * result;
1257     GC_thread me;
1258     pthread_t my_pthread;
1259
1260     my_pthread = pthread_self();
1261 #   ifdef DEBUG_THREADS
1262         GC_printf1("Starting thread 0x%lx\n", my_pthread);
1263         GC_printf1("pid = %ld\n", (long) getpid());
1264         GC_printf1("sp = 0x%lx\n", (long) &arg);
1265 #   endif
1266     LOCK();
1267     GC_in_thread_creation = TRUE;
1268     me = GC_new_thread(my_pthread);
1269     GC_in_thread_creation = FALSE;
1270 #ifdef GC_DARWIN_THREADS
1271     me -> stop_info.mach_thread = mach_thread_self();
1272 #else
1273     me -> stop_info.stack_ptr = 0;
1274 #endif
1275     me -> flags = si -> flags;
1276     /* me -> stack_end = GC_linux_stack_base(); -- currently (11/99)    */
1277     /* doesn't work because the stack base in /proc/self/stat is the    */
1278     /* one for the main thread.  There is a strong argument that that's */
1279     /* a kernel bug, but a pervasive one.                               */
1280 #   ifdef STACK_GROWS_DOWN
1281       me -> stack_end = (ptr_t)(((word)(base_addr) + (GC_page_size - 1))
1282                                 & ~(GC_page_size - 1));
1283 #         ifndef GC_DARWIN_THREADS
1284         me -> stop_info.stack_ptr = me -> stack_end - 0x10;
1285 #         endif
1286         /* Needs to be plausible, since an asynchronous stack mark      */
1287         /* should not crash.                                            */
1288 #   else
1289       me -> stack_end = (ptr_t)((word)(base_addr) & ~(GC_page_size - 1));
1290       me -> stop_info.stack_ptr = me -> stack_end + 0x10;
1291 #   endif
1292     /* This is dubious, since we may be more than a page into the stack, */
1293     /* and hence skip some of it, though it's not clear that matters.    */
1294 #   ifdef IA64
1295       me -> backing_store_end = (ptr_t)
1296                         (GC_save_regs_in_stack() & ~(GC_page_size - 1));
1297       /* This is also < 100% convincing.  We should also read this      */
1298       /* from /proc, but the hook to do so isn't there yet.             */
1299 #   endif /* IA64 */
1300 #ifdef MONO_DEBUGGER_SUPPORTED
1301     if (gc_thread_vtable && gc_thread_vtable->thread_created)
1302         gc_thread_vtable->thread_created (my_pthread, &me->stop_info.stack_ptr);
1303 #endif
1304     UNLOCK();
1305
1306     if (start) *start = si -> start_routine;
1307     if (start_arg) *start_arg = si -> arg;
1308
1309     sem_post(&(si -> registered));      /* Last action on si.   */
1310                                         /* OK to deallocate.    */
1311 #   if defined(THREAD_LOCAL_ALLOC) && !defined(DBG_HDRS_ALL)
1312         LOCK();
1313         GC_init_thread_local(me);
1314         UNLOCK();
1315 #   endif
1316
1317     return me;
1318 }
1319
1320 int GC_thread_register_foreign (void *base_addr)
1321 {
1322     struct start_info si = { 0, }; /* stacked for legibility & locking */
1323     GC_thread me;
1324
1325 #   ifdef DEBUG_THREADS
1326         GC_printf1( "GC_thread_register_foreign %p\n", &si );
1327 #   endif
1328
1329     si.flags = FOREIGN_THREAD;
1330
1331     if (!parallel_initialized) GC_init_parallel();
1332     LOCK();
1333     if (!GC_thr_initialized) GC_thr_init();
1334
1335     UNLOCK();
1336
1337     me = GC_start_routine_head(&si, base_addr, NULL, NULL);
1338
1339     return me != NULL;
1340 }
1341
1342 void * GC_start_routine(void * arg)
1343 {
1344     int dummy;
1345     struct start_info * si = arg;
1346     void * result;
1347     GC_thread me;
1348     ThreadStartFn start;
1349     void *start_arg;
1350
1351     me = GC_start_routine_head (arg, &dummy, &start, &start_arg);
1352
1353     pthread_cleanup_push(GC_thread_exit_proc, 0);
1354 #   ifdef DEBUG_THREADS
1355         GC_printf1("start_routine = 0x%lx\n", start);
1356 #   endif
1357     result = (*start)(start_arg);
1358 #if DEBUG_THREADS
1359         GC_printf1("Finishing thread 0x%x\n", pthread_self());
1360 #endif
1361     me -> status = result;
1362     pthread_cleanup_pop(1);
1363     /* Cleanup acquires lock, ensuring that we can't exit               */
1364     /* while a collection that thinks we're alive is trying to stop     */
1365     /* us.                                                              */
1366     return(result);
1367 }
1368
1369 int
1370 WRAP_FUNC(pthread_create)(pthread_t *new_thread,
1371                   const pthread_attr_t *attr,
1372                   void *(*start_routine)(void *), void *arg)
1373 {
1374     int result;
1375     int detachstate;
1376     word my_flags = 0;
1377     struct start_info * si; 
1378         /* This is otherwise saved only in an area mmapped by the thread */
1379         /* library, which isn't visible to the collector.                */
1380  
1381     /* We resist the temptation to muck with the stack size here,       */
1382     /* even if the default is unreasonably small.  That's the client's  */
1383     /* responsibility.                                                  */
1384
1385     LOCK();
1386     si = (struct start_info *)GC_INTERNAL_MALLOC(sizeof(struct start_info),
1387                                                  NORMAL);
1388     UNLOCK();
1389     if (!parallel_initialized) GC_init_parallel();
1390     if (0 == si) return(ENOMEM);
1391     sem_init(&(si -> registered), 0, 0);
1392     si -> start_routine = start_routine;
1393     si -> arg = arg;
1394     LOCK();
1395     if (!GC_thr_initialized) GC_thr_init();
1396 #   ifdef GC_ASSERTIONS
1397       {
1398         size_t stack_size;
1399         if (NULL == attr) {
1400            pthread_attr_t my_attr;
1401            pthread_attr_init(&my_attr);
1402            pthread_attr_getstacksize(&my_attr, &stack_size);
1403         } else {
1404            pthread_attr_getstacksize(attr, &stack_size);
1405         }
1406 #       ifdef PARALLEL_MARK
1407           GC_ASSERT(stack_size >= (8*HBLKSIZE*sizeof(word)));
1408 #       else
1409           /* FreeBSD-5.3/Alpha: default pthread stack is 64K,   */
1410           /* HBLKSIZE=8192, sizeof(word)=8                      */
1411           GC_ASSERT(stack_size >= 65536);
1412 #       endif
1413         /* Our threads may need to do some work for the GC.     */
1414         /* Ridiculously small threads won't work, and they      */
1415         /* probably wouldn't work anyway.                       */
1416       }
1417 #   endif
1418     if (NULL == attr) {
1419         detachstate = PTHREAD_CREATE_JOINABLE;
1420     } else { 
1421         pthread_attr_getdetachstate(attr, &detachstate);
1422     }
1423     if (PTHREAD_CREATE_DETACHED == detachstate) my_flags |= DETACHED;
1424     si -> flags = my_flags;
1425     UNLOCK();
1426 #   ifdef DEBUG_THREADS
1427         GC_printf1("About to start new thread from thread 0x%X\n",
1428                    pthread_self());
1429 #   endif
1430
1431     result = REAL_FUNC(pthread_create)(new_thread, attr, GC_start_routine, si);
1432
1433 #   ifdef DEBUG_THREADS
1434         GC_printf1("Started thread 0x%X\n", *new_thread);
1435 #   endif
1436     /* Wait until child has been added to the thread table.             */
1437     /* This also ensures that we hold onto si until the child is done   */
1438     /* with it.  Thus it doesn't matter whether it is otherwise         */
1439     /* visible to the collector.                                        */
1440     if (0 == result) {
1441         while (0 != sem_wait(&(si -> registered))) {
1442             if (EINTR != errno) ABORT("sem_wait failed");
1443         }
1444     }
1445     sem_destroy(&(si -> registered));
1446     LOCK();
1447     GC_INTERNAL_FREE(si);
1448     UNLOCK();
1449
1450     return(result);
1451 }
1452
1453 #ifdef GENERIC_COMPARE_AND_SWAP
1454   pthread_mutex_t GC_compare_and_swap_lock = PTHREAD_MUTEX_INITIALIZER;
1455
1456   GC_bool GC_compare_and_exchange(volatile GC_word *addr,
1457                                   GC_word old, GC_word new_val)
1458   {
1459     GC_bool result;
1460     pthread_mutex_lock(&GC_compare_and_swap_lock);
1461     if (*addr == old) {
1462       *addr = new_val;
1463       result = TRUE;
1464     } else {
1465       result = FALSE;
1466     }
1467     pthread_mutex_unlock(&GC_compare_and_swap_lock);
1468     return result;
1469   }
1470   
1471   GC_word GC_atomic_add(volatile GC_word *addr, GC_word how_much)
1472   {
1473     GC_word old;
1474     pthread_mutex_lock(&GC_compare_and_swap_lock);
1475     old = *addr;
1476     *addr = old + how_much;
1477     pthread_mutex_unlock(&GC_compare_and_swap_lock);
1478     return old;
1479   }
1480
1481 #endif /* GENERIC_COMPARE_AND_SWAP */
1482 /* Spend a few cycles in a way that can't introduce contention with     */
1483 /* othre threads.                                                       */
1484 void GC_pause()
1485 {
1486     int i;
1487 #   if !defined(__GNUC__) || defined(__INTEL_COMPILER)
1488       volatile word dummy = 0;
1489 #   endif
1490
1491     for (i = 0; i < 10; ++i) { 
1492 #     if defined(__GNUC__) && !defined(__INTEL_COMPILER)
1493         __asm__ __volatile__ (" " : : : "memory");
1494 #     else
1495         /* Something that's unlikely to be optimized away. */
1496         GC_noop(++dummy);
1497 #     endif
1498     }
1499 }
1500     
1501 #define SPIN_MAX 128    /* Maximum number of calls to GC_pause before   */
1502                         /* give up.                                     */
1503
1504 VOLATILE GC_bool GC_collecting = 0;
1505                         /* A hint that we're in the collector and       */
1506                         /* holding the allocation lock for an           */
1507                         /* extended period.                             */
1508
1509 #if !defined(USE_SPIN_LOCK) || defined(PARALLEL_MARK)
1510 /* If we don't want to use the below spinlock implementation, either    */
1511 /* because we don't have a GC_test_and_set implementation, or because   */
1512 /* we don't want to risk sleeping, we can still try spinning on         */
1513 /* pthread_mutex_trylock for a while.  This appears to be very          */
1514 /* beneficial in many cases.                                            */
1515 /* I suspect that under high contention this is nearly always better    */
1516 /* than the spin lock.  But it's a bit slower on a uniprocessor.        */
1517 /* Hence we still default to the spin lock.                             */
1518 /* This is also used to acquire the mark lock for the parallel          */
1519 /* marker.                                                              */
1520
1521 /* Here we use a strict exponential backoff scheme.  I don't know       */
1522 /* whether that's better or worse than the above.  We eventually        */
1523 /* yield by calling pthread_mutex_lock(); it never makes sense to       */
1524 /* explicitly sleep.                                                    */
1525
1526 #define LOCK_STATS
1527 #ifdef LOCK_STATS
1528   unsigned long GC_spin_count = 0;
1529   unsigned long GC_block_count = 0;
1530   unsigned long GC_unlocked_count = 0;
1531 #endif
1532
1533 void GC_generic_lock(pthread_mutex_t * lock)
1534 {
1535 #ifndef NO_PTHREAD_TRYLOCK
1536     unsigned pause_length = 1;
1537     unsigned i;
1538     
1539     if (0 == pthread_mutex_trylock(lock)) {
1540 #       ifdef LOCK_STATS
1541             ++GC_unlocked_count;
1542 #       endif
1543         return;
1544     }
1545     for (; pause_length <= SPIN_MAX; pause_length <<= 1) {
1546         for (i = 0; i < pause_length; ++i) {
1547             GC_pause();
1548         }
1549         switch(pthread_mutex_trylock(lock)) {
1550             case 0:
1551 #               ifdef LOCK_STATS
1552                     ++GC_spin_count;
1553 #               endif
1554                 return;
1555             case EBUSY:
1556                 break;
1557             default:
1558                 ABORT("Unexpected error from pthread_mutex_trylock");
1559         }
1560     }
1561 #endif /* !NO_PTHREAD_TRYLOCK */
1562 #   ifdef LOCK_STATS
1563         ++GC_block_count;
1564 #   endif
1565     pthread_mutex_lock(lock);
1566 }
1567
1568 #endif /* !USE_SPIN_LOCK || PARALLEL_MARK */
1569
1570 #if defined(USE_SPIN_LOCK)
1571
1572 /* Reasonably fast spin locks.  Basically the same implementation */
1573 /* as STL alloc.h.  This isn't really the right way to do this.   */
1574 /* but until the POSIX scheduling mess gets straightened out ...  */
1575
1576 volatile unsigned int GC_allocate_lock = 0;
1577
1578
1579 void GC_lock()
1580 {
1581 #   define low_spin_max 30  /* spin cycles if we suspect uniprocessor */
1582 #   define high_spin_max SPIN_MAX /* spin cycles for multiprocessor */
1583     static unsigned spin_max = low_spin_max;
1584     unsigned my_spin_max;
1585     static unsigned last_spins = 0;
1586     unsigned my_last_spins;
1587     int i;
1588
1589     if (!GC_test_and_set(&GC_allocate_lock)) {
1590         return;
1591     }
1592     my_spin_max = spin_max;
1593     my_last_spins = last_spins;
1594     for (i = 0; i < my_spin_max; i++) {
1595         if (GC_collecting || GC_nprocs == 1) goto yield;
1596         if (i < my_last_spins/2 || GC_allocate_lock) {
1597             GC_pause();
1598             continue;
1599         }
1600         if (!GC_test_and_set(&GC_allocate_lock)) {
1601             /*
1602              * got it!
1603              * Spinning worked.  Thus we're probably not being scheduled
1604              * against the other process with which we were contending.
1605              * Thus it makes sense to spin longer the next time.
1606              */
1607             last_spins = i;
1608             spin_max = high_spin_max;
1609             return;
1610         }
1611     }
1612     /* We are probably being scheduled against the other process.  Sleep. */
1613     spin_max = low_spin_max;
1614 yield:
1615     for (i = 0;; ++i) {
1616         if (!GC_test_and_set(&GC_allocate_lock)) {
1617             return;
1618         }
1619 #       define SLEEP_THRESHOLD 12
1620                 /* Under Linux very short sleeps tend to wait until     */
1621                 /* the current time quantum expires.  On old Linux      */
1622                 /* kernels nanosleep(<= 2ms) just spins under Linux.    */
1623                 /* (Under 2.4, this happens only for real-time          */
1624                 /* processes.)  We want to minimize both behaviors      */
1625                 /* here.                                                */
1626         if (i < SLEEP_THRESHOLD) {
1627             sched_yield();
1628         } else {
1629             struct timespec ts;
1630         
1631             if (i > 24) i = 24;
1632                         /* Don't wait for more than about 15msecs, even */
1633                         /* under extreme contention.                    */
1634             ts.tv_sec = 0;
1635             ts.tv_nsec = 1 << i;
1636             nanosleep(&ts, 0);
1637         }
1638     }
1639 }
1640
1641 #else  /* !USE_SPINLOCK */
1642 void GC_lock()
1643 {
1644 #ifndef NO_PTHREAD_TRYLOCK
1645     if (1 == GC_nprocs || GC_collecting) {
1646         pthread_mutex_lock(&GC_allocate_ml);
1647     } else {
1648         GC_generic_lock(&GC_allocate_ml);
1649     }
1650 #else  /* !NO_PTHREAD_TRYLOCK */
1651     pthread_mutex_lock(&GC_allocate_ml);
1652 #endif /* !NO_PTHREAD_TRYLOCK */
1653 }
1654
1655 #endif /* !USE_SPINLOCK */
1656
1657 #if defined(PARALLEL_MARK) || defined(THREAD_LOCAL_ALLOC)
1658
1659 #ifdef GC_ASSERTIONS
1660   pthread_t GC_mark_lock_holder = NO_THREAD;
1661 #endif
1662
1663 #if 0
1664   /* Ugly workaround for a linux threads bug in the final versions      */
1665   /* of glibc2.1.  Pthread_mutex_trylock sets the mutex owner           */
1666   /* field even when it fails to acquire the mutex.  This causes        */
1667   /* pthread_cond_wait to die.  Remove for glibc2.2.                    */
1668   /* According to the man page, we should use                           */
1669   /* PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP, but that isn't actually   */
1670   /* defined.                                                           */
1671   static pthread_mutex_t mark_mutex =
1672         {0, 0, 0, PTHREAD_MUTEX_ERRORCHECK_NP, {0, 0}};
1673 #else
1674   static pthread_mutex_t mark_mutex = PTHREAD_MUTEX_INITIALIZER;
1675 #endif
1676
1677 static pthread_cond_t builder_cv = PTHREAD_COND_INITIALIZER;
1678
1679 void GC_acquire_mark_lock()
1680 {
1681 /*
1682     if (pthread_mutex_lock(&mark_mutex) != 0) {
1683         ABORT("pthread_mutex_lock failed");
1684     }
1685 */
1686     GC_generic_lock(&mark_mutex);
1687 #   ifdef GC_ASSERTIONS
1688         GC_mark_lock_holder = pthread_self();
1689 #   endif
1690 }
1691
1692 void GC_release_mark_lock()
1693 {
1694     GC_ASSERT(GC_mark_lock_holder == pthread_self());
1695 #   ifdef GC_ASSERTIONS
1696         GC_mark_lock_holder = NO_THREAD;
1697 #   endif
1698     if (pthread_mutex_unlock(&mark_mutex) != 0) {
1699         ABORT("pthread_mutex_unlock failed");
1700     }
1701 }
1702
1703 /* Collector must wait for a freelist builders for 2 reasons:           */
1704 /* 1) Mark bits may still be getting examined without lock.             */
1705 /* 2) Partial free lists referenced only by locals may not be scanned   */
1706 /*    correctly, e.g. if they contain "pointer-free" objects, since the */
1707 /*    free-list link may be ignored.                                    */
1708 void GC_wait_builder()
1709 {
1710     GC_ASSERT(GC_mark_lock_holder == pthread_self());
1711 #   ifdef GC_ASSERTIONS
1712         GC_mark_lock_holder = NO_THREAD;
1713 #   endif
1714     if (pthread_cond_wait(&builder_cv, &mark_mutex) != 0) {
1715         ABORT("pthread_cond_wait failed");
1716     }
1717     GC_ASSERT(GC_mark_lock_holder == NO_THREAD);
1718 #   ifdef GC_ASSERTIONS
1719         GC_mark_lock_holder = pthread_self();
1720 #   endif
1721 }
1722
1723 void GC_wait_for_reclaim()
1724 {
1725     GC_acquire_mark_lock();
1726     while (GC_fl_builder_count > 0) {
1727         GC_wait_builder();
1728     }
1729     GC_release_mark_lock();
1730 }
1731
1732 void GC_notify_all_builder()
1733 {
1734     GC_ASSERT(GC_mark_lock_holder == pthread_self());
1735     if (pthread_cond_broadcast(&builder_cv) != 0) {
1736         ABORT("pthread_cond_broadcast failed");
1737     }
1738 }
1739
1740 #endif /* PARALLEL_MARK || THREAD_LOCAL_ALLOC */
1741
1742 #ifdef PARALLEL_MARK
1743
1744 static pthread_cond_t mark_cv = PTHREAD_COND_INITIALIZER;
1745
1746 void GC_wait_marker()
1747 {
1748     GC_ASSERT(GC_mark_lock_holder == pthread_self());
1749 #   ifdef GC_ASSERTIONS
1750         GC_mark_lock_holder = NO_THREAD;
1751 #   endif
1752     if (pthread_cond_wait(&mark_cv, &mark_mutex) != 0) {
1753         ABORT("pthread_cond_wait failed");
1754     }
1755     GC_ASSERT(GC_mark_lock_holder == NO_THREAD);
1756 #   ifdef GC_ASSERTIONS
1757         GC_mark_lock_holder = pthread_self();
1758 #   endif
1759 }
1760
1761 void GC_notify_all_marker()
1762 {
1763     if (pthread_cond_broadcast(&mark_cv) != 0) {
1764         ABORT("pthread_cond_broadcast failed");
1765     }
1766 }
1767
1768 #endif /* PARALLEL_MARK */
1769
1770 # endif /* GC_LINUX_THREADS and friends */
1771