[5d1093]: src / runtime / thread.c Maximize Restore History

Download this file

thread.c    1104 lines (1009 with data), 37.5 kB

   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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
/*
* This software is part of the SBCL system. See the README file for
* more information.
*
* This software is derived from the CMU CL system, which was
* written at Carnegie Mellon University and released into the
* public domain. The software is in the public domain and is
* provided with absolutely no warranty. See the COPYING and CREDITS
* files for more information.
*/
#include "sbcl.h"
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#ifndef LISP_FEATURE_WIN32
#include <sched.h>
#endif
#include "runtime.h"
#include <stddef.h>
#include <errno.h>
#include <sys/types.h>
#ifndef LISP_FEATURE_WIN32
#include <sys/wait.h>
#endif
#ifdef LISP_FEATURE_MACH_EXCEPTION_HANDLER
#include <mach/mach.h>
#include <mach/mach_error.h>
#include <mach/mach_types.h>
#endif
#include "runtime.h"
#include "validate.h" /* for BINDING_STACK_SIZE etc */
#include "thread.h"
#include "arch.h"
#include "target-arch-os.h"
#include "os.h"
#include "globals.h"
#include "dynbind.h"
#include "genesis/cons.h"
#include "genesis/fdefn.h"
#include "interr.h" /* for lose() */
#include "alloc.h"
#include "gc-internal.h"
#include "cpputil.h"
#include "pseudo-atomic.h"
#include "interrupt.h"
#include "lispregs.h"
#if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THREAD)
# define IMMEDIATE_POST_MORTEM
#endif
#if defined(LISP_FEATURE_DARWIN) && defined(LISP_FEATURE_SB_THREAD)
#define DELAY_THREAD_POST_MORTEM 5
#define LOCK_CREATE_THREAD
#endif
#ifdef LISP_FEATURE_FREEBSD
#define CREATE_CLEANUP_THREAD
#define LOCK_CREATE_THREAD
#endif
#ifdef LISP_FEATURE_SB_THREAD
struct thread_post_mortem {
#ifdef DELAY_THREAD_POST_MORTEM
struct thread_post_mortem *next;
#endif
os_thread_t os_thread;
pthread_attr_t *os_attr;
os_vm_address_t os_address;
};
#ifdef DELAY_THREAD_POST_MORTEM
static int pending_thread_post_mortem_count = 0;
pthread_mutex_t thread_post_mortem_lock = PTHREAD_MUTEX_INITIALIZER;
#endif
static struct thread_post_mortem * volatile pending_thread_post_mortem = 0;
#endif
int dynamic_values_bytes=TLS_SIZE*sizeof(lispobj); /* same for all threads */
struct thread *all_threads;
extern struct interrupt_data * global_interrupt_data;
#ifdef LISP_FEATURE_SB_THREAD
pthread_mutex_t all_threads_lock = PTHREAD_MUTEX_INITIALIZER;
#ifdef LOCK_CREATE_THREAD
static pthread_mutex_t create_thread_lock = PTHREAD_MUTEX_INITIALIZER;
#endif
#ifdef LISP_FEATURE_GCC_TLS
__thread struct thread *current_thread;
#endif
pthread_key_t lisp_thread = 0;
#endif
#if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
extern lispobj call_into_lisp_first_time(lispobj fun, lispobj *args, int nargs)
# ifdef LISP_FEATURE_X86_64
__attribute__((sysv_abi))
# endif
;
#endif
static void
link_thread(struct thread *th)
{
if (all_threads) all_threads->prev=th;
th->next=all_threads;
th->prev=0;
all_threads=th;
}
#ifdef LISP_FEATURE_SB_THREAD
static void
unlink_thread(struct thread *th)
{
if (th->prev)
th->prev->next = th->next;
else
all_threads = th->next;
if (th->next)
th->next->prev = th->prev;
}
#ifndef LISP_FEATURE_SB_SAFEPOINT
/* Only access thread state with blockables blocked. */
lispobj
thread_state(struct thread *thread)
{
lispobj state;
sigset_t old;
block_blockable_signals(NULL, &old);
os_sem_wait(thread->state_sem, "thread_state");
state = thread->state;
os_sem_post(thread->state_sem, "thread_state");
thread_sigmask(SIG_SETMASK, &old, NULL);
return state;
}
void
set_thread_state(struct thread *thread, lispobj state)
{
int i, waitcount = 0;
sigset_t old;
block_blockable_signals(NULL, &old);
os_sem_wait(thread->state_sem, "set_thread_state");
if (thread->state != state) {
if ((STATE_STOPPED==state) ||
(STATE_DEAD==state)) {
waitcount = thread->state_not_running_waitcount;
thread->state_not_running_waitcount = 0;
for (i=0; i<waitcount; i++)
os_sem_post(thread->state_not_running_sem, "set_thread_state (not running)");
}
if ((STATE_RUNNING==state) ||
(STATE_DEAD==state)) {
waitcount = thread->state_not_stopped_waitcount;
thread->state_not_stopped_waitcount = 0;
for (i=0; i<waitcount; i++)
os_sem_post(thread->state_not_stopped_sem, "set_thread_state (not stopped)");
}
thread->state = state;
}
os_sem_post(thread->state_sem, "set_thread_state");
thread_sigmask(SIG_SETMASK, &old, NULL);
}
void
wait_for_thread_state_change(struct thread *thread, lispobj state)
{
sigset_t old;
os_sem_t *wait_sem;
block_blockable_signals(NULL, &old);
start:
os_sem_wait(thread->state_sem, "wait_for_thread_state_change");
if (thread->state == state) {
switch (state) {
case STATE_RUNNING:
wait_sem = thread->state_not_running_sem;
thread->state_not_running_waitcount++;
break;
case STATE_STOPPED:
wait_sem = thread->state_not_stopped_sem;
thread->state_not_stopped_waitcount++;
break;
default:
lose("Invalid state in wait_for_thread_state_change: "OBJ_FMTX"\n", state);
}
} else {
wait_sem = NULL;
}
os_sem_post(thread->state_sem, "wait_for_thread_state_change");
if (wait_sem) {
os_sem_wait(wait_sem, "wait_for_thread_state_change");
goto start;
}
thread_sigmask(SIG_SETMASK, &old, NULL);
}
#endif /* sb-safepoint */
#endif /* sb-thread */
static int
initial_thread_trampoline(struct thread *th)
{
lispobj function;
#if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
lispobj *args = NULL;
#endif
#ifdef LISP_FEATURE_SB_THREAD
pthread_setspecific(lisp_thread, (void *)1);
#endif
#if defined(THREADS_USING_GCSIGNAL) && defined(LISP_FEATURE_PPC)
/* SIG_STOP_FOR_GC defaults to blocked on PPC? */
unblock_gc_signals(0,0);
#endif
function = th->no_tls_value_marker;
th->no_tls_value_marker = NO_TLS_VALUE_MARKER_WIDETAG;
if(arch_os_thread_init(th)==0) return 1;
link_thread(th);
th->os_thread=thread_self();
#ifndef LISP_FEATURE_WIN32
protect_control_stack_hard_guard_page(1, NULL);
#endif
protect_binding_stack_hard_guard_page(1, NULL);
protect_alien_stack_hard_guard_page(1, NULL);
#ifndef LISP_FEATURE_WIN32
protect_control_stack_guard_page(1, NULL);
#endif
protect_binding_stack_guard_page(1, NULL);
protect_alien_stack_guard_page(1, NULL);
#if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
return call_into_lisp_first_time(function,args,0);
#else
return funcall0(function);
#endif
}
#ifdef LISP_FEATURE_SB_THREAD
# if defined(IMMEDIATE_POST_MORTEM)
/*
* If this feature is set, we are running on a stack managed by the OS,
* and no fancy delays are required for anything. Just do it.
*/
static void
schedule_thread_post_mortem(struct thread *corpse)
{
pthread_detach(pthread_self());
gc_assert(!pthread_attr_destroy(corpse->os_attr));
free(corpse->os_attr);
#if defined(LISP_FEATURE_WIN32)
os_invalidate_free(corpse->os_address, THREAD_STRUCT_SIZE);
#else
os_invalidate(corpse->os_address, THREAD_STRUCT_SIZE);
#endif
}
# else
/* THREAD POST MORTEM CLEANUP
*
* Memory allocated for the thread stacks cannot be reclaimed while
* the thread is still alive, so we need a mechanism for post mortem
* cleanups. FIXME: We actually have three, for historical reasons as
* the saying goes. Do we really need three? Nikodemus guesses that
* not anymore, now that we properly call pthread_attr_destroy before
* freeing the stack. */
static struct thread_post_mortem *
plan_thread_post_mortem(struct thread *corpse)
{
if (corpse) {
struct thread_post_mortem *post_mortem = malloc(sizeof(struct thread_post_mortem));
gc_assert(post_mortem);
post_mortem->os_thread = corpse->os_thread;
post_mortem->os_attr = corpse->os_attr;
post_mortem->os_address = corpse->os_address;
#ifdef DELAY_THREAD_POST_MORTEM
post_mortem->next = NULL;
#endif
return post_mortem;
} else {
/* FIXME: When does this happen? */
return NULL;
}
}
static void
perform_thread_post_mortem(struct thread_post_mortem *post_mortem)
{
#ifdef CREATE_POST_MORTEM_THREAD
pthread_detach(pthread_self());
#endif
if (post_mortem) {
gc_assert(!pthread_join(post_mortem->os_thread, NULL));
gc_assert(!pthread_attr_destroy(post_mortem->os_attr));
free(post_mortem->os_attr);
os_invalidate(post_mortem->os_address, THREAD_STRUCT_SIZE);
free(post_mortem);
}
}
static void
schedule_thread_post_mortem(struct thread *corpse)
{
struct thread_post_mortem *post_mortem = NULL;
if (corpse) {
post_mortem = plan_thread_post_mortem(corpse);
#ifdef DELAY_THREAD_POST_MORTEM
pthread_mutex_lock(&thread_post_mortem_lock);
/* First stick the new post mortem to the end of the queue. */
if (pending_thread_post_mortem) {
struct thread_post_mortem *next = pending_thread_post_mortem;
while (next->next) {
next = next->next;
}
next->next = post_mortem;
} else {
pending_thread_post_mortem = post_mortem;
}
/* Then, if there are enough things in the queue, clean up one
* from the head -- or increment the count, and null out the
* post_mortem we have. */
if (pending_thread_post_mortem_count > DELAY_THREAD_POST_MORTEM) {
post_mortem = pending_thread_post_mortem;
pending_thread_post_mortem = post_mortem->next;
} else {
pending_thread_post_mortem_count++;
post_mortem = NULL;
}
pthread_mutex_unlock(&thread_post_mortem_lock);
/* Finally run, the cleanup, if any. */
perform_thread_post_mortem(post_mortem);
#elif defined(CREATE_POST_MORTEM_THREAD)
gc_assert(!pthread_create(&thread, NULL, perform_thread_post_mortem, post_mortem));
#else
post_mortem = (struct thread_post_mortem *)
swap_lispobjs((lispobj *)(void *)&pending_thread_post_mortem,
(lispobj)post_mortem);
perform_thread_post_mortem(post_mortem);
#endif
}
}
# endif /* !IMMEDIATE_POST_MORTEM */
/* Note: scribble must be stack-allocated */
static void
init_new_thread(struct thread *th, init_thread_data *scribble, int guardp)
{
int lock_ret;
pthread_setspecific(lisp_thread, (void *)1);
if(arch_os_thread_init(th)==0) {
/* FIXME: handle error */
lose("arch_os_thread_init failed\n");
}
th->os_thread=thread_self();
if (guardp)
protect_control_stack_guard_page(1, NULL);
protect_binding_stack_guard_page(1, NULL);
protect_alien_stack_guard_page(1, NULL);
/* Since GC can only know about this thread from the all_threads
* list and we're just adding this thread to it, there is no
* danger of deadlocking even with SIG_STOP_FOR_GC blocked (which
* it is not). */
#ifdef LISP_FEATURE_SB_SAFEPOINT
*th->csp_around_foreign_call = (lispobj)scribble;
#endif
lock_ret = pthread_mutex_lock(&all_threads_lock);
gc_assert(lock_ret == 0);
link_thread(th);
lock_ret = pthread_mutex_unlock(&all_threads_lock);
gc_assert(lock_ret == 0);
/* Kludge: Changed the order of some steps between the safepoint/
* non-safepoint versions of this code. Can we unify this more?
*/
#ifdef LISP_FEATURE_SB_SAFEPOINT
gc_state_lock();
gc_state_wait(GC_NONE);
gc_state_unlock();
push_gcing_safety(&scribble->safety);
#endif
}
static void
undo_init_new_thread(struct thread *th, init_thread_data *scribble)
{
int lock_ret;
/* Kludge: Changed the order of some steps between the safepoint/
* non-safepoint versions of this code. Can we unify this more?
*/
#ifdef LISP_FEATURE_SB_SAFEPOINT
block_blockable_signals(0, 0);
gc_alloc_update_page_tables(BOXED_PAGE_FLAG, &th->alloc_region);
#if defined(LISP_FEATURE_SB_SAFEPOINT_STRICTLY) && !defined(LISP_FEATURE_WIN32)
gc_alloc_update_page_tables(BOXED_PAGE_FLAG, &th->sprof_alloc_region);
#endif
pop_gcing_safety(&scribble->safety);
lock_ret = pthread_mutex_lock(&all_threads_lock);
gc_assert(lock_ret == 0);
unlink_thread(th);
lock_ret = pthread_mutex_unlock(&all_threads_lock);
gc_assert(lock_ret == 0);
#else
/* Block GC */
block_blockable_signals(0, 0);
set_thread_state(th, STATE_DEAD);
/* SIG_STOP_FOR_GC is blocked and GC might be waiting for this
* thread, but since we are already dead it won't wait long. */
lock_ret = pthread_mutex_lock(&all_threads_lock);
gc_assert(lock_ret == 0);
gc_alloc_update_page_tables(BOXED_PAGE_FLAG, &th->alloc_region);
#if defined(LISP_FEATURE_SB_SAFEPOINT_STRICTLY) && !defined(LISP_FEATURE_WIN32)
gc_alloc_update_page_tables(BOXED_PAGE_FLAG, &th->sprof_alloc_region);
#endif
unlink_thread(th);
pthread_mutex_unlock(&all_threads_lock);
gc_assert(lock_ret == 0);
#endif
if(th->tls_cookie>=0) arch_os_thread_cleanup(th);
#ifndef LISP_FEATURE_SB_SAFEPOINT
os_sem_destroy(th->state_sem);
os_sem_destroy(th->state_not_running_sem);
os_sem_destroy(th->state_not_stopped_sem);
#endif
#if defined(LISP_FEATURE_WIN32)
free((os_vm_address_t)th->interrupt_data);
#else
os_invalidate((os_vm_address_t)th->interrupt_data,
(sizeof (struct interrupt_data)));
#endif
#ifdef LISP_FEATURE_MACH_EXCEPTION_HANDLER
mach_lisp_thread_destroy(th);
#endif
#if defined(LISP_FEATURE_WIN32)
int i;
for (i = 0; i<
(int) (sizeof(th->private_events.events)/
sizeof(th->private_events.events[0])); ++i) {
CloseHandle(th->private_events.events[i]);
}
TlsSetValue(OUR_TLS_INDEX,NULL);
#endif
/* Undo the association of the current pthread to its `struct thread',
* such that we can call arch_os_get_current_thread() later in this
* thread and cleanly get back NULL. */
#ifdef LISP_FEATURE_GCC_TLS
current_thread = NULL;
#else
pthread_setspecific(specials, NULL);
#endif
schedule_thread_post_mortem(th);
}
/* this is the first thing that runs in the child (which is why the
* silly calling convention). Basically it calls the user's requested
* lisp function after doing arch_os_thread_init and whatever other
* bookkeeping needs to be done
*/
int
new_thread_trampoline(struct thread *th)
{
int result;
init_thread_data scribble;
FSHOW((stderr,"/creating thread %lu\n", thread_self()));
check_deferrables_blocked_or_lose(0);
#ifndef LISP_FEATURE_SB_SAFEPOINT
check_gc_signals_unblocked_or_lose(0);
#endif
lispobj function = th->no_tls_value_marker;
th->no_tls_value_marker = NO_TLS_VALUE_MARKER_WIDETAG;
init_new_thread(th, &scribble, 1);
result = funcall0(function);
undo_init_new_thread(th, &scribble);
FSHOW((stderr,"/exiting thread %lu\n", thread_self()));
return result;
}
# ifdef LISP_FEATURE_SB_SAFEPOINT
static struct thread *create_thread_struct(lispobj);
void
attach_os_thread(init_thread_data *scribble)
{
os_thread_t os = pthread_self();
odxprint(misc, "attach_os_thread: attaching to %p", os);
struct thread *th = create_thread_struct(NIL);
block_deferrable_signals(0, &scribble->oldset);
th->no_tls_value_marker = NO_TLS_VALUE_MARKER_WIDETAG;
/* We don't actually want a pthread_attr here, but rather than add
* `if's to the post-mostem, let's just keep that code happy by
* keeping it initialized: */
pthread_attr_init(th->os_attr);
#ifndef LISP_FEATURE_WIN32
/* On windows, arch_os_thread_init will take care of finding the
* stack. */
pthread_attr_t attr;
int pthread_getattr_np(pthread_t, pthread_attr_t *);
pthread_getattr_np(os, &attr);
void *stack_addr;
size_t stack_size;
pthread_attr_getstack(&attr, &stack_addr, &stack_size);
th->control_stack_start = stack_addr;
th->control_stack_end = (void *) (((uintptr_t) stack_addr) + stack_size);
#endif
init_new_thread(th, scribble, 0);
/* We will be calling into Lisp soon, and the functions being called
* recklessly ignore the comment in target-thread which says that we
* must be careful to not cause GC while initializing a new thread.
* Since we first need to create a fresh thread object, it's really
* tempting to just perform such unsafe allocation though. So let's
* at least try to suppress GC before consing, and hope that it
* works: */
bind_variable(GC_INHIBIT, T, th);
uword_t stacksize
= (uword_t) th->control_stack_end - (uword_t) th->control_stack_start;
odxprint(misc, "attach_os_thread: attached %p as %p (0x%lx bytes stack)",
os, th, (long) stacksize);
}
void
detach_os_thread(init_thread_data *scribble)
{
struct thread *th = arch_os_get_current_thread();
odxprint(misc, "detach_os_thread: detaching");
undo_init_new_thread(th, scribble);
odxprint(misc, "deattach_os_thread: detached");
pthread_setspecific(lisp_thread, (void *)0);
thread_sigmask(SIG_SETMASK, &scribble->oldset, 0);
}
# endif /* safepoint */
#endif /* LISP_FEATURE_SB_THREAD */
static void
free_thread_struct(struct thread *th)
{
#if defined(LISP_FEATURE_WIN32)
if (th->interrupt_data) {
os_invalidate_free((os_vm_address_t) th->interrupt_data,
(sizeof (struct interrupt_data)));
}
os_invalidate_free((os_vm_address_t) th->os_address,
THREAD_STRUCT_SIZE);
#else
if (th->interrupt_data)
os_invalidate((os_vm_address_t) th->interrupt_data,
(sizeof (struct interrupt_data)));
os_invalidate((os_vm_address_t) th->os_address,
THREAD_STRUCT_SIZE);
#endif
}
#ifdef LISP_FEATURE_SB_THREAD
/* FIXME: should be MAX_INTERRUPTS -1 ? */
const unsigned int tls_index_start =
MAX_INTERRUPTS + sizeof(struct thread)/sizeof(lispobj);
#endif
/* this is called from any other thread to create the new one, and
* initialize all parts of it that can be initialized from another
* thread
*/
static struct thread *
create_thread_struct(lispobj initial_function) {
union per_thread_data *per_thread;
struct thread *th=0; /* subdue gcc */
void *spaces=0;
void *aligned_spaces=0;
#if defined(LISP_FEATURE_SB_THREAD) || defined(LISP_FEATURE_WIN32)
unsigned int i;
#endif
/* May as well allocate all the spaces at once: it saves us from
* having to decide what to do if only some of the allocations
* succeed. SPACES must be appropriately aligned, since the GC
* expects the control stack to start at a page boundary -- and
* the OS may have even more rigorous requirements. We can't rely
* on the alignment passed from os_validate, since that might
* assume the current (e.g. 4k) pagesize, while we calculate with
* the biggest (e.g. 64k) pagesize allowed by the ABI. */
spaces=os_validate(0, THREAD_STRUCT_SIZE);
if(!spaces)
return NULL;
/* Aligning up is safe as THREAD_STRUCT_SIZE has
* THREAD_ALIGNMENT_BYTES padding. */
aligned_spaces = (void *)((((uword_t)(char *)spaces)
+ THREAD_ALIGNMENT_BYTES-1)
&~(uword_t)(THREAD_ALIGNMENT_BYTES-1));
void* csp_page=
(aligned_spaces+
thread_control_stack_size+
BINDING_STACK_SIZE+
ALIEN_STACK_SIZE);
per_thread=(union per_thread_data *)
(csp_page + THREAD_CSP_PAGE_SIZE);
struct nonpointer_thread_data *nonpointer_data
= (void *) &per_thread->dynamic_values[TLS_SIZE];
#ifdef LISP_FEATURE_SB_THREAD
for(i = 0; i < (dynamic_values_bytes / sizeof(lispobj)); i++)
per_thread->dynamic_values[i] = NO_TLS_VALUE_MARKER_WIDETAG;
if (all_threads == 0) {
if(SymbolValue(FREE_TLS_INDEX,0)==UNBOUND_MARKER_WIDETAG) {
SetSymbolValue(FREE_TLS_INDEX,tls_index_start << WORD_SHIFT,0);
SetSymbolValue(TLS_INDEX_LOCK,make_fixnum(0),0);
}
#define STATIC_TLS_INIT(sym,field) \
((struct symbol *)(sym-OTHER_POINTER_LOWTAG))->tls_index= \
(THREAD_SLOT_OFFSET_WORDS(field) << WORD_SHIFT)
STATIC_TLS_INIT(BINDING_STACK_START,binding_stack_start);
#ifdef BINDING_STACK_POINTER
STATIC_TLS_INIT(BINDING_STACK_POINTER,binding_stack_pointer);
#endif
STATIC_TLS_INIT(CONTROL_STACK_START,control_stack_start);
STATIC_TLS_INIT(CONTROL_STACK_END,control_stack_end);
#ifdef ALIEN_STACK
STATIC_TLS_INIT(ALIEN_STACK,alien_stack_pointer);
#endif
#if defined(LISP_FEATURE_X86) || defined (LISP_FEATURE_X86_64)
STATIC_TLS_INIT(PSEUDO_ATOMIC_BITS,pseudo_atomic_bits);
#endif
#undef STATIC_TLS_INIT
}
#endif
th=&per_thread->thread;
th->os_address = spaces;
th->control_stack_start = aligned_spaces;
th->binding_stack_start=
(lispobj*)((void*)th->control_stack_start+thread_control_stack_size);
th->control_stack_end = th->binding_stack_start;
th->control_stack_guard_page_protected = T;
th->alien_stack_start=
(lispobj*)((void*)th->binding_stack_start+BINDING_STACK_SIZE);
set_binding_stack_pointer(th,th->binding_stack_start);
th->this=th;
th->os_thread=0;
#ifdef LISP_FEATURE_SB_SAFEPOINT
# ifdef LISP_FEATURE_WIN32
th->carried_base_pointer = 0;
# endif
# ifdef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
th->pc_around_foreign_call = 0;
# endif
th->csp_around_foreign_call = csp_page;
#endif
#ifdef LISP_FEATURE_SB_THREAD
/* Contrary to the "allocate all the spaces at once" comment above,
* the os_attr is allocated separately. We cannot put it into the
* nonpointer data, because it's used for post_mortem and freed
* separately */
th->os_attr=malloc(sizeof(pthread_attr_t));
th->nonpointer_data = nonpointer_data;
# ifndef LISP_FEATURE_SB_SAFEPOINT
th->state_sem=&nonpointer_data->state_sem;
th->state_not_running_sem=&nonpointer_data->state_not_running_sem;
th->state_not_stopped_sem=&nonpointer_data->state_not_stopped_sem;
os_sem_init(th->state_sem, 1);
os_sem_init(th->state_not_running_sem, 0);
os_sem_init(th->state_not_stopped_sem, 0);
# endif
th->state_not_running_waitcount = 0;
th->state_not_stopped_waitcount = 0;
#endif
th->state=STATE_RUNNING;
#ifdef ALIEN_STACK_GROWS_DOWNWARD
th->alien_stack_pointer=((void *)th->alien_stack_start
+ ALIEN_STACK_SIZE-N_WORD_BYTES);
#else
th->alien_stack_pointer=((void *)th->alien_stack_start);
#endif
#if defined(LISP_FEATURE_X86) || defined (LISP_FEATURE_X86_64) || defined(LISP_FEATURE_SB_THREAD)
th->pseudo_atomic_bits=0;
#endif
#ifdef LISP_FEATURE_GENCGC
gc_set_region_empty(&th->alloc_region);
# if defined(LISP_FEATURE_SB_SAFEPOINT_STRICTLY) && !defined(LISP_FEATURE_WIN32)
gc_set_region_empty(&th->sprof_alloc_region);
# endif
#endif
#ifdef LISP_FEATURE_SB_THREAD
/* This parallels the same logic in globals.c for the
* single-threaded foreign_function_call_active, KLUDGE and
* all. */
#if defined(LISP_FEATURE_X86) || defined(LISP_FEATURE_X86_64)
th->foreign_function_call_active = 0;
#else
th->foreign_function_call_active = 1;
#endif
#endif
#ifndef LISP_FEATURE_SB_THREAD
/* the tls-points-into-struct-thread trick is only good for threaded
* sbcl, because unithread sbcl doesn't have tls. So, we copy the
* appropriate values from struct thread here, and make sure that
* we use the appropriate SymbolValue macros to access any of the
* variable quantities from the C runtime. It's not quite OAOOM,
* it just feels like it */
SetSymbolValue(BINDING_STACK_START,(lispobj)th->binding_stack_start,th);
SetSymbolValue(CONTROL_STACK_START,(lispobj)th->control_stack_start,th);
SetSymbolValue(CONTROL_STACK_END,(lispobj)th->control_stack_end,th);
#if defined(LISP_FEATURE_X86) || defined (LISP_FEATURE_X86_64)
SetSymbolValue(ALIEN_STACK,(lispobj)th->alien_stack_pointer,th);
SetSymbolValue(PSEUDO_ATOMIC_BITS,(lispobj)th->pseudo_atomic_bits,th);
#endif
#endif
bind_variable(CURRENT_CATCH_BLOCK,make_fixnum(0),th);
bind_variable(CURRENT_UNWIND_PROTECT_BLOCK,make_fixnum(0),th);
bind_variable(FREE_INTERRUPT_CONTEXT_INDEX,make_fixnum(0),th);
bind_variable(INTERRUPT_PENDING, NIL,th);
bind_variable(INTERRUPTS_ENABLED,T,th);
bind_variable(ALLOW_WITH_INTERRUPTS,T,th);
bind_variable(GC_PENDING,NIL,th);
bind_variable(ALLOC_SIGNAL,NIL,th);
#ifdef PINNED_OBJECTS
bind_variable(PINNED_OBJECTS,NIL,th);
#endif
#ifdef LISP_FEATURE_SB_THREAD
bind_variable(STOP_FOR_GC_PENDING,NIL,th);
#endif
#if defined(LISP_FEATURE_SB_SAFEPOINT)
bind_variable(GC_SAFE,NIL,th);
bind_variable(IN_SAFEPOINT,NIL,th);
#endif
#ifdef LISP_FEATURE_SB_THRUPTION
bind_variable(THRUPTION_PENDING,NIL,th);
bind_variable(RESTART_CLUSTERS,NIL,th);
#endif
#ifndef LISP_FEATURE_C_STACK_IS_CONTROL_STACK
access_control_stack_pointer(th)=th->control_stack_start;
#endif
#if defined(LISP_FEATURE_WIN32)
th->interrupt_data = (struct interrupt_data *)
calloc((sizeof (struct interrupt_data)),1);
#else
th->interrupt_data = (struct interrupt_data *)
os_validate(0,(sizeof (struct interrupt_data)));
#endif
if (!th->interrupt_data) {
free_thread_struct(th);
return 0;
}
th->interrupt_data->pending_handler = 0;
th->interrupt_data->gc_blocked_deferrables = 0;
#ifdef GENCGC_IS_PRECISE
th->interrupt_data->allocation_trap_context = 0;
#endif
th->no_tls_value_marker=initial_function;
#if defined(LISP_FEATURE_WIN32)
for (i = 0; i<sizeof(th->private_events.events)/
sizeof(th->private_events.events[0]); ++i) {
th->private_events.events[i] = CreateEvent(NULL,FALSE,FALSE,NULL);
}
th->synchronous_io_handle_and_flag = 0;
#endif
th->stepping = NIL;
return th;
}
void create_initial_thread(lispobj initial_function) {
struct thread *th=create_thread_struct(initial_function);
#ifdef LISP_FEATURE_SB_THREAD
pthread_key_create(&lisp_thread, 0);
#endif
if(th) {
initial_thread_trampoline(th); /* no return */
} else lose("can't create initial thread\n");
}
#ifdef LISP_FEATURE_SB_THREAD
#ifndef __USE_XOPEN2K
extern int pthread_attr_setstack (pthread_attr_t *__attr, void *__stackaddr,
size_t __stacksize);
#endif
boolean create_os_thread(struct thread *th,os_thread_t *kid_tid)
{
/* The new thread inherits the restrictive signal mask set here,
* and enables signals again when it is set up properly. */
sigset_t oldset;
boolean r=1;
int retcode = 0, initcode;
FSHOW_SIGNAL((stderr,"/create_os_thread: creating new thread\n"));
/* Blocking deferrable signals is enough, no need to block
* SIG_STOP_FOR_GC because the child process is not linked onto
* all_threads until it's ready. */
block_deferrable_signals(0, &oldset);
#ifdef LOCK_CREATE_THREAD
retcode = pthread_mutex_lock(&create_thread_lock);
gc_assert(retcode == 0);
FSHOW_SIGNAL((stderr,"/create_os_thread: got lock\n"));
#endif
if((initcode = pthread_attr_init(th->os_attr)) ||
/* call_into_lisp_first_time switches the stack for the initial
* thread. For the others, we use this. */
#if defined(LISP_FEATURE_WIN32)
(pthread_attr_setstacksize(th->os_attr, thread_control_stack_size)) ||
#else
# if defined(LISP_FEATURE_C_STACK_IS_CONTROL_STACK)
(pthread_attr_setstack(th->os_attr,th->control_stack_start,
thread_control_stack_size)) ||
# else
(pthread_attr_setstack(th->os_attr,th->alien_stack_start,
ALIEN_STACK_SIZE)) ||
# endif
#endif
(retcode = pthread_create
(kid_tid,th->os_attr,(void *(*)(void *))new_thread_trampoline,th))) {
FSHOW_SIGNAL((stderr, "init = %d\n", initcode));
FSHOW_SIGNAL((stderr, "pthread_create returned %d, errno %d\n",
retcode, errno));
if(retcode < 0) {
perror("create_os_thread");
}
r=0;
}
#ifdef LOCK_CREATE_THREAD
retcode = pthread_mutex_unlock(&create_thread_lock);
gc_assert(retcode == 0);
FSHOW_SIGNAL((stderr,"/create_os_thread: released lock\n"));
#endif
thread_sigmask(SIG_SETMASK,&oldset,0);
return r;
}
os_thread_t create_thread(lispobj initial_function) {
struct thread *th, *thread = arch_os_get_current_thread();
os_thread_t kid_tid = 0;
/* Must defend against async unwinds. */
if (SymbolValue(INTERRUPTS_ENABLED, thread) != NIL)
lose("create_thread is not safe when interrupts are enabled.\n");
/* Assuming that a fresh thread struct has no lisp objects in it,
* linking it to all_threads can be left to the thread itself
* without fear of gc lossage. initial_function violates this
* assumption and must stay pinned until the child starts up. */
th = create_thread_struct(initial_function);
if (th && !create_os_thread(th,&kid_tid)) {
free_thread_struct(th);
kid_tid = 0;
}
return kid_tid;
}
/* stopping the world is a two-stage process. From this thread we signal
* all the others with SIG_STOP_FOR_GC. The handler for this signal does
* the usual pseudo-atomic checks (we don't want to stop a thread while
* it's in the middle of allocation) then waits for another SIG_STOP_FOR_GC.
*/
/*
* (With SB-SAFEPOINT, see the definitions in safepoint.c instead.)
*/
#ifndef LISP_FEATURE_SB_SAFEPOINT
/* To avoid deadlocks when gc stops the world all clients of each
* mutex must enable or disable SIG_STOP_FOR_GC for the duration of
* holding the lock, but they must agree on which. */
void gc_stop_the_world()
{
struct thread *p,*th=arch_os_get_current_thread();
int status, lock_ret;
#ifdef LOCK_CREATE_THREAD
/* KLUDGE: Stopping the thread during pthread_create() causes deadlock
* on FreeBSD. */
FSHOW_SIGNAL((stderr,"/gc_stop_the_world:waiting on create_thread_lock\n"));
lock_ret = pthread_mutex_lock(&create_thread_lock);
gc_assert(lock_ret == 0);
FSHOW_SIGNAL((stderr,"/gc_stop_the_world:got create_thread_lock\n"));
#endif
FSHOW_SIGNAL((stderr,"/gc_stop_the_world:waiting on lock\n"));
/* keep threads from starting while the world is stopped. */
lock_ret = pthread_mutex_lock(&all_threads_lock); \
gc_assert(lock_ret == 0);
FSHOW_SIGNAL((stderr,"/gc_stop_the_world:got lock\n"));
/* stop all other threads by sending them SIG_STOP_FOR_GC */
for(p=all_threads; p; p=p->next) {
gc_assert(p->os_thread != 0);
FSHOW_SIGNAL((stderr,"/gc_stop_the_world: thread=%lu, state=%x\n",
p->os_thread, thread_state(p)));
if((p!=th) && ((thread_state(p)==STATE_RUNNING))) {
FSHOW_SIGNAL((stderr,"/gc_stop_the_world: suspending thread %lu\n",
p->os_thread));
/* We already hold all_thread_lock, P can become DEAD but
* cannot exit, ergo it's safe to use pthread_kill. */
status=pthread_kill(p->os_thread,SIG_STOP_FOR_GC);
if (status==ESRCH) {
/* This thread has exited. */
gc_assert(thread_state(p)==STATE_DEAD);
} else if (status) {
lose("cannot send suspend thread=%lu: %d, %s\n",
p->os_thread,status,strerror(status));
}
}
}
FSHOW_SIGNAL((stderr,"/gc_stop_the_world:signals sent\n"));
for(p=all_threads;p;p=p->next) {
if (p!=th) {
FSHOW_SIGNAL
((stderr,
"/gc_stop_the_world: waiting for thread=%lu: state=%x\n",
p->os_thread, thread_state(p)));
wait_for_thread_state_change(p, STATE_RUNNING);
if (p->state == STATE_RUNNING)
lose("/gc_stop_the_world: unexpected state");
}
}
FSHOW_SIGNAL((stderr,"/gc_stop_the_world:end\n"));
}
void gc_start_the_world()
{
struct thread *p,*th=arch_os_get_current_thread();
int lock_ret;
/* if a resumed thread creates a new thread before we're done with
* this loop, the new thread will get consed on the front of
* all_threads, but it won't have been stopped so won't need
* restarting */
FSHOW_SIGNAL((stderr,"/gc_start_the_world:begin\n"));
for(p=all_threads;p;p=p->next) {
gc_assert(p->os_thread!=0);
if (p!=th) {
lispobj state = thread_state(p);
if (state != STATE_DEAD) {
if(state != STATE_STOPPED) {
lose("gc_start_the_world: wrong thread state is %d\n",
fixnum_value(state));
}
FSHOW_SIGNAL((stderr, "/gc_start_the_world: resuming %lu\n",
p->os_thread));
set_thread_state(p, STATE_RUNNING);
}
}
}
lock_ret = pthread_mutex_unlock(&all_threads_lock);
gc_assert(lock_ret == 0);
#ifdef LOCK_CREATE_THREAD
lock_ret = pthread_mutex_unlock(&create_thread_lock);
gc_assert(lock_ret == 0);
#endif
FSHOW_SIGNAL((stderr,"/gc_start_the_world:end\n"));
}
#endif /* !LISP_FEATURE_SB_SAFEPOINT */
#endif /* !LISP_FEATURE_SB_THREAD */
int
thread_yield()
{
#ifdef LISP_FEATURE_SB_THREAD
return sched_yield();
#else
return 0;
#endif
}
int
wake_thread(os_thread_t os_thread)
{
#if defined(LISP_FEATURE_WIN32)
return kill_safely(os_thread, 1);
#elif !defined(LISP_FEATURE_SB_THRUPTION)
return kill_safely(os_thread, SIGPIPE);
#else
return wake_thread_posix(os_thread);
#endif
}
/* If the thread id given does not belong to a running thread (it has
* exited or never even existed) pthread_kill _may_ fail with ESRCH,
* but it is also allowed to just segfault, see
* <http://udrepper.livejournal.com/16844.html>.
*
* Relying on thread ids can easily backfire since ids are recycled
* (NPTL recycles them extremely fast) so a signal can be sent to
* another process if the one it was sent to exited.
*
* For these reasons, we must make sure that the thread is still alive
* when the pthread_kill is called and return if the thread is
* exiting.
*
* Note (DFL, 2011-06-22): At the time of writing, this function is only
* used for INTERRUPT-THREAD, hence the wake_thread special-case for
* Windows is OK. */
int
kill_safely(os_thread_t os_thread, int signal)
{
FSHOW_SIGNAL((stderr,"/kill_safely: %lu, %d\n", os_thread, signal));
{
#ifdef LISP_FEATURE_SB_THREAD
sigset_t oldset;
struct thread *thread;
/* Frequent special case: resignalling to self. The idea is
* that leave_region safepoint will acknowledge the signal, so
* there is no need to take locks, roll thread to safepoint
* etc. */
/* Kludge (on safepoint builds): At the moment, this isn't just
* an optimization; rather it masks the fact that
* gc_stop_the_world() grabs the all_threads mutex without
* releasing it, and since we're not using recursive pthread
* mutexes, the pthread_mutex_lock() around the all_threads loop
* would go wrong. Why are we running interruptions while
* stopping the world though? Test case is (:ASYNC-UNWIND
* :SPECIALS), especially with s/10/100/ in both loops. */
if (os_thread == pthread_self()) {
pthread_kill(os_thread, signal);
#ifdef LISP_FEATURE_WIN32
check_pending_thruptions(NULL);
#endif
return 0;
}
/* pthread_kill is not async signal safe and we don't want to be
* interrupted while holding the lock. */
block_deferrable_signals(0, &oldset);
pthread_mutex_lock(&all_threads_lock);
for (thread = all_threads; thread; thread = thread->next) {
if (thread->os_thread == os_thread) {
int status = pthread_kill(os_thread, signal);
if (status)
lose("kill_safely: pthread_kill failed with %d\n", status);
#if defined(LISP_FEATURE_WIN32) && defined(LISP_FEATURE_SB_THRUPTION)
wake_thread_win32(thread);
#endif
break;
}
}
pthread_mutex_unlock(&all_threads_lock);
thread_sigmask(SIG_SETMASK,&oldset,0);
if (thread)
return 0;
else
return -1;
#elif defined(LISP_FEATURE_WIN32)
return 0;
#else
int status;
if (os_thread != 0)
lose("kill_safely: who do you want to kill? %d?\n", os_thread);
/* Dubious (as in don't know why it works) workaround for the
* signal sometimes not being generated on darwin. */
#ifdef LISP_FEATURE_DARWIN
{
sigset_t oldset;
sigprocmask(SIG_BLOCK, &deferrable_sigset, &oldset);
status = raise(signal);
sigprocmask(SIG_SETMASK,&oldset,0);
}
#else
status = raise(signal);
#endif
if (status == 0) {
return 0;
} else {
lose("cannot raise signal %d, %d %s\n",
signal, status, strerror(errno));
}
#endif
}
}