1 #define PERL_NO_GET_CONTEXT
10 #include <win32thread.h>
11 #define PERL_THREAD_SETSPECIFIC(k,v) TlsSetValue(k,v)
12 #define PERL_THREAD_GETSPECIFIC(k,v) v = TlsGetValue(k)
13 #define PERL_THREAD_ALLOC_SPECIFIC(k) \
15 if((k = TlsAlloc()) == TLS_OUT_OF_INDEXES) {\
16 PerlIO_printf(PerlIO_stderr(),"panic threads.h: TlsAlloc");\
24 #define PERL_THREAD_SETSPECIFIC(k,v) pthread_setspecific(k,v)
25 #ifdef OLD_PTHREADS_API
26 #define PERL_THREAD_DETACH(t) pthread_detach(&(t))
27 #define PERL_THREAD_GETSPECIFIC(k,v) pthread_getspecific(k,&v)
28 #define PERL_THREAD_ALLOC_SPECIFIC(k) STMT_START {\
29 if(pthread_keycreate(&(k),0)) {\
30 PerlIO_printf(PerlIO_stderr(), "panic threads.h: pthread_key_create");\
35 #define PERL_THREAD_DETACH(t) pthread_detach((t))
36 #define PERL_THREAD_GETSPECIFIC(k,v) v = pthread_getspecific(k)
37 #define PERL_THREAD_ALLOC_SPECIFIC(k) STMT_START {\
38 if(pthread_key_create(&(k),0)) {\
39 PerlIO_printf(PerlIO_stderr(), "panic threads.h: pthread_key_create");\
46 /* Values for 'state' member */
47 #define PERL_ITHR_JOINABLE 0
48 #define PERL_ITHR_DETACHED 1
49 #define PERL_ITHR_FINISHED 4
50 #define PERL_ITHR_JOINED 2
52 typedef struct ithread_s {
53 struct ithread_s *next; /* next thread in the list */
54 struct ithread_s *prev; /* prev thread in the list */
55 PerlInterpreter *interp; /* The threads interpreter */
56 I32 tid; /* threads module's thread id */
57 perl_mutex mutex; /* mutex for updating things in this struct */
58 I32 count; /* how many SVs have a reference to us */
59 signed char state; /* are we detached ? */
60 int gimme; /* Context of create */
61 SV* init_function; /* Code to run */
62 SV* params; /* args to pass function */
64 DWORD thr; /* OS's idea if thread id */
65 HANDLE handle; /* OS's waitable handle */
67 pthread_t thr; /* OS's handle for the thread */
73 /* Macros to supply the aTHX_ in an embed.h like manner */
74 #define ithread_join(thread) Perl_ithread_join(aTHX_ thread)
75 #define ithread_DESTROY(thread) Perl_ithread_DESTROY(aTHX_ thread)
76 #define ithread_CLONE(thread) Perl_ithread_CLONE(aTHX_ thread)
77 #define ithread_detach(thread) Perl_ithread_detach(aTHX_ thread)
78 #define ithread_tid(thread) ((thread)->tid)
79 #define ithread_yield(thread) (YIELD);
81 static perl_mutex create_destruct_mutex; /* protects the creation and destruction of threads*/
84 I32 known_threads = 0;
85 I32 active_threads = 0;
89 * Clear up after thread is done with
92 Perl_ithread_destruct (pTHX_ ithread* thread, const char *why)
94 MUTEX_LOCK(&thread->mutex);
96 Perl_croak(aTHX_ "panic: destruct destroyed thread %p (%s)",thread, why);
98 if (thread->count != 0) {
99 MUTEX_UNLOCK(&thread->mutex);
102 MUTEX_LOCK(&create_destruct_mutex);
103 /* Remove from circular list of threads */
104 if (thread->next == thread) {
105 /* last one should never get here ? */
109 thread->next->prev = thread->prev;
110 thread->prev->next = thread->next;
111 if (threads == thread) {
112 threads = thread->next;
118 assert( known_threads >= 0 );
120 Perl_warn(aTHX_ "destruct %d @ %p by %p now %d",
121 thread->tid,thread->interp,aTHX, known_threads);
123 MUTEX_UNLOCK(&create_destruct_mutex);
124 /* Thread is now disowned */
125 if (thread->interp) {
126 dTHXa(thread->interp);
127 PERL_SET_CONTEXT(thread->interp);
128 SvREFCNT_dec(thread->params);
129 thread->params = Nullsv;
130 perl_destruct(thread->interp);
131 perl_free(thread->interp);
132 thread->interp = NULL;
134 PERL_SET_CONTEXT(aTHX);
135 MUTEX_UNLOCK(&thread->mutex);
136 MUTEX_DESTROY(&thread->mutex);
137 PerlMemShared_free(thread);
141 Perl_ithread_hook(pTHX)
143 int veto_cleanup = 0;
144 MUTEX_LOCK(&create_destruct_mutex);
145 if (aTHX == PL_curinterp && active_threads != 1) {
146 Perl_warn(aTHX_ "Cleanup skipped %d active threads", active_threads);
149 MUTEX_UNLOCK(&create_destruct_mutex);
154 Perl_ithread_detach(pTHX_ ithread *thread)
156 MUTEX_LOCK(&thread->mutex);
157 if (!(thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED))) {
158 thread->state |= PERL_ITHR_DETACHED;
160 CloseHandle(thread->handle);
163 PERL_THREAD_DETACH(thread->thr);
166 if ((thread->state & PERL_ITHR_FINISHED) &&
167 (thread->state & PERL_ITHR_DETACHED)) {
168 MUTEX_UNLOCK(&thread->mutex);
169 Perl_ithread_destruct(aTHX_ thread, "detach");
172 MUTEX_UNLOCK(&thread->mutex);
176 /* MAGIC (in mg.h sense) hooks */
179 ithread_mg_get(pTHX_ SV *sv, MAGIC *mg)
181 ithread *thread = (ithread *) mg->mg_ptr;
182 SvIVX(sv) = PTR2IV(thread);
188 ithread_mg_free(pTHX_ SV *sv, MAGIC *mg)
190 ithread *thread = (ithread *) mg->mg_ptr;
191 MUTEX_LOCK(&thread->mutex);
193 if (thread->count == 0) {
194 if(thread->state & PERL_ITHR_FINISHED &&
195 (thread->state & PERL_ITHR_DETACHED ||
196 thread->state & PERL_ITHR_JOINED))
198 MUTEX_UNLOCK(&thread->mutex);
199 Perl_ithread_destruct(aTHX_ thread, "no reference");
201 MUTEX_UNLOCK(&thread->mutex);
204 MUTEX_UNLOCK(&thread->mutex);
210 ithread_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
212 ithread *thread = (ithread *) mg->mg_ptr;
213 MUTEX_LOCK(&thread->mutex);
215 MUTEX_UNLOCK(&thread->mutex);
219 MGVTBL ithread_vtbl = {
220 ithread_mg_get, /* get */
224 ithread_mg_free, /* free */
226 ithread_mg_dup /* dup */
231 * Starts executing the thread. Needs to clean up memory a tad better.
232 * Passed as the C level function to run in the new thread
237 Perl_ithread_run(LPVOID arg) {
240 Perl_ithread_run(void * arg) {
242 ithread* thread = (ithread*) arg;
243 dTHXa(thread->interp);
244 PERL_SET_CONTEXT(thread->interp);
245 PERL_THREAD_SETSPECIFIC(self_key,thread);
248 /* Far from clear messing with ->thr child-side is a good idea */
249 MUTEX_LOCK(&thread->mutex);
251 thread->thr = GetCurrentThreadId();
253 thread->thr = pthread_self();
255 MUTEX_UNLOCK(&thread->mutex);
258 PL_perl_destruct_level = 2;
261 AV* params = (AV*) SvRV(thread->params);
262 I32 len = av_len(params)+1;
268 for(i = 0; i < len; i++) {
269 XPUSHs(av_shift(params));
272 len = call_sv(thread->init_function, thread->gimme|G_EVAL);
274 for (i=len-1; i >= 0; i--) {
276 av_store(params, i, SvREFCNT_inc(sv));
280 Perl_warn(aTHX_ "Died:%_",ERRSV);
284 SvREFCNT_dec(thread->init_function);
287 PerlIO_flush((PerlIO*)NULL);
288 MUTEX_LOCK(&create_destruct_mutex);
290 assert( active_threads >= 0 );
291 MUTEX_UNLOCK(&create_destruct_mutex);
292 MUTEX_LOCK(&thread->mutex);
293 thread->state |= PERL_ITHR_FINISHED;
295 if (thread->state & PERL_ITHR_DETACHED) {
296 MUTEX_UNLOCK(&thread->mutex);
297 Perl_ithread_destruct(aTHX_ thread, "detached finish");
299 MUTEX_UNLOCK(&thread->mutex);
309 ithread_to_SV(pTHX_ SV *obj, ithread *thread, char *classname, bool inc)
314 MUTEX_LOCK(&thread->mutex);
316 MUTEX_UNLOCK(&thread->mutex);
320 sv = newSVrv(obj,classname);
321 sv_setiv(sv,PTR2IV(thread));
322 mg = sv_magicext(sv,Nullsv,PERL_MAGIC_shared_scalar,&ithread_vtbl,(char *)thread,0);
323 mg->mg_flags |= MGf_DUP;
329 SV_to_ithread(pTHX_ SV *sv)
334 thread = INT2PTR(ithread*, SvIV(SvRV(sv)));
338 PERL_THREAD_GETSPECIFIC(self_key,thread);
344 * iThread->create(); ( aka iThread->new() )
345 * Called in context of parent thread
349 Perl_ithread_create(pTHX_ SV *obj, char* classname, SV* init_function, SV* params)
352 CLONE_PARAMS clone_param;
354 MUTEX_LOCK(&create_destruct_mutex);
355 thread = PerlMemShared_malloc(sizeof(ithread));
356 Zero(thread,1,ithread);
357 thread->next = threads;
358 thread->prev = threads->prev;
359 threads->prev = thread;
360 thread->prev->next = thread;
361 /* Set count to 1 immediately in case thread exits before
362 * we return to caller !
365 MUTEX_INIT(&thread->mutex);
366 thread->tid = tid_counter++;
367 thread->gimme = GIMME_V;
368 thread->state = (thread->gimme == G_VOID) ? 1 : 0;
370 /* "Clone" our interpreter into the thread's interpreter
371 * This gives thread access to "static data" and code.
374 PerlIO_flush((PerlIO*)NULL);
377 thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE | CLONEf_CLONE_HOST);
379 thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE);
381 /* perl_clone leaves us in new interpreter's context.
382 As it is tricky to spot implcit aTHX create a new scope
383 with aTHX matching the context for the duration of
384 our work for new interpreter.
387 dTHXa(thread->interp);
388 /* Here we remove END blocks since they should only run
389 in the thread they are created
391 SvREFCNT_dec(PL_endav);
393 clone_param.flags = 0;
394 thread->init_function = sv_dup(init_function, &clone_param);
395 if (SvREFCNT(thread->init_function) == 0) {
396 SvREFCNT_inc(thread->init_function);
399 thread->params = sv_dup(params, &clone_param);
400 SvREFCNT_inc(thread->params);
401 SvTEMP_off(thread->init_function);
402 ptr_table_free(PL_ptr_table);
406 PERL_SET_CONTEXT(aTHX);
408 /* Start the thread */
412 thread->handle = CreateThread(NULL, 0, Perl_ithread_run,
413 (LPVOID)thread, 0, &thread->thr);
417 static pthread_attr_t attr;
418 static int attr_inited = 0;
419 static int attr_joinable = PTHREAD_CREATE_JOINABLE;
422 pthread_attr_init(&attr);
424 # ifdef PTHREAD_ATTR_SETDETACHSTATE
425 PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable);
427 # ifdef THREAD_CREATE_NEEDS_STACK
428 if(pthread_attr_setstacksize(&attr, THREAD_CREATE_NEEDS_STACK))
429 croak("panic: pthread_attr_setstacksize failed");
432 #ifdef OLD_PTHREADS_API
433 pthread_create( &thread->thr, attr, Perl_ithread_run, (void *)thread);
435 pthread_create( &thread->thr, &attr, Perl_ithread_run, (void *)thread);
441 MUTEX_UNLOCK(&create_destruct_mutex);
442 return ithread_to_SV(aTHX_ obj, thread, classname, FALSE);
446 Perl_ithread_self (pTHX_ SV *obj, char* Class)
449 PERL_THREAD_GETSPECIFIC(self_key,thread);
450 return ithread_to_SV(aTHX_ obj, thread, Class, TRUE);
454 * Joins the thread this code needs to take the returnvalue from the
455 * call_sv and send it back
459 Perl_ithread_CLONE(pTHX_ SV *obj)
463 ithread *thread = SV_to_ithread(aTHX_ obj);
467 Perl_warn(aTHX_ "CLONE %_",obj);
472 Perl_ithread_join(pTHX_ SV *obj)
474 ithread *thread = SV_to_ithread(aTHX_ obj);
475 MUTEX_LOCK(&thread->mutex);
476 if (thread->state & PERL_ITHR_DETACHED) {
477 MUTEX_UNLOCK(&thread->mutex);
478 Perl_croak(aTHX_ "Cannot join a detached thread");
480 else if (thread->state & PERL_ITHR_JOINED) {
481 MUTEX_UNLOCK(&thread->mutex);
482 Perl_croak(aTHX_ "Thread already joined");
491 MUTEX_UNLOCK(&thread->mutex);
493 waitcode = WaitForSingleObject(thread->handle, INFINITE);
495 pthread_join(thread->thr,&retval);
497 MUTEX_LOCK(&thread->mutex);
499 /* sv_dup over the args */
501 AV* params = (AV*) SvRV(thread->params);
502 CLONE_PARAMS clone_params;
503 clone_params.stashes = newAV();
504 PL_ptr_table = ptr_table_new();
505 retparam = (AV*) sv_dup((SV*)params, &clone_params);
506 SvREFCNT_dec(clone_params.stashes);
507 SvREFCNT_inc(retparam);
508 ptr_table_free(PL_ptr_table);
512 /* We have finished with it */
513 thread->state |= PERL_ITHR_JOINED;
514 MUTEX_UNLOCK(&thread->mutex);
521 Perl_ithread_DESTROY(pTHX_ SV *sv)
523 ithread *thread = SV_to_ithread(aTHX_ sv);
524 sv_unmagic(SvRV(sv),PERL_MAGIC_shared_scalar);
527 #endif /* USE_ITHREADS */
529 MODULE = threads PACKAGE = threads PREFIX = ithread_
535 ithread_new (classname, function_to_call, ...)
537 SV * function_to_call
540 AV* params = newAV();
543 for(i = 2; i < items ; i++) {
544 av_push(params, ST(i));
547 ST(0) = sv_2mortal(Perl_ithread_create(aTHX_ Nullsv, classname, function_to_call, newRV_noinc((SV*) params)));
552 ithread_self(char *classname)
555 ST(0) = sv_2mortal(Perl_ithread_self(aTHX_ Nullsv,classname));
560 ithread_tid(ithread *thread)
563 ithread_join(SV *obj)
566 AV* params = Perl_ithread_join(aTHX_ obj);
568 I32 len = AvFILL(params);
569 for (i = 0; i <= len; i++) {
570 SV* tmp = av_shift(params);
574 SvREFCNT_dec(params);
578 ithread_yield(ithread *thread)
581 ithread_detach(ithread *thread)
584 ithread_DESTROY(SV *thread)
586 #endif /* USE_ITHREADS */
592 PL_perl_destruct_level = 2;
593 PERL_THREAD_ALLOC_SPECIFIC(self_key);
594 MUTEX_INIT(&create_destruct_mutex);
595 MUTEX_LOCK(&create_destruct_mutex);
596 PL_threadhook = &Perl_ithread_hook;
597 thread = PerlMemShared_malloc(sizeof(ithread));
598 Zero(thread,1,ithread);
599 PL_perl_destruct_level = 2;
600 MUTEX_INIT(&thread->mutex);
602 thread->next = thread;
603 thread->prev = thread;
604 thread->interp = aTHX;
605 thread->count = 1; /* imortal */
606 thread->tid = tid_counter++;
611 thread->thr = GetCurrentThreadId();
613 thread->thr = pthread_self();
616 PERL_THREAD_SETSPECIFIC(self_key,thread);
617 MUTEX_UNLOCK(&create_destruct_mutex);
618 #endif /* USE_ITHREADS */