[Patch t/op/re_tests] Re: [perl #56690] Some bugs in Perl regexp (core Perl issues)
[p5sagit/p5-mst-13.2.git] / ext / threads / shared / shared.xs
CommitLineData
afe38520 1/* shared.xs
68795e93 2 *
60c5c75c 3 * Copyright (c) 2001-2002, 2006 Larry Wall
68795e93 4 *
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
7 *
21312124 8 * "Hand any two wizards a piece of rope and they would instinctively pull in
9 * opposite directions."
10 * --Sourcery
11 *
7473853a 12 * Contributed by Artur Bergman <sky AT crucially DOT net>
13 * Pulled in the (an)other direction by Nick Ing-Simmons
14 * <nick AT ing-simmons DOT net>
15 * CPAN version produced by Jerry D. Hedden <jdhedden AT cpan DOT org>
21312124 16 */
68795e93 17
29ecdb6f 18/*
19 * Shared variables are implemented by a scheme similar to tieing.
20 * Each thread has a proxy SV with attached magic -- "private SVs" --
21 * which all point to a single SV in a separate shared interpreter
22 * (PL_sharedsv_space) -- "shared SVs".
23 *
24 * The shared SV holds the variable's true values, and its state is
25 * copied between the shared and private SVs with the usual
26 * mg_get()/mg_set() arrangement.
27 *
28 * Aggregates (AVs and HVs) are implemented using tie magic, except that
29 * the vtable used is one defined in this file rather than the standard one.
7473853a 30 * This means that where a tie function like FETCH is normally invoked by
29ecdb6f 31 * the tie magic's mg_get() function, we completely bypass the calling of a
32 * perl-level function, and directly call C-level code to handle it. On
7473853a 33 * the other hand, calls to functions like PUSH are done directly by code
34 * in av.c, etc., which we can't bypass. So the best we can do is to provide
29ecdb6f 35 * XS versions of these functions. We also have to attach a tie object,
36 * blessed into the class threads::shared::tie, to keep the method-calling
37 * code happy.
38 *
39 * Access to aggregate elements is done the usual tied way by returning a
40 * proxy PVLV element with attached element magic.
41 *
42 * Pointers to the shared SV are squirrelled away in the mg->mg_ptr field
43 * of magic (with mg_len == 0), and in the IV2PTR(SvIV(sv)) field of tied
44 * object SVs. These pointers have to be hidden like this because they
45 * cross interpreter boundaries, and we don't want sv_clear() and friends
46 * following them.
47 *
48 * The three basic shared types look like the following:
49 *
50 * -----------------
51 *
52 * Shared scalar (my $s : shared):
53 *
54 * SV = PVMG(0x7ba238) at 0x7387a8
55 * FLAGS = (PADMY,GMG,SMG)
56 * MAGIC = 0x824d88
57 * MG_TYPE = PERL_MAGIC_shared_scalar(n)
7473853a 58 * MG_PTR = 0x810358 <<<< pointer to the shared SV
29ecdb6f 59 *
60 * -----------------
61 *
62 * Shared aggregate (my @a : shared; my %h : shared):
63 *
64 * SV = PVAV(0x7175d0) at 0x738708
65 * FLAGS = (PADMY,RMG)
66 * MAGIC = 0x824e48
67 * MG_TYPE = PERL_MAGIC_tied(P)
7473853a 68 * MG_OBJ = 0x7136e0 <<<< ref to the tied object
29ecdb6f 69 * SV = RV(0x7136f0) at 0x7136e0
70 * RV = 0x738640
71 * SV = PVMG(0x7ba238) at 0x738640 <<<< the tied object
72 * FLAGS = (OBJECT,IOK,pIOK)
7473853a 73 * IV = 8455000 <<<< pointer to the shared AV
29ecdb6f 74 * STASH = 0x80abf0 "threads::shared::tie"
7473853a 75 * MG_PTR = 0x810358 "" <<<< another pointer to the shared AV
29ecdb6f 76 * ARRAY = 0x0
77 *
78 * -----------------
79 *
80 * Aggregate element (my @a : shared; $a[0])
81 *
82 * SV = PVLV(0x77f628) at 0x713550
83 * FLAGS = (GMG,SMG,RMG,pIOK)
84 * MAGIC = 0x72bd58
85 * MG_TYPE = PERL_MAGIC_shared_scalar(n)
7473853a 86 * MG_PTR = 0x8103c0 "" <<<< pointer to the shared element
29ecdb6f 87 * MAGIC = 0x72bd18
88 * MG_TYPE = PERL_MAGIC_tiedelem(p)
7473853a 89 * MG_OBJ = 0x7136e0 <<<< ref to the tied object
29ecdb6f 90 * SV = RV(0x7136f0) at 0x7136e0
91 * RV = 0x738660
92 * SV = PVMG(0x7ba278) at 0x738660 <<<< the tied object
93 * FLAGS = (OBJECT,IOK,pIOK)
7473853a 94 * IV = 8455064 <<<< pointer to the shared AV
29ecdb6f 95 * STASH = 0x80ac30 "threads::shared::tie"
96 * TYPE = t
97 *
98 * Note that PERL_MAGIC_tiedelem(p) magic doesn't have a pointer to a
99 * shared SV in mg_ptr; instead this is used to store the hash key,
100 * if any, like normal tied elements. Note also that element SVs may have
7473853a 101 * pointers to both the shared aggregate and the shared element.
29ecdb6f 102 *
103 *
104 * Userland locks:
105 *
7473853a 106 * If a shared variable is used as a perl-level lock or condition
29ecdb6f 107 * variable, then PERL_MAGIC_ext magic is attached to the associated
7473853a 108 * *shared* SV, whose mg_ptr field points to a malloc'ed structure
29ecdb6f 109 * containing the necessary mutexes and condition variables.
110 *
111 * Nomenclature:
112 *
7473853a 113 * In this file, any variable name prefixed with 's' (e.g., ssv, stmp or sobj)
114 * usually represents a shared SV which corresponds to a private SV named
115 * without the prefix (e.g., sv, tmp or obj).
116 */
117
68795e93 118#define PERL_NO_GET_CONTEXT
b050c948 119#include "EXTERN.h"
120#include "perl.h"
121#include "XSUB.h"
7473853a 122#ifdef HAS_PPPORT_H
39ec4146 123# define NEED_sv_2pv_flags
05b59262 124# define NEED_vnewSVpvf
125# define NEED_warner
c4393b60 126# define NEED_newSVpvn_flags
7473853a 127# include "ppport.h"
128# include "shared.h"
129#endif
b050c948 130
73e09c8f 131#ifdef USE_ITHREADS
132
e21694ed 133/* Magic signature(s) for mg_private to make PERL_MAGIC_ext magic safer */
134#define UL_MAGIC_SIG 0x554C /* UL = user lock */
135
21312124 136/*
137 * The shared things need an intepreter to live in ...
138 */
139PerlInterpreter *PL_sharedsv_space; /* The shared sv space */
140/* To access shared space we fake aTHX in this scope and thread's context */
057e91b3 141
7473853a 142/* Bug #24255: We include ENTER+SAVETMPS/FREETMPS+LEAVE with
143 * SHARED_CONTEXT/CALLER_CONTEXT macros, so that any mortals, etc. created
1011f542 144 * while in the shared interpreter context don't languish */
057e91b3 145
7473853a 146#define SHARED_CONTEXT \
147 STMT_START { \
148 PERL_SET_CONTEXT((aTHX = PL_sharedsv_space)); \
149 ENTER; \
150 SAVETMPS; \
057e91b3 151 } STMT_END
21312124 152
153/* So we need a way to switch back to the caller's context... */
154/* So we declare _another_ copy of the aTHX variable ... */
155#define dTHXc PerlInterpreter *caller_perl = aTHX
057e91b3 156
7473853a 157/* ... and use it to switch back */
158#define CALLER_CONTEXT \
159 STMT_START { \
160 FREETMPS; \
161 LEAVE; \
162 PERL_SET_CONTEXT((aTHX = caller_perl)); \
057e91b3 163 } STMT_END
21312124 164
165/*
166 * Only one thread at a time is allowed to mess with shared space.
167 */
a446a88f 168
7473853a 169typedef struct {
170 perl_mutex mutex;
171 PerlInterpreter *owner;
172 I32 locks;
173 perl_cond cond;
6b85e4fe 174#ifdef DEBUG_LOCKS
7473853a 175 char * file;
176 int line;
6b85e4fe 177#endif
6d56dc1c 178} recursive_lock_t;
179
7473853a 180recursive_lock_t PL_sharedsv_lock; /* Mutex protecting the shared sv space */
6d56dc1c 181
182void
183recursive_lock_init(pTHX_ recursive_lock_t *lock)
184{
185 Zero(lock,1,recursive_lock_t);
186 MUTEX_INIT(&lock->mutex);
187 COND_INIT(&lock->cond);
188}
189
a39edb3a 190void
579f9913 191recursive_lock_destroy(pTHX_ recursive_lock_t *lock)
192{
193 MUTEX_DESTROY(&lock->mutex);
194 COND_DESTROY(&lock->cond);
195}
196
6d56dc1c 197void
198recursive_lock_release(pTHX_ recursive_lock_t *lock)
199{
200 MUTEX_LOCK(&lock->mutex);
ba2940ce 201 if (lock->owner == aTHX) {
202 if (--lock->locks == 0) {
203 lock->owner = NULL;
204 COND_SIGNAL(&lock->cond);
205 }
6d56dc1c 206 }
207 MUTEX_UNLOCK(&lock->mutex);
208}
a446a88f 209
6d56dc1c 210void
7473853a 211recursive_lock_acquire(pTHX_ recursive_lock_t *lock, char *file, int line)
6d56dc1c 212{
213 assert(aTHX);
214 MUTEX_LOCK(&lock->mutex);
215 if (lock->owner == aTHX) {
7473853a 216 lock->locks++;
217 } else {
218 while (lock->owner) {
6b85e4fe 219#ifdef DEBUG_LOCKS
7473853a 220 Perl_warn(aTHX_ " %p waiting - owned by %p %s:%d\n",
221 aTHX, lock->owner, lock->file, lock->line);
6b85e4fe 222#endif
7473853a 223 COND_WAIT(&lock->cond,&lock->mutex);
6b85e4fe 224 }
7473853a 225 lock->locks = 1;
226 lock->owner = aTHX;
6b85e4fe 227#ifdef DEBUG_LOCKS
7473853a 228 lock->file = file;
229 lock->line = line;
6b85e4fe 230#endif
6d56dc1c 231 }
232 MUTEX_UNLOCK(&lock->mutex);
6b85e4fe 233 SAVEDESTRUCTOR_X(recursive_lock_release,lock);
6d56dc1c 234}
235
7473853a 236#define ENTER_LOCK \
237 STMT_START { \
238 ENTER; \
239 recursive_lock_acquire(aTHX_ &PL_sharedsv_lock, __FILE__, __LINE__);\
240 } STMT_END
21312124 241
7473853a 242/* The unlocking is done automatically at scope exit */
243#define LEAVE_LOCK LEAVE
6d56dc1c 244
21312124 245
246/* A common idiom is to acquire access and switch in ... */
7473853a 247#define SHARED_EDIT \
248 STMT_START { \
249 ENTER_LOCK; \
250 SHARED_CONTEXT; \
251 } STMT_END
21312124 252
7473853a 253/* ... then switch out and release access. */
254#define SHARED_RELEASE \
255 STMT_START { \
256 CALLER_CONTEXT; \
257 LEAVE_LOCK; \
258 } STMT_END
85e0a142 259
21312124 260
7473853a 261/* User-level locks:
29ecdb6f 262 This structure is attached (using ext magic) to any shared SV that
263 is used by user-level locking or condition code
21312124 264*/
68795e93 265
266typedef struct {
7473853a 267 recursive_lock_t lock; /* For user-levl locks */
68795e93 268 perl_cond user_cond; /* For user-level conditions */
29ecdb6f 269} user_lock;
68795e93 270
7473853a 271/* Magic used for attaching user_lock structs to shared SVs
68795e93 272
21312124 273 The vtable used has just one entry - when the SV goes away
274 we free the memory for the above.
21312124 275 */
68795e93 276
21312124 277int
29ecdb6f 278sharedsv_userlock_free(pTHX_ SV *sv, MAGIC *mg)
21312124 279{
29ecdb6f 280 user_lock *ul = (user_lock *) mg->mg_ptr;
281 assert(aTHX == PL_sharedsv_space);
282 if (ul) {
7473853a 283 recursive_lock_destroy(aTHX_ &ul->lock);
284 COND_DESTROY(&ul->user_cond);
285 PerlMemShared_free(ul);
286 mg->mg_ptr = NULL;
21312124 287 }
7473853a 288 return (0);
21312124 289}
290
7473853a 291MGVTBL sharedsv_userlock_vtbl = {
292 0, /* get */
293 0, /* set */
294 0, /* len */
295 0, /* clear */
296 sharedsv_userlock_free, /* free */
297 0, /* copy */
298 0, /* dup */
299#ifdef MGf_LOCAL
300 0, /* local */
301#endif
21312124 302};
303
7473853a 304/*
305 * Access to shared things is heavily based on MAGIC
306 * - in mg.h/mg.c/sv.c sense
307 */
21312124 308
309/* In any thread that has access to a shared thing there is a "proxy"
310 for it in its own space which has 'MAGIC' associated which accesses
311 the shared thing.
312 */
313
3bc7ad01 314extern MGVTBL sharedsv_scalar_vtbl; /* Scalars have this vtable */
315extern MGVTBL sharedsv_array_vtbl; /* Hashes and arrays have this
316 - like 'tie' */
317extern MGVTBL sharedsv_elem_vtbl; /* Elements of hashes and arrays have
318 this _AS WELL AS_ the scalar magic:
29ecdb6f 319 The sharedsv_elem_vtbl associates the element with the array/hash and
21312124 320 the sharedsv_scalar_vtbl associates it with the value
321 */
322
6b85e4fe 323
7473853a 324/* Get shared aggregate SV pointed to by threads::shared::tie magic object */
29ecdb6f 325
326STATIC SV *
327S_sharedsv_from_obj(pTHX_ SV *sv)
6b85e4fe 328{
7473853a 329 return ((SvROK(sv)) ? INT2PTR(SV *, SvIV(SvRV(sv))) : NULL);
29ecdb6f 330}
331
332
333/* Return the user_lock structure (if any) associated with a shared SV.
7473853a 334 * If create is true, create one if it doesn't exist
335 */
29ecdb6f 336STATIC user_lock *
337S_get_userlock(pTHX_ SV* ssv, bool create)
338{
339 MAGIC *mg;
340 user_lock *ul = NULL;
341
342 assert(ssv);
7473853a 343 /* XXX Redesign the storage of user locks so we don't need a global
29ecdb6f 344 * lock to access them ???? DAPM */
345 ENTER_LOCK;
e21694ed 346
347 /* Version of mg_find that also checks the private signature */
348 for (mg = SvMAGIC(ssv); mg; mg = mg->mg_moremagic) {
349 if ((mg->mg_type == PERL_MAGIC_ext) &&
350 (mg->mg_private == UL_MAGIC_SIG))
351 {
352 break;
353 }
354 }
355
7473853a 356 if (mg) {
357 ul = (user_lock*)(mg->mg_ptr);
358 } else if (create) {
359 dTHXc;
360 SHARED_CONTEXT;
361 ul = (user_lock *) PerlMemShared_malloc(sizeof(user_lock));
362 Zero(ul, 1, user_lock);
363 /* Attach to shared SV using ext magic */
e21694ed 364 mg = sv_magicext(ssv, NULL, PERL_MAGIC_ext, &sharedsv_userlock_vtbl,
365 (char *)ul, 0);
366 mg->mg_private = UL_MAGIC_SIG; /* Set private signature */
7473853a 367 recursive_lock_init(aTHX_ &ul->lock);
368 COND_INIT(&ul->user_cond);
369 CALLER_CONTEXT;
29ecdb6f 370 }
371 LEAVE_LOCK;
7473853a 372 return (ul);
6b85e4fe 373}
374
29ecdb6f 375
ba2940ce 376/* Given a private side SV tries to find if the SV has a shared backend,
377 * by looking for the magic.
378 */
29ecdb6f 379SV *
21312124 380Perl_sharedsv_find(pTHX_ SV *sv)
381{
382 MAGIC *mg;
a446a88f 383 if (SvTYPE(sv) >= SVt_PVMG) {
7473853a 384 switch(SvTYPE(sv)) {
385 case SVt_PVAV:
386 case SVt_PVHV:
387 if ((mg = mg_find(sv, PERL_MAGIC_tied))
388 && mg->mg_virtual == &sharedsv_array_vtbl) {
389 return ((SV *)mg->mg_ptr);
390 }
391 break;
392 default:
393 /* This should work for elements as well as they
394 * have scalar magic as well as their element magic
395 */
396 if ((mg = mg_find(sv, PERL_MAGIC_shared_scalar))
397 && mg->mg_virtual == &sharedsv_scalar_vtbl) {
398 return ((SV *)mg->mg_ptr);
399 }
400 break;
401 }
21312124 402 }
6b85e4fe 403 /* Just for tidyness of API also handle tie objects */
404 if (SvROK(sv) && sv_derived_from(sv, "threads::shared::tie")) {
7473853a 405 return (S_sharedsv_from_obj(aTHX_ sv));
6b85e4fe 406 }
7473853a 407 return (NULL);
21312124 408}
68795e93 409
68795e93 410
7473853a 411/* Associate a private SV with a shared SV by pointing the appropriate
412 * magics at it.
413 * Assumes lock is held.
414 */
29ecdb6f 415void
416Perl_sharedsv_associate(pTHX_ SV *sv, SV *ssv)
21312124 417{
a446a88f 418 MAGIC *mg = 0;
a446a88f 419
29ecdb6f 420 /* If we are asked for any private ops we need a thread */
a446a88f 421 assert ( aTHX != PL_sharedsv_space );
422
423 /* To avoid need for recursive locks require caller to hold lock */
6d56dc1c 424 assert ( PL_sharedsv_lock.owner == aTHX );
6b85e4fe 425
29ecdb6f 426 switch(SvTYPE(sv)) {
427 case SVt_PVAV:
428 case SVt_PVHV:
7473853a 429 if (!(mg = mg_find(sv, PERL_MAGIC_tied))
430 || mg->mg_virtual != &sharedsv_array_vtbl
431 || (SV*) mg->mg_ptr != ssv)
432 {
433 SV *obj = newSV(0);
434 sv_setref_iv(obj, "threads::shared::tie", PTR2IV(ssv));
435 if (mg) {
436 sv_unmagic(sv, PERL_MAGIC_tied);
437 }
438 mg = sv_magicext(sv, obj, PERL_MAGIC_tied, &sharedsv_array_vtbl,
439 (char *)ssv, 0);
440 mg->mg_flags |= (MGf_COPY|MGf_DUP);
441 SvREFCNT_inc_void(ssv);
442 SvREFCNT_dec(obj);
443 }
444 break;
68795e93 445
29ecdb6f 446 default:
7473853a 447 if ((SvTYPE(sv) < SVt_PVMG)
448 || !(mg = mg_find(sv, PERL_MAGIC_shared_scalar))
449 || mg->mg_virtual != &sharedsv_scalar_vtbl
450 || (SV*) mg->mg_ptr != ssv)
451 {
452 if (mg) {
453 sv_unmagic(sv, PERL_MAGIC_shared_scalar);
454 }
455 mg = sv_magicext(sv, Nullsv, PERL_MAGIC_shared_scalar,
456 &sharedsv_scalar_vtbl, (char *)ssv, 0);
457 mg->mg_flags |= (MGf_DUP
458#ifdef MGf_LOCAL
459 |MGf_LOCAL
460#endif
461 );
462 SvREFCNT_inc_void(ssv);
463 }
464 break;
21312124 465 }
7473853a 466
29ecdb6f 467 assert ( Perl_sharedsv_find(aTHX_ sv) == ssv );
468}
6b85e4fe 469
6b85e4fe 470
29ecdb6f 471/* Given a private SV, create and return an associated shared SV.
7473853a 472 * Assumes lock is held.
473 */
29ecdb6f 474STATIC SV *
475S_sharedsv_new_shared(pTHX_ SV *sv)
476{
477 dTHXc;
478 SV *ssv;
6b85e4fe 479
29ecdb6f 480 assert(PL_sharedsv_lock.owner == aTHX);
481 assert(aTHX != PL_sharedsv_space);
68795e93 482
29ecdb6f 483 SHARED_CONTEXT;
484 ssv = newSV(0);
7473853a 485 SvREFCNT(ssv) = 0; /* Will be upped to 1 by Perl_sharedsv_associate */
29ecdb6f 486 sv_upgrade(ssv, SvTYPE(sv));
487 CALLER_CONTEXT;
488 Perl_sharedsv_associate(aTHX_ sv, ssv);
7473853a 489 return (ssv);
29ecdb6f 490}
21312124 491
21312124 492
29ecdb6f 493/* Given a shared SV, create and return an associated private SV.
7473853a 494 * Assumes lock is held.
495 */
29ecdb6f 496STATIC SV *
497S_sharedsv_new_private(pTHX_ SV *ssv)
498{
499 SV *sv;
500
501 assert(PL_sharedsv_lock.owner == aTHX);
502 assert(aTHX != PL_sharedsv_space);
503
504 sv = newSV(0);
505 sv_upgrade(sv, SvTYPE(ssv));
506 Perl_sharedsv_associate(aTHX_ sv, ssv);
7473853a 507 return (sv);
21312124 508}
68795e93 509
29ecdb6f 510
7473853a 511/* A threadsafe version of SvREFCNT_dec(ssv) */
29ecdb6f 512
513STATIC void
514S_sharedsv_dec(pTHX_ SV* ssv)
68795e93 515{
7473853a 516 if (! ssv)
517 return;
29ecdb6f 518 ENTER_LOCK;
519 if (SvREFCNT(ssv) > 1) {
7473853a 520 /* No side effects, so can do it lightweight */
521 SvREFCNT_dec(ssv);
522 } else {
523 dTHXc;
524 SHARED_CONTEXT;
525 SvREFCNT_dec(ssv);
526 CALLER_CONTEXT;
21312124 527 }
29ecdb6f 528 LEAVE_LOCK;
68795e93 529}
530
7473853a 531
532/* Implements Perl-level share() and :shared */
29ecdb6f 533
21312124 534void
535Perl_sharedsv_share(pTHX_ SV *sv)
536{
537 switch(SvTYPE(sv)) {
538 case SVt_PVGV:
7473853a 539 Perl_croak(aTHX_ "Cannot share globs yet");
540 break;
21312124 541
542 case SVt_PVCV:
7473853a 543 Perl_croak(aTHX_ "Cannot share subs yet");
544 break;
85e0a142 545
21312124 546 default:
7473853a 547 ENTER_LOCK;
548 (void) S_sharedsv_new_shared(aTHX_ sv);
549 LEAVE_LOCK;
550 SvSETMAGIC(sv);
551 break;
21312124 552 }
553}
68795e93 554
7473853a 555
2a6601ce 556#ifdef WIN32
557/* Number of milliseconds from 1/1/1601 to 1/1/1970 */
558#define EPOCH_BIAS 11644473600000.
559
560/* Returns relative time in milliseconds. (Adapted from Time::HiRes.) */
561STATIC DWORD
562S_abs_2_rel_milli(double abs)
563{
564 double rel;
565
566 /* Get current time (in units of 100 nanoseconds since 1/1/1601) */
567 union {
05b59262 568 FILETIME ft;
569 __int64 i64; /* 'signed' to keep compilers happy */
2a6601ce 570 } now;
571
572 GetSystemTimeAsFileTime(&now.ft);
573
574 /* Relative time in milliseconds */
575 rel = (abs * 1000.) - (((double)now.i64 / 10000.) - EPOCH_BIAS);
2a6601ce 576 if (rel <= 0.0) {
577 return (0);
578 }
579 return (DWORD)rel;
580}
581
582#else
583# if defined(OS2)
7473853a 584# define ABS2RELMILLI(abs) \
a0e036c1 585 do { \
2666606c 586 abs -= (double)time(NULL); \
a0e036c1 587 if (abs > 0) { abs *= 1000; } \
588 else { abs = 0; } \
589 } while (0)
2a6601ce 590# endif /* OS2 */
591#endif /* WIN32 */
a0e036c1 592
7473853a 593/* Do OS-specific condition timed wait */
29ecdb6f 594
a0e036c1 595bool
596Perl_sharedsv_cond_timedwait(perl_cond *cond, perl_mutex *mut, double abs)
597{
598#if defined(NETWARE) || defined(FAKE_THREADS) || defined(I_MACH_CTHREADS)
599 Perl_croak_nocontext("cond_timedwait not supported on this platform");
600#else
601# ifdef WIN32
602 int got_it = 0;
603
a0e036c1 604 cond->waiters++;
605 MUTEX_UNLOCK(mut);
606 /* See comments in win32/win32thread.h COND_WAIT vis-a-vis race */
2a6601ce 607 switch (WaitForSingleObject(cond->sem, S_abs_2_rel_milli(abs))) {
a0e036c1 608 case WAIT_OBJECT_0: got_it = 1; break;
609 case WAIT_TIMEOUT: break;
610 default:
611 /* WAIT_FAILED? WAIT_ABANDONED? others? */
612 Perl_croak_nocontext("panic: cond_timedwait (%ld)",GetLastError());
613 break;
614 }
615 MUTEX_LOCK(mut);
2666606c 616 cond->waiters--;
7473853a 617 return (got_it);
a0e036c1 618# else
619# ifdef OS2
620 int rc, got_it = 0;
621 STRLEN n_a;
622
623 ABS2RELMILLI(abs);
624
625 if ((rc = DosResetEventSem(*cond,&n_a)) && (rc != ERROR_ALREADY_RESET))
626 Perl_rc = rc, croak_with_os2error("panic: cond_timedwait-reset");
627 MUTEX_UNLOCK(mut);
628 if (CheckOSError(DosWaitEventSem(*cond,abs))
629 && (rc != ERROR_INTERRUPT))
630 croak_with_os2error("panic: cond_timedwait");
631 if (rc == ERROR_INTERRUPT) errno = EINTR;
632 MUTEX_LOCK(mut);
7473853a 633 return (got_it);
634# else /* Hope you're I_PTHREAD! */
a0e036c1 635 struct timespec ts;
636 int got_it = 0;
637
638 ts.tv_sec = (long)abs;
639 abs -= (NV)ts.tv_sec;
640 ts.tv_nsec = (long)(abs * 1000000000.0);
641
642 switch (pthread_cond_timedwait(cond, mut, &ts)) {
643 case 0: got_it = 1; break;
644 case ETIMEDOUT: break;
cf0d1c66 645#ifdef OEMVS
646 case -1:
7473853a 647 if (errno == ETIMEDOUT || errno == EAGAIN)
648 break;
cf0d1c66 649#endif
a0e036c1 650 default:
651 Perl_croak_nocontext("panic: cond_timedwait");
652 break;
653 }
7473853a 654 return (got_it);
a0e036c1 655# endif /* OS2 */
656# endif /* WIN32 */
657#endif /* NETWARE || FAKE_THREADS || I_MACH_CTHREADS */
658}
659
dad67c22 660
7473853a 661/* Given a shared RV, copy it's value to a private RV, also copying the
dad67c22 662 * object status of the referent.
663 * If the private side is already an appropriate RV->SV combination, keep
664 * it if possible.
665 */
dad67c22 666STATIC void
667S_get_RV(pTHX_ SV *sv, SV *ssv) {
668 SV *sobj = SvRV(ssv);
669 SV *obj;
7473853a 670 if (! (SvROK(sv) &&
671 ((obj = SvRV(sv))) &&
672 (Perl_sharedsv_find(aTHX_ obj) == sobj) &&
673 (SvTYPE(obj) == SvTYPE(sobj))))
dad67c22 674 {
7473853a 675 /* Can't reuse obj */
676 if (SvROK(sv)) {
677 SvREFCNT_dec(SvRV(sv));
678 } else {
679 assert(SvTYPE(sv) >= SVt_RV);
680 sv_setsv_nomg(sv, &PL_sv_undef);
681 SvROK_on(sv);
682 }
683 obj = S_sharedsv_new_private(aTHX_ SvRV(ssv));
684 SvRV_set(sv, obj);
dad67c22 685 }
686
687 if (SvOBJECT(obj)) {
7473853a 688 /* Remove any old blessing */
689 SvREFCNT_dec(SvSTASH(obj));
690 SvOBJECT_off(obj);
dad67c22 691 }
692 if (SvOBJECT(sobj)) {
7473853a 693 /* Add any new old blessing */
694 STRLEN len;
695 char* stash_ptr = SvPV((SV*) SvSTASH(sobj), len);
696 HV* stash = gv_stashpvn(stash_ptr, len, TRUE);
697 SvOBJECT_on(obj);
698 SvSTASH_set(obj, (HV*)SvREFCNT_inc(stash));
dad67c22 699 }
700}
701
702
29ecdb6f 703/* ------------ PERL_MAGIC_shared_scalar(n) functions -------------- */
704
7473853a 705/* Get magic for PERL_MAGIC_shared_scalar(n) */
68795e93 706
21312124 707int
708sharedsv_scalar_mg_get(pTHX_ SV *sv, MAGIC *mg)
68795e93 709{
29ecdb6f 710 SV *ssv = (SV *) mg->mg_ptr;
711 assert(ssv);
21312124 712
6d56dc1c 713 ENTER_LOCK;
29ecdb6f 714 if (SvROK(ssv)) {
7473853a 715 S_get_RV(aTHX_ sv, ssv);
500a8019 716 /* Look ahead for refs of refs */
f6d55995 717 if (SvROK(SvRV(ssv))) {
718 SvROK_on(SvRV(sv));
719 S_get_RV(aTHX_ SvRV(sv), SvRV(ssv));
720 }
7473853a 721 } else {
722 sv_setsv_nomg(sv, ssv);
21312124 723 }
6d56dc1c 724 LEAVE_LOCK;
7473853a 725 return (0);
21312124 726}
727
7473853a 728/* Copy the contents of a private SV to a shared SV.
729 * Used by various mg_set()-type functions.
730 * Assumes lock is held.
731 */
6b85e4fe 732void
29ecdb6f 733sharedsv_scalar_store(pTHX_ SV *sv, SV *ssv)
21312124 734{
735 dTHXc;
21312124 736 bool allowed = TRUE;
29ecdb6f 737
738 assert(PL_sharedsv_lock.owner == aTHX);
21312124 739 if (SvROK(sv)) {
7473853a 740 SV *obj = SvRV(sv);
741 SV *sobj = Perl_sharedsv_find(aTHX_ obj);
742 if (sobj) {
743 SHARED_CONTEXT;
2a6601ce 744 (void)SvUPGRADE(ssv, SVt_RV);
7473853a 745 sv_setsv_nomg(ssv, &PL_sv_undef);
746
747 SvRV_set(ssv, SvREFCNT_inc(sobj));
748 SvROK_on(ssv);
749 if (SvOBJECT(sobj)) {
750 /* Remove any old blessing */
751 SvREFCNT_dec(SvSTASH(sobj));
752 SvOBJECT_off(sobj);
753 }
754 if (SvOBJECT(obj)) {
755 SV* fake_stash = newSVpv(HvNAME_get(SvSTASH(obj)),0);
756 SvOBJECT_on(sobj);
757 SvSTASH_set(sobj, (HV*)fake_stash);
758 }
759 CALLER_CONTEXT;
760 } else {
761 allowed = FALSE;
762 }
763 } else {
5c360ac5 764 SvTEMP_off(sv);
7473853a 765 SHARED_CONTEXT;
766 sv_setsv_nomg(ssv, sv);
767 if (SvOBJECT(ssv)) {
768 /* Remove any old blessing */
769 SvREFCNT_dec(SvSTASH(ssv));
770 SvOBJECT_off(ssv);
771 }
772 if (SvOBJECT(sv)) {
773 SV* fake_stash = newSVpv(HvNAME_get(SvSTASH(sv)),0);
774 SvOBJECT_on(ssv);
775 SvSTASH_set(ssv, (HV*)fake_stash);
776 }
777 CALLER_CONTEXT;
21312124 778 }
21312124 779 if (!allowed) {
7473853a 780 Perl_croak(aTHX_ "Invalid value for shared scalar");
21312124 781 }
6b85e4fe 782}
783
7473853a 784/* Set magic for PERL_MAGIC_shared_scalar(n) */
29ecdb6f 785
6b85e4fe 786int
787sharedsv_scalar_mg_set(pTHX_ SV *sv, MAGIC *mg)
788{
29ecdb6f 789 SV *ssv = (SV*)(mg->mg_ptr);
790 assert(ssv);
6b85e4fe 791 ENTER_LOCK;
29ecdb6f 792 if (SvTYPE(ssv) < SvTYPE(sv)) {
7473853a 793 dTHXc;
794 SHARED_CONTEXT;
795 sv_upgrade(ssv, SvTYPE(sv));
796 CALLER_CONTEXT;
29ecdb6f 797 }
798 sharedsv_scalar_store(aTHX_ sv, ssv);
6b85e4fe 799 LEAVE_LOCK;
7473853a 800 return (0);
68795e93 801}
802
7473853a 803/* Free magic for PERL_MAGIC_shared_scalar(n) */
a446a88f 804
805int
29ecdb6f 806sharedsv_scalar_mg_free(pTHX_ SV *sv, MAGIC *mg)
a446a88f 807{
29ecdb6f 808 S_sharedsv_dec(aTHX_ (SV*)mg->mg_ptr);
7473853a 809 return (0);
21312124 810}
68795e93 811
812/*
29ecdb6f 813 * Called during cloning of PERL_MAGIC_shared_scalar(n) magic in new thread
21312124 814 */
815int
816sharedsv_scalar_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
817{
7473853a 818 SvREFCNT_inc_void(mg->mg_ptr);
819 return (0);
21312124 820}
68795e93 821
7473853a 822#ifdef MGf_LOCAL
a5063e7c 823/*
824 * Called during local $shared
825 */
826int
827sharedsv_scalar_mg_local(pTHX_ SV* nsv, MAGIC *mg)
828{
829 MAGIC *nmg;
29ecdb6f 830 SV *ssv = (SV *) mg->mg_ptr;
831 if (ssv) {
7473853a 832 ENTER_LOCK;
833 SvREFCNT_inc_void(ssv);
834 LEAVE_LOCK;
a5063e7c 835 }
836 nmg = sv_magicext(nsv, mg->mg_obj, mg->mg_type, mg->mg_virtual,
7473853a 837 mg->mg_ptr, mg->mg_len);
a5063e7c 838 nmg->mg_flags = mg->mg_flags;
839 nmg->mg_private = mg->mg_private;
840
7473853a 841 return (0);
a5063e7c 842}
7473853a 843#endif
a5063e7c 844
21312124 845MGVTBL sharedsv_scalar_vtbl = {
7473853a 846 sharedsv_scalar_mg_get, /* get */
847 sharedsv_scalar_mg_set, /* set */
848 0, /* len */
849 0, /* clear */
850 sharedsv_scalar_mg_free, /* free */
851 0, /* copy */
852 sharedsv_scalar_mg_dup, /* dup */
853#ifdef MGf_LOCAL
854 sharedsv_scalar_mg_local, /* local */
855#endif
21312124 856};
68795e93 857
29ecdb6f 858/* ------------ PERL_MAGIC_tiedelem(p) functions -------------- */
859
7473853a 860/* Get magic for PERL_MAGIC_tiedelem(p) */
29ecdb6f 861
21312124 862int
863sharedsv_elem_mg_FETCH(pTHX_ SV *sv, MAGIC *mg)
68795e93 864{
21312124 865 dTHXc;
29ecdb6f 866 SV *saggregate = S_sharedsv_from_obj(aTHX_ mg->mg_obj);
21312124 867 SV** svp;
868
6b85e4fe 869 ENTER_LOCK;
29ecdb6f 870 if (SvTYPE(saggregate) == SVt_PVAV) {
7473853a 871 assert ( mg->mg_ptr == 0 );
872 SHARED_CONTEXT;
873 svp = av_fetch((AV*) saggregate, mg->mg_len, 0);
874 } else {
875 char *key = mg->mg_ptr;
876 STRLEN len = mg->mg_len;
877 assert ( mg->mg_ptr != 0 );
878 if (mg->mg_len == HEf_SVKEY) {
a1335164 879 key = SvPV((SV *)mg->mg_ptr, len);
880 if (SvUTF8((SV *)mg->mg_ptr)) {
881 len = -len;
882 }
7473853a 883 }
884 SHARED_CONTEXT;
885 svp = hv_fetch((HV*) saggregate, key, len, 0);
21312124 886 }
6b85e4fe 887 CALLER_CONTEXT;
21312124 888 if (svp) {
7473853a 889 /* Exists in the array */
890 if (SvROK(*svp)) {
891 S_get_RV(aTHX_ sv, *svp);
500a8019 892 /* Look ahead for refs of refs */
f6d55995 893 if (SvROK(SvRV(*svp))) {
894 SvROK_on(SvRV(sv));
895 S_get_RV(aTHX_ SvRV(sv), SvRV(*svp));
896 }
7473853a 897 } else {
373098c0 898 /* $ary->[elem] or $ary->{elem} is a scalar */
7473853a 899 Perl_sharedsv_associate(aTHX_ sv, *svp);
900 sv_setsv(sv, *svp);
901 }
902 } else {
903 /* Not in the array */
904 sv_setsv(sv, &PL_sv_undef);
68795e93 905 }
6b85e4fe 906 LEAVE_LOCK;
7473853a 907 return (0);
68795e93 908}
909
7473853a 910/* Set magic for PERL_MAGIC_tiedelem(p) */
29ecdb6f 911
21312124 912int
913sharedsv_elem_mg_STORE(pTHX_ SV *sv, MAGIC *mg)
914{
915 dTHXc;
29ecdb6f 916 SV *saggregate = S_sharedsv_from_obj(aTHX_ mg->mg_obj);
6b85e4fe 917 SV **svp;
21312124 918 /* Theory - SV itself is magically shared - and we have ordered the
919 magic such that by the time we get here it has been stored
920 to its shared counterpart
921 */
6d56dc1c 922 ENTER_LOCK;
29ecdb6f 923 assert(saggregate);
924 if (SvTYPE(saggregate) == SVt_PVAV) {
7473853a 925 assert ( mg->mg_ptr == 0 );
926 SHARED_CONTEXT;
927 svp = av_fetch((AV*) saggregate, mg->mg_len, 1);
928 } else {
929 char *key = mg->mg_ptr;
930 STRLEN len = mg->mg_len;
931 assert ( mg->mg_ptr != 0 );
a1335164 932 if (mg->mg_len == HEf_SVKEY) {
933 key = SvPV((SV *)mg->mg_ptr, len);
934 if (SvUTF8((SV *)mg->mg_ptr)) {
935 len = -len;
936 }
937 }
7473853a 938 SHARED_CONTEXT;
939 svp = hv_fetch((HV*) saggregate, key, len, 1);
21312124 940 }
6b85e4fe 941 CALLER_CONTEXT;
29ecdb6f 942 Perl_sharedsv_associate(aTHX_ sv, *svp);
943 sharedsv_scalar_store(aTHX_ sv, *svp);
6b85e4fe 944 LEAVE_LOCK;
7473853a 945 return (0);
21312124 946}
68795e93 947
7473853a 948/* Clear magic for PERL_MAGIC_tiedelem(p) */
29ecdb6f 949
21312124 950int
951sharedsv_elem_mg_DELETE(pTHX_ SV *sv, MAGIC *mg)
68795e93 952{
21312124 953 dTHXc;
057e91b3 954 MAGIC *shmg;
29ecdb6f 955 SV *saggregate = S_sharedsv_from_obj(aTHX_ mg->mg_obj);
6b85e4fe 956 ENTER_LOCK;
957 sharedsv_elem_mg_FETCH(aTHX_ sv, mg);
057e91b3 958 if ((shmg = mg_find(sv, PERL_MAGIC_shared_scalar)))
7473853a 959 sharedsv_scalar_mg_get(aTHX_ sv, shmg);
29ecdb6f 960 if (SvTYPE(saggregate) == SVt_PVAV) {
7473853a 961 SHARED_CONTEXT;
962 av_delete((AV*) saggregate, mg->mg_len, G_DISCARD);
963 } else {
964 char *key = mg->mg_ptr;
965 STRLEN len = mg->mg_len;
966 assert ( mg->mg_ptr != 0 );
a1335164 967 if (mg->mg_len == HEf_SVKEY) {
968 key = SvPV((SV *)mg->mg_ptr, len);
969 if (SvUTF8((SV *)mg->mg_ptr)) {
970 len = -len;
971 }
972 }
7473853a 973 SHARED_CONTEXT;
974 hv_delete((HV*) saggregate, key, len, G_DISCARD);
21312124 975 }
6b85e4fe 976 CALLER_CONTEXT;
977 LEAVE_LOCK;
7473853a 978 return (0);
21312124 979}
980
29ecdb6f 981/* Called during cloning of PERL_MAGIC_tiedelem(p) magic in new
982 * thread */
983
21312124 984int
985sharedsv_elem_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
986{
7473853a 987 SvREFCNT_inc_void(S_sharedsv_from_obj(aTHX_ mg->mg_obj));
29ecdb6f 988 assert(mg->mg_flags & MGf_DUP);
7473853a 989 return (0);
21312124 990}
991
992MGVTBL sharedsv_elem_vtbl = {
7473853a 993 sharedsv_elem_mg_FETCH, /* get */
994 sharedsv_elem_mg_STORE, /* set */
995 0, /* len */
996 sharedsv_elem_mg_DELETE, /* clear */
997 0, /* free */
998 0, /* copy */
999 sharedsv_elem_mg_dup, /* dup */
1000#ifdef MGf_LOCAL
1001 0, /* local */
1002#endif
21312124 1003};
1004
29ecdb6f 1005/* ------------ PERL_MAGIC_tied(P) functions -------------- */
1006
7473853a 1007/* Len magic for PERL_MAGIC_tied(P) */
29ecdb6f 1008
21312124 1009U32
1010sharedsv_array_mg_FETCHSIZE(pTHX_ SV *sv, MAGIC *mg)
1011{
1012 dTHXc;
29ecdb6f 1013 SV *ssv = (SV *) mg->mg_ptr;
21312124 1014 U32 val;
1015 SHARED_EDIT;
29ecdb6f 1016 if (SvTYPE(ssv) == SVt_PVAV) {
7473853a 1017 val = av_len((AV*) ssv);
1018 } else {
1019 /* Not actually defined by tie API but ... */
1020 val = HvKEYS((HV*) ssv);
21312124 1021 }
1022 SHARED_RELEASE;
7473853a 1023 return (val);
21312124 1024}
1025
7473853a 1026/* Clear magic for PERL_MAGIC_tied(P) */
29ecdb6f 1027
21312124 1028int
1029sharedsv_array_mg_CLEAR(pTHX_ SV *sv, MAGIC *mg)
1030{
1031 dTHXc;
29ecdb6f 1032 SV *ssv = (SV *) mg->mg_ptr;
21312124 1033 SHARED_EDIT;
29ecdb6f 1034 if (SvTYPE(ssv) == SVt_PVAV) {
7473853a 1035 av_clear((AV*) ssv);
1036 } else {
1037 hv_clear((HV*) ssv);
21312124 1038 }
1039 SHARED_RELEASE;
7473853a 1040 return (0);
21312124 1041}
1042
7473853a 1043/* Free magic for PERL_MAGIC_tied(P) */
29ecdb6f 1044
21312124 1045int
1046sharedsv_array_mg_free(pTHX_ SV *sv, MAGIC *mg)
1047{
29ecdb6f 1048 S_sharedsv_dec(aTHX_ (SV*)mg->mg_ptr);
7473853a 1049 return (0);
68795e93 1050}
1051
1052/*
7473853a 1053 * Copy magic for PERL_MAGIC_tied(P)
21312124 1054 * This is called when perl is about to access an element of
1055 * the array -
1056 */
33d16ee7 1057#if PERL_VERSION >= 11
21312124 1058int
1059sharedsv_array_mg_copy(pTHX_ SV *sv, MAGIC* mg,
3468c7ea 1060 SV *nsv, const char *name, I32 namlen)
33d16ee7 1061#else
1062int
1063sharedsv_array_mg_copy(pTHX_ SV *sv, MAGIC* mg,
1064 SV *nsv, const char *name, int namlen)
1065#endif
21312124 1066{
21312124 1067 MAGIC *nmg = sv_magicext(nsv,mg->mg_obj,
7473853a 1068 toLOWER(mg->mg_type),&sharedsv_elem_vtbl,
1069 name, namlen);
21312124 1070 nmg->mg_flags |= MGf_DUP;
7473853a 1071 return (1);
21312124 1072}
1073
29ecdb6f 1074/* Called during cloning of PERL_MAGIC_tied(P) magic in new thread */
1075
21312124 1076int
1077sharedsv_array_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
1078{
7473853a 1079 SvREFCNT_inc_void((SV*)mg->mg_ptr);
29ecdb6f 1080 assert(mg->mg_flags & MGf_DUP);
7473853a 1081 return (0);
21312124 1082}
1083
1084MGVTBL sharedsv_array_vtbl = {
7473853a 1085 0, /* get */
1086 0, /* set */
1087 sharedsv_array_mg_FETCHSIZE,/* len */
1088 sharedsv_array_mg_CLEAR, /* clear */
1089 sharedsv_array_mg_free, /* free */
1090 sharedsv_array_mg_copy, /* copy */
1091 sharedsv_array_mg_dup, /* dup */
1092#ifdef MGf_LOCAL
1093 0, /* local */
1094#endif
21312124 1095};
1096
68795e93 1097
ba2940ce 1098/* Recursively unlocks a shared sv. */
68795e93 1099
1100void
29ecdb6f 1101Perl_sharedsv_unlock(pTHX_ SV *ssv)
68795e93 1102{
29ecdb6f 1103 user_lock *ul = S_get_userlock(aTHX_ ssv, 0);
1104 assert(ul);
1105 recursive_lock_release(aTHX_ &ul->lock);
68795e93 1106}
1107
68795e93 1108
ba2940ce 1109/* Recursive locks on a sharedsv.
1110 * Locks are dynamically scoped at the level of the first lock.
1111 */
68795e93 1112void
29ecdb6f 1113Perl_sharedsv_lock(pTHX_ SV *ssv)
68795e93 1114{
29ecdb6f 1115 user_lock *ul;
7473853a 1116 if (! ssv)
1117 return;
29ecdb6f 1118 ul = S_get_userlock(aTHX_ ssv, 1);
1119 recursive_lock_acquire(aTHX_ &ul->lock, __FILE__, __LINE__);
68795e93 1120}
1121
7473853a 1122/* Handles calls from lock() builtin via PL_lockhook */
afe38520 1123
21312124 1124void
1125Perl_sharedsv_locksv(pTHX_ SV *sv)
1126{
29ecdb6f 1127 SV *ssv;
afe38520 1128
7473853a 1129 if (SvROK(sv))
1130 sv = SvRV(sv);
29ecdb6f 1131 ssv = Perl_sharedsv_find(aTHX_ sv);
7473853a 1132 if (!ssv)
afe38520 1133 croak("lock can only be used on shared values");
29ecdb6f 1134 Perl_sharedsv_lock(aTHX_ ssv);
b050c948 1135}
1136
b050c948 1137
794f4697 1138/* Can a shared object be destroyed?
1139 * True if not a shared,
1140 * or if detroying last proxy on a shared object
1141 */
1142#ifdef PL_destroyhook
1143bool
1144Perl_shared_object_destroy(pTHX_ SV *sv)
1145{
1146 SV *ssv;
1147
1148 if (SvROK(sv))
1149 sv = SvRV(sv);
1150 ssv = Perl_sharedsv_find(aTHX_ sv);
1151 return (!ssv || (SvREFCNT(ssv) <= 1));
1152}
1153#endif
1154
1155
ba2940ce 1156/* Saves a space for keeping SVs wider than an interpreter. */
21312124 1157
1158void
1159Perl_sharedsv_init(pTHX)
1160{
7473853a 1161 dTHXc;
1162 /* This pair leaves us in shared context ... */
1163 PL_sharedsv_space = perl_alloc();
1164 perl_construct(PL_sharedsv_space);
1165 CALLER_CONTEXT;
1166 recursive_lock_init(aTHX_ &PL_sharedsv_lock);
1167 PL_lockhook = &Perl_sharedsv_locksv;
1168 PL_sharehook = &Perl_sharedsv_share;
794f4697 1169#ifdef PL_destroyhook
1170 PL_destroyhook = &Perl_shared_object_destroy;
1171#endif
b050c948 1172}
1173
73e09c8f 1174#endif /* USE_ITHREADS */
1175
7473853a 1176MODULE = threads::shared PACKAGE = threads::shared::tie
b050c948 1177
21312124 1178PROTOTYPES: DISABLE
b050c948 1179
73e09c8f 1180#ifdef USE_ITHREADS
6b85e4fe 1181
21312124 1182void
29ecdb6f 1183PUSH(SV *obj, ...)
7473853a 1184 CODE:
1185 dTHXc;
1186 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1187 int i;
1188 for (i = 1; i < items; i++) {
1189 SV* tmp = newSVsv(ST(i));
1190 SV *stmp;
1191 ENTER_LOCK;
1192 stmp = S_sharedsv_new_shared(aTHX_ tmp);
1193 sharedsv_scalar_store(aTHX_ tmp, stmp);
1194 SHARED_CONTEXT;
1195 av_push((AV*) sobj, stmp);
1196 SvREFCNT_inc_void(stmp);
1197 SHARED_RELEASE;
1198 SvREFCNT_dec(tmp);
1199 }
1200
b050c948 1201
21312124 1202void
29ecdb6f 1203UNSHIFT(SV *obj, ...)
7473853a 1204 CODE:
1205 dTHXc;
1206 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1207 int i;
1208 ENTER_LOCK;
1209 SHARED_CONTEXT;
1210 av_unshift((AV*)sobj, items - 1);
1211 CALLER_CONTEXT;
1212 for (i = 1; i < items; i++) {
1213 SV *tmp = newSVsv(ST(i));
1214 SV *stmp = S_sharedsv_new_shared(aTHX_ tmp);
1215 sharedsv_scalar_store(aTHX_ tmp, stmp);
1216 SHARED_CONTEXT;
1217 av_store((AV*) sobj, i - 1, stmp);
1218 SvREFCNT_inc_void(stmp);
1219 CALLER_CONTEXT;
1220 SvREFCNT_dec(tmp);
1221 }
1222 LEAVE_LOCK;
1223
b050c948 1224
21312124 1225void
29ecdb6f 1226POP(SV *obj)
7473853a 1227 CODE:
1228 dTHXc;
1229 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1230 SV* ssv;
1231 ENTER_LOCK;
1232 SHARED_CONTEXT;
1233 ssv = av_pop((AV*)sobj);
1234 CALLER_CONTEXT;
1235 ST(0) = sv_newmortal();
1236 Perl_sharedsv_associate(aTHX_ ST(0), ssv);
1237 SvREFCNT_dec(ssv);
1238 LEAVE_LOCK;
1239 /* XSRETURN(1); - implied */
1240
b050c948 1241
21312124 1242void
29ecdb6f 1243SHIFT(SV *obj)
7473853a 1244 CODE:
1245 dTHXc;
1246 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1247 SV* ssv;
1248 ENTER_LOCK;
1249 SHARED_CONTEXT;
1250 ssv = av_shift((AV*)sobj);
1251 CALLER_CONTEXT;
1252 ST(0) = sv_newmortal();
1253 Perl_sharedsv_associate(aTHX_ ST(0), ssv);
1254 SvREFCNT_dec(ssv);
1255 LEAVE_LOCK;
1256 /* XSRETURN(1); - implied */
1257
b050c948 1258
21312124 1259void
29ecdb6f 1260EXTEND(SV *obj, IV count)
7473853a 1261 CODE:
1262 dTHXc;
1263 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1264 SHARED_EDIT;
1265 av_extend((AV*)sobj, count);
1266 SHARED_RELEASE;
1267
b050c948 1268
21312124 1269void
29ecdb6f 1270STORESIZE(SV *obj,IV count)
7473853a 1271 CODE:
1272 dTHXc;
1273 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1274 SHARED_EDIT;
1275 av_fill((AV*) sobj, count);
1276 SHARED_RELEASE;
6b85e4fe 1277
1278
1279void
29ecdb6f 1280EXISTS(SV *obj, SV *index)
7473853a 1281 CODE:
1282 dTHXc;
1283 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1284 bool exists;
1285 if (SvTYPE(sobj) == SVt_PVAV) {
1286 SHARED_EDIT;
1287 exists = av_exists((AV*) sobj, SvIV(index));
1288 } else {
1289 STRLEN len;
c4393b60 1290 char *key = SvPVutf8(index, len);
a1335164 1291 if (SvUTF8(index)) {
1292 len = -len;
1293 }
7473853a 1294 SHARED_EDIT;
1295 exists = hv_exists((HV*) sobj, key, len);
1296 }
1297 SHARED_RELEASE;
1298 ST(0) = (exists) ? &PL_sv_yes : &PL_sv_no;
1299 /* XSRETURN(1); - implied */
b050c948 1300
1301
1302void
29ecdb6f 1303FIRSTKEY(SV *obj)
7473853a 1304 CODE:
1305 dTHXc;
1306 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1307 char* key = NULL;
1308 I32 len = 0;
1309 HE* entry;
1310 ENTER_LOCK;
1311 SHARED_CONTEXT;
1312 hv_iterinit((HV*) sobj);
1313 entry = hv_iternext((HV*) sobj);
1314 if (entry) {
a1335164 1315 I32 utf8 = HeKUTF8(entry);
7473853a 1316 key = hv_iterkey(entry,&len);
1317 CALLER_CONTEXT;
a1335164 1318 ST(0) = sv_2mortal(newSVpvn_utf8(key, len, utf8));
7473853a 1319 } else {
1320 CALLER_CONTEXT;
1321 ST(0) = &PL_sv_undef;
1322 }
1323 LEAVE_LOCK;
1324 /* XSRETURN(1); - implied */
1325
b050c948 1326
866fba46 1327void
29ecdb6f 1328NEXTKEY(SV *obj, SV *oldkey)
7473853a 1329 CODE:
1330 dTHXc;
1331 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1332 char* key = NULL;
1333 I32 len = 0;
1334 HE* entry;
2a6601ce 1335
1336 PERL_UNUSED_VAR(oldkey);
1337
7473853a 1338 ENTER_LOCK;
1339 SHARED_CONTEXT;
1340 entry = hv_iternext((HV*) sobj);
1341 if (entry) {
a1335164 1342 I32 utf8 = HeKUTF8(entry);
7473853a 1343 key = hv_iterkey(entry,&len);
1344 CALLER_CONTEXT;
a1335164 1345 ST(0) = sv_2mortal(newSVpvn_utf8(key, len, utf8));
7473853a 1346 } else {
1347 CALLER_CONTEXT;
1348 ST(0) = &PL_sv_undef;
1349 }
1350 LEAVE_LOCK;
1351 /* XSRETURN(1); - implied */
1352
1353
1354MODULE = threads::shared PACKAGE = threads::shared
21312124 1355
1356PROTOTYPES: ENABLE
866fba46 1357
68795e93 1358void
39ec4146 1359_id(SV *myref)
7473853a 1360 PROTOTYPE: \[$@%]
1361 PREINIT:
1362 SV *ssv;
1363 CODE:
39ec4146 1364 myref = SvRV(myref);
373098c0 1365 if (SvMAGICAL(myref))
1366 mg_get(myref);
39ec4146 1367 if (SvROK(myref))
1368 myref = SvRV(myref);
1369 ssv = Perl_sharedsv_find(aTHX_ myref);
7473853a 1370 if (! ssv)
1371 XSRETURN_UNDEF;
1372 ST(0) = sv_2mortal(newSVuv(PTR2UV(ssv)));
1373 /* XSRETURN(1); - implied */
9c4972d9 1374
1375
1376void
39ec4146 1377_refcnt(SV *myref)
7473853a 1378 PROTOTYPE: \[$@%]
1379 PREINIT:
1380 SV *ssv;
1381 CODE:
39ec4146 1382 myref = SvRV(myref);
1383 if (SvROK(myref))
1384 myref = SvRV(myref);
1385 ssv = Perl_sharedsv_find(aTHX_ myref);
7473853a 1386 if (! ssv) {
7c8caac0 1387 if (ckWARN(WARN_THREADS)) {
1388 Perl_warner(aTHX_ packWARN(WARN_THREADS),
1389 "%" SVf " is not shared", ST(0));
1390 }
7473853a 1391 XSRETURN_UNDEF;
1392 }
1393 ST(0) = sv_2mortal(newSViv(SvREFCNT(ssv)));
1394 /* XSRETURN(1); - implied */
1395
1396
1397void
39ec4146 1398share(SV *myref)
7473853a 1399 PROTOTYPE: \[$@%]
1400 CODE:
39ec4146 1401 if (! SvROK(myref))
56fcff86 1402 Perl_croak(aTHX_ "Argument to share needs to be passed as ref");
39ec4146 1403 myref = SvRV(myref);
1404 if (SvROK(myref))
1405 myref = SvRV(myref);
1406 Perl_sharedsv_share(aTHX_ myref);
1407 ST(0) = sv_2mortal(newRV_inc(myref));
7473853a 1408 /* XSRETURN(1); - implied */
a446a88f 1409
6f942b98 1410
1411void
7473853a 1412cond_wait(SV *ref_cond, SV *ref_lock = 0)
1413 PROTOTYPE: \[$@%];\[$@%]
1414 PREINIT:
1415 SV *ssv;
1416 perl_cond* user_condition;
1417 int locks;
1418 user_lock *ul;
1419 CODE:
1420 if (!SvROK(ref_cond))
56fcff86 1421 Perl_croak(aTHX_ "Argument to cond_wait needs to be passed as ref");
7473853a 1422 ref_cond = SvRV(ref_cond);
1423 if (SvROK(ref_cond))
1424 ref_cond = SvRV(ref_cond);
1425 ssv = Perl_sharedsv_find(aTHX_ ref_cond);
1426 if (! ssv)
1427 Perl_croak(aTHX_ "cond_wait can only be used on shared values");
1428 ul = S_get_userlock(aTHX_ ssv, 1);
1429
1430 user_condition = &ul->user_cond;
1431 if (ref_lock && (ref_cond != ref_lock)) {
1432 if (!SvROK(ref_lock))
1433 Perl_croak(aTHX_ "cond_wait lock needs to be passed as ref");
1434 ref_lock = SvRV(ref_lock);
1435 if (SvROK(ref_lock)) ref_lock = SvRV(ref_lock);
1436 ssv = Perl_sharedsv_find(aTHX_ ref_lock);
1437 if (! ssv)
1438 Perl_croak(aTHX_ "cond_wait lock must be a shared value");
1439 ul = S_get_userlock(aTHX_ ssv, 1);
1440 }
1441 if (ul->lock.owner != aTHX)
1442 croak("You need a lock before you can cond_wait");
ba2940ce 1443
7473853a 1444 /* Stealing the members of the lock object worries me - NI-S */
1445 MUTEX_LOCK(&ul->lock.mutex);
1446 ul->lock.owner = NULL;
1447 locks = ul->lock.locks;
1448 ul->lock.locks = 0;
1449
ba2940ce 1450 /* Since we are releasing the lock here, we need to tell other
1451 * people that it is ok to go ahead and use it */
7473853a 1452 COND_SIGNAL(&ul->lock.cond);
1453 COND_WAIT(user_condition, &ul->lock.mutex);
ba2940ce 1454 while (ul->lock.owner != NULL) {
7473853a 1455 /* OK -- must reacquire the lock */
1456 COND_WAIT(&ul->lock.cond, &ul->lock.mutex);
1457 }
1458 ul->lock.owner = aTHX;
1459 ul->lock.locks = locks;
1460 MUTEX_UNLOCK(&ul->lock.mutex);
1461
a0e036c1 1462
1463int
7473853a 1464cond_timedwait(SV *ref_cond, double abs, SV *ref_lock = 0)
1465 PROTOTYPE: \[$@%]$;\[$@%]
1466 PREINIT:
1467 SV *ssv;
1468 perl_cond* user_condition;
1469 int locks;
1470 user_lock *ul;
1471 CODE:
1472 if (! SvROK(ref_cond))
1473 Perl_croak(aTHX_ "Argument to cond_timedwait needs to be passed as ref");
1474 ref_cond = SvRV(ref_cond);
1475 if (SvROK(ref_cond))
1476 ref_cond = SvRV(ref_cond);
1477 ssv = Perl_sharedsv_find(aTHX_ ref_cond);
1478 if (! ssv)
1479 Perl_croak(aTHX_ "cond_timedwait can only be used on shared values");
1480 ul = S_get_userlock(aTHX_ ssv, 1);
1481
1482 user_condition = &ul->user_cond;
1483 if (ref_lock && (ref_cond != ref_lock)) {
1484 if (! SvROK(ref_lock))
1485 Perl_croak(aTHX_ "cond_timedwait lock needs to be passed as ref");
1486 ref_lock = SvRV(ref_lock);
1487 if (SvROK(ref_lock)) ref_lock = SvRV(ref_lock);
1488 ssv = Perl_sharedsv_find(aTHX_ ref_lock);
1489 if (! ssv)
1490 Perl_croak(aTHX_ "cond_timedwait lock must be a shared value");
1491 ul = S_get_userlock(aTHX_ ssv, 1);
1492 }
1493 if (ul->lock.owner != aTHX)
1494 Perl_croak(aTHX_ "You need a lock before you can cond_wait");
1495
1496 MUTEX_LOCK(&ul->lock.mutex);
1497 ul->lock.owner = NULL;
1498 locks = ul->lock.locks;
1499 ul->lock.locks = 0;
ba2940ce 1500 /* Since we are releasing the lock here, we need to tell other
1501 * people that it is ok to go ahead and use it */
7473853a 1502 COND_SIGNAL(&ul->lock.cond);
1503 RETVAL = Perl_sharedsv_cond_timedwait(user_condition, &ul->lock.mutex, abs);
1504 while (ul->lock.owner != NULL) {
1505 /* OK -- must reacquire the lock... */
1506 COND_WAIT(&ul->lock.cond, &ul->lock.mutex);
1507 }
1508 ul->lock.owner = aTHX;
1509 ul->lock.locks = locks;
1510 MUTEX_UNLOCK(&ul->lock.mutex);
1511
1512 if (RETVAL == 0)
a0e036c1 1513 XSRETURN_UNDEF;
7473853a 1514 OUTPUT:
1515 RETVAL
a0e036c1 1516
29ecdb6f 1517
7473853a 1518void
39ec4146 1519cond_signal(SV *myref)
7473853a 1520 PROTOTYPE: \[$@%]
1521 PREINIT:
1522 SV *ssv;
1523 user_lock *ul;
1524 CODE:
39ec4146 1525 if (! SvROK(myref))
56fcff86 1526 Perl_croak(aTHX_ "Argument to cond_signal needs to be passed as ref");
39ec4146 1527 myref = SvRV(myref);
1528 if (SvROK(myref))
1529 myref = SvRV(myref);
1530 ssv = Perl_sharedsv_find(aTHX_ myref);
7473853a 1531 if (! ssv)
1532 Perl_croak(aTHX_ "cond_signal can only be used on shared values");
1533 ul = S_get_userlock(aTHX_ ssv, 1);
1534 if (ckWARN(WARN_THREADS) && ul->lock.owner != aTHX) {
1535 Perl_warner(aTHX_ packWARN(WARN_THREADS),
1536 "cond_signal() called on unlocked variable");
1537 }
1538 COND_SIGNAL(&ul->user_cond);
6f942b98 1539
29ecdb6f 1540
7473853a 1541void
39ec4146 1542cond_broadcast(SV *myref)
7473853a 1543 PROTOTYPE: \[$@%]
1544 PREINIT:
1545 SV *ssv;
1546 user_lock *ul;
1547 CODE:
39ec4146 1548 if (! SvROK(myref))
56fcff86 1549 Perl_croak(aTHX_ "Argument to cond_broadcast needs to be passed as ref");
39ec4146 1550 myref = SvRV(myref);
1551 if (SvROK(myref))
1552 myref = SvRV(myref);
1553 ssv = Perl_sharedsv_find(aTHX_ myref);
7473853a 1554 if (! ssv)
1555 Perl_croak(aTHX_ "cond_broadcast can only be used on shared values");
1556 ul = S_get_userlock(aTHX_ ssv, 1);
1557 if (ckWARN(WARN_THREADS) && ul->lock.owner != aTHX) {
1558 Perl_warner(aTHX_ packWARN(WARN_THREADS),
1559 "cond_broadcast() called on unlocked variable");
1560 }
1561 COND_BROADCAST(&ul->user_cond);
1562
1563
1564void
39ec4146 1565bless(SV* myref, ...);
7473853a 1566 PROTOTYPE: $;$
1567 PREINIT:
1568 HV* stash;
1569 SV *ssv;
1570 CODE:
1571 if (items == 1) {
1572 stash = CopSTASH(PL_curcop);
1573 } else {
1574 SV* classname = ST(1);
1575 STRLEN len;
1576 char *ptr;
1577
1578 if (classname &&
1579 ! SvGMAGICAL(classname) &&
1580 ! SvAMAGIC(classname) &&
1581 SvROK(classname))
1582 {
1583 Perl_croak(aTHX_ "Attempt to bless into a reference");
1584 }
1585 ptr = SvPV(classname, len);
1586 if (ckWARN(WARN_MISC) && len == 0) {
1587 Perl_warner(aTHX_ packWARN(WARN_MISC),
1588 "Explicit blessing to '' (assuming package main)");
1589 }
1590 stash = gv_stashpvn(ptr, len, TRUE);
1591 }
39ec4146 1592 SvREFCNT_inc_void(myref);
1593 (void)sv_bless(myref, stash);
1594 ST(0) = sv_2mortal(myref);
1595 ssv = Perl_sharedsv_find(aTHX_ myref);
7473853a 1596 if (ssv) {
1597 dTHXc;
1598 ENTER_LOCK;
1599 SHARED_CONTEXT;
1600 {
1601 SV* fake_stash = newSVpv(HvNAME_get(stash), 0);
1602 (void)sv_bless(ssv, (HV*)fake_stash);
1603 }
1604 CALLER_CONTEXT;
1605 LEAVE_LOCK;
1606 }
1607 /* XSRETURN(1); - implied */
5c360ac5 1608
73e09c8f 1609#endif /* USE_ITHREADS */
1610
68795e93 1611BOOT:
1612{
73e09c8f 1613#ifdef USE_ITHREADS
68795e93 1614 Perl_sharedsv_init(aTHX);
73e09c8f 1615#endif /* USE_ITHREADS */
68795e93 1616}