Coro-Multicore/Multicore.xs

/* most win32 perls are beyond fixing, requiring dTHX */
/* even for ISO-C functions such as malloc. avoid! avoid! avoid! */
/* and fail to define numerous symbols, but still overrwide them */
/* with non-working versions (e.g. setjmp). */
#ifdef _WIN32
/*# define PERL_CORE 1 fixes some, breaks others */
#else
# define PERL_NO_GET_CONTEXT
#endif

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

#define X_STACKSIZE 1024 * sizeof (void *)

#include "CoroAPI.h"
#include "perlmulticore.h"
#include "schmorp.h"
#include "xthread.h"

#ifdef _WIN32
  #ifndef sigset_t
    #define sigset_t int
  #endif
#endif

#ifndef SvREFCNT_dec_NN
  #define SvREFCNT_dec_NN(sv) SvREFCNT_dec (sv)
#endif

#ifndef SvREFCNT_dec_simple_void_NN
  #define SvREFCNT_dec_simple_void_NN(sv) SvREFCNT_dec (sv)
#endif

#ifndef SvREFCNT_inc_NN
  #define SvREFCNT_inc_NN(sv) SvREFCNT_inc (sv)
#endif

#ifndef RECURSION_CHECK
  #define RECURSION_CHECK 0
#endif

static X_TLS_DECLARE(current_key);
#if RECURSION_CHECK
static X_TLS_DECLARE(check_key);
#endif

static void
fatal (const char *msg)
{
  write (2, msg, strlen (msg));
  abort ();
}

static s_epipe ep;
static void *perl_thx;
static sigset_t cursigset, fullsigset;

static int global_enable = 0;
static int thread_enable; /* 0 undefined, 1 disabled, 2 enabled */

/* assigned to a thread for each release/acquire */
struct tctx
{
  void *coro;
  int wait_f;
  xcond_t acquire_c;
  int jeret;
};

static struct tctx *tctx_free;

static struct tctx *
tctx_get (void)
{
  struct tctx *ctx;

  if (!tctx_free)
    {
      ctx = malloc (sizeof (*tctx_free));
      X_COND_CREATE (ctx->acquire_c);
    }
  else
    {
      ctx = tctx_free;
      tctx_free = tctx_free->coro;
    }

  return ctx;
}

static void
tctx_put (struct tctx *ctx)
{
  ctx->coro = tctx_free;
  tctx_free = ctx;
}

/* a stack of tctxs */
struct tctxs
{
  struct tctx **ctxs;
  int cur, max;
};

static struct tctx *
tctxs_get (struct tctxs *ctxs)
{
  return ctxs->ctxs[--ctxs->cur];
}

static void
tctxs_put (struct tctxs *ctxs, struct tctx *ctx)
{
  if (ctxs->cur >= ctxs->max)
    {
      ctxs->max = ctxs->max ? ctxs->max * 2 : 16;
      ctxs->ctxs = realloc (ctxs->ctxs, ctxs->max * sizeof (ctxs->ctxs[0]));
    }

  ctxs->ctxs[ctxs->cur++] = ctx;
}

static xmutex_t release_m = X_MUTEX_INIT;
static xcond_t release_c = X_COND_INIT;
static struct tctxs releasers;
static int idle;
static int min_idle = 1;
static int curthreads, max_threads = 1; /* protected by release_m */

static xmutex_t acquire_m = X_MUTEX_INIT;
static struct tctxs acquirers;

X_THREAD_PROC(thread_proc)
{
  PERL_SET_CONTEXT (perl_thx);

  {
    dTHXa (perl_thx);
    dJMPENV;
    struct tctx *ctx;
    int catchret;

    X_LOCK (release_m);

    for (;;)
      {
        while (!releasers.cur)
          if (idle <= min_idle || 1)
            X_COND_WAIT (release_c, release_m);
          else
            {
              struct timespec ts = { time (0) + idle - min_idle, 0 };

              if (X_COND_TIMEDWAIT (release_c, release_m, ts) == ETIMEDOUT)
                if (idle > min_idle && !releasers.cur)
                  break;
            }

        ctx = tctxs_get (&releasers);
        --idle;
        X_UNLOCK (release_m);

        if (!ctx) /* timed out? */
          break;

        pthread_sigmask (SIG_SETMASK, &cursigset, 0);
        JMPENV_PUSH (ctx->jeret);

        if (!ctx->jeret)
          while (ctx->coro)
            CORO_SCHEDULE;

        JMPENV_POP;
        pthread_sigmask (SIG_SETMASK, &fullsigset, &cursigset);

        X_LOCK (acquire_m);
        ctx->wait_f = 1;
        X_COND_SIGNAL (ctx->acquire_c);
        X_UNLOCK (acquire_m);

        X_LOCK (release_m);
        ++idle;
      }
  }
}

