[p5sagit/p5-mst-13.2.git] / ext / threads / threads.xs

#define PERL_NO_GET_CONTEXT
#include "EXTERN.h"
#include "perl.h"
#include "XSUB.h"

#ifdef USE_ITHREADS

#ifdef WIN32
#include <windows.h>
#include <win32thread.h>
#define PERL_THREAD_SETSPECIFIC(k,v) TlsSetValue(k,v)
#define PERL_THREAD_GETSPECIFIC(k,v) v = TlsGetValue(k)
#define PERL_THREAD_ALLOC_SPECIFIC(k) \
STMT_START {\
  if((k = TlsAlloc()) == TLS_OUT_OF_INDEXES) {\
    PerlIO_printf(PerlIO_stderr(),"panic threads.h: TlsAlloc");\
    exit(1);\
  }\
} STMT_END
#else
#include <pthread.h>
#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))
#define PERL_THREAD_GETSPECIFIC(k,v) pthread_getspecific(k,&v)
#define PERL_THREAD_ALLOC_SPECIFIC(k) STMT_START {\
  if(pthread_keycreate(&(k),0)) {\
    PerlIO_printf(PerlIO_stderr(), "panic threads.h: pthread_key_create");\
    exit(1);\
  }\
} STMT_END
#else
#define PERL_THREAD_DETACH(t) pthread_detach((t))
#define PERL_THREAD_GETSPECIFIC(k,v) v = pthread_getspecific(k)
#define PERL_THREAD_ALLOC_SPECIFIC(k) STMT_START {\
  if(pthread_key_create(&(k),0)) {\
    PerlIO_printf(PerlIO_stderr(), "panic threads.h: pthread_key_create");\
    exit(1);\
  }\
} STMT_END
#endif
#endif

/* Values for 'state' member */
#define PERL_ITHR_JOINABLE		0
#define PERL_ITHR_DETACHED		1
#define PERL_ITHR_FINISHED		4
#define PERL_ITHR_JOINED		2

typedef struct ithread_s {
    struct ithread_s *next;	/* next thread in the list */
    struct ithread_s *prev;	/* prev thread in the list */
    PerlInterpreter *interp;	/* The threads interpreter */
    I32 tid;              	/* threads module's thread id */
    perl_mutex mutex; 		/* mutex for updating things in this struct */
    I32 count;			/* how many SVs have a reference to us */
    signed char state;		/* are we detached ? */
    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
} ithread;

ithread *threads;

/* Macros to supply the aTHX_ in an embed.h like manner */
#define ithread_join(thread)		Perl_ithread_join(aTHX_ thread)
#define ithread_DESTROY(thread)		Perl_ithread_DESTROY(aTHX_ thread)
#define ithread_CLONE(thread)		Perl_ithread_CLONE(aTHX_ thread)
#define ithread_detach(thread)		Perl_ithread_detach(aTHX_ thread)
#define ithread_tid(thread)		((thread)->tid)
#define ithread_yield(thread)		(YIELD);

static perl_mutex create_destruct_mutex;  /* protects the creation and destruction of threads*/

I32 tid_counter = 0;
I32 known_threads = 0;
I32 active_threads = 0;
perl_key self_key;

/*
 *  Clear up after thread is done with
 */
void
Perl_ithread_destruct (pTHX_ ithread* thread, const char *why)
{
	MUTEX_LOCK(&thread->mutex);
	if (!thread->next) {
	    Perl_croak(aTHX_ "panic: destruct destroyed thread %p (%s)",thread, why);
	}
	if (thread->count != 0) {
		MUTEX_UNLOCK(&thread->mutex);
		return;
	}
	MUTEX_LOCK(&create_destruct_mutex);
	/* Remove from circular list of threads */
	if (thread->next == thread) {
	    /* last one should never get here ? */
	    threads = NULL;
        }
	else {
	    thread->next->prev = thread->prev;
	    thread->prev->next = thread->next;
	    if (threads == thread) {
		threads = thread->next;
	    }
	    thread->next = NULL;
	    thread->prev = NULL;
	}
	known_threads--;
	assert( known_threads >= 0 );
#if 0
        Perl_warn(aTHX_ "destruct %d @ %p by %p now %d",
	          thread->tid,thread->interp,aTHX, known_threads);
#endif
	MUTEX_UNLOCK(&create_destruct_mutex);
	/* Thread is now disowned */
	if (thread->interp) {
	    dTHXa(thread->interp);
	    PERL_SET_CONTEXT(thread->interp);
	    SvREFCNT_dec(thread->params);
	    thread->params = Nullsv;
	    perl_destruct(thread->interp);
	    perl_free(thread->interp);
	    thread->interp = NULL;
	}
	PERL_SET_CONTEXT(aTHX);
	MUTEX_UNLOCK(&thread->mutex);
	MUTEX_DESTROY(&thread->mutex);
        PerlMemShared_free(thread);
}

int
Perl_ithread_hook(pTHX)
{
    int veto_cleanup = 0;
    MUTEX_LOCK(&create_destruct_mutex);
    if (aTHX == PL_curinterp && active_threads != 1) {
	Perl_warn(aTHX_ "Cleanup skipped %" IVdf " active threads",
						(IV)active_threads);
	veto_cleanup = 1;
    }
    MUTEX_UNLOCK(&create_destruct_mutex);
    return veto_cleanup;
}

