/
threads.xs
1887 lines (1638 loc) · 56.4 KB
/
threads.xs
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
#define PERL_NO_GET_CONTEXT
/* Workaround for mingw 32-bit compiler by mingw-w64.sf.net - has to come before any #include.
* It also defines USE_NO_MINGW_SETJMP_TWO_ARGS for the mingw.org 32-bit compilers ... but
* that's ok as that compiler makes no use of that symbol anyway */
#if defined(WIN32) && defined(__MINGW32__) && !defined(__MINGW64__)
# define USE_NO_MINGW_SETJMP_TWO_ARGS 1
#endif
#include "EXTERN.h"
#include "perl.h"
#include "XSUB.h"
/* Workaround for XSUB.h bug under WIN32 */
#ifdef WIN32
# undef setjmp
# if defined(USE_NO_MINGW_SETJMP_TWO_ARGS) || (!defined(__BORLANDC__) && !defined(__MINGW64__))
# define setjmp(x) _setjmp(x)
# endif
# if defined(__MINGW64__)
# define setjmp(x) _setjmpex((x), mingw_getsp())
# endif
#endif
#ifdef HAS_PPPORT_H
# define NEED_PL_signals
# define NEED_sv_2pv_flags
# include "ppport.h"
# include "threads.h"
#endif
#ifndef sv_dup_inc
# define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
#endif
#ifndef PERL_UNUSED_RESULT
# if defined(__GNUC__) && defined(HASATTRIBUTE_WARN_UNUSED_RESULT)
# define PERL_UNUSED_RESULT(v) STMT_START { __typeof__(v) z = (v); (void)sizeof(z); } STMT_END
# else
# define PERL_UNUSED_RESULT(v) ((void)(v))
# endif
#endif
#ifndef CLANG_DIAG_IGNORE
# define CLANG_DIAG_IGNORE(x)
# define CLANG_DIAG_RESTORE
#endif
#ifndef CLANG_DIAG_IGNORE_STMT
# define CLANG_DIAG_IGNORE_STMT(x) CLANG_DIAG_IGNORE(x) NOOP
# define CLANG_DIAG_RESTORE_STMT CLANG_DIAG_RESTORE NOOP
# define CLANG_DIAG_IGNORE_DECL(x) CLANG_DIAG_IGNORE(x) dNOOP
# define CLANG_DIAG_RESTORE_DECL CLANG_DIAG_RESTORE dNOOP
#endif
#ifndef G_LIST
# define G_LIST G_ARRAY
#endif
#ifdef USE_ITHREADS
#ifdef __amigaos4__
# undef YIELD
# define YIELD sleep(0)
#endif
#ifdef WIN32
# include <windows.h>
/* Supposed to be in Winbase.h */
# ifndef STACK_SIZE_PARAM_IS_A_RESERVATION
# define STACK_SIZE_PARAM_IS_A_RESERVATION 0x00010000
# endif
# include <win32thread.h>
#else
# ifdef OS2
typedef perl_os_thread pthread_t;
# else
# include <pthread.h>
# endif
# include <thread.h>
# define PERL_THREAD_SETSPECIFIC(k,v) pthread_setspecific(k,v)
# ifdef OLD_PTHREADS_API
# define PERL_THREAD_DETACH(t) pthread_detach(&(t))
# else
# define PERL_THREAD_DETACH(t) pthread_detach((t))
# endif
#endif
#if !defined(HAS_GETPAGESIZE) && defined(I_SYS_PARAM)
# include <sys/param.h>
#endif
/* Values for 'state' member */
#define PERL_ITHR_DETACHED 1 /* Thread has been detached */
#define PERL_ITHR_JOINED 2 /* Thread is being / has been joined */
#define PERL_ITHR_FINISHED 4 /* Thread has finished execution */
#define PERL_ITHR_THREAD_EXIT_ONLY 8 /* exit() only exits current thread */
#define PERL_ITHR_NONVIABLE 16 /* Thread creation failed */
#define PERL_ITHR_DIED 32 /* Thread finished by dying */
#define PERL_ITHR_UNCALLABLE (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)
typedef struct _ithread {
struct _ithread *next; /* Next thread in the list */
struct _ithread *prev; /* Prev thread in the list */
PerlInterpreter *interp; /* The threads interpreter */
UV tid; /* Threads module's thread id */
perl_mutex mutex; /* Mutex for updating things in this struct */
int count; /* Reference count. See S_ithread_create. */
int state; /* Detached, joined, finished, etc. */
int gimme; /* Context of create */
SV *init_function; /* Code to run */
AV *params; /* Args to pass function */
#ifdef WIN32
DWORD thr; /* OS's idea if thread id */
HANDLE handle; /* OS's waitable handle */
#else
pthread_t thr; /* OS's handle for the thread */
#endif
IV stack_size;
SV *err; /* Error from abnormally terminated thread */
char *err_class; /* Error object's classname if applicable */
#ifndef WIN32
sigset_t initial_sigmask; /* Thread wakes up with signals blocked */
#endif
} ithread;
#define MY_CXT_KEY "threads::_cxt" XS_VERSION
typedef struct {
/* Used by Perl interpreter for thread context switching */
ithread *context;
} my_cxt_t;
START_MY_CXT
#define MY_POOL_KEY "threads::_pool" XS_VERSION
typedef struct {
/* Structure for 'main' thread
* Also forms the 'base' for the doubly-linked list of threads */
ithread main_thread;
/* Protects the creation and destruction of threads*/
perl_mutex create_destruct_mutex;
UV tid_counter;
IV joinable_threads;
IV running_threads;
IV detached_threads;
IV total_threads;
IV default_stack_size;
IV page_size;
} my_pool_t;
#define dMY_POOL \
SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY, \
sizeof(MY_POOL_KEY)-1, TRUE); \
my_pool_t *my_poolp = INT2PTR(my_pool_t*, SvUV(my_pool_sv))
#define MY_POOL (*my_poolp)
#if defined(WIN32) || (defined(__amigaos4__) && defined(__NEWLIB__))
# undef THREAD_SIGNAL_BLOCKING
#else
# define THREAD_SIGNAL_BLOCKING
#endif
#ifdef THREAD_SIGNAL_BLOCKING
/* Block most signals for calling thread, setting the old signal mask to
* oldmask, if it is not NULL */
STATIC int
S_block_most_signals(sigset_t *oldmask)
{
sigset_t newmask;
sigfillset(&newmask);
/* Don't block certain "important" signals (stolen from mg.c) */
#ifdef SIGILL
sigdelset(&newmask, SIGILL);
#endif
#ifdef SIGBUS
sigdelset(&newmask, SIGBUS);
#endif
#ifdef SIGSEGV
sigdelset(&newmask, SIGSEGV);
#endif
#if defined(VMS)
/* no per-thread blocking available */
return sigprocmask(SIG_BLOCK, &newmask, oldmask);
#else
return pthread_sigmask(SIG_BLOCK, &newmask, oldmask);
#endif /* VMS */
}
/* Set the signal mask for this thread to newmask */
STATIC int
S_set_sigmask(sigset_t *newmask)
{
#if defined(VMS)
return sigprocmask(SIG_SETMASK, newmask, NULL);
#else
return pthread_sigmask(SIG_SETMASK, newmask, NULL);
#endif /* VMS */
}
#endif /* WIN32 */
/* Used by Perl interpreter for thread context switching */
STATIC void
S_ithread_set(pTHX_ ithread *thread)
{
dMY_CXT;
MY_CXT.context = thread;
}
STATIC ithread *
S_ithread_get(pTHX)
{
dMY_CXT;
return (MY_CXT.context);
}
/* Free any data (such as the Perl interpreter) attached to an ithread
* structure. This is a bit like undef on SVs, where the SV isn't freed,
* but the PVX is. Must be called with thread->mutex already locked. Also,
* must be called with MY_POOL.create_destruct_mutex unlocked as destruction
* of the interpreter can lead to recursive destruction calls that could
* lead to a deadlock on that mutex.
*/
STATIC void
S_ithread_clear(pTHX_ ithread *thread)
{
PerlInterpreter *interp;
#ifndef WIN32
sigset_t origmask;
#endif
assert(((thread->state & PERL_ITHR_FINISHED) &&
(thread->state & PERL_ITHR_UNCALLABLE))
||
(thread->state & PERL_ITHR_NONVIABLE));
#ifdef THREAD_SIGNAL_BLOCKING
/* We temporarily set the interpreter context to the interpreter being
* destroyed. It's in no condition to handle signals while it's being
* taken apart.
*/
S_block_most_signals(&origmask);
#endif
interp = thread->interp;
if (interp) {
dTHXa(interp);
PERL_SET_CONTEXT(interp);
S_ithread_set(aTHX_ thread);
SvREFCNT_dec(thread->params);
thread->params = NULL;
if (thread->err) {
SvREFCNT_dec(thread->err);
thread->err = Nullsv;
}
perl_destruct(interp);
perl_free(interp);
thread->interp = NULL;
}
PERL_SET_CONTEXT(aTHX);
#ifdef THREAD_SIGNAL_BLOCKING
S_set_sigmask(&origmask);
#endif
}
/* Decrement the refcount of an ithread, and if it reaches zero, free it.
* Must be called with the mutex held.
* On return, mutex is released (or destroyed).
*/
STATIC void
S_ithread_free(pTHX_ ithread *thread)
PERL_TSA_RELEASE(thread->mutex)
{
#ifdef WIN32
HANDLE handle;
#endif
dMY_POOL;
if (! (thread->state & PERL_ITHR_NONVIABLE)) {
assert(thread->count > 0);
if (--thread->count > 0) {
MUTEX_UNLOCK(&thread->mutex);
return;
}
assert((thread->state & PERL_ITHR_FINISHED) &&
(thread->state & PERL_ITHR_UNCALLABLE));
}
MUTEX_UNLOCK(&thread->mutex);
/* Main thread (0) is immortal and should never get here */
assert(thread->tid != 0);
/* Remove from circular list of threads */
MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
assert(thread->prev && thread->next);
thread->next->prev = thread->prev;
thread->prev->next = thread->next;
thread->next = NULL;
thread->prev = NULL;
MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
/* Thread is now disowned */
MUTEX_LOCK(&thread->mutex);
S_ithread_clear(aTHX_ thread);
#ifdef WIN32
handle = thread->handle;
thread->handle = NULL;
#endif
MUTEX_UNLOCK(&thread->mutex);
MUTEX_DESTROY(&thread->mutex);
#ifdef WIN32
if (handle) {
CloseHandle(handle);
}
#endif
PerlMemShared_free(thread);
/* total_threads >= 1 is used to veto cleanup by the main thread,
* should it happen to exit while other threads still exist.
* Decrement this as the very last thing in the thread's existence.
* Otherwise, MY_POOL and global state such as PL_op_mutex may get
* freed while we're still using it.
*/
MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
MY_POOL.total_threads--;
MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
}
static void
S_ithread_count_inc(pTHX_ ithread *thread)
PERL_TSA_EXCLUDES(thread->mutex)
{
MUTEX_LOCK(&thread->mutex);
thread->count++;
MUTEX_UNLOCK(&thread->mutex);
}
/* Warn if exiting with any unjoined threads */
STATIC int
S_exit_warning(pTHX)
{
int veto_cleanup, warn;
dMY_POOL;
MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
veto_cleanup = (MY_POOL.total_threads > 0);
warn = (MY_POOL.running_threads || MY_POOL.joinable_threads);
MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
if (warn) {
if (ckWARN_d(WARN_THREADS)) {
Perl_warn(aTHX_ "Perl exited with active threads:\n\t%"
IVdf " running and unjoined\n\t%"
IVdf " finished and unjoined\n\t%"
IVdf " running and detached\n",
MY_POOL.running_threads,
MY_POOL.joinable_threads,
MY_POOL.detached_threads);
}
}
return (veto_cleanup);
}
/* Called from perl_destruct() in each thread. If it's the main thread,
* stop it from freeing everything if there are other threads still running.
*/
STATIC int
Perl_ithread_hook(pTHX)
{
dMY_POOL;
return ((aTHX == MY_POOL.main_thread.interp) ? S_exit_warning(aTHX) : 0);
}
/* MAGIC (in mg.h sense) hooks */
STATIC int
ithread_mg_get(pTHX_ SV *sv, MAGIC *mg)
{
ithread *thread = (ithread *)mg->mg_ptr;
SvIV_set(sv, PTR2IV(thread));
SvIOK_on(sv);
return (0);
}
STATIC int
ithread_mg_free(pTHX_ SV *sv, MAGIC *mg)
{
ithread *thread = (ithread *)mg->mg_ptr;
PERL_UNUSED_ARG(sv);
MUTEX_LOCK(&thread->mutex);
S_ithread_free(aTHX_ thread); /* Releases MUTEX */
return (0);
}
STATIC int
ithread_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
{
PERL_UNUSED_ARG(param);
S_ithread_count_inc(aTHX_ (ithread *)mg->mg_ptr);
return (0);
}
STATIC const MGVTBL ithread_vtbl = {
ithread_mg_get, /* get */
0, /* set */
0, /* len */
0, /* clear */
ithread_mg_free, /* free */
0, /* copy */
ithread_mg_dup, /* dup */
#if PERL_VERSION_GT(5,8,8)
0 /* local */
#endif
};
/* Provided default, minimum and rational stack sizes */
STATIC IV
S_good_stack_size(pTHX_ IV stack_size)
{
dMY_POOL;
/* Use default stack size if no stack size specified */
if (! stack_size) {
return (MY_POOL.default_stack_size);
}
#ifdef PTHREAD_STACK_MIN
/* Can't use less than minimum */
if (stack_size < PTHREAD_STACK_MIN) {
if (ckWARN(WARN_THREADS)) {
Perl_warn(aTHX_ "Using minimum thread stack size of %" IVdf, (IV)PTHREAD_STACK_MIN);
}
return (PTHREAD_STACK_MIN);
}
#endif
/* Round up to page size boundary */
if (MY_POOL.page_size <= 0) {
#if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
SETERRNO(0, SS_NORMAL);
# ifdef _SC_PAGESIZE
MY_POOL.page_size = sysconf(_SC_PAGESIZE);
# else
MY_POOL.page_size = sysconf(_SC_MMAP_PAGE_SIZE);
# endif
if ((long)MY_POOL.page_size < 0) {
if (errno) {
SV * const error = get_sv("@", 0);
(void)SvUPGRADE(error, SVt_PV);
Perl_croak(aTHX_ "PANIC: sysconf: %s", SvPV_nolen(error));
} else {
Perl_croak(aTHX_ "PANIC: sysconf: pagesize unknown");
}
}
#else
# ifdef HAS_GETPAGESIZE
MY_POOL.page_size = getpagesize();
# else
# if defined(I_SYS_PARAM) && defined(PAGESIZE)
MY_POOL.page_size = PAGESIZE;
# else
MY_POOL.page_size = 8192; /* A conservative default */
# endif
# endif
if (MY_POOL.page_size <= 0) {
Perl_croak(aTHX_ "PANIC: bad pagesize %" IVdf, (IV)MY_POOL.page_size);
}
#endif
}
stack_size = ((stack_size + (MY_POOL.page_size - 1)) / MY_POOL.page_size) * MY_POOL.page_size;
return (stack_size);
}
/* Run code within a JMPENV environment.
* Using a separate function avoids
* "variable 'foo' might be clobbered by 'longjmp'"
* warnings.
* The three _p vars return values to the caller
*/
static int
S_jmpenv_run(pTHX_ int action, ithread *thread,
int *len_p, int *exit_app_p, int *exit_code_p)
{
dJMPENV;
volatile I32 oldscope = PL_scopestack_ix;
int jmp_rc = 0;
JMPENV_PUSH(jmp_rc);
if (jmp_rc == 0) {
if (action == 0) {
/* Run the specified function */
*len_p = (int)call_sv(thread->init_function, thread->gimme|G_EVAL);
} else if (action == 1) {
/* Warn that thread died */
Perl_warn(aTHX_ "Thread %" UVuf " terminated abnormally: %" SVf, thread->tid, ERRSV);
} else {
/* Warn if there are unjoined threads */
S_exit_warning(aTHX);
}
} else if (jmp_rc == 2) {
/* Thread exited */
*exit_app_p = 1;
*exit_code_p = STATUS_CURRENT;
while (PL_scopestack_ix > oldscope) {
LEAVE;
}
}
JMPENV_POP;
return jmp_rc;
}
/* Starts executing the thread.
* Passed as the C level function to run in the new thread.
*/
#ifdef WIN32
STATIC THREAD_RET_TYPE
S_ithread_run(LPVOID arg)
#else
STATIC void *
S_ithread_run(void * arg)
#endif
{
ithread *thread = (ithread *)arg;
int exit_app = 0; /* Thread terminated using 'exit' */
int exit_code = 0;
int died = 0; /* Thread terminated abnormally */
dTHXa(thread->interp);
dMY_POOL;
/* The following mutex lock + mutex unlock pair explained.
*
* parent:
* - calls ithread_create (and S_ithread_create), which:
* - creates the new thread
* - does MUTEX_LOCK(&thread->mutex)
* - calls pthread_create(..., S_ithread_run,...)
* child:
* - starts the S_ithread_run (where we are now), which:
* - tries to MUTEX_LOCK(&thread->mutex)
* - blocks
* parent:
* - continues doing more createy stuff
* - does MUTEX_UNLOCK(&thread->mutex)
* - continues
* child:
* - finishes MUTEX_LOCK(&thread->mutex)
* - does MUTEX_UNLOCK(&thread->mutex)
* - continues
*/
MUTEX_LOCK(&thread->mutex);
MUTEX_UNLOCK(&thread->mutex);
PERL_SET_CONTEXT(thread->interp);
S_ithread_set(aTHX_ thread);
#ifdef THREAD_SIGNAL_BLOCKING
/* Thread starts with most signals blocked - restore the signal mask from
* the ithread struct.
*/
S_set_sigmask(&thread->initial_sigmask);
#endif
thread_locale_init();
PL_perl_destruct_level = 2;
{
AV *params = thread->params;
int len = (int)av_len(params)+1;
int ii;
int jmp_rc;
dSP;
ENTER;
SAVETMPS;
/* Put args on the stack */
PUSHMARK(SP);
for (ii=0; ii < len; ii++) {
XPUSHs(av_shift(params));
}
PUTBACK;
jmp_rc = S_jmpenv_run(aTHX_ 0, thread, &len, &exit_app, &exit_code);
#ifdef THREAD_SIGNAL_BLOCKING
/* The interpreter is finished, so this thread can stop receiving
* signals. This way, our signal handler doesn't get called in the
* middle of our parent thread calling perl_destruct()...
*/
S_block_most_signals(NULL);
#endif
/* Remove args from stack and put back in params array */
SPAGAIN;
for (ii=len-1; ii >= 0; ii--) {
SV *sv = POPs;
if (jmp_rc == 0 && (thread->gimme & G_WANT) != G_VOID) {
av_store(params, ii, SvREFCNT_inc(sv));
}
}
FREETMPS;
LEAVE;
/* Check for abnormal termination */
if (SvTRUE(ERRSV)) {
died = PERL_ITHR_DIED;
thread->err = newSVsv(ERRSV);
/* If ERRSV is an object, remember the classname and then
* rebless into 'main' so it will survive 'cloning'
*/
if (sv_isobject(thread->err)) {
thread->err_class = HvNAME(SvSTASH(SvRV(thread->err)));
sv_bless(thread->err, gv_stashpv("main", 0));
}
if (ckWARN_d(WARN_THREADS)) {
(void)S_jmpenv_run(aTHX_ 1, thread, NULL,
&exit_app, &exit_code);
}
}
/* Release function ref */
SvREFCNT_dec(thread->init_function);
thread->init_function = Nullsv;
}
PerlIO_flush((PerlIO *)NULL);
MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
MUTEX_LOCK(&thread->mutex);
/* Mark as finished */
thread->state |= (PERL_ITHR_FINISHED | died);
/* Clear exit flag if required */
if (thread->state & PERL_ITHR_THREAD_EXIT_ONLY) {
exit_app = 0;
}
/* Adjust thread status counts */
if (thread->state & PERL_ITHR_DETACHED) {
MY_POOL.detached_threads--;
} else {
MY_POOL.running_threads--;
MY_POOL.joinable_threads++;
}
MUTEX_UNLOCK(&thread->mutex);
MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
thread_locale_term();
/* Exit application if required */
if (exit_app) {
(void)S_jmpenv_run(aTHX_ 2, thread, NULL, &exit_app, &exit_code);
my_exit(exit_code);
}
/* At this point, the interpreter may have been freed, so call
* free in the context of the 'main' interpreter which
* can't have been freed due to the veto_cleanup mechanism.
*/
aTHX = MY_POOL.main_thread.interp;
MUTEX_LOCK(&thread->mutex);
S_ithread_free(aTHX_ thread); /* Releases MUTEX */
#ifdef WIN32
return ((DWORD)0);
#else
return (0);
#endif
}
/* Type conversion helper functions */
STATIC SV *
S_ithread_to_SV(pTHX_ SV *obj, ithread *thread, char *classname, bool inc)
{
SV *sv;
MAGIC *mg;
if (inc)
S_ithread_count_inc(aTHX_ thread);
if (! obj) {
obj = newSV(0);
}
sv = newSVrv(obj, classname);
sv_setiv(sv, PTR2IV(thread));
mg = sv_magicext(sv, Nullsv, PERL_MAGIC_shared_scalar, &ithread_vtbl, (char *)thread, 0);
mg->mg_flags |= MGf_DUP;
SvREADONLY_on(sv);
return (obj);
}
STATIC ithread *
S_SV_to_ithread(pTHX_ SV *sv)
{
/* Argument is a thread */
if (SvROK(sv)) {
return (INT2PTR(ithread *, SvIV(SvRV(sv))));
}
/* Argument is classname, therefore return current thread */
return (S_ithread_get(aTHX));
}
/* threads->create()
* Called in context of parent thread.
* Called with my_pool->create_destruct_mutex locked.
* (Unlocked both on error and on success.)
*/
STATIC ithread *
S_ithread_create(
PerlInterpreter *parent_perl,
my_pool_t *my_pool,
SV *init_function,
IV stack_size,
int gimme,
int exit_opt,
int params_start,
int num_params)
PERL_TSA_RELEASE(my_pool->create_destruct_mutex)
{
dTHXa(parent_perl);
ithread *thread;
ithread *current_thread = S_ithread_get(aTHX);
AV *params;
SV **array;
#if PERL_VERSION_LE(5,8,7)
SV **tmps_tmp = PL_tmps_stack;
IV tmps_ix = PL_tmps_ix;
#endif
#ifndef WIN32
int rc_stack_size = 0;
int rc_thread_create = 0;
#endif
/* Allocate thread structure in context of the main thread's interpreter */
{
PERL_SET_CONTEXT(my_pool->main_thread.interp);
thread = (ithread *)PerlMemShared_malloc(sizeof(ithread));
}
PERL_SET_CONTEXT(aTHX);
if (!thread) {
/* This lock was acquired in ithread_create()
* prior to calling S_ithread_create(). */
MUTEX_UNLOCK(&my_pool->create_destruct_mutex);
{
int fd = PerlIO_fileno(Perl_error_log);
if (fd >= 0) {
/* If there's no error_log, we cannot scream about it missing. */
PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, strlen(PL_no_mem)));
}
}
my_exit(1);
}
Zero(thread, 1, ithread);
/* Add to threads list */
thread->next = &my_pool->main_thread;
thread->prev = my_pool->main_thread.prev;
my_pool->main_thread.prev = thread;
thread->prev->next = thread;
my_pool->total_threads++;
/* 1 ref to be held by the local var 'thread' in S_ithread_run().
* 1 ref to be held by the threads object that we assume we will
* be embedded in upon our return.
* 1 ref to be the responsibility of join/detach, so we don't get
* freed until join/detach, even if no thread objects remain.
* This allows the following to work:
* { threads->create(sub{...}); } threads->object(1)->join;
*/
thread->count = 3;
/* Block new thread until ->create() call finishes */
MUTEX_INIT(&thread->mutex);
MUTEX_LOCK(&thread->mutex); /* See S_ithread_run() for more detail. */
thread->tid = my_pool->tid_counter++;
thread->stack_size = S_good_stack_size(aTHX_ stack_size);
thread->gimme = gimme;
thread->state = exit_opt;
/* "Clone" our interpreter into the thread's interpreter.
* This gives thread access to "static data" and code.
*/
PerlIO_flush((PerlIO *)NULL);
S_ithread_set(aTHX_ thread);
SAVEBOOL(PL_srand_called); /* Save this so it becomes the correct value */
PL_srand_called = FALSE; /* Set it to false so we can detect if it gets
set during the clone */
#ifdef THREAD_SIGNAL_BLOCKING
/* perl_clone() will leave us the new interpreter's context. This poses
* two problems for our signal handler. First, it sets the new context
* before the new interpreter struct is fully initialized, so our signal
* handler might find bogus data in the interpreter struct it gets.
* Second, even if the interpreter is initialized before a signal comes in,
* we would like to avoid that interpreter receiving notifications for
* signals (especially when they ought to be for the one running in this
* thread), until it is running in its own thread. Another problem is that
* the new thread will not have set the context until some time after it
* has started, so it won't be safe for our signal handler to run until
* that time.
*
* So we block most signals here, so the new thread will inherit the signal
* mask, and unblock them right after the thread creation. The original
* mask is saved in the thread struct so that the new thread can restore
* the original mask.
*/
S_block_most_signals(&thread->initial_sigmask);
#endif
#ifdef WIN32
thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE | CLONEf_CLONE_HOST);
#else
thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE);
#endif
/* perl_clone() leaves us in new interpreter's context. As it is tricky
* to spot an implicit aTHX, create a new scope with aTHX matching the
* context for the duration of our work for new interpreter.
*/
{
#if PERL_VERSION_GE(5,13,2)
CLONE_PARAMS *clone_param = Perl_clone_params_new(aTHX, thread->interp);
#else
CLONE_PARAMS clone_param_s;
CLONE_PARAMS *clone_param = &clone_param_s;
#endif
dTHXa(thread->interp);
MY_CXT_CLONE;
#if PERL_VERSION_LT(5,13,2)
clone_param->flags = 0;
#endif
/* Here we remove END blocks since they should only run in the thread
* they are created
*/
SvREFCNT_dec(PL_endav);
PL_endav = NULL;
if (SvPOK(init_function)) {
thread->init_function = newSV(0);
sv_copypv(thread->init_function, init_function);
} else {
thread->init_function = sv_dup_inc(init_function, clone_param);
}
thread->params = params = newAV();
av_extend(params, num_params - 1);
AvFILLp(params) = num_params - 1;
array = AvARRAY(params);
/* params_start is an offset onto the Perl stack. This can be
reallocated (and hence move) as a side effect of calls to
perl_clone() and sv_dup_inc(). Hence copy the parameters
somewhere under our control first, before duplicating. */
if (num_params) {
#if PERL_VERSION_GE(5,9,0)
Copy(parent_perl->Istack_base + params_start, array, num_params, SV *);
#else
Copy(parent_perl->Tstack_base + params_start, array, num_params, SV *);
#endif
while (num_params--) {
*array = sv_dup_inc(*array, clone_param);
++array;
}
}
#if PERL_VERSION_GE(5,13,2)
Perl_clone_params_del(clone_param);
#endif
#if PERL_VERSION_LT(5,8,8)
/* The code below checks that anything living on the tmps stack and
* has been cloned (so it lives in the ptr_table) has a refcount
* higher than 0.
*
* If the refcount is 0 it means that a something on the stack/context
* was holding a reference to it and since we init_stacks() in
* perl_clone that won't get cleaned and we will get a leaked scalar.
* The reason it was cloned was that it lived on the @_ stack.
*
* Example of this can be found in bugreport 15837 where calls in the
* parameter list end up as a temp.
*
* As of 5.8.8 this is done in perl_clone.
*/
while (tmps_ix > 0) {
SV* sv = (SV*)ptr_table_fetch(PL_ptr_table, tmps_tmp[tmps_ix]);
tmps_ix--;
if (sv && SvREFCNT(sv) == 0) {
SvREFCNT_inc_void(sv);
SvREFCNT_dec(sv);
}
}
#endif
SvTEMP_off(thread->init_function);
ptr_table_free(PL_ptr_table);
PL_ptr_table = NULL;
PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
}
S_ithread_set(aTHX_ current_thread);
PERL_SET_CONTEXT(aTHX);
/* Create/start the thread */
#ifdef WIN32
thread->handle = CreateThread(NULL,
(DWORD)thread->stack_size,
S_ithread_run,
(LPVOID)thread,
STACK_SIZE_PARAM_IS_A_RESERVATION,
&thread->thr);
#else
{
STATIC pthread_attr_t attr;
STATIC int attr_inited = 0;
STATIC int attr_joinable = PTHREAD_CREATE_JOINABLE;
if (! attr_inited) {
pthread_attr_init(&attr);
attr_inited = 1;
}
# ifdef PTHREAD_ATTR_SETDETACHSTATE
/* Threads start out joinable */
PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable);
# endif
# ifdef _POSIX_THREAD_ATTR_STACKSIZE
/* Set thread's stack size */
if (thread->stack_size > 0) {
rc_stack_size = pthread_attr_setstacksize(&attr, (size_t)thread->stack_size);
}
# endif
/* Create the thread */
if (! rc_stack_size) {
# ifdef OLD_PTHREADS_API
rc_thread_create = pthread_create(&thread->thr,
attr,
S_ithread_run,
(void *)thread);
# else
# if defined(HAS_PTHREAD_ATTR_SETSCOPE) && defined(PTHREAD_SCOPE_SYSTEM)
pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM);
# endif
rc_thread_create = pthread_create(&thread->thr,
&attr,
S_ithread_run,
(void *)thread);
# endif
}
#ifdef THREAD_SIGNAL_BLOCKING
/* Now it's safe to accept signals, since we're in our own interpreter's
* context and we have created the thread.
*/
S_set_sigmask(&thread->initial_sigmask);
#endif
# ifdef _POSIX_THREAD_ATTR_STACKSIZE
/* Try to get thread's actual stack size */
{
size_t stacksize;
#ifdef HPUX1020