static void
start_thread (void)
{
  xthread_t tid;

  if (!curthreads)
    {
      X_UNLOCK (release_m);
      eval_pv ("Coro::Multicore::init", 1);
      X_LOCK (release_m);
    }

  if (curthreads >= max_threads && 0)
    return;

  ++curthreads;
  ++idle;
  xthread_create (&tid, thread_proc, 0);
}

static void
pmapi_release (void)
{
  if (! ((thread_enable ? thread_enable : global_enable) & 1))
    {
      X_TLS_SET (current_key, 0);
      return;
    }

  #if RECURSION_CHECK
  if (X_TLS_GET (check_key))
    fatal ("FATAL: perlinterp_release () called without valid perl context");

  X_TLS_SET (check_key, &check_key);
  #endif

  struct tctx *ctx = tctx_get ();
  ctx->coro = SvREFCNT_inc_simple_NN (CORO_CURRENT);
  ctx->wait_f = 0;

  X_TLS_SET (current_key, ctx);
  pthread_sigmask (SIG_SETMASK, &fullsigset, &cursigset);

  X_LOCK (release_m);

  if (idle <= min_idle)
    start_thread ();

  tctxs_put (&releasers, ctx);
  X_COND_SIGNAL (release_c);

  while (!idle && releasers.cur)
    {
      X_UNLOCK (release_m);
      X_LOCK (release_m);
    }

  X_UNLOCK (release_m);
}

static void
pmapi_acquire (void)
{
  int jeret;
  struct tctx *ctx = X_TLS_GET (current_key);

  if (!ctx)
    return;

  #if RECURSION_CHECK
  if (X_TLS_GET (check_key) != &check_key)
    fatal ("FATAL: perlinterp_acquire () called with valid perl context");

  X_TLS_SET (check_key, 0);
  #endif

  X_LOCK (acquire_m);

  tctxs_put (&acquirers, ctx);

  s_epipe_signal (&ep);
  while (!ctx->wait_f)
    X_COND_WAIT (ctx->acquire_c, acquire_m);
  X_UNLOCK (acquire_m);

  jeret = ctx->jeret;
  tctx_put (ctx);
  pthread_sigmask (SIG_SETMASK, &cursigset, 0);

  if (jeret)
    {
      dTHX;
      JMPENV_JUMP (jeret);
    }
}

static void
set_thread_enable (pTHX_ void *arg)
{
  thread_enable = PTR2IV (arg);
}

MODULE = Coro::Multicore                PACKAGE = Coro::Multicore

PROTOTYPES: DISABLE

BOOT:
{
#ifndef _WIN32
        sigfillset (&fullsigset);
#endif

        X_TLS_INIT (current_key);
#if RECURSION_CHECK
        X_TLS_INIT (check_key);
#endif

        if (s_epipe_new (&ep))
          croak ("Coro::Multicore: unable to initialise event pipe.\n");

        perl_thx = PERL_GET_CONTEXT;

        I_CORO_API ("Coro::Multicore");

        if (0) { /*D*/
        X_LOCK (release_m);
        while (idle < min_idle)
          start_thread ();
        X_UNLOCK (release_m);
        }

        /* not perfectly efficient to do it this way, but it is simple */
        perl_multicore_init (); /* calls release */
        perl_multicore_api->pmapi_release = pmapi_release;
        perl_multicore_api->pmapi_acquire = pmapi_acquire;
}

bool
enable (bool enable = NO_INIT)
        CODE:
        RETVAL = global_enable;
        if (items)
          global_enable = enable;
        OUTPUT:
        RETVAL

void
scoped_enable ()
        CODE:
        LEAVE; /* see Guard.xs */
        CORO_ENTERLEAVE_SCOPE_HOOK (set_thread_enable, (void *)1, set_thread_enable, (void *)0);
        ENTER; /* see Guard.xs */