void
Perl_ithread_detach(pTHX_ ithread *thread)
{
    MUTEX_LOCK(&thread->mutex);
    if (!(thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED))) {
	thread->state |= PERL_ITHR_DETACHED;
#ifdef WIN32
	CloseHandle(thread->handle);
	thread->handle = 0;
#else
	PERL_THREAD_DETACH(thread->thr);
#endif
    }
    if ((thread->state & PERL_ITHR_FINISHED) &&
        (thread->state & PERL_ITHR_DETACHED)) {
	MUTEX_UNLOCK(&thread->mutex);
	Perl_ithread_destruct(aTHX_ thread, "detach");
    }
    else {
	MUTEX_UNLOCK(&thread->mutex);
    }
}

/* MAGIC (in mg.h sense) hooks */

int
ithread_mg_get(pTHX_ SV *sv, MAGIC *mg)
{
    ithread *thread = (ithread *) mg->mg_ptr;
    SvIVX(sv) = PTR2IV(thread);
    SvIOK_on(sv);
    return 0;
}

int
ithread_mg_free(pTHX_ SV *sv, MAGIC *mg)
{
    ithread *thread = (ithread *) mg->mg_ptr;
    MUTEX_LOCK(&thread->mutex);
    thread->count--;
    if (thread->count == 0) {
       if(thread->state & PERL_ITHR_FINISHED &&
          (thread->state & PERL_ITHR_DETACHED ||
           thread->state & PERL_ITHR_JOINED))
       {
            MUTEX_UNLOCK(&thread->mutex);
            Perl_ithread_destruct(aTHX_ thread, "no reference");
       }
       else {
	    MUTEX_UNLOCK(&thread->mutex);
       }    
    }
    else {
	MUTEX_UNLOCK(&thread->mutex);
    }
    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 */
};


/*
 *	Starts executing the thread. Needs to clean up memory a tad better.
 *      Passed as the C level function to run in the new thread
 */

#ifdef WIN32
THREAD_RET_TYPE
Perl_ithread_run(LPVOID arg) {
#else
void*
Perl_ithread_run(void * arg) {
#endif
	ithread* thread = (ithread*) arg;
	dTHXa(thread->interp);
	PERL_SET_CONTEXT(thread->interp);
	PERL_THREAD_SETSPECIFIC(self_key,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);
		I32 len = av_len(params)+1;
		int i;
		dSP;
		ENTER;
		SAVETMPS;
		PUSHMARK(SP);
		for(i = 0; i < len; i++) {
		    XPUSHs(av_shift(params));
		}
		PUTBACK;
		len = call_sv(thread->init_function, thread->gimme|G_EVAL);
		SPAGAIN;
		for (i=len-1; i >= 0; i--) {
		  SV *sv = POPs;
		  av_store(params, i, SvREFCNT_inc(sv));
		}
		PUTBACK;
		if (SvTRUE(ERRSV)) {
		    Perl_warn(aTHX_ "Died:%" SVf,ERRSV);
		}
		FREETMPS;
		LEAVE;
		SvREFCNT_dec(thread->init_function);
	}

	PerlIO_flush((PerlIO*)NULL);
	MUTEX_LOCK(&create_destruct_mutex);
	active_threads--;
	assert( active_threads >= 0 );
	MUTEX_UNLOCK(&create_destruct_mutex);
	MUTEX_LOCK(&thread->mutex);
	thread->state |= PERL_ITHR_FINISHED;

	if (thread->state & PERL_ITHR_DETACHED) {
		MUTEX_UNLOCK(&thread->mutex);
		Perl_ithread_destruct(aTHX_ thread, "detached finish");
	} else {
		MUTEX_UNLOCK(&thread->mutex);
	}
#ifdef WIN32
	return (DWORD)0;
#else
	return 0;
#endif
}

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;
}

ithread *
SV_to_ithread(pTHX_ SV *sv)
{
    ithread *thread;
    if (SvROK(sv))
     {
      thread = INT2PTR(ithread*, SvIV(SvRV(sv)));
     }
    else
     {
      PERL_THREAD_GETSPECIFIC(self_key,thread);
     }
    return thread;
}

/*
 * iThread->create(); ( aka iThread->new() )
 * Called in context of parent thread
 */

SV *
Perl_ithread_create(pTHX_ SV *obj, char* classname, SV* init_function, SV* params)
{
	ithread*	thread;
	CLONE_PARAMS	clone_param;

	MUTEX_LOCK(&create_destruct_mutex);
	thread = PerlMemShared_malloc(sizeof(ithread));
	Zero(thread,1,ithread);
	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->gimme = GIMME_V;

	/* "Clone" our interpreter into the thread's interpreter
	 * This gives thread access to "static data" and code.
	 */

	PerlIO_flush((PerlIO*)NULL);

#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 implcit aTHX create a new scope
	   with aTHX matching the context for the duration of
	   our work for new interpreter.
	 */
	{
	    dTHXa(thread->interp);
            /* Here we remove END blocks since they should only run
	       in the thread they are created
            */
            SvREFCNT_dec(PL_endav);
            PL_endav = newAV();
            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);
	    SvTEMP_off(thread->init_function);
	    ptr_table_free(PL_ptr_table);
	    PL_ptr_table = NULL;
	    PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
	}

	PERL_SET_CONTEXT(aTHX);

	/* Start the thread */

#ifdef WIN32

	thread->handle = CreateThread(NULL, 0, Perl_ithread_run,
			(LPVOID)thread, 0, &thread->thr);

