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
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
|
#define PERL_NO_GET_CONTEXT
#include "EXTERN.h"
#include "perl.h"
#include "XSUB.h"
#ifdef HAS_PPPORT_H
# define NEED_PL_signals
# define NEED_newRV_noinc
# define NEED_sv_2pv_nolen
# include "ppport.h"
# include "threads.h"
#endif
#ifdef USE_ITHREADS
#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_JOINABLE 0
#define PERL_ITHR_DETACHED 1
#define PERL_ITHR_JOINED 2
#define PERL_ITHR_FINISHED 4
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; /* How many SVs have a reference to us */
int state; /* Detached, joined, finished, etc. */
int gimme; /* Context of create */
SV *init_function; /* Code to run */
SV *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;
} ithread;
/* Used by Perl interpreter for thread context switching */
#define MY_CXT_KEY "threads::_guts" XS_VERSION
typedef struct {
ithread *thread;
} my_cxt_t;
START_MY_CXT
/* Linked list of all threads */
static ithread *threads;
/* Protects the creation and destruction of threads*/
static perl_mutex create_destruct_mutex;
static UV tid_counter = 0;
static IV active_threads = 0;
#ifdef THREAD_CREATE_NEEDS_STACK
static IV default_stack_size = THREAD_CREATE_NEEDS_STACK;
#else
static IV default_stack_size = 0;
#endif
static IV page_size = 0;
/* Used by Perl interpreter for thread context switching */
static void
S_ithread_set(pTHX_ ithread *thread)
{
dMY_CXT;
MY_CXT.thread = thread;
}
static ithread *
S_ithread_get(pTHX)
{
dMY_CXT;
return (MY_CXT.thread);
}
/* 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 held.
*/
static void
S_ithread_clear(pTHX_ ithread *thread)
{
PerlInterpreter *interp;
assert(thread->state & PERL_ITHR_FINISHED &&
thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED));
interp = thread->interp;
if (interp) {
dTHXa(interp);
PERL_SET_CONTEXT(interp);
S_ithread_set(aTHX_ thread);
SvREFCNT_dec(thread->params);
thread->params = Nullsv;
perl_destruct(interp);
thread->interp = NULL;
}
if (interp)
perl_free(interp);
PERL_SET_CONTEXT(aTHX);
}
/* Free an ithread structure and any attached data if its count == 0 */
static void
S_ithread_destruct(pTHX_ ithread *thread)
{
#ifdef WIN32
HANDLE handle;
#endif
MUTEX_LOCK(&thread->mutex);
/* Thread is still in use */
if (thread->count != 0) {
MUTEX_UNLOCK(&thread->mutex);
return;
}
MUTEX_LOCK(&create_destruct_mutex);
/* Main thread (0) is immortal and should never get here */
assert(thread->tid != 0);
/* Remove from circular list of threads */
thread->next->prev = thread->prev;
thread->prev->next = thread->next;
thread->next = NULL;
thread->prev = NULL;
MUTEX_UNLOCK(&create_destruct_mutex);
/* Thread is now disowned */
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
/* Call PerlMemShared_free() in the context of the "first" interpreter
* per http://www.nntp.perl.org/group/perl.perl5.porters/110772
*/
aTHX = PL_curinterp;
PerlMemShared_free(thread);
}
/* Called on exit */
int
Perl_ithread_hook(pTHX)
{
int veto_cleanup = 0;
MUTEX_LOCK(&create_destruct_mutex);
if ((aTHX == PL_curinterp) && (active_threads != 1)) {
if (ckWARN_d(WARN_THREADS)) {
Perl_warn(aTHX_ "A thread exited while %" IVdf " threads were running", active_threads);
}
veto_cleanup = 1;
}
MUTEX_UNLOCK(&create_destruct_mutex);
return (veto_cleanup);
}
/* MAGIC (in mg.h sense) hooks */
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);
}
int
ithread_mg_free(pTHX_ SV *sv, MAGIC *mg)
{
ithread *thread = (ithread *)mg->mg_ptr;
int cleanup;
MUTEX_LOCK(&thread->mutex);
cleanup = ((--thread->count == 0) &&
(thread->state & PERL_ITHR_FINISHED) &&
(thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)));
MUTEX_UNLOCK(&thread->mutex);
if (cleanup)
S_ithread_destruct(aTHX_ thread);
return (0);
}
int
ithread_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
{
ithread *thread = (ithread *)mg->mg_ptr;
MUTEX_LOCK(&thread->mutex);
thread->count++;
MUTEX_UNLOCK(&thread->mutex);
return (0);
}
MGVTBL ithread_vtbl = {
ithread_mg_get, /* get */
0, /* set */
0, /* len */
0, /* clear */
ithread_mg_free, /* free */
0, /* copy */
ithread_mg_dup /* dup */
};
/* Provided default, minimum and rational stack sizes */
static IV
good_stack_size(pTHX_ IV stack_size)
{
/* Use default stack size if no stack size specified */
if (! stack_size)
return (default_stack_size);
#ifdef PTHREAD_STACK_MIN
/* Can't use less than minimum */
if (stack_size < PTHREAD_STACK_MIN) {
if (ckWARN_d(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 (page_size <= 0) {
#if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
SETERRNO(0, SS_NORMAL);
# ifdef _SC_PAGESIZE
page_size = sysconf(_SC_PAGESIZE);
# else
page_size = sysconf(_SC_MMAP_PAGE_SIZE);
# endif
if ((long)page_size < 0) {
if (errno) {
SV * const error = get_sv("@", FALSE);
(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
page_size = getpagesize();
# else
# if defined(I_SYS_PARAM) && defined(PAGESIZE)
page_size = PAGESIZE;
# else
page_size = 8192; /* A conservative default */
# endif
# endif
if (page_size <= 0)
Perl_croak(aTHX_ "PANIC: bad pagesize %" IVdf, (IV)page_size);
#endif
}
stack_size = ((stack_size + (page_size - 1)) / page_size) * page_size;
return (stack_size);
}
/* 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 cleanup;
dTHXa(thread->interp);
PERL_SET_CONTEXT(thread->interp);
S_ithread_set(aTHX_ thread);
#if 0
/* Far from clear messing with ->thr child-side is a good idea */
MUTEX_LOCK(&thread->mutex);
#ifdef WIN32
thread->thr = GetCurrentThreadId();
#else
thread->thr = pthread_self();
#endif
MUTEX_UNLOCK(&thread->mutex);
#endif
PL_perl_destruct_level = 2;
{
AV *params = (AV *)SvRV(thread->params);
int len = (int)av_len(params)+1;
int ii;
dSP;
ENTER;
SAVETMPS;
/* Put args on the stack */
PUSHMARK(SP);
for (ii=0; ii < len; ii++) {
XPUSHs(av_shift(params));
}
PUTBACK;
/* Run the specified function */
len = (int)call_sv(thread->init_function, thread->gimme|G_EVAL);
/* Remove args from stack and put back in params array */
SPAGAIN;
for (ii=len-1; ii >= 0; ii--) {
SV *sv = POPs;
av_store(params, ii, SvREFCNT_inc(sv));
}
/* Check for failure */
if (SvTRUE(ERRSV) && ckWARN_d(WARN_THREADS)) {
Perl_warn(aTHX_ "Thread %" UVuf " terminated abnormally: %" SVf, thread->tid, ERRSV);
}
FREETMPS;
LEAVE;
/* Release function ref */
SvREFCNT_dec(thread->init_function);
thread->init_function = Nullsv;
}
PerlIO_flush((PerlIO *)NULL);
MUTEX_LOCK(&thread->mutex);
/* Mark as finished */
thread->state |= PERL_ITHR_FINISHED;
/* Cleanup if detached */
cleanup = (thread->state & PERL_ITHR_DETACHED);
MUTEX_UNLOCK(&thread->mutex);
if (cleanup)
S_ithread_destruct(aTHX_ thread);
MUTEX_LOCK(&create_destruct_mutex);
active_threads--;
MUTEX_UNLOCK(&create_destruct_mutex);
#ifdef WIN32
return ((DWORD)0);
#else
return (0);
#endif
}
/* Type conversion helper functions */
static SV *
ithread_to_SV(pTHX_ SV *obj, ithread *thread, char *classname, bool inc)
{
SV *sv;
MAGIC *mg;
if (inc) {
MUTEX_LOCK(&thread->mutex);
thread->count++;
MUTEX_UNLOCK(&thread->mutex);
}
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 *
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.
*/
static SV *
S_ithread_create(
pTHX_ SV *obj,
char *classname,
SV *init_function,
IV stack_size,
SV *params)
{
ithread *thread;
CLONE_PARAMS clone_param;
ithread *current_thread = S_ithread_get(aTHX);
SV **tmps_tmp = PL_tmps_stack;
IV tmps_ix = PL_tmps_ix;
#ifndef WIN32
int rc_stack_size = 0;
int rc_thread_create = 0;
#endif
MUTEX_LOCK(&create_destruct_mutex);
/* Allocate thread structure */
thread = (ithread *)PerlMemShared_malloc(sizeof(ithread));
if (!thread) {
MUTEX_UNLOCK(&create_destruct_mutex);
PerlLIO_write(PerlIO_fileno(Perl_error_log), PL_no_mem, strlen(PL_no_mem));
my_exit(1);
}
Zero(thread, 1, ithread);
/* Add to threads list */
thread->next = threads;
thread->prev = threads->prev;
threads->prev = thread;
thread->prev->next = thread;
/* Set count to 1 immediately in case thread exits before
* we return to caller!
*/
thread->count = 1;
MUTEX_INIT(&thread->mutex);
thread->tid = tid_counter++;
thread->stack_size = good_stack_size(aTHX_ stack_size);
thread->gimme = GIMME_V;
/* "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 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.
*/
{
dTHXa(thread->interp);
MY_CXT_CLONE;
/* Here we remove END blocks since they should only run in the thread
* they are created
*/
SvREFCNT_dec(PL_endav);
PL_endav = newAV();
if (SvPOK(init_function)) {
thread->init_function = newSV(0);
sv_copypv(thread->init_function, init_function);
} else {
clone_param.flags = 0;
thread->init_function = sv_dup(init_function, &clone_param);
if (SvREFCNT(thread->init_function) == 0) {
SvREFCNT_inc(thread->init_function);
}
}
thread->params = sv_dup(params, &clone_param);
SvREFCNT_inc(thread->params);
/* 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.
*
* One could argue that this fix should be 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(sv);
SvREFCNT_dec(sv);
}
}
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 _POSIX_THREAD_ATTR_STACKSIZE
/* Try to get thread's actual stack size */
{
size_t stacksize;
if (! pthread_attr_getstacksize(&attr, &stacksize)) {
if (stacksize) {
thread->stack_size = (IV)stacksize;
}
}
}
# endif
}
#endif
/* Check for errors */
#ifdef WIN32
if (thread->handle == NULL) {
#else
if (rc_stack_size || rc_thread_create) {
#endif
MUTEX_UNLOCK(&create_destruct_mutex);
sv_2mortal(params);
S_ithread_destruct(aTHX_ thread);
#ifndef WIN32
if (ckWARN_d(WARN_THREADS)) {
if (rc_stack_size)
Perl_warn(aTHX_ "Thread creation failed: pthread_attr_setstacksize(%" IVdf ") returned %d", thread->stack_size, rc_stack_size);
else
Perl_warn(aTHX_ "Thread creation failed: pthread_create returned %d", rc_thread_create);
}
#endif
return (&PL_sv_undef);
}
active_threads++;
MUTEX_UNLOCK(&create_destruct_mutex);
sv_2mortal(params);
return (ithread_to_SV(aTHX_ obj, thread, classname, FALSE));
}
#endif /* USE_ITHREADS */
MODULE = threads PACKAGE = threads PREFIX = ithread_
PROTOTYPES: DISABLE
#ifdef USE_ITHREADS
void
ithread_create(...)
PREINIT:
char *classname;
ithread *thread;
SV *function_to_call;
AV *params;
HV *specs;
IV stack_size;
int idx;
int ii;
CODE:
if ((items >= 2) && SvROK(ST(1)) && SvTYPE(SvRV(ST(1)))==SVt_PVHV) {
if (--items < 2)
Perl_croak(aTHX_ "Usage: threads->create(\\%specs, function, ...)");
specs = (HV*)SvRV(ST(1));
idx = 1;
} else {
if (items < 2)
Perl_croak(aTHX_ "Usage: threads->create(function, ...)");
specs = NULL;
idx = 0;
}
if (sv_isobject(ST(0))) {
/* $thr->create() */
classname = HvNAME(SvSTASH(SvRV(ST(0))));
thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
stack_size = thread->stack_size;
} else {
/* threads->create() */
classname = (char *)SvPV_nolen(ST(0));
stack_size = default_stack_size;
}
function_to_call = ST(idx+1);
if (specs) {
/* stack_size */
if (hv_exists(specs, "stack", 5)) {
stack_size = SvIV(*hv_fetch(specs, "stack", 5, 0));
} else if (hv_exists(specs, "stacksize", 9)) {
stack_size = SvIV(*hv_fetch(specs, "stacksize", 9, 0));
} else if (hv_exists(specs, "stack_size", 10)) {
stack_size = SvIV(*hv_fetch(specs, "stack_size", 10, 0));
}
}
/* Function args */
params = newAV();
if (items > 2) {
for (ii=2; ii < items ; ii++) {
av_push(params, SvREFCNT_inc(ST(idx+ii)));
}
}
/* Create thread */
ST(0) = sv_2mortal(S_ithread_create(aTHX_ Nullsv,
classname,
function_to_call,
stack_size,
newRV_noinc((SV*)params)));
/* XSRETURN(1); - implied */
void
ithread_list(...)
PREINIT:
char *classname;
ithread *thread;
int list_context;
IV count = 0;
PPCODE:
/* Class method only */
if (SvROK(ST(0)))
Perl_croak(aTHX_ "Usage: threads->list()");
classname = (char *)SvPV_nolen(ST(0));
/* Calling context */
list_context = (GIMME_V == G_ARRAY);
/* Walk through threads list */
MUTEX_LOCK(&create_destruct_mutex);
for (thread = threads->next;
thread != threads;
thread = thread->next)
{
/* Ignore detached or joined threads */
if (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)) {
continue;
}
/* Push object on stack if list context */
if (list_context) {
XPUSHs(sv_2mortal(ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE)));
}
count++;
}
MUTEX_UNLOCK(&create_destruct_mutex);
/* If scalar context, send back count */
if (! list_context) {
XSRETURN_IV(count);
}
void
ithread_self(...)
PREINIT:
char *classname;
ithread *thread;
CODE:
/* Class method only */
if (SvROK(ST(0)))
Perl_croak(aTHX_ "Usage: threads->self()");
classname = (char *)SvPV_nolen(ST(0));
thread = S_ithread_get(aTHX);
ST(0) = sv_2mortal(ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
/* XSRETURN(1); - implied */
void
ithread_tid(...)
PREINIT:
ithread *thread;
CODE:
thread = SV_to_ithread(aTHX_ ST(0));
XST_mUV(0, thread->tid);
/* XSRETURN(1); - implied */
void
ithread_join(...)
PREINIT:
ithread *thread;
int join_err;
AV *params;
int len;
int ii;
#ifdef WIN32
DWORD waitcode;
#else
void *retval;
#endif
PPCODE:
/* Object method only */
if (! sv_isobject(ST(0)))
Perl_croak(aTHX_ "Usage: $thr->join()");
/* Check if the thread is joinable */
thread = SV_to_ithread(aTHX_ ST(0));
MUTEX_LOCK(&thread->mutex);
join_err = (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED));
MUTEX_UNLOCK(&thread->mutex);
if (join_err) {
if (join_err & PERL_ITHR_DETACHED) {
Perl_croak(aTHX_ "Cannot join a detached thread");
} else {
Perl_croak(aTHX_ "Thread already joined");
}
}
/* Join the thread */
#ifdef WIN32
waitcode = WaitForSingleObject(thread->handle, INFINITE);
#else
pthread_join(thread->thr, &retval);
#endif
MUTEX_LOCK(&thread->mutex);
/* Mark as joined */
thread->state |= PERL_ITHR_JOINED;
/* Get the return value from the call_sv */
{
AV *params_copy;
PerlInterpreter *other_perl;
CLONE_PARAMS clone_params;
ithread *current_thread;
params_copy = (AV *)SvRV(thread->params);
other_perl = thread->interp;
clone_params.stashes = newAV();
clone_params.flags = CLONEf_JOIN_IN;
PL_ptr_table = ptr_table_new();
current_thread = S_ithread_get(aTHX);
S_ithread_set(aTHX_ thread);
/* Ensure 'meaningful' addresses retain their meaning */
ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
params = (AV *)sv_dup((SV*)params_copy, &clone_params);
S_ithread_set(aTHX_ current_thread);
SvREFCNT_dec(clone_params.stashes);
SvREFCNT_inc(params);
ptr_table_free(PL_ptr_table);
PL_ptr_table = NULL;
}
/* We are finished with the thread */
S_ithread_clear(aTHX_ thread);
MUTEX_UNLOCK(&thread->mutex);
/* If no return values, then just return */
if (! params) {
XSRETURN_UNDEF;
}
/* Put return values on stack */
len = (int)AvFILL(params);
for (ii=0; ii <= len; ii++) {
SV* param = av_shift(params);
XPUSHs(sv_2mortal(param));
}
/* Free return value array */
SvREFCNT_dec(params);
void
ithread_yield(...)
CODE:
YIELD;
void
ithread_detach(...)
PREINIT:
ithread *thread;
int detach_err;
int cleanup;
CODE:
thread = SV_to_ithread(aTHX_ ST(0));
MUTEX_LOCK(&thread->mutex);
/* Check if the thread is detachable */
if ((detach_err = (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)))) {
MUTEX_UNLOCK(&thread->mutex);
if (detach_err & PERL_ITHR_DETACHED) {
Perl_croak(aTHX_ "Thread already detached");
} else {
Perl_croak(aTHX_ "Cannot detach a joined thread");
}
}
/* Detach the thread */
thread->state |= PERL_ITHR_DETACHED;
#ifdef WIN32
/* Windows has no 'detach thread' function */
#else
PERL_THREAD_DETACH(thread->thr);
#endif
/* Cleanup if finished */
cleanup = (thread->state & PERL_ITHR_FINISHED);
MUTEX_UNLOCK(&thread->mutex);
if (cleanup)
S_ithread_destruct(aTHX_ thread);
void
ithread_kill(...)
PREINIT:
ithread *thread;
char *sig_name;
IV signal;
CODE:
/* Must have safe signals */
if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG)
Perl_croak(aTHX_ "Cannot signal other threads without safe signals");
/* Object method only */
if (! sv_isobject(ST(0)))
Perl_croak(aTHX_ "Usage: $thr->kill('SIG...')");
/* Get thread */
thread = SV_to_ithread(aTHX_ ST(0));
/* Get signal */
sig_name = SvPV_nolen(ST(1));
if (isALPHA(*sig_name)) {
if (*sig_name == 'S' && sig_name[1] == 'I' && sig_name[2] == 'G')
sig_name += 3;
if ((signal = whichsig(sig_name)) < 0)
Perl_croak(aTHX_ "Unrecognized signal name: %s", sig_name);
} else
signal = SvIV(ST(1));
/* Set the signal for the thread */
{
dTHXa(thread->interp);
PL_psig_pend[signal]++;
PL_sig_pending = 1;
}
/* Return the thread to allow for method chaining */
ST(0) = ST(0);
/* XSRETURN(1); - implied */
void
ithread_DESTROY(...)
CODE:
sv_unmagic(SvRV(ST(0)), PERL_MAGIC_shared_scalar);
void
ithread_equal(...)
PREINIT:
int are_equal = 0;
CODE:
/* Compares TIDs to determine thread equality */
if (sv_isobject(ST(0)) && sv_isobject(ST(1))) {
ithread *thr1 = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
ithread *thr2 = INT2PTR(ithread *, SvIV(SvRV(ST(1))));
are_equal = (thr1->tid == thr2->tid);
}
if (are_equal) {
XST_mYES(0);
} else {
/* Return 0 on false for backward compatibility */
XST_mIV(0, 0);
}
/* XSRETURN(1); - implied */
void
ithread_object(...)
PREINIT:
char *classname;
UV tid;
ithread *thread;
int found = 0;
CODE:
/* Class method only */
if (SvROK(ST(0)))
Perl_croak(aTHX_ "Usage: threads->object($tid)");
classname = (char *)SvPV_nolen(ST(0));
if ((items < 2) || ! SvOK(ST(1))) {
XSRETURN_UNDEF;
}
/* threads->object($tid) */
tid = SvUV(ST(1));
/* Walk through threads list */
MUTEX_LOCK(&create_destruct_mutex);
for (thread = threads->next;
thread != threads;
thread = thread->next)
{
/* Look for TID, but ignore detached or joined threads */
if ((thread->tid != tid) ||
(thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)))
{
continue;
}
/* Put object on stack */
ST(0) = sv_2mortal(ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
found = 1;
break;
}
MUTEX_UNLOCK(&create_destruct_mutex);
if (! found) {
XSRETURN_UNDEF;
}
/* XSRETURN(1); - implied */
void
ithread__handle(...);
PREINIT:
ithread *thread;
CODE:
thread = SV_to_ithread(aTHX_ ST(0));
#ifdef WIN32
XST_mUV(0, PTR2UV(&thread->handle));
#else
XST_mUV(0, PTR2UV(&thread->thr));
#endif
/* XSRETURN(1); - implied */
void
ithread_get_stack_size(...)
PREINIT:
IV stack_size;
CODE:
if (sv_isobject(ST(0))) {
/* $thr->get_stack_size() */
ithread *thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
stack_size = thread->stack_size;
} else {
/* threads->get_stack_size() */
stack_size = default_stack_size;
}
XST_mIV(0, stack_size);
/* XSRETURN(1); - implied */
void
ithread_set_stack_size(...)
PREINIT:
IV old_size;
CODE:
if (items != 2)
Perl_croak(aTHX_ "Usage: threads->set_stack_size($size)");
if (sv_isobject(ST(0)))
Perl_croak(aTHX_ "Cannot change stack size of an existing thread");
old_size = default_stack_size;
default_stack_size = good_stack_size(aTHX_ SvIV(ST(1)));
XST_mIV(0, old_size);
/* XSRETURN(1); - implied */
#endif /* USE_ITHREADS */
BOOT:
{
#ifdef USE_ITHREADS
/* The 'main' thread is thread 0.
* It is detached (unjoinable) and immortal.
*/
ithread *thread;
MY_CXT_INIT;
PL_perl_destruct_level = 2;
MUTEX_INIT(&create_destruct_mutex);
MUTEX_LOCK(&create_destruct_mutex);
PL_threadhook = &Perl_ithread_hook;
thread = (ithread *)PerlMemShared_malloc(sizeof(ithread));
if (! thread) {
PerlLIO_write(PerlIO_fileno(Perl_error_log), PL_no_mem, strlen(PL_no_mem));
my_exit(1);
}
Zero(thread, 1, ithread);
PL_perl_destruct_level = 2;
MUTEX_INIT(&thread->mutex);
thread->tid = tid_counter++; /* Thread 0 */
/* Head of the threads list */
threads = thread;
thread->next = thread;
thread->prev = thread;
thread->count = 1; /* Immortal */
thread->interp = aTHX;
thread->state = PERL_ITHR_DETACHED; /* Detached */
thread->stack_size = default_stack_size;
# ifdef WIN32
thread->thr = GetCurrentThreadId();
# else
thread->thr = pthread_self();
# endif
active_threads++;
S_ithread_set(aTHX_ thread);
MUTEX_UNLOCK(&create_destruct_mutex);
#endif /* USE_ITHREADS */
}
|