void
scoped_disable ()
        CODE:
        LEAVE; /* see Guard.xs */
        CORO_ENTERLEAVE_SCOPE_HOOK (set_thread_enable, (void *)2, set_thread_enable, (void *)0);
        ENTER; /* see Guard.xs */

#if 0

U32
min_idle_threads (U32 min = NO_INIT)
        CODE:
        X_LOCK (acquire_m);
        RETVAL = min_idle;
        if (items)
          min_idle = min;
        X_UNLOCK (acquire_m);
        OUTPUT:
        RETVAL

#endif

int
fd ()
        CODE:
        RETVAL = s_epipe_fd (&ep);
        OUTPUT:
        RETVAL

void
poll (...)
        CODE:
        s_epipe_drain (&ep);
        X_LOCK (acquire_m);
        while (acquirers.cur)
          {
            struct tctx *ctx = tctxs_get (&acquirers);
            CORO_READY ((SV *)ctx->coro);
            SvREFCNT_dec_simple_void_NN ((SV *)ctx->coro);
            ctx->coro = 0;
          }
        X_UNLOCK (acquire_m);

void
sleep (NV seconds)
        CODE:
        perlinterp_release ();
        {
          int nsec = seconds;
          if (nsec) sleep (nsec);
          nsec = (seconds - nsec) * 1e9;
          if (nsec) usleep (nsec);
        }
        perlinterp_acquire ();