#else
	{
	  static pthread_attr_t attr;
	  static int attr_inited = 0;
	  static int attr_joinable = PTHREAD_CREATE_JOINABLE;
	  if (!attr_inited) {
	    attr_inited = 1;
	    pthread_attr_init(&attr);
	  }
#  ifdef PTHREAD_ATTR_SETDETACHSTATE
            PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable);
#  endif
#  ifdef THREAD_CREATE_NEEDS_STACK
	    if(pthread_attr_setstacksize(&attr, THREAD_CREATE_NEEDS_STACK))
	      croak("panic: pthread_attr_setstacksize failed");
#  endif

#ifdef OLD_PTHREADS_API
	  pthread_create( &thread->thr, attr, Perl_ithread_run, (void *)thread);
#else
	  pthread_create( &thread->thr, &attr, Perl_ithread_run, (void *)thread);
#endif
	}
#endif
	known_threads++;
	active_threads++;
	MUTEX_UNLOCK(&create_destruct_mutex);
	sv_2mortal(params);
	return ithread_to_SV(aTHX_ obj, thread, classname, FALSE);
}

SV*
Perl_ithread_self (pTHX_ SV *obj, char* Class)
{
    ithread *thread;
    PERL_THREAD_GETSPECIFIC(self_key,thread);
    return ithread_to_SV(aTHX_ obj, thread, Class, TRUE);
}

/*
 * Joins the thread this code needs to take the returnvalue from the
 * call_sv and send it back
 */

void
Perl_ithread_CLONE(pTHX_ SV *obj)
{
 if (SvROK(obj))
  {
   ithread *thread = SV_to_ithread(aTHX_ obj);
  }
 else
  {
   Perl_warn(aTHX_ "CLONE %" SVf,obj);
  }
}

AV*
Perl_ithread_join(pTHX_ SV *obj)
{
    ithread *thread = SV_to_ithread(aTHX_ obj);
    MUTEX_LOCK(&thread->mutex);
    if (thread->state & PERL_ITHR_DETACHED) {
	MUTEX_UNLOCK(&thread->mutex);
	Perl_croak(aTHX_ "Cannot join a detached thread");
    }
    else if (thread->state & PERL_ITHR_JOINED) {
	MUTEX_UNLOCK(&thread->mutex);
	Perl_croak(aTHX_ "Thread already joined");
    }
    else {
        AV* retparam;
#ifdef WIN32
	DWORD waitcode;
#else
	void *retval;
#endif
	MUTEX_UNLOCK(&thread->mutex);
#ifdef WIN32
	waitcode = WaitForSingleObject(thread->handle, INFINITE);
#else
	pthread_join(thread->thr,&retval);
#endif
	MUTEX_LOCK(&thread->mutex);
	
	/* sv_dup over the args */
	{
	  AV* params = (AV*) SvRV(thread->params);	
	  CLONE_PARAMS clone_params;
	  clone_params.stashes = newAV();
	  PL_ptr_table = ptr_table_new();
	  retparam = (AV*) sv_dup((SV*)params, &clone_params);
	  SvREFCNT_dec(clone_params.stashes);
	  SvREFCNT_inc(retparam);
	  ptr_table_free(PL_ptr_table);
	  PL_ptr_table = NULL;

	}
	/* We have finished with it */
	thread->state |= PERL_ITHR_JOINED;
	MUTEX_UNLOCK(&thread->mutex);
    	sv_unmagic(SvRV(obj),PERL_MAGIC_shared_scalar);
	return retparam;
    }
    return (AV*)NULL;
}

void
Perl_ithread_DESTROY(pTHX_ SV *sv)
{
    ithread *thread = SV_to_ithread(aTHX_ sv);
    sv_unmagic(SvRV(sv),PERL_MAGIC_shared_scalar);
}

#endif /* USE_ITHREADS */

MODULE = threads		PACKAGE = threads	PREFIX = ithread_
PROTOTYPES: DISABLE

#ifdef USE_ITHREADS

void
ithread_new (classname, function_to_call, ...)
char *	classname
SV *	function_to_call
CODE:
{
    AV* params = newAV();
    if (items > 2) {
	int i;
	for(i = 2; i < items ; i++) {
	    av_push(params, SvREFCNT_inc(ST(i)));
	}
    }
    ST(0) = sv_2mortal(Perl_ithread_create(aTHX_ Nullsv, classname, function_to_call, newRV_noinc((SV*) params)));
    XSRETURN(1);
}

void
ithread_list(char *classname)
PPCODE:
{
  ithread *curr_thread;
  MUTEX_LOCK(&create_destruct_mutex);
  curr_thread = threads;
  PUSHs( sv_2mortal(ithread_to_SV(aTHX_ NULL, curr_thread, classname, TRUE)));
  while(curr_thread) {
    curr_thread = curr_thread->next;
    if(curr_thread == threads)
      break;
    if(curr_thread->state & PERL_ITHR_DETACHED ||
       curr_thread->state & PERL_ITHR_JOINED) 
      continue;
    PUSHs( sv_2mortal(ithread_to_SV(aTHX_ NULL, curr_thread, classname, TRUE)));
  }	
  MUTEX_UNLOCK(&create_destruct_mutex);
}


void
ithread_self(char *classname)
CODE:
{
	ST(0) = sv_2mortal(Perl_ithread_self(aTHX_ Nullsv,classname));
	XSRETURN(1);
}

int
ithread_tid(ithread *thread)

