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