Revision:	1.26
Committed:	Tue Dec 3 07:12:28 2019 UTC (4 years, 5 months ago) by root
Branch:	MAIN
CVS Tags:	rel-1_04
Changes since 1.25:	+7 -0 lines
Log Message:	1.04
#	Content
1	/* most win32 perls are beyond fixing, requiring dTHX */
2	/* even for ISO-C functions such as malloc. avoid! avoid! avoid! */
3	/* and fail to define numerous symbols, but still overrwide them */
4	/* with non-working versions (e.g. setjmp). */
5	#ifdef _WIN32
6	/# define PERL_CORE 1 fixes some, breaks others /
7	#else
8	# define PERL_NO_GET_CONTEXT
9	#endif
10
11	#include "EXTERN.h"
12	#include "perl.h"
13	#include "XSUB.h"
14
15	#define X_STACKSIZE 1024 * sizeof (void *)
16
17	#include "CoroAPI.h"
18	#include "perlmulticore.h"
19	#include "schmorp.h"
20	#include "xthread.h"
21
22	#ifdef _WIN32
23	#ifndef sigset_t
24	#define sigset_t int
25	#endif
26	#endif
27
28	#ifndef SvREFCNT_dec_NN
29	#define SvREFCNT_dec_NN(sv) SvREFCNT_dec (sv)
30	#endif
31
32	#ifndef SvREFCNT_dec_simple_void_NN
33	#define SvREFCNT_dec_simple_void_NN(sv) SvREFCNT_dec (sv)
34	#endif
35
36	#ifndef SvREFCNT_inc_NN
37	#define SvREFCNT_inc_NN(sv) SvREFCNT_inc (sv)
38	#endif
39
40	#ifndef RECURSION_CHECK
41	#define RECURSION_CHECK 0
42	#endif
43
44	static X_TLS_DECLARE(current_key);
45	#if RECURSION_CHECK
46	static X_TLS_DECLARE(check_key);
47	#endif
48
49	static void
50	fatal (const char *msg)
51	{
52	write (2, msg, strlen (msg));
53	abort ();
54	}
55
56	static s_epipe ep;
57	static void *perl_thx;
58	static sigset_t cursigset, fullsigset;
59
60	static int global_enable = 0;
61	static int thread_enable; /* 0 undefined, 1 disabled, 2 enabled */
62
63	/* assigned to a thread for each release/acquire */
64	struct tctx
65	{
66	void *coro;
67	int wait_f;
68	xcond_t acquire_c;
69	int jeret;
70	};
71
72	static struct tctx *tctx_free;
73
74	static struct tctx *
75	tctx_get (void)
76	{
77	struct tctx *ctx;
78
79	if (!tctx_free)
80	{
81	ctx = malloc (sizeof (*tctx_free));
82	X_COND_CREATE (ctx->acquire_c);
83	}
84	else
85	{
86	ctx = tctx_free;
87	tctx_free = tctx_free->coro;
88	}
89
90	return ctx;
91	}
92
93	static void
94	tctx_put (struct tctx *ctx)
95	{
96	ctx->coro = tctx_free;
97	tctx_free = ctx;
98	}
99
100	/* a stack of tctxs */
101	struct tctxs
102	{
103	struct tctx **ctxs;
104	int cur, max;
105	};
106
107	static struct tctx *
108	tctxs_get (struct tctxs *ctxs)
109	{
110	return ctxs->ctxs[--ctxs->cur];
111	}
112
113	static void
114	tctxs_put (struct tctxs ctxs, struct tctx ctx)
115	{
116	if (ctxs->cur >= ctxs->max)
117	{
118	ctxs->max = ctxs->max ? ctxs->max * 2 : 16;
119	ctxs->ctxs = realloc (ctxs->ctxs, ctxs->max * sizeof (ctxs->ctxs[0]));
120	}
121
122	ctxs->ctxs[ctxs->cur++] = ctx;
123	}
124
125	static xmutex_t release_m = X_MUTEX_INIT;
126	static xcond_t release_c = X_COND_INIT;
127	static struct tctxs releasers;
128	static int idle;
129	static int min_idle = 1;
130	static int curthreads, max_threads = 1; /* protected by release_m */
131
132	static xmutex_t acquire_m = X_MUTEX_INIT;
133	static struct tctxs acquirers;
134
135	X_THREAD_PROC(thread_proc)
136	{
137	PERL_SET_CONTEXT (perl_thx);
138
139	{
140	dTHXa (perl_thx);
141	dJMPENV;
142	struct tctx *ctx;
143	int catchret;
144
145	X_LOCK (release_m);
146
147	for (;;)
148	{
149	while (!releasers.cur)
150	if (idle <= min_idle \|\| 1)
151	X_COND_WAIT (release_c, release_m);
152	else
153	{
154	struct timespec ts = { time (0) + idle - min_idle, 0 };
155
156	if (X_COND_TIMEDWAIT (release_c, release_m, ts) == ETIMEDOUT)
157	if (idle > min_idle && !releasers.cur)
158	break;
159	}
160
161	ctx = tctxs_get (&releasers);
162	--idle;
163	X_UNLOCK (release_m);
164
165	if (!ctx) /* timed out? */
166	break;
167
168	pthread_sigmask (SIG_SETMASK, &cursigset, 0);
169	JMPENV_PUSH (ctx->jeret);
170
171	if (!ctx->jeret)
172	while (ctx->coro)
173	CORO_SCHEDULE;
174
175	JMPENV_POP;
176	pthread_sigmask (SIG_SETMASK, &fullsigset, &cursigset);
177
178	X_LOCK (acquire_m);
179	ctx->wait_f = 1;
180	X_COND_SIGNAL (ctx->acquire_c);
181	X_UNLOCK (acquire_m);
182
183	X_LOCK (release_m);
184	++idle;
185	}
186	}
187	}
188
189	static void
190	start_thread (void)
191	{
192	xthread_t tid;
193
194	if (!curthreads)
195	{
196	X_UNLOCK (release_m);
197	eval_pv ("Coro::Multicore::init", 1);
198	X_LOCK (release_m);
199	}
200
201	if (curthreads >= max_threads && 0)
202	return;
203
204	++curthreads;
205	++idle;
206	xthread_create (&tid, thread_proc, 0);
207	}
208
209	static void
210	pmapi_release (void)
211	{
212	if (! ((thread_enable ? thread_enable : global_enable) & 1))
213	{
214	X_TLS_SET (current_key, 0);
215	return;
216	}
217
218	#if RECURSION_CHECK
219	if (X_TLS_GET (check_key))
220	fatal ("FATAL: perlinterp_release () called without valid perl context");
221
222	X_TLS_SET (check_key, &check_key);
223	#endif
224
225	struct tctx *ctx = tctx_get ();
226	ctx->coro = SvREFCNT_inc_simple_NN (CORO_CURRENT);
227	ctx->wait_f = 0;
228
229	X_TLS_SET (current_key, ctx);
230	pthread_sigmask (SIG_SETMASK, &fullsigset, &cursigset);
231
232	X_LOCK (release_m);
233
234	if (idle <= min_idle)
235	start_thread ();
236
237	tctxs_put (&releasers, ctx);
238	X_COND_SIGNAL (release_c);
239
240	while (!idle && releasers.cur)
241	{
242	X_UNLOCK (release_m);
243	X_LOCK (release_m);
244	}
245
246	X_UNLOCK (release_m);
247	}
248
249	static void
250	pmapi_acquire (void)
251	{
252	int jeret;
253	struct tctx *ctx = X_TLS_GET (current_key);
254
255	if (!ctx)
256	return;
257
258	#if RECURSION_CHECK
259	if (X_TLS_GET (check_key) != &check_key)
260	fatal ("FATAL: perlinterp_acquire () called with valid perl context");
261
262	X_TLS_SET (check_key, 0);
263	#endif
264
265	X_LOCK (acquire_m);
266
267	tctxs_put (&acquirers, ctx);
268
269	s_epipe_signal (&ep);
270	while (!ctx->wait_f)
271	X_COND_WAIT (ctx->acquire_c, acquire_m);
272	X_UNLOCK (acquire_m);
273
274	jeret = ctx->jeret;
275	tctx_put (ctx);
276	pthread_sigmask (SIG_SETMASK, &cursigset, 0);
277
278	if (jeret)
279	{
280	dTHX;
281	JMPENV_JUMP (jeret);
282	}
283	}
284
285	static void
286	set_thread_enable (pTHX_ void *arg)
287	{
288	thread_enable = PTR2IV (arg);
289	}
290
291	MODULE = Coro::Multicore PACKAGE = Coro::Multicore
292
293	PROTOTYPES: DISABLE
294
295	BOOT:
296	{
297	#ifndef _WIN32
298	sigfillset (&fullsigset);
299	#endif
300
301	X_TLS_INIT (current_key);
302	#if RECURSION_CHECK
303	X_TLS_INIT (check_key);
304	#endif
305
306	if (s_epipe_new (&ep))
307	croak ("Coro::Multicore: unable to initialise event pipe.\n");
308
309	perl_thx = PERL_GET_CONTEXT;
310
311	I_CORO_API ("Coro::Multicore");
312
313	if (0) { /D/
314	X_LOCK (release_m);
315	while (idle < min_idle)
316	start_thread ();
317	X_UNLOCK (release_m);
318	}
319
320	/* not perfectly efficient to do it this way, but it is simple */
321	perl_multicore_init (); /* calls release */
322	perl_multicore_api->pmapi_release = pmapi_release;
323	perl_multicore_api->pmapi_acquire = pmapi_acquire;
324	}
325
326	bool
327	enable (bool enable = NO_INIT)
328	CODE:
329	RETVAL = global_enable;
330	if (items)
331	global_enable = enable;
332	OUTPUT:
333	RETVAL
334
335	void
336	scoped_enable ()
337	CODE:
338	LEAVE; /* see Guard.xs */
339	CORO_ENTERLEAVE_SCOPE_HOOK (set_thread_enable, (void )1, set_thread_enable, (void )0);
340	ENTER; /* see Guard.xs */
341
342	void
343	scoped_disable ()
344	CODE:
345	LEAVE; /* see Guard.xs */
346	CORO_ENTERLEAVE_SCOPE_HOOK (set_thread_enable, (void )2, set_thread_enable, (void )0);
347	ENTER; /* see Guard.xs */
348
349	#if 0
350
351	U32
352	min_idle_threads (U32 min = NO_INIT)
353	CODE:
354	X_LOCK (acquire_m);
355	RETVAL = min_idle;
356	if (items)
357	min_idle = min;
358	X_UNLOCK (acquire_m);
359	OUTPUT:
360	RETVAL
361
362	#endif
363
364	int
365	fd ()
366	CODE:
367	RETVAL = s_epipe_fd (&ep);
368	OUTPUT:
369	RETVAL
370
371	void
372	poll (...)
373	CODE:
374	s_epipe_drain (&ep);
375	X_LOCK (acquire_m);
376	while (acquirers.cur)
377	{
378	struct tctx *ctx = tctxs_get (&acquirers);
379	CORO_READY ((SV *)ctx->coro);
380	SvREFCNT_dec_simple_void_NN ((SV *)ctx->coro);
381	ctx->coro = 0;
382	}
383	X_UNLOCK (acquire_m);
384
385	void
386	sleep (NV seconds)
387	CODE:
388	perlinterp_release ();
389	{
390	int nsec = seconds;
391	if (nsec) sleep (nsec);
392	nsec = (seconds - nsec) * 1e9;
393	if (nsec) usleep (nsec);
394	}
395	perlinterp_acquire ();
396