void
ithread_join(SV *obj)
PPCODE:
{
  AV* params = Perl_ithread_join(aTHX_ obj);
  int i;
  I32 len = AvFILL(params);
  for (i = 0; i <= len; i++) {
    SV* tmp = av_shift(params);
    XPUSHs(tmp);
    sv_2mortal(tmp);
  }
  SvREFCNT_dec(params);
}

void
ithread_yield(ithread *thread)

void
ithread_detach(ithread *thread)

void
ithread_DESTROY(SV *thread)

#endif /* USE_ITHREADS */

BOOT:
{
#ifdef USE_ITHREADS
	ithread* thread;
	PL_perl_destruct_level = 2;
	PERL_THREAD_ALLOC_SPECIFIC(self_key);
	MUTEX_INIT(&create_destruct_mutex);
	MUTEX_LOCK(&create_destruct_mutex);
	PL_threadhook = &Perl_ithread_hook;
	thread  = PerlMemShared_malloc(sizeof(ithread));
	Zero(thread,1,ithread);
	PL_perl_destruct_level = 2;
	MUTEX_INIT(&thread->mutex);
	threads = thread;
	thread->next = thread;
        thread->prev = thread;
	thread->interp = aTHX;
	thread->count  = 1;  /* imortal */
	thread->tid = tid_counter++;
	known_threads++;
	active_threads++;
	thread->state = 1;
#ifdef WIN32
	thread->thr = GetCurrentThreadId();
#else
	thread->thr = pthread_self();
#endif

	PERL_THREAD_SETSPECIFIC(self_key,thread);
	MUTEX_UNLOCK(&create_destruct_mutex);
#endif /* USE_ITHREADS */
}
Commit	Line	Data
68795e93	1	#define PERL_NO_GET_CONTEXT
	2	#include "EXTERN.h"
	3	#include "perl.h"
	4	#include "XSUB.h"
	5
73e09c8f	6	#ifdef USE_ITHREADS
73e09c8f	7
68795e93	8	#ifdef WIN32
	9	#include <windows.h>
	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) \
	14	STMT_START {\
	15	if((k = TlsAlloc()) == TLS_OUT_OF_INDEXES) {\
	16	PerlIO_printf(PerlIO_stderr(),"panic threads.h: TlsAlloc");\
	17	exit(1);\
	18	}\
	19	} STMT_END
	20	#else
	21	#include <pthread.h>
	22	#include <thread.h>
	23
	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");\
	31	exit(1);\
	32	}\
	33	} STMT_END
	34	#else
	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");\
	40	exit(1);\
	41	}\
	42	} STMT_END
	43	#endif
	44	#endif
	45
62375a60	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
	51
68795e93	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 */
62375a60	59	signed char state; /* are we detached ? */
a446a88f	60	int gimme; /* Context of create */
68795e93	61	SV* init_function; /* Code to run */
	62	SV* params; /* args to pass function */
	63	#ifdef WIN32
	64	DWORD thr; /* OS's idea if thread id */
	65	HANDLE handle; /* OS's waitable handle */
	66	#else
	67	pthread_t thr; /* OS's handle for the thread */
	68	#endif
	69	} ithread;
	70
	71	ithread *threads;
	72
	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)
f9dff5f5	79	#define ithread_yield(thread) (YIELD);
68795e93	80
58c2ef19	81	static perl_mutex create_destruct_mutex; /* protects the creation and destruction of threads*/
68795e93	82
68795e93	83	I32 tid_counter = 0;
62375a60	84	I32 known_threads = 0;
58c2ef19	85	I32 active_threads = 0;
68795e93	86	perl_key self_key;
	87
	88	/*
	89	* Clear up after thread is done with
	90	*/
	91	void
62375a60	92	Perl_ithread_destruct (pTHX_ ithread* thread, const char *why)
68795e93	93	{
68795e93	94	MUTEX_LOCK(&thread->mutex);
62375a60	95	if (!thread->next) {
	96	Perl_croak(aTHX_ "panic: destruct destroyed thread %p (%s)",thread, why);
	97	}
68795e93	98	if (thread->count != 0) {
68795e93	99	MUTEX_UNLOCK(&thread->mutex);
d1400e48	100	return;
68795e93	101	}
58c2ef19	102	MUTEX_LOCK(&create_destruct_mutex);
68795e93	103	/* Remove from circular list of threads */
	104	if (thread->next == thread) {
	105	/* last one should never get here ? */
	106	threads = NULL;
	107	}
	108	else {
f42ad631	109	thread->next->prev = thread->prev;
f42ad631	110	thread->prev->next = thread->next;
68795e93	111	if (threads == thread) {
	112	threads = thread->next;
	113	}
62375a60	114	thread->next = NULL;
62375a60	115	thread->prev = NULL;
68795e93	116	}
62375a60	117	known_threads--;
62375a60	118	assert( known_threads >= 0 );
ba14dd9a	119	#if 0
62375a60	120	Perl_warn(aTHX_ "destruct %d @ %p by %p now %d",
62375a60	121	thread->tid,thread->interp,aTHX, known_threads);
ba14dd9a	122	#endif
62375a60	123	MUTEX_UNLOCK(&create_destruct_mutex);
62375a60	124	/* Thread is now disowned */
68795e93	125	if (thread->interp) {
1c3adb19	126	dTHXa(thread->interp);
68795e93	127	PERL_SET_CONTEXT(thread->interp);
1c3adb19	128	SvREFCNT_dec(thread->params);
1c3adb19	129	thread->params = Nullsv;
68795e93	130	perl_destruct(thread->interp);
	131	perl_free(thread->interp);
	132	thread->interp = NULL;
	133	}
	134	PERL_SET_CONTEXT(aTHX);
d1400e48	135	MUTEX_UNLOCK(&thread->mutex);
1c3adb19	136	MUTEX_DESTROY(&thread->mutex);
1c3adb19	137	PerlMemShared_free(thread);
68795e93	138	}
68795e93	139
62375a60	140	int
	141	Perl_ithread_hook(pTHX)
	142	{
	143	int veto_cleanup = 0;
	144	MUTEX_LOCK(&create_destruct_mutex);
	145	if (aTHX == PL_curinterp && active_threads != 1) {
436c6dd3	146	Perl_warn(aTHX_ "Cleanup skipped %" IVdf " active threads",
436c6dd3	147	(IV)active_threads);
62375a60	148	veto_cleanup = 1;
	149	}
	150	MUTEX_UNLOCK(&create_destruct_mutex);
	151	return veto_cleanup;
	152	}
	153
	154	void
	155	Perl_ithread_detach(pTHX_ ithread *thread)
	156	{
	157	MUTEX_LOCK(&thread->mutex);
	158	if (!(thread->state & (PERL_ITHR_DETACHED\|PERL_ITHR_JOINED))) {
	159	thread->state \|= PERL_ITHR_DETACHED;
	160	#ifdef WIN32
	161	CloseHandle(thread->handle);
	162	thread->handle = 0;
	163	#else
	164	PERL_THREAD_DETACH(thread->thr);
	165	#endif
	166	}
	167	if ((thread->state & PERL_ITHR_FINISHED) &&
	168	(thread->state & PERL_ITHR_DETACHED)) {
	169	MUTEX_UNLOCK(&thread->mutex);
	170	Perl_ithread_destruct(aTHX_ thread, "detach");
	171	}
	172	else {
	173	MUTEX_UNLOCK(&thread->mutex);
	174	}
	175	}
