-
Notifications
You must be signed in to change notification settings - Fork 412
/
Copy pathpthread_stop_world.c
1488 lines (1347 loc) · 47.7 KB
/
pthread_stop_world.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 1994 by Xerox Corporation. All rights reserved.
* Copyright (c) 1996 by Silicon Graphics. All rights reserved.
* Copyright (c) 1998 by Fergus Henderson. All rights reserved.
* Copyright (c) 2000-2009 by Hewlett-Packard Development Company.
* All rights reserved.
* Copyright (c) 2008-2022 Ivan Maidanski
*
* THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
* OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
*
* Permission is hereby granted to use or copy this program
* for any purpose, provided the above notices are retained on all copies.
* Permission to modify the code and to distribute modified code is granted,
* provided the above notices are retained, and a notice that the code was
* modified is included with the above copyright notice.
*/
#include "private/pthread_support.h"
#ifdef PTHREAD_STOP_WORLD_IMPL
# ifdef NACL
# include <sys/time.h>
# else
# include <errno.h>
# include <semaphore.h>
# include <signal.h>
# include <time.h>
# endif /* !NACL */
# ifdef E2K
# include <alloca.h>
# endif
GC_INLINE void
GC_usleep(unsigned us)
{
# if defined(LINT2) || defined(THREAD_SANITIZER)
/* Workaround "waiting while holding a lock" static analyzer warning. */
/* Workaround a rare hang in usleep() trying to acquire TSan Lock. */
while (us-- > 0) {
/* Sleep for a moment, pretending it takes 1us. */
sched_yield();
}
# elif defined(CPPCHECK) /* || _POSIX_C_SOURCE >= 199309L */
struct timespec ts;
ts.tv_sec = 0;
ts.tv_nsec = (unsigned32)us * 1000;
/* This requires _POSIX_TIMERS feature. */
(void)nanosleep(&ts, NULL);
# else
usleep(us);
# endif
}
# ifdef NACL
STATIC int GC_nacl_num_gc_threads = 0;
STATIC volatile int GC_nacl_park_threads_now = 0;
STATIC volatile pthread_t GC_nacl_thread_parker = -1;
STATIC __thread int GC_nacl_thread_idx = -1;
/* TODO: Use GC_get_tlfs() instead. */
STATIC __thread GC_thread GC_nacl_gc_thread_self = NULL;
volatile int GC_nacl_thread_parked[MAX_NACL_GC_THREADS];
int GC_nacl_thread_used[MAX_NACL_GC_THREADS];
# else /* !NACL */
# if (!defined(AO_HAVE_load_acquire) || !defined(AO_HAVE_store_release)) \
&& !defined(CPPCHECK)
# error AO_load_acquire and/or AO_store_release are missing;
# error please define AO_REQUIRE_CAS manually
# endif
# ifdef DEBUG_THREADS
/* It's safe to call original pthread_sigmask() here. */
# undef pthread_sigmask
# ifndef NSIG
# ifdef CPPCHECK
# define NSIG 32
# elif defined(MAXSIG)
# define NSIG (MAXSIG + 1)
# elif defined(_NSIG)
# define NSIG _NSIG
# elif defined(__SIGRTMAX)
# define NSIG (__SIGRTMAX + 1)
# else
# error define NSIG
# endif
# endif
void
GC_print_sig_mask(void)
{
sigset_t blocked;
int i;
if (pthread_sigmask(SIG_BLOCK, NULL, &blocked) != 0)
ABORT("pthread_sigmask failed");
for (i = 1; i < NSIG; i++) {
if (sigismember(&blocked, i))
GC_printf("Signal blocked: %d\n", i);
}
}
# endif /* DEBUG_THREADS */
/* Remove the signals that we want to allow in thread stopping */
/* handler from a set. */
STATIC void
GC_remove_allowed_signals(sigset_t *set)
{
if (sigdelset(set, SIGINT) != 0 || sigdelset(set, SIGQUIT) != 0
|| sigdelset(set, SIGABRT) != 0 || sigdelset(set, SIGTERM) != 0) {
ABORT("sigdelset failed");
}
# ifdef MPROTECT_VDB
/* Handlers write to the thread structure, which is in the heap, */
/* and hence can trigger a protection fault. */
if (sigdelset(set, SIGSEGV) != 0
# ifdef HAVE_SIGBUS
|| sigdelset(set, SIGBUS) != 0
# endif
) {
ABORT("sigdelset failed");
}
# endif
}
static sigset_t suspend_handler_mask;
# define THREAD_RESTARTED 0x1
/* Incremented (to the nearest even value) at the beginning of */
/* GC_stop_world() (or when a thread is requested to be suspended by */
/* GC_suspend_thread) and once more (to an odd value) at the beginning */
/* of GC_start_world(). The lowest bit is THREAD_RESTARTED one which, */
/* if set, means it is safe for threads to restart, i.e. they will see */
/* another suspend signal before they are expected to stop (unless they */
/* have stopped voluntarily). */
STATIC volatile AO_t GC_stop_count;
STATIC GC_bool GC_retry_signals = FALSE;
/*
* We use signals to stop threads during GC.
*
* Suspended threads wait in signal handler for SIG_THR_RESTART.
* That's more portable than semaphores or condition variables.
* (We do use sem_post from a signal handler, but that should be portable.)
*
* The thread suspension signal SIG_SUSPEND is now defined in gc_priv.h.
* Note that we can't just stop a thread; we need it to save its stack
* pointer(s) and acknowledge.
*/
# ifndef SIG_THR_RESTART
# if defined(SUSPEND_HANDLER_NO_CONTEXT) || defined(GC_REUSE_SIG_SUSPEND)
/* Reuse the suspend signal. */
# define SIG_THR_RESTART SIG_SUSPEND
# elif defined(HPUX) || defined(NETBSD) || defined(OSF1) \
|| defined(GC_USESIGRT_SIGNALS)
# if defined(_SIGRTMIN) && !defined(CPPCHECK)
# define SIG_THR_RESTART (_SIGRTMIN + 5)
# else
# define SIG_THR_RESTART (SIGRTMIN + 5)
# endif
# elif defined(FREEBSD) && defined(__GLIBC__)
# define SIG_THR_RESTART (32 + 5)
# elif defined(FREEBSD) || defined(HURD) || defined(RTEMS)
# define SIG_THR_RESTART SIGUSR2
# else
# define SIG_THR_RESTART SIGXCPU
# endif
# endif /* !SIG_THR_RESTART */
# define SIGNAL_UNSET (-1)
/* Since SIG_SUSPEND and/or SIG_THR_RESTART could represent */
/* a non-constant expression (e.g., in case of SIGRTMIN), actual signal */
/* numbers are determined by GC_stop_init() unless manually set (before */
/* GC initialization). Might be set to the same signal number. */
STATIC int GC_sig_suspend = SIGNAL_UNSET;
STATIC int GC_sig_thr_restart = SIGNAL_UNSET;
GC_API void GC_CALL
GC_set_suspend_signal(int sig)
{
if (GC_is_initialized)
return;
GC_sig_suspend = sig;
}
GC_API void GC_CALL
GC_set_thr_restart_signal(int sig)
{
if (GC_is_initialized)
return;
GC_sig_thr_restart = sig;
}
GC_API int GC_CALL
GC_get_suspend_signal(void)
{
return GC_sig_suspend != SIGNAL_UNSET ? GC_sig_suspend : SIG_SUSPEND;
}
GC_API int GC_CALL
GC_get_thr_restart_signal(void)
{
return GC_sig_thr_restart != SIGNAL_UNSET ? GC_sig_thr_restart
: SIG_THR_RESTART;
}
# ifdef BASE_ATOMIC_OPS_EMULATED
/* The AO primitives emulated with locks cannot be used inside signal */
/* handlers as this could cause a deadlock or a double lock. */
/* The following "async" macro definitions are correct only for */
/* an uniprocessor case and are provided for a test purpose. */
# define ao_load_acquire_async(p) (*(p))
# define ao_load_async(p) ao_load_acquire_async(p)
# define ao_store_release_async(p, v) (void)(*(p) = (v))
# define ao_cptr_store_async(p, v) (void)(*(p) = (v))
# else
# define ao_load_acquire_async(p) AO_load_acquire(p)
# define ao_load_async(p) AO_load(p)
# define ao_store_release_async(p, v) AO_store_release(p, v)
# define ao_cptr_store_async(p, v) GC_cptr_store(p, v)
# endif /* !BASE_ATOMIC_OPS_EMULATED */
/* Note: this is also used to acknowledge restart. */
STATIC sem_t GC_suspend_ack_sem;
STATIC void GC_suspend_handler_inner(ptr_t dummy, void *context);
# ifdef SUSPEND_HANDLER_NO_CONTEXT
STATIC void
GC_suspend_handler(int sig)
# else
STATIC void
GC_suspend_sigaction(int sig, siginfo_t *info, void *context)
# endif
{
int old_errno = errno;
if (sig != GC_sig_suspend) {
# ifdef FREEBSD
/* Workaround "deferred signal handling" bug in FreeBSD 9.2. */
if (0 == sig)
return;
# endif
ABORT("Bad signal in suspend_handler");
}
# ifdef SUSPEND_HANDLER_NO_CONTEXT
/* A quick check if the signal is called to restart the world. */
if ((ao_load_async(&GC_stop_count) & THREAD_RESTARTED) != 0)
return;
GC_with_callee_saves_pushed(GC_suspend_handler_inner, NULL);
# else
UNUSED_ARG(info);
/* We believe that in this case the full context is already */
/* in the signal handler frame. */
GC_suspend_handler_inner(NULL, context);
# endif
errno = old_errno;
}
/* The lookup here is safe, since this is done on behalf */
/* of a thread which holds the allocator lock in order */
/* to stop the world. Thus concurrent modification of the */
/* data structure is impossible. Unfortunately, we have to */
/* instruct TSan that the lookup is safe. */
# ifdef THREAD_SANITIZER
/* Almost same as GC_self_thread_inner() except for the */
/* no-sanitize attribute added and the result is never NULL. */
GC_ATTR_NO_SANITIZE_THREAD
static GC_thread
GC_lookup_self_thread_async(void)
{
thread_id_t self_id = thread_id_self();
GC_thread p = GC_threads[THREAD_TABLE_INDEX(self_id)];
for (;; p = p->tm.next) {
if (THREAD_EQUAL(p->id, self_id))
break;
}
return p;
}
# else
# define GC_lookup_self_thread_async() GC_self_thread_inner()
# endif
GC_INLINE void
GC_store_stack_ptr(GC_stack_context_t crtn)
{
/* There is no data race between the suspend handler (storing */
/* stack_ptr) and GC_push_all_stacks (fetching stack_ptr) because */
/* GC_push_all_stacks is executed after GC_stop_world exits and the */
/* latter runs sem_wait repeatedly waiting for all the suspended */
/* threads to call sem_post. Nonetheless, stack_ptr is stored (here) */
/* and fetched (by GC_push_all_stacks) using the atomic primitives to */
/* avoid the related TSan warning. */
# ifdef SPARC
ao_cptr_store_async(&crtn->stack_ptr, GC_save_regs_in_stack());
/* TODO: regs saving already done by GC_with_callee_saves_pushed */
# else
# ifdef IA64
crtn->backing_store_ptr = GC_save_regs_in_stack();
# endif
ao_cptr_store_async(&crtn->stack_ptr, GC_approx_sp());
# endif
}
STATIC void
GC_suspend_handler_inner(ptr_t dummy, void *context)
{
GC_thread me;
GC_stack_context_t crtn;
# ifdef E2K
ptr_t bs_lo;
size_t stack_size;
# endif
IF_CANCEL(int cancel_state;)
# ifdef GC_ENABLE_SUSPEND_THREAD
AO_t suspend_cnt;
# endif
AO_t my_stop_count = ao_load_acquire_async(&GC_stop_count);
/* After the barrier, this thread should see the actual content of */
/* GC_threads. */
UNUSED_ARG(dummy);
UNUSED_ARG(context);
if ((my_stop_count & THREAD_RESTARTED) != 0) {
/* Restarting the world. */
return;
}
/* pthread_setcancelstate() is not defined to be async-signal-safe. */
/* But the glibc version appears to be in the absence of asynchronous */
/* cancellation. And since this signal handler to block on */
/* sigsuspend, which is both async-signal-safe and a cancellation */
/* point, there seems to be no obvious way out of it. In fact, it */
/* looks to me like an async-signal-safe cancellation point is */
/* inherently a problem, unless there is some way to disable */
/* cancellation in the handler. */
DISABLE_CANCEL(cancel_state);
# ifdef DEBUG_THREADS
GC_log_printf("Suspending %p\n", PTHREAD_TO_VPTR(pthread_self()));
# endif
me = GC_lookup_self_thread_async();
if ((me->last_stop_count & ~(word)THREAD_RESTARTED) == my_stop_count) {
/* Duplicate signal. OK if we are retrying. */
if (!GC_retry_signals) {
WARN("Duplicate suspend signal in thread %p\n", pthread_self());
}
RESTORE_CANCEL(cancel_state);
return;
}
crtn = me->crtn;
GC_store_stack_ptr(crtn);
# ifdef E2K
GC_ASSERT(NULL == crtn->backing_store_end);
GET_PROCEDURE_STACK_LOCAL(crtn->ps_ofs, &bs_lo, &stack_size);
crtn->backing_store_end = bs_lo;
crtn->backing_store_ptr = bs_lo + stack_size;
# endif
# ifdef GC_ENABLE_SUSPEND_THREAD
suspend_cnt = ao_load_async(&me->ext_suspend_cnt);
# endif
/* Tell the thread that wants to stop the world that this */
/* thread has been stopped. Note that sem_post() is */
/* the only async-signal-safe primitive in LinuxThreads. */
sem_post(&GC_suspend_ack_sem);
ao_store_release_async(&me->last_stop_count, my_stop_count);
/* Wait until that thread tells us to restart by sending */
/* this thread a GC_sig_thr_restart signal (should be masked */
/* at this point thus there is no race). */
/* We do not continue until we receive that signal, */
/* but we do not take that as authoritative. (We may be */
/* accidentally restarted by one of the user signals we */
/* don't block.) After we receive the signal, we use a */
/* primitive and expensive mechanism to wait until it's */
/* really safe to proceed. Under normal circumstances, */
/* this code should not be executed. */
do {
sigsuspend(&suspend_handler_mask);
/* Iterate while not restarting the world or thread is suspended. */
} while (ao_load_acquire_async(&GC_stop_count) == my_stop_count
# ifdef GC_ENABLE_SUSPEND_THREAD
|| ((suspend_cnt & 1) != 0
&& ao_load_async(&me->ext_suspend_cnt) == suspend_cnt)
# endif
);
# ifdef DEBUG_THREADS
GC_log_printf("Resuming %p\n", PTHREAD_TO_VPTR(pthread_self()));
# endif
# ifdef E2K
GC_ASSERT(crtn->backing_store_end == bs_lo);
crtn->backing_store_ptr = NULL;
crtn->backing_store_end = NULL;
# endif
# ifndef GC_NETBSD_THREADS_WORKAROUND
if (GC_retry_signals || GC_sig_suspend == GC_sig_thr_restart)
# endif
{
/* If the RESTART signal loss is possible (though it should be */
/* less likely than losing the SUSPEND signal as we do not do */
/* much between the first sem_post and sigsuspend calls), more */
/* handshaking is provided to work around it. */
sem_post(&GC_suspend_ack_sem);
/* Set the flag that the thread has been restarted. */
if (GC_retry_signals)
ao_store_release_async(&me->last_stop_count,
my_stop_count | THREAD_RESTARTED);
}
RESTORE_CANCEL(cancel_state);
}
static void
suspend_restart_barrier(int n_live_threads)
{
int i;
for (i = 0; i < n_live_threads; i++) {
while (sem_wait(&GC_suspend_ack_sem) == -1) {
/* On Linux, sem_wait is documented to always return zero. */
/* But the documentation appears to be incorrect. */
/* EINTR seems to happen with some versions of gdb. */
if (errno != EINTR)
ABORT("sem_wait failed");
}
}
# ifdef GC_ASSERTIONS
sem_getvalue(&GC_suspend_ack_sem, &i);
GC_ASSERT(0 == i);
# endif
}
# define WAIT_UNIT 3000 /* us */
static int
resend_lost_signals(int n_live_threads, int (*suspend_restart_all)(void))
{
# define RESEND_SIGNALS_LIMIT 150
# define RETRY_INTERVAL 100000 /* us */
if (n_live_threads > 0) {
unsigned long wait_usecs = 0; /* total wait since retry */
int retry = 0;
int prev_sent = 0;
for (;;) {
int ack_count;
sem_getvalue(&GC_suspend_ack_sem, &ack_count);
if (ack_count == n_live_threads)
break;
if (wait_usecs > RETRY_INTERVAL) {
int newly_sent = suspend_restart_all();
if (newly_sent != prev_sent) {
/* Restart the counter. */
retry = 0;
} else if (++retry >= RESEND_SIGNALS_LIMIT) {
/* No progress. */
ABORT_ARG1("Signals delivery fails constantly", " at GC #%lu",
(unsigned long)GC_gc_no);
}
GC_COND_LOG_PRINTF("Resent %d signals after timeout, retry: %d\n",
newly_sent, retry);
sem_getvalue(&GC_suspend_ack_sem, &ack_count);
if (newly_sent < n_live_threads - ack_count) {
WARN("Lost some threads while stopping or starting world?!\n", 0);
n_live_threads = ack_count + newly_sent;
}
prev_sent = newly_sent;
wait_usecs = 0;
}
GC_usleep(WAIT_UNIT);
wait_usecs += WAIT_UNIT;
}
}
return n_live_threads;
}
# ifdef HAVE_CLOCK_GETTIME
# define TS_NSEC_ADD(ts, ns) \
(ts.tv_nsec += (ns), \
(void)(ts.tv_nsec >= 1000000L * 1000 \
? (ts.tv_nsec -= 1000000L * 1000, ts.tv_sec++, 0) \
: 0))
# endif
static void
resend_lost_signals_retry(int n_live_threads, int (*suspend_restart_all)(void))
{
# if defined(HAVE_CLOCK_GETTIME) && !defined(DONT_TIMEDWAIT_ACK_SEM)
# define TIMEOUT_BEFORE_RESEND 10000 /* us */
struct timespec ts;
if (n_live_threads > 0 && clock_gettime(CLOCK_REALTIME, &ts) == 0) {
int i;
TS_NSEC_ADD(ts, TIMEOUT_BEFORE_RESEND * (unsigned32)1000);
/* First, try to wait for the semaphore with some timeout. */
/* On failure, fallback to WAIT_UNIT pause and resend of the signal. */
for (i = 0; i < n_live_threads; i++) {
if (sem_timedwait(&GC_suspend_ack_sem, &ts) == -1)
break; /* Wait timed out or any other error. */
}
/* Update the count of threads to wait the ack from. */
n_live_threads -= i;
}
# endif
n_live_threads = resend_lost_signals(n_live_threads, suspend_restart_all);
suspend_restart_barrier(n_live_threads);
}
STATIC void
GC_restart_handler(int sig)
{
# ifdef DEBUG_THREADS
/* Preserve errno value. */
int old_errno = errno;
# endif
if (sig != GC_sig_thr_restart)
ABORT("Bad signal in restart handler");
/* Note: even if we do not do anything useful here, it would still */
/* be necessary to have a signal handler, rather than ignoring the */
/* signals, otherwise the signals will not be delivered at all, */
/* and will thus not interrupt the sigsuspend() above. */
# ifdef DEBUG_THREADS
GC_log_printf("In GC_restart_handler for %p\n",
PTHREAD_TO_VPTR(pthread_self()));
errno = old_errno;
# endif
}
# ifdef USE_TKILL_ON_ANDROID
EXTERN_C_BEGIN
extern int tkill(pid_t tid, int sig); /* from sys/linux-unistd.h */
EXTERN_C_END
# define THREAD_SYSTEM_ID(t) (t)->kernel_id
# else
# define THREAD_SYSTEM_ID(t) (t)->id
# endif
# ifndef RETRY_TKILL_EAGAIN_LIMIT
# define RETRY_TKILL_EAGAIN_LIMIT 16
# endif
static int
raise_signal(GC_thread p, int sig)
{
int res;
# ifdef RETRY_TKILL_ON_EAGAIN
int retry;
# endif
# if defined(SIMULATE_LOST_SIGNALS) && !defined(GC_ENABLE_SUSPEND_THREAD)
# ifndef LOST_SIGNALS_RATIO
# define LOST_SIGNALS_RATIO 25
# endif
/* Note: race is OK, it is for test purpose only. */
static int signal_cnt;
if (GC_retry_signals && (++signal_cnt) % LOST_SIGNALS_RATIO == 0) {
/* Simulate the signal is sent but lost. */
return 0;
}
# endif
# ifdef RETRY_TKILL_ON_EAGAIN
for (retry = 0;; retry++)
# endif
{
# ifdef USE_TKILL_ON_ANDROID
int old_errno = errno;
res = tkill(THREAD_SYSTEM_ID(p), sig);
if (res < 0) {
res = errno;
errno = old_errno;
}
# else
res = pthread_kill(THREAD_SYSTEM_ID(p), sig);
# endif
# ifdef RETRY_TKILL_ON_EAGAIN
if (res != EAGAIN || retry >= RETRY_TKILL_EAGAIN_LIMIT)
break;
/* A temporal overflow of the real-time signal queue. */
GC_usleep(WAIT_UNIT);
# endif
}
return res;
}
# ifdef GC_ENABLE_SUSPEND_THREAD
# include <sys/time.h>
/* This is to get the prototypes as extern "C". */
# include "gc/javaxfc.h"
STATIC void
GC_brief_async_signal_safe_sleep(void)
{
struct timeval tv;
tv.tv_sec = 0;
# if defined(GC_TIME_LIMIT) && !defined(CPPCHECK)
tv.tv_usec = 1000 * GC_TIME_LIMIT / 2;
# else
tv.tv_usec = 1000 * 15 / 2;
# endif
(void)select(0, 0, 0, 0, &tv);
}
GC_INNER void
GC_suspend_self_inner(GC_thread me, size_t suspend_cnt)
{
IF_CANCEL(int cancel_state;)
GC_ASSERT((suspend_cnt & 1) != 0);
DISABLE_CANCEL(cancel_state);
# ifdef DEBUG_THREADS
GC_log_printf("Suspend self: %p\n", THREAD_ID_TO_VPTR(me->id));
# endif
while (ao_load_acquire_async(&me->ext_suspend_cnt) == suspend_cnt) {
/* TODO: Use sigsuspend() even for self-suspended threads. */
GC_brief_async_signal_safe_sleep();
}
# ifdef DEBUG_THREADS
GC_log_printf("Resume self: %p\n", THREAD_ID_TO_VPTR(me->id));
# endif
RESTORE_CANCEL(cancel_state);
}
GC_API void GC_CALL
GC_suspend_thread(GC_SUSPEND_THREAD_ID thread)
{
GC_thread t;
AO_t next_stop_count;
AO_t suspend_cnt;
IF_CANCEL(int cancel_state;)
LOCK();
t = GC_lookup_by_pthread((pthread_t)thread);
if (NULL == t) {
UNLOCK();
return;
}
suspend_cnt = t->ext_suspend_cnt;
if ((suspend_cnt & 1) != 0) /* already suspended? */ {
GC_ASSERT(!THREAD_EQUAL((pthread_t)thread, pthread_self()));
UNLOCK();
return;
}
if ((t->flags & (FINISHED | DO_BLOCKING)) != 0) {
t->ext_suspend_cnt = suspend_cnt | 1; /* suspend */
/* Terminated but not joined yet, or in do-blocking state. */
UNLOCK();
return;
}
if (THREAD_EQUAL((pthread_t)thread, pthread_self())) {
t->ext_suspend_cnt = suspend_cnt | 1;
GC_with_callee_saves_pushed(GC_suspend_self_blocked, (ptr_t)t);
UNLOCK();
return;
}
/* GC_suspend_thread is not a cancellation point. */
DISABLE_CANCEL(cancel_state);
# ifdef PARALLEL_MARK
/* Ensure we do not suspend a thread while it is rebuilding */
/* a free list, otherwise such a deadlock is possible: */
/* thread 1 is blocked in GC_wait_for_reclaim holding */
/* the allocator lock, thread 2 is suspended in */
/* GC_reclaim_generic invoked from GC_generic_malloc_many */
/* (with GC_fl_builder_count > 0), and thread 3 is blocked */
/* acquiring the allocator lock in GC_resume_thread. */
if (GC_parallel)
GC_wait_for_reclaim();
# endif
if (GC_manual_vdb) {
/* See the relevant comment in GC_stop_world. */
GC_acquire_dirty_lock();
}
/* Else do not acquire the dirty lock as the write fault handler */
/* might be trying to acquire it too, and the suspend handler */
/* execution is deferred until the write fault handler completes. */
next_stop_count = GC_stop_count + THREAD_RESTARTED;
GC_ASSERT((next_stop_count & THREAD_RESTARTED) == 0);
AO_store(&GC_stop_count, next_stop_count);
/* Set the flag making the change visible to the signal handler. */
AO_store_release(&t->ext_suspend_cnt, suspend_cnt | 1);
/* TODO: Support GC_retry_signals (not needed for TSan) */
switch (raise_signal(t, GC_sig_suspend)) {
/* ESRCH cannot happen as terminated threads are handled above. */
case 0:
break;
default:
ABORT("pthread_kill failed");
}
/* Wait for the thread to complete threads table lookup and */
/* stack_ptr assignment. */
GC_ASSERT(GC_thr_initialized);
suspend_restart_barrier(1);
if (GC_manual_vdb)
GC_release_dirty_lock();
AO_store(&GC_stop_count, next_stop_count | THREAD_RESTARTED);
RESTORE_CANCEL(cancel_state);
UNLOCK();
}
GC_API void GC_CALL
GC_resume_thread(GC_SUSPEND_THREAD_ID thread)
{
GC_thread t;
LOCK();
t = GC_lookup_by_pthread((pthread_t)thread);
if (t != NULL) {
AO_t suspend_cnt = t->ext_suspend_cnt;
if ((suspend_cnt & 1) != 0) /* is suspended? */ {
GC_ASSERT((GC_stop_count & THREAD_RESTARTED) != 0);
/* Mark the thread as not suspended - it will be resumed shortly. */
AO_store(&t->ext_suspend_cnt, suspend_cnt + 1);
if ((t->flags & (FINISHED | DO_BLOCKING)) == 0) {
int result = raise_signal(t, GC_sig_thr_restart);
/* TODO: Support signal resending on GC_retry_signals */
if (result != 0)
ABORT_ARG1("pthread_kill failed in GC_resume_thread",
": errcode= %d", result);
# ifndef GC_NETBSD_THREADS_WORKAROUND
if (GC_retry_signals || GC_sig_suspend == GC_sig_thr_restart)
# endif
{
IF_CANCEL(int cancel_state;)
DISABLE_CANCEL(cancel_state);
suspend_restart_barrier(1);
RESTORE_CANCEL(cancel_state);
}
}
}
}
UNLOCK();
}
GC_API int GC_CALL
GC_is_thread_suspended(GC_SUSPEND_THREAD_ID thread)
{
GC_thread t;
int is_suspended = 0;
READER_LOCK();
t = GC_lookup_by_pthread((pthread_t)thread);
if (t != NULL && (t->ext_suspend_cnt & 1) != 0)
is_suspended = (int)TRUE;
READER_UNLOCK();
return is_suspended;
}
# endif /* GC_ENABLE_SUSPEND_THREAD */
# undef ao_cptr_store_async
# undef ao_load_acquire_async
# undef ao_load_async
# undef ao_store_release_async
# endif /* !NACL */
/* Should do exactly the right thing if the world is stopped; should */
/* not fail if it is not. */
GC_INNER void
GC_push_all_stacks(void)
{
GC_bool found_me = FALSE;
size_t nthreads = 0;
int i;
GC_thread p;
ptr_t lo; /* stack top (sp) */
ptr_t hi; /* bottom */
# if defined(E2K) || defined(IA64)
/* We also need to scan the register backing store. */
ptr_t bs_lo, bs_hi;
# endif
struct GC_traced_stack_sect_s *traced_stack_sect;
pthread_t self = pthread_self();
word total_size = 0;
GC_ASSERT(I_HOLD_LOCK());
GC_ASSERT(GC_thr_initialized);
# ifdef DEBUG_THREADS
GC_log_printf("Pushing stacks from thread %p\n", PTHREAD_TO_VPTR(self));
# endif
for (i = 0; i < THREAD_TABLE_SZ; i++) {
for (p = GC_threads[i]; p != NULL; p = p->tm.next) {
# if defined(E2K) || defined(IA64)
GC_bool is_self = FALSE;
# endif
GC_stack_context_t crtn = p->crtn;
GC_ASSERT(THREAD_TABLE_INDEX(p->id) == i);
if (KNOWN_FINISHED(p))
continue;
++nthreads;
traced_stack_sect = crtn->traced_stack_sect;
if (THREAD_EQUAL(p->id, self)) {
GC_ASSERT((p->flags & DO_BLOCKING) == 0);
# ifdef SPARC
lo = GC_save_regs_in_stack();
# else
lo = GC_approx_sp();
# ifdef IA64
bs_hi = GC_save_regs_in_stack();
# elif defined(E2K)
{
size_t stack_size;
GC_ASSERT(NULL == crtn->backing_store_end);
GET_PROCEDURE_STACK_LOCAL(crtn->ps_ofs, &bs_lo, &stack_size);
bs_hi = bs_lo + stack_size;
}
# endif
# endif
found_me = TRUE;
# if defined(E2K) || defined(IA64)
is_self = TRUE;
# endif
} else {
lo = GC_cptr_load(&crtn->stack_ptr);
# ifdef IA64
bs_hi = crtn->backing_store_ptr;
# elif defined(E2K)
bs_lo = crtn->backing_store_end;
bs_hi = crtn->backing_store_ptr;
# endif
if (traced_stack_sect != NULL
&& traced_stack_sect->saved_stack_ptr == lo) {
/* If the thread has never been stopped since the recent */
/* GC_call_with_gc_active invocation then skip the top */
/* "stack section" as stack_ptr already points to. */
traced_stack_sect = traced_stack_sect->prev;
}
}
hi = crtn->stack_end;
# ifdef IA64
bs_lo = crtn->backing_store_end;
# endif
# ifdef DEBUG_THREADS
# ifdef STACK_GROWS_UP
GC_log_printf("Stack for thread %p is (%p,%p]\n",
THREAD_ID_TO_VPTR(p->id), (void *)hi, (void *)lo);
# else
GC_log_printf("Stack for thread %p is [%p,%p)\n",
THREAD_ID_TO_VPTR(p->id), (void *)lo, (void *)hi);
# endif
# endif
if (NULL == lo)
ABORT("GC_push_all_stacks: sp not set!");
if (crtn->altstack != NULL && ADDR_GE(lo, crtn->altstack)
&& ADDR_GE(crtn->altstack + crtn->altstack_size, lo)) {
# ifdef STACK_GROWS_UP
hi = crtn->altstack;
# else
hi = crtn->altstack + crtn->altstack_size;
# endif
/* FIXME: Need to scan the normal stack too, but how ? */
}
# ifdef STACKPTR_CORRECTOR_AVAILABLE
if (GC_sp_corrector != 0)
GC_sp_corrector((void **)&lo, THREAD_ID_TO_VPTR(p->id));
# endif
GC_push_all_stack_sections(lo, hi, traced_stack_sect);
# ifdef STACK_GROWS_UP
total_size += lo - hi;
# else
total_size += hi - lo; /* lo <= hi */
# endif
# ifdef NACL
/* Push reg_storage as roots, this will cover the reg context. */
GC_push_all_stack((ptr_t)p->reg_storage,
(ptr_t)(p->reg_storage + NACL_GC_REG_STORAGE_SIZE));
total_size += NACL_GC_REG_STORAGE_SIZE * sizeof(ptr_t);
# endif
# ifdef E2K
if ((GC_stop_count & THREAD_RESTARTED) != 0
# ifdef GC_ENABLE_SUSPEND_THREAD
&& (p->ext_suspend_cnt & 1) == 0
# endif
&& !is_self && (p->flags & DO_BLOCKING) == 0) {
/* Procedure stack buffer has already been freed. */
continue;
}
# endif
# if defined(E2K) || defined(IA64)
# ifdef DEBUG_THREADS
GC_log_printf("Reg stack for thread %p is [%p,%p)\n",
THREAD_ID_TO_VPTR(p->id), (void *)bs_lo, (void *)bs_hi);
# endif
GC_ASSERT(bs_lo != NULL && bs_hi != NULL);
/* FIXME: This (if is_self) may add an unbounded number of */
/* entries, and hence overflow the mark stack, which is bad. */
# ifdef IA64
GC_push_all_register_sections(bs_lo, bs_hi, is_self, traced_stack_sect);
# else
if (is_self) {
GC_push_all_eager(bs_lo, bs_hi);
} else {
GC_push_all_stack(bs_lo, bs_hi);
}
# endif
total_size += bs_hi - bs_lo; /* bs_lo <= bs_hi */
# endif
}
}
GC_VERBOSE_LOG_PRINTF("Pushed %d thread stacks\n", (int)nthreads);
if (!found_me && !GC_in_thread_creation)
ABORT("Collecting from unknown thread");
GC_total_stacksize = total_size;
}
# ifdef DEBUG_THREADS
/* There seems to be a very rare thread stopping problem. To help us */
/* debug that, we save the ids of the stopping thread. */
pthread_t GC_stopping_thread;
int GC_stopping_pid = 0;
# endif
/* Suspend all threads that might still be running. Return the number */
/* of suspend signals that were sent. */
STATIC int
GC_suspend_all(void)
{
int n_live_threads = 0;
int i;
# ifndef NACL
GC_thread p;
pthread_t self = pthread_self();
int result;
GC_ASSERT((GC_stop_count & THREAD_RESTARTED) == 0);
GC_ASSERT(I_HOLD_LOCK());
for (i = 0; i < THREAD_TABLE_SZ; i++) {
for (p = GC_threads[i]; p != NULL; p = p->tm.next) {
if (!THREAD_EQUAL(p->id, self)) {
if ((p->flags & (FINISHED | DO_BLOCKING)) != 0)
continue;
# ifdef GC_ENABLE_SUSPEND_THREAD
if ((p->ext_suspend_cnt & 1) != 0)
continue;
# endif
if (AO_load(&p->last_stop_count) == GC_stop_count) {
/* Matters only if GC_retry_signals. */
continue;
}
n_live_threads++;
# ifdef DEBUG_THREADS
GC_log_printf("Sending suspend signal to %p\n",
THREAD_ID_TO_VPTR(p->id));
# endif
/* The synchronization between GC_dirty (based on */
/* test-and-set) and the signal-based thread suspension */
/* is performed in GC_stop_world because */
/* GC_release_dirty_lock cannot be called before */
/* acknowledging the thread is really suspended. */
result = raise_signal(p, GC_sig_suspend);
switch (result) {
case ESRCH:
/* Not really there anymore. Possible? */
n_live_threads--;
break;
case 0:
if (GC_on_thread_event) {
/* Note: thread id might be truncated. */
GC_on_thread_event(GC_EVENT_THREAD_SUSPENDED,
THREAD_ID_TO_VPTR(THREAD_SYSTEM_ID(p)));