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