68795e93	176
	177	/* MAGIC (in mg.h sense) hooks */
	178
	179	int
	180	ithread_mg_get(pTHX_ SV sv, MAGIC mg)
	181	{
	182	ithread thread = (ithread ) mg->mg_ptr;
	183	SvIVX(sv) = PTR2IV(thread);
	184	SvIOK_on(sv);
	185	return 0;
	186	}
	187
	188	int
	189	ithread_mg_free(pTHX_ SV sv, MAGIC mg)
	190	{
	191	ithread thread = (ithread ) mg->mg_ptr;
	192	MUTEX_LOCK(&thread->mutex);
68795e93	193	thread->count--;
62375a60	194	if (thread->count == 0) {
1c3adb19	195	if(thread->state & PERL_ITHR_FINISHED &&
	196	(thread->state & PERL_ITHR_DETACHED \|\|
	197	thread->state & PERL_ITHR_JOINED))
	198	{
	199	MUTEX_UNLOCK(&thread->mutex);
	200	Perl_ithread_destruct(aTHX_ thread, "no reference");
	201	}
1ea20f42	202	else {
	203	MUTEX_UNLOCK(&thread->mutex);
	204	}
62375a60	205	}
	206	else {
	207	MUTEX_UNLOCK(&thread->mutex);
	208	}
68795e93	209	return 0;
	210	}
	211
	212	int
	213	ithread_mg_dup(pTHX_ MAGIC mg, CLONE_PARAMS param)
	214	{
	215	ithread thread = (ithread ) mg->mg_ptr;
	216	MUTEX_LOCK(&thread->mutex);
68795e93	217	thread->count++;
	218	MUTEX_UNLOCK(&thread->mutex);
	219	return 0;
	220	}
	221
	222	MGVTBL ithread_vtbl = {
	223	ithread_mg_get, /* get */
	224	0, /* set */
	225	0, /* len */
	226	0, /* clear */
	227	ithread_mg_free, /* free */
	228	0, /* copy */
	229	ithread_mg_dup /* dup */
	230	};
	231
