[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)
{
        PerlInterpreter* destroyperl = NULL;        
	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;
	    destroyperl = thread->interp;
	    thread->interp = NULL;
	}
	MUTEX_UNLOCK(&thread->mutex);
	MUTEX_DESTROY(&thread->mutex);
        PerlMemShared_free(thread);
	if(destroyperl) {
	    perl_destruct(destroyperl);
            perl_free(destroyperl);
	}
	PERL_SET_CONTEXT(aTHX);
}

int
Perl_ithread_hook(pTHX)
{
    int veto_cleanup = 0;
    MUTEX_LOCK(&create_destruct_mutex);
    if (aTHX == PL_curinterp && active_threads != 1) {
	Perl_warn(aTHX_ "A thread exited while %" IVdf " other threads were still running",
						(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_ "thread failed to start: %" SVf, ERRSV);
		}
		FREETMPS;
		LEAVE;
		SvREFCNT_dec(thread->init_function);
	}

	PerlIO_flush((PerlIO*)NULL);
	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);
	}
	MUTEX_LOCK(&create_destruct_mutex);
	active_threads--;
	assert( active_threads >= 0 );
	MUTEX_UNLOCK(&create_destruct_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 an implicit 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;
  if(curr_thread->tid != 0)	
    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
yield(...)
CODE:
{
    YIELD;
}
	

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