47ba8780	232
47ba8780	233	/*
b1edfb69	234	* Starts executing the thread. Needs to clean up memory a tad better.
68795e93	235	* Passed as the C level function to run in the new thread
b1edfb69	236	*/
47ba8780	237
47ba8780	238	#ifdef WIN32
68795e93	239	THREAD_RET_TYPE
68795e93	240	Perl_ithread_run(LPVOID arg) {
47ba8780	241	#else
68795e93	242	void*
68795e93	243	Perl_ithread_run(void * arg) {
47ba8780	244	#endif
5b414d21	245	ithread* thread = (ithread*) arg;
47ba8780	246	dTHXa(thread->interp);
47ba8780	247	PERL_SET_CONTEXT(thread->interp);
68795e93	248	PERL_THREAD_SETSPECIFIC(self_key,thread);
47ba8780	249
68795e93	250	#if 0
	251	/* Far from clear messing with ->thr child-side is a good idea */
	252	MUTEX_LOCK(&thread->mutex);
47ba8780	253	#ifdef WIN32
	254	thread->thr = GetCurrentThreadId();
	255	#else
	256	thread->thr = pthread_self();
	257	#endif
68795e93	258	MUTEX_UNLOCK(&thread->mutex);
68795e93	259	#endif
47ba8780	260
47ba8780	261	PL_perl_destruct_level = 2;
4f896ddc	262
47ba8780	263	{
68795e93	264	AV* params = (AV*) SvRV(thread->params);
68795e93	265	I32 len = av_len(params)+1;
47ba8780	266	int i;
47ba8780	267	dSP;
47ba8780	268	ENTER;
	269	SAVETMPS;
	270	PUSHMARK(SP);
68795e93	271	for(i = 0; i < len; i++) {
68795e93	272	XPUSHs(av_shift(params));
47ba8780	273	}
47ba8780	274	PUTBACK;
a446a88f	275	len = call_sv(thread->init_function, thread->gimme\|G_EVAL);
68795e93	276	SPAGAIN;
a446a88f	277	for (i=len-1; i >= 0; i--) {
e1c44605	278	SV *sv = POPs;
e1c44605	279	av_store(params, i, SvREFCNT_inc(sv));
a446a88f	280	}
	281	PUTBACK;
	282	if (SvTRUE(ERRSV)) {
436c6dd3	283	Perl_warn(aTHX_ "Died:%" SVf,ERRSV);
a446a88f	284	}
47ba8780	285	FREETMPS;
47ba8780	286	LEAVE;
68795e93	287	SvREFCNT_dec(thread->init_function);
47ba8780	288	}
47ba8780	289
fd58862f	290	PerlIO_flush((PerlIO*)NULL);
62375a60	291	MUTEX_LOCK(&create_destruct_mutex);
	292	active_threads--;
	293	assert( active_threads >= 0 );
	294	MUTEX_UNLOCK(&create_destruct_mutex);
68795e93	295	MUTEX_LOCK(&thread->mutex);
62375a60	296	thread->state \|= PERL_ITHR_FINISHED;
	297
	298	if (thread->state & PERL_ITHR_DETACHED) {
47ba8780	299	MUTEX_UNLOCK(&thread->mutex);
62375a60	300	Perl_ithread_destruct(aTHX_ thread, "detached finish");
47ba8780	301	} else {
62375a60	302	MUTEX_UNLOCK(&thread->mutex);
62375a60	303	}
47ba8780	304	#ifdef WIN32
47ba8780	305	return (DWORD)0;
e8f2bb9a	306	#else
e8f2bb9a	307	return 0;
47ba8780	308	#endif
68795e93	309	}
	310
	311	SV *
	312	ithread_to_SV(pTHX_ SV obj, ithread thread, char *classname, bool inc)
	313	{
	314	SV *sv;
	315	MAGIC *mg;
	316	if (inc) {
	317	MUTEX_LOCK(&thread->mutex);
	318	thread->count++;
68795e93	319	MUTEX_UNLOCK(&thread->mutex);
	320	}
	321	if (!obj)
	322	obj = newSV(0);
	323	sv = newSVrv(obj,classname);
	324	sv_setiv(sv,PTR2IV(thread));
	325	mg = sv_magicext(sv,Nullsv,PERL_MAGIC_shared_scalar,&ithread_vtbl,(char *)thread,0);
	326	mg->mg_flags \|= MGf_DUP;
	327	SvREADONLY_on(sv);
	328	return obj;
	329	}
47ba8780	330
68795e93	331	ithread *
	332	SV_to_ithread(pTHX_ SV *sv)
	333	{
	334	ithread *thread;
	335	if (SvROK(sv))
	336	{
	337	thread = INT2PTR(ithread*, SvIV(SvRV(sv)));
	338	}
	339	else
	340	{
	341	PERL_THREAD_GETSPECIFIC(self_key,thread);
	342	}
	343	return thread;
47ba8780	344	}
47ba8780	345
47ba8780	346	/*
68795e93	347	* iThread->create(); ( aka iThread->new() )
68795e93	348	* Called in context of parent thread
b1edfb69	349	*/
47ba8780	350
68795e93	351	SV *
	352	Perl_ithread_create(pTHX_ SV obj, char classname, SV* init_function, SV* params)
	353	{
	354	ithread* thread;
	355	CLONE_PARAMS clone_param;
	356
58c2ef19	357	MUTEX_LOCK(&create_destruct_mutex);
68795e93	358	thread = PerlMemShared_malloc(sizeof(ithread));
	359	Zero(thread,1,ithread);
	360	thread->next = threads;
	361	thread->prev = threads->prev;
f42ad631	362	threads->prev = thread;
68795e93	363	thread->prev->next = thread;
	364	/* Set count to 1 immediately in case thread exits before
	365	* we return to caller !
	366	*/
	367	thread->count = 1;
	368	MUTEX_INIT(&thread->mutex);
	369	thread->tid = tid_counter++;
a446a88f	370	thread->gimme = GIMME_V;
4f896ddc	371
68795e93	372	/* "Clone" our interpreter into the thread's interpreter
	373	* This gives thread access to "static data" and code.
	374	*/
47ba8780	375
68795e93	376	PerlIO_flush((PerlIO*)NULL);
cd8c9bf8	377
47ba8780	378	#ifdef WIN32
68795e93	379	thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE \| CLONEf_CLONE_HOST);
47ba8780	380	#else
68795e93	381	thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE);
47ba8780	382	#endif
ba14dd9a	383	/* perl_clone leaves us in new interpreter's context.
ba14dd9a	384	As it is tricky to spot implcit aTHX create a new scope
a446a88f	385	with aTHX matching the context for the duration of
ba14dd9a	386	our work for new interpreter.
	387	*/
	388	{
	389	dTHXa(thread->interp);
58c2ef19	390	/* Here we remove END blocks since they should only run
62375a60	391	in the thread they are created
58c2ef19	392	*/
	393	SvREFCNT_dec(PL_endav);
	394	PL_endav = newAV();
d1400e48	395	clone_param.flags = 0;
ba14dd9a	396	thread->init_function = sv_dup(init_function, &clone_param);
	397	if (SvREFCNT(thread->init_function) == 0) {
	398	SvREFCNT_inc(thread->init_function);
d1400e48	399	}
ba14dd9a	400
	401	thread->params = sv_dup(params, &clone_param);
	402	SvREFCNT_inc(thread->params);
	403	SvTEMP_off(thread->init_function);
	404	ptr_table_free(PL_ptr_table);
	405	PL_ptr_table = NULL;
ffb29f90	406	PL_exit_flags \|= PERL_EXIT_DESTRUCT_END;
ba14dd9a	407	}
d1400e48	408
68795e93	409	PERL_SET_CONTEXT(aTHX);
47ba8780	410
68795e93	411	/* Start the thread */
47ba8780	412
	413	#ifdef WIN32
	414
68795e93	415	thread->handle = CreateThread(NULL, 0, Perl_ithread_run,
47ba8780	416	(LPVOID)thread, 0, &thread->thr);
47ba8780	417
82c40bf6	418	#else
fa26028c	419	{
	420	static pthread_attr_t attr;
	421	static int attr_inited = 0;
fa26028c	422	static int attr_joinable = PTHREAD_CREATE_JOINABLE;
	423	if (!attr_inited) {
	424	attr_inited = 1;
	425	pthread_attr_init(&attr);
	426	}
	427	# ifdef PTHREAD_ATTR_SETDETACHSTATE
	428	PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable);
	429	# endif
3eb37d38	430	# ifdef THREAD_CREATE_NEEDS_STACK
	431	if(pthread_attr_setstacksize(&attr, THREAD_CREATE_NEEDS_STACK))
	432	croak("panic: pthread_attr_setstacksize failed");
	433	# endif
	434
3ad0b7d6	435	#ifdef OLD_PTHREADS_API
68795e93	436	pthread_create( &thread->thr, attr, Perl_ithread_run, (void *)thread);
47ba8780	437	#else
68795e93	438	pthread_create( &thread->thr, &attr, Perl_ithread_run, (void *)thread);
47ba8780	439	#endif
3ad0b7d6	440	}
82c40bf6	441	#endif
62375a60	442	known_threads++;
58c2ef19	443	active_threads++;
58c2ef19	444	MUTEX_UNLOCK(&create_destruct_mutex);
95393226	445	sv_2mortal(params);
68795e93	446	return ithread_to_SV(aTHX_ obj, thread, classname, FALSE);
68795e93	447	}
47ba8780	448
68795e93	449	SV*
	450	Perl_ithread_self (pTHX_ SV obj, char Class)
	451	{
	452	ithread *thread;
	453	PERL_THREAD_GETSPECIFIC(self_key,thread);
	454	return ithread_to_SV(aTHX_ obj, thread, Class, TRUE);
47ba8780	455	}
	456
	457	/*
e1c44605	458	* Joins the thread this code needs to take the returnvalue from the
68795e93	459	* call_sv and send it back
b1edfb69	460	*/
47ba8780	461
68795e93	462	void
	463	Perl_ithread_CLONE(pTHX_ SV *obj)
	464	{
	465	if (SvROK(obj))
	466	{
	467	ithread *thread = SV_to_ithread(aTHX_ obj);
	468	}
	469	else
	470	{
436c6dd3	471	Perl_warn(aTHX_ "CLONE %" SVf,obj);
68795e93	472	}
47ba8780	473	}
47ba8780	474
62375a60	475	AV*
68795e93	476	Perl_ithread_join(pTHX_ SV *obj)
	477	{
	478	ithread *thread = SV_to_ithread(aTHX_ obj);
	479	MUTEX_LOCK(&thread->mutex);
62375a60	480	if (thread->state & PERL_ITHR_DETACHED) {
a446a88f	481	MUTEX_UNLOCK(&thread->mutex);
	482	Perl_croak(aTHX_ "Cannot join a detached thread");
	483	}
62375a60	484	else if (thread->state & PERL_ITHR_JOINED) {
a446a88f	485	MUTEX_UNLOCK(&thread->mutex);
	486	Perl_croak(aTHX_ "Thread already joined");
	487	}
	488	else {
e1c44605	489	AV* retparam;
47ba8780	490	#ifdef WIN32
47ba8780	491	DWORD waitcode;
47ba8780	492	#else
47ba8780	493	void *retval;
47ba8780	494	#endif
47ba8780	495	MUTEX_UNLOCK(&thread->mutex);
68795e93	496	#ifdef WIN32
	497	waitcode = WaitForSingleObject(thread->handle, INFINITE);
	498	#else
	499	pthread_join(thread->thr,&retval);
	500	#endif
47ba8780	501	MUTEX_LOCK(&thread->mutex);
e1c44605	502
62375a60	503	/* sv_dup over the args */
e1c44605	504	{
62375a60	505	AV* params = (AV*) SvRV(thread->params);
e1c44605	506	CLONE_PARAMS clone_params;
3275ba96	507	clone_params.stashes = newAV();
e1c44605	508	PL_ptr_table = ptr_table_new();
e1c44605	509	retparam = (AV) sv_dup((SV)params, &clone_params);
3275ba96	510	SvREFCNT_dec(clone_params.stashes);
e1c44605	511	SvREFCNT_inc(retparam);
	512	ptr_table_free(PL_ptr_table);
	513	PL_ptr_table = NULL;
	514
	515	}
a446a88f	516	/* We have finished with it */
62375a60	517	thread->state \|= PERL_ITHR_JOINED;
47ba8780	518	MUTEX_UNLOCK(&thread->mutex);
9684265f	519	sv_unmagic(SvRV(obj),PERL_MAGIC_shared_scalar);
e1c44605	520	return retparam;
68795e93	521	}
e1c44605	522	return (AV*)NULL;
47ba8780	523	}
47ba8780	524
68795e93	525	void
68795e93	526	Perl_ithread_DESTROY(pTHX_ SV *sv)
	527	{
	528	ithread *thread = SV_to_ithread(aTHX_ sv);
68795e93	529	sv_unmagic(SvRV(sv),PERL_MAGIC_shared_scalar);
68795e93	530	}
8222d950	531
73e09c8f	532	#endif /* USE_ITHREADS */
e1c44605	533
68795e93	534	MODULE = threads PACKAGE = threads PREFIX = ithread_
68795e93	535	PROTOTYPES: DISABLE
8222d950	536
73e09c8f	537	#ifdef USE_ITHREADS
73e09c8f	538
68795e93	539	void
	540	ithread_new (classname, function_to_call, ...)
	541	char * classname
	542	SV * function_to_call
	543	CODE:
	544	{
	545	AV* params = newAV();
	546	if (items > 2) {
	547	int i;
	548	for(i = 2; i < items ; i++) {
95393226	549	av_push(params, SvREFCNT_inc(ST(i)));
68795e93	550	}
	551	}
	552	ST(0) = sv_2mortal(Perl_ithread_create(aTHX_ Nullsv, classname, function_to_call, newRV_noinc((SV*) params)));
	553	XSRETURN(1);
	554	}
8222d950	555
68795e93	556	void
678a9b6c	557	ithread_list(char *classname)
	558	PPCODE:
	559	{
	560	ithread *curr_thread;
	561	MUTEX_LOCK(&create_destruct_mutex);
	562	curr_thread = threads;
6794f985	563	PUSHs( sv_2mortal(ithread_to_SV(aTHX_ NULL, curr_thread, classname, TRUE)));
678a9b6c	564	while(curr_thread) {
678a9b6c	565	curr_thread = curr_thread->next;
	566	if(curr_thread == threads)
	567	break;
6794f985	568	if(curr_thread->state & PERL_ITHR_DETACHED \|\|
	569	curr_thread->state & PERL_ITHR_JOINED)
	570	continue;
	571	PUSHs( sv_2mortal(ithread_to_SV(aTHX_ NULL, curr_thread, classname, TRUE)));
678a9b6c	572	}
	573	MUTEX_UNLOCK(&create_destruct_mutex);
	574	}
	575
	576
	577	void
68795e93	578	ithread_self(char *classname)
	579	CODE:
	580	{
	581	ST(0) = sv_2mortal(Perl_ithread_self(aTHX_ Nullsv,classname));
	582	XSRETURN(1);
	583	}
47ba8780	584
47ba8780	585	int
68795e93	586	ithread_tid(ithread *thread)
47ba8780	587
47ba8780	588	void
68795e93	589	ithread_join(SV *obj)
e1c44605	590	PPCODE:
	591	{
	592	AV* params = Perl_ithread_join(aTHX_ obj);
	593	int i;
	594	I32 len = AvFILL(params);
	595	for (i = 0; i <= len; i++) {
1c3adb19	596	SV* tmp = av_shift(params);
	597	XPUSHs(tmp);
	598	sv_2mortal(tmp);
e1c44605	599	}
	600	SvREFCNT_dec(params);
	601	}
	602
f9dff5f5	603	void
f9dff5f5	604	ithread_yield(ithread *thread)
47ba8780	605
47ba8780	606	void
68795e93	607	ithread_detach(ithread *thread)
47ba8780	608
47ba8780	609	void
68795e93	610	ithread_DESTROY(SV *thread)
68795e93	611
73e09c8f	612	#endif /* USE_ITHREADS */
73e09c8f	613
68795e93	614	BOOT:
68795e93	615	{
73e09c8f	616	#ifdef USE_ITHREADS
68795e93	617	ithread* thread;
e1c44605	618	PL_perl_destruct_level = 2;
68795e93	619	PERL_THREAD_ALLOC_SPECIFIC(self_key);
58c2ef19	620	MUTEX_INIT(&create_destruct_mutex);
58c2ef19	621	MUTEX_LOCK(&create_destruct_mutex);
62375a60	622	PL_threadhook = &Perl_ithread_hook;
68795e93	623	thread = PerlMemShared_malloc(sizeof(ithread));
	624	Zero(thread,1,ithread);
	625	PL_perl_destruct_level = 2;
	626	MUTEX_INIT(&thread->mutex);
	627	threads = thread;
	628	thread->next = thread;
	629	thread->prev = thread;
	630	thread->interp = aTHX;
	631	thread->count = 1; /* imortal */
	632	thread->tid = tid_counter++;
62375a60	633	known_threads++;
58c2ef19	634	active_threads++;
62375a60	635	thread->state = 1;
68795e93	636	#ifdef WIN32
	637	thread->thr = GetCurrentThreadId();
	638	#else
	639	thread->thr = pthread_self();
	640	#endif
62375a60	641
68795e93	642	PERL_THREAD_SETSPECIFIC(self_key,thread);
58c2ef19	643	MUTEX_UNLOCK(&create_destruct_mutex);
73e09c8f	644	#endif /* USE_ITHREADS */
68795e93	645	}
68795e93	646