3 * Copyright (c) 2001-2002, 2006 Larry Wall
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.
8 * "Hand any two wizards a piece of rope and they would instinctively pull in
9 * opposite directions."
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>
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".
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.
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.
30 * This means that where a tie function like FETCH is normally invoked by
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
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
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
39 * Access to aggregate elements is done the usual tied way by returning a
40 * proxy PVLV element with attached element magic.
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
48 * The three basic shared types look like the following:
52 * Shared scalar (my $s : shared):
54 * SV = PVMG(0x7ba238) at 0x7387a8
55 * FLAGS = (PADMY,GMG,SMG)
57 * MG_TYPE = PERL_MAGIC_shared_scalar(n)
58 * MG_PTR = 0x810358 <<<< pointer to the shared SV
62 * Shared aggregate (my @a : shared; my %h : shared):
64 * SV = PVAV(0x7175d0) at 0x738708
67 * MG_TYPE = PERL_MAGIC_tied(P)
68 * MG_OBJ = 0x7136e0 <<<< ref to the tied object
69 * SV = RV(0x7136f0) at 0x7136e0
71 * SV = PVMG(0x7ba238) at 0x738640 <<<< the tied object
72 * FLAGS = (OBJECT,IOK,pIOK)
73 * IV = 8455000 <<<< pointer to the shared AV
74 * STASH = 0x80abf0 "threads::shared::tie"
75 * MG_PTR = 0x810358 "" <<<< another pointer to the shared AV
80 * Aggregate element (my @a : shared; $a[0])
82 * SV = PVLV(0x77f628) at 0x713550
83 * FLAGS = (GMG,SMG,RMG,pIOK)
85 * MG_TYPE = PERL_MAGIC_shared_scalar(n)
86 * MG_PTR = 0x8103c0 "" <<<< pointer to the shared element
88 * MG_TYPE = PERL_MAGIC_tiedelem(p)
89 * MG_OBJ = 0x7136e0 <<<< ref to the tied object
90 * SV = RV(0x7136f0) at 0x7136e0
92 * SV = PVMG(0x7ba278) at 0x738660 <<<< the tied object
93 * FLAGS = (OBJECT,IOK,pIOK)
94 * IV = 8455064 <<<< pointer to the shared AV
95 * STASH = 0x80ac30 "threads::shared::tie"
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
101 * pointers to both the shared aggregate and the shared element.
106 * If a shared variable is used as a perl-level lock or condition
107 * variable, then PERL_MAGIC_ext magic is attached to the associated
108 * *shared* SV, whose mg_ptr field points to a malloc'ed structure
109 * containing the necessary mutexes and condition variables.
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).
120 * Perl 5.8.8 contains threads::shared patches up to 26626 (equivalent to
121 * blead patches 26350+26351).
123 * The CPAN version of threads::shared contains the following blead patches:
124 * 26569 (applicable to 5.9.3 only)
130 #define PERL_NO_GET_CONTEXT
135 #define NEED_vnewSVpvf
144 * The shared things need an intepreter to live in ...
146 PerlInterpreter *PL_sharedsv_space; /* The shared sv space */
147 /* To access shared space we fake aTHX in this scope and thread's context */
149 /* Bug #24255: We include ENTER+SAVETMPS/FREETMPS+LEAVE with
150 * SHARED_CONTEXT/CALLER_CONTEXT macros, so that any mortals, etc. created
151 * while in the shared interpreter context don't languish */
153 #define SHARED_CONTEXT \
155 PERL_SET_CONTEXT((aTHX = PL_sharedsv_space)); \
160 /* So we need a way to switch back to the caller's context... */
161 /* So we declare _another_ copy of the aTHX variable ... */
162 #define dTHXc PerlInterpreter *caller_perl = aTHX
164 /* ... and use it to switch back */
165 #define CALLER_CONTEXT \
169 PERL_SET_CONTEXT((aTHX = caller_perl)); \
173 * Only one thread at a time is allowed to mess with shared space.
178 PerlInterpreter *owner;
187 recursive_lock_t PL_sharedsv_lock; /* Mutex protecting the shared sv space */
190 recursive_lock_init(pTHX_ recursive_lock_t *lock)
192 Zero(lock,1,recursive_lock_t);
193 MUTEX_INIT(&lock->mutex);
194 COND_INIT(&lock->cond);
198 recursive_lock_destroy(pTHX_ recursive_lock_t *lock)
200 MUTEX_DESTROY(&lock->mutex);
201 COND_DESTROY(&lock->cond);
205 recursive_lock_release(pTHX_ recursive_lock_t *lock)
207 MUTEX_LOCK(&lock->mutex);
208 if (lock->owner != aTHX) {
209 MUTEX_UNLOCK(&lock->mutex);
210 } else if (--lock->locks == 0) {
212 COND_SIGNAL(&lock->cond);
214 MUTEX_UNLOCK(&lock->mutex);
218 recursive_lock_acquire(pTHX_ recursive_lock_t *lock, char *file, int line)
221 MUTEX_LOCK(&lock->mutex);
222 if (lock->owner == aTHX) {
225 while (lock->owner) {
227 Perl_warn(aTHX_ " %p waiting - owned by %p %s:%d\n",
228 aTHX, lock->owner, lock->file, lock->line);
230 COND_WAIT(&lock->cond,&lock->mutex);
239 MUTEX_UNLOCK(&lock->mutex);
240 SAVEDESTRUCTOR_X(recursive_lock_release,lock);
246 recursive_lock_acquire(aTHX_ &PL_sharedsv_lock, __FILE__, __LINE__);\
249 /* The unlocking is done automatically at scope exit */
250 #define LEAVE_LOCK LEAVE
253 /* A common idiom is to acquire access and switch in ... */
254 #define SHARED_EDIT \
260 /* ... then switch out and release access. */
261 #define SHARED_RELEASE \
269 This structure is attached (using ext magic) to any shared SV that
270 is used by user-level locking or condition code
274 recursive_lock_t lock; /* For user-levl locks */
275 perl_cond user_cond; /* For user-level conditions */
278 /* Magic used for attaching user_lock structs to shared SVs
280 The vtable used has just one entry - when the SV goes away
281 we free the memory for the above.
285 sharedsv_userlock_free(pTHX_ SV *sv, MAGIC *mg)
287 user_lock *ul = (user_lock *) mg->mg_ptr;
288 assert(aTHX == PL_sharedsv_space);
290 recursive_lock_destroy(aTHX_ &ul->lock);
291 COND_DESTROY(&ul->user_cond);
292 PerlMemShared_free(ul);
298 MGVTBL sharedsv_userlock_vtbl = {
303 sharedsv_userlock_free, /* free */
312 * Access to shared things is heavily based on MAGIC
313 * - in mg.h/mg.c/sv.c sense
316 /* In any thread that has access to a shared thing there is a "proxy"
317 for it in its own space which has 'MAGIC' associated which accesses
321 MGVTBL sharedsv_scalar_vtbl; /* Scalars have this vtable */
322 MGVTBL sharedsv_array_vtbl; /* Hashes and arrays have this - like 'tie' */
323 MGVTBL sharedsv_elem_vtbl; /* Elements of hashes and arrays have this
324 _AS WELL AS_ the scalar magic:
325 The sharedsv_elem_vtbl associates the element with the array/hash and
326 the sharedsv_scalar_vtbl associates it with the value
330 /* Get shared aggregate SV pointed to by threads::shared::tie magic object */
333 S_sharedsv_from_obj(pTHX_ SV *sv)
335 return ((SvROK(sv)) ? INT2PTR(SV *, SvIV(SvRV(sv))) : NULL);
339 /* Return the user_lock structure (if any) associated with a shared SV.
340 * If create is true, create one if it doesn't exist
343 S_get_userlock(pTHX_ SV* ssv, bool create)
346 user_lock *ul = NULL;
349 /* XXX Redesign the storage of user locks so we don't need a global
350 * lock to access them ???? DAPM */
352 mg = mg_find(ssv, PERL_MAGIC_ext);
354 ul = (user_lock*)(mg->mg_ptr);
358 ul = (user_lock *) PerlMemShared_malloc(sizeof(user_lock));
359 Zero(ul, 1, user_lock);
360 /* Attach to shared SV using ext magic */
361 sv_magicext(ssv, NULL, PERL_MAGIC_ext, &sharedsv_userlock_vtbl,
363 recursive_lock_init(aTHX_ &ul->lock);
364 COND_INIT(&ul->user_cond);
372 =for apidoc sharedsv_find
374 Given a private side SV tries to find if the SV has a shared backend,
375 by looking for the magic.
380 Perl_sharedsv_find(pTHX_ SV *sv)
383 if (SvTYPE(sv) >= SVt_PVMG) {
387 if ((mg = mg_find(sv, PERL_MAGIC_tied))
388 && mg->mg_virtual == &sharedsv_array_vtbl) {
389 return ((SV *)mg->mg_ptr);
393 /* This should work for elements as well as they
394 * have scalar magic as well as their element magic
396 if ((mg = mg_find(sv, PERL_MAGIC_shared_scalar))
397 && mg->mg_virtual == &sharedsv_scalar_vtbl) {
398 return ((SV *)mg->mg_ptr);
403 /* Just for tidyness of API also handle tie objects */
404 if (SvROK(sv) && sv_derived_from(sv, "threads::shared::tie")) {
405 return (S_sharedsv_from_obj(aTHX_ sv));
411 /* Associate a private SV with a shared SV by pointing the appropriate
413 * Assumes lock is held.
416 Perl_sharedsv_associate(pTHX_ SV *sv, SV *ssv)
421 /* If we are asked for any private ops we need a thread */
422 assert ( aTHX != PL_sharedsv_space );
424 /* To avoid need for recursive locks require caller to hold lock */
425 assert ( PL_sharedsv_lock.owner == aTHX );
430 if (!(mg = mg_find(sv, PERL_MAGIC_tied))
431 || mg->mg_virtual != &sharedsv_array_vtbl
432 || (SV*) mg->mg_ptr != ssv)
435 sv_setref_iv(obj, "threads::shared::tie", PTR2IV(ssv));
437 sv_unmagic(sv, PERL_MAGIC_tied);
439 mg = sv_magicext(sv, obj, PERL_MAGIC_tied, &sharedsv_array_vtbl,
441 mg->mg_flags |= (MGf_COPY|MGf_DUP);
442 SvREFCNT_inc_void(ssv);
448 if ((SvTYPE(sv) < SVt_PVMG)
449 || !(mg = mg_find(sv, PERL_MAGIC_shared_scalar))
450 || mg->mg_virtual != &sharedsv_scalar_vtbl
451 || (SV*) mg->mg_ptr != ssv)
454 sv_unmagic(sv, PERL_MAGIC_shared_scalar);
456 mg = sv_magicext(sv, Nullsv, PERL_MAGIC_shared_scalar,
457 &sharedsv_scalar_vtbl, (char *)ssv, 0);
458 mg->mg_flags |= (MGf_DUP
463 SvREFCNT_inc_void(ssv);
468 assert ( Perl_sharedsv_find(aTHX_ sv) == ssv );
472 /* Given a private SV, create and return an associated shared SV.
473 * Assumes lock is held.
476 S_sharedsv_new_shared(pTHX_ SV *sv)
481 assert(PL_sharedsv_lock.owner == aTHX);
482 assert(aTHX != PL_sharedsv_space);
486 SvREFCNT(ssv) = 0; /* Will be upped to 1 by Perl_sharedsv_associate */
487 sv_upgrade(ssv, SvTYPE(sv));
489 Perl_sharedsv_associate(aTHX_ sv, ssv);
494 /* Given a shared SV, create and return an associated private SV.
495 * Assumes lock is held.
498 S_sharedsv_new_private(pTHX_ SV *ssv)
502 assert(PL_sharedsv_lock.owner == aTHX);
503 assert(aTHX != PL_sharedsv_space);
506 sv_upgrade(sv, SvTYPE(ssv));
507 Perl_sharedsv_associate(aTHX_ sv, ssv);
512 /* A threadsafe version of SvREFCNT_dec(ssv) */
515 S_sharedsv_dec(pTHX_ SV* ssv)
520 if (SvREFCNT(ssv) > 1) {
521 /* No side effects, so can do it lightweight */
533 /* Implements Perl-level share() and :shared */
536 Perl_sharedsv_share(pTHX_ SV *sv)
540 Perl_croak(aTHX_ "Cannot share globs yet");
544 Perl_croak(aTHX_ "Cannot share subs yet");
549 (void) S_sharedsv_new_shared(aTHX_ sv);
557 #if defined(WIN32) || defined(OS2)
558 # define ABS2RELMILLI(abs) \
560 abs -= (double)time(NULL); \
561 if (abs > 0) { abs *= 1000; } \
564 #endif /* WIN32 || OS2 */
566 /* Do OS-specific condition timed wait */
569 Perl_sharedsv_cond_timedwait(perl_cond *cond, perl_mutex *mut, double abs)
571 #if defined(NETWARE) || defined(FAKE_THREADS) || defined(I_MACH_CTHREADS)
572 Perl_croak_nocontext("cond_timedwait not supported on this platform");
581 /* See comments in win32/win32thread.h COND_WAIT vis-a-vis race */
582 switch (WaitForSingleObject(cond->sem, (DWORD)abs)) {
583 case WAIT_OBJECT_0: got_it = 1; break;
584 case WAIT_TIMEOUT: break;
586 /* WAIT_FAILED? WAIT_ABANDONED? others? */
587 Perl_croak_nocontext("panic: cond_timedwait (%ld)",GetLastError());
600 if ((rc = DosResetEventSem(*cond,&n_a)) && (rc != ERROR_ALREADY_RESET))
601 Perl_rc = rc, croak_with_os2error("panic: cond_timedwait-reset");
603 if (CheckOSError(DosWaitEventSem(*cond,abs))
604 && (rc != ERROR_INTERRUPT))
605 croak_with_os2error("panic: cond_timedwait");
606 if (rc == ERROR_INTERRUPT) errno = EINTR;
609 # else /* Hope you're I_PTHREAD! */
613 ts.tv_sec = (long)abs;
614 abs -= (NV)ts.tv_sec;
615 ts.tv_nsec = (long)(abs * 1000000000.0);
617 switch (pthread_cond_timedwait(cond, mut, &ts)) {
618 case 0: got_it = 1; break;
619 case ETIMEDOUT: break;
622 if (errno == ETIMEDOUT || errno == EAGAIN)
626 Perl_croak_nocontext("panic: cond_timedwait");
632 #endif /* NETWARE || FAKE_THREADS || I_MACH_CTHREADS */
636 /* Given a shared RV, copy it's value to a private RV, also copying the
637 * object status of the referent.
638 * If the private side is already an appropriate RV->SV combination, keep
642 S_get_RV(pTHX_ SV *sv, SV *ssv) {
643 SV *sobj = SvRV(ssv);
646 ((obj = SvRV(sv))) &&
647 (Perl_sharedsv_find(aTHX_ obj) == sobj) &&
648 (SvTYPE(obj) == SvTYPE(sobj))))
650 /* Can't reuse obj */
652 SvREFCNT_dec(SvRV(sv));
654 assert(SvTYPE(sv) >= SVt_RV);
655 sv_setsv_nomg(sv, &PL_sv_undef);
658 obj = S_sharedsv_new_private(aTHX_ SvRV(ssv));
663 /* Remove any old blessing */
664 SvREFCNT_dec(SvSTASH(obj));
667 if (SvOBJECT(sobj)) {
668 /* Add any new old blessing */
670 char* stash_ptr = SvPV((SV*) SvSTASH(sobj), len);
671 HV* stash = gv_stashpvn(stash_ptr, len, TRUE);
673 SvSTASH_set(obj, (HV*)SvREFCNT_inc(stash));
678 /* ------------ PERL_MAGIC_shared_scalar(n) functions -------------- */
680 /* Get magic for PERL_MAGIC_shared_scalar(n) */
683 sharedsv_scalar_mg_get(pTHX_ SV *sv, MAGIC *mg)
685 SV *ssv = (SV *) mg->mg_ptr;
690 S_get_RV(aTHX_ sv, ssv);
692 sv_setsv_nomg(sv, ssv);
698 /* Copy the contents of a private SV to a shared SV.
699 * Used by various mg_set()-type functions.
700 * Assumes lock is held.
703 sharedsv_scalar_store(pTHX_ SV *sv, SV *ssv)
708 assert(PL_sharedsv_lock.owner == aTHX);
711 SV *sobj = Perl_sharedsv_find(aTHX_ obj);
714 SvUPGRADE(ssv, SVt_RV);
715 sv_setsv_nomg(ssv, &PL_sv_undef);
717 SvRV_set(ssv, SvREFCNT_inc(sobj));
719 if (SvOBJECT(sobj)) {
720 /* Remove any old blessing */
721 SvREFCNT_dec(SvSTASH(sobj));
725 SV* fake_stash = newSVpv(HvNAME_get(SvSTASH(obj)),0);
727 SvSTASH_set(sobj, (HV*)fake_stash);
736 sv_setsv_nomg(ssv, sv);
738 /* Remove any old blessing */
739 SvREFCNT_dec(SvSTASH(ssv));
743 SV* fake_stash = newSVpv(HvNAME_get(SvSTASH(sv)),0);
745 SvSTASH_set(ssv, (HV*)fake_stash);
750 Perl_croak(aTHX_ "Invalid value for shared scalar");
754 /* Set magic for PERL_MAGIC_shared_scalar(n) */
757 sharedsv_scalar_mg_set(pTHX_ SV *sv, MAGIC *mg)
759 SV *ssv = (SV*)(mg->mg_ptr);
762 if (SvTYPE(ssv) < SvTYPE(sv)) {
765 sv_upgrade(ssv, SvTYPE(sv));
768 sharedsv_scalar_store(aTHX_ sv, ssv);
773 /* Free magic for PERL_MAGIC_shared_scalar(n) */
776 sharedsv_scalar_mg_free(pTHX_ SV *sv, MAGIC *mg)
778 S_sharedsv_dec(aTHX_ (SV*)mg->mg_ptr);
783 * Called during cloning of PERL_MAGIC_shared_scalar(n) magic in new thread
786 sharedsv_scalar_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
788 SvREFCNT_inc_void(mg->mg_ptr);
794 * Called during local $shared
797 sharedsv_scalar_mg_local(pTHX_ SV* nsv, MAGIC *mg)
800 SV *ssv = (SV *) mg->mg_ptr;
803 SvREFCNT_inc_void(ssv);
806 nmg = sv_magicext(nsv, mg->mg_obj, mg->mg_type, mg->mg_virtual,
807 mg->mg_ptr, mg->mg_len);
808 nmg->mg_flags = mg->mg_flags;
809 nmg->mg_private = mg->mg_private;
815 MGVTBL sharedsv_scalar_vtbl = {
816 sharedsv_scalar_mg_get, /* get */
817 sharedsv_scalar_mg_set, /* set */
820 sharedsv_scalar_mg_free, /* free */
822 sharedsv_scalar_mg_dup, /* dup */
824 sharedsv_scalar_mg_local, /* local */
828 /* ------------ PERL_MAGIC_tiedelem(p) functions -------------- */
830 /* Get magic for PERL_MAGIC_tiedelem(p) */
833 sharedsv_elem_mg_FETCH(pTHX_ SV *sv, MAGIC *mg)
836 SV *saggregate = S_sharedsv_from_obj(aTHX_ mg->mg_obj);
840 if (SvTYPE(saggregate) == SVt_PVAV) {
841 assert ( mg->mg_ptr == 0 );
843 svp = av_fetch((AV*) saggregate, mg->mg_len, 0);
845 char *key = mg->mg_ptr;
846 STRLEN len = mg->mg_len;
847 assert ( mg->mg_ptr != 0 );
848 if (mg->mg_len == HEf_SVKEY) {
849 key = SvPV((SV *) mg->mg_ptr, len);
852 svp = hv_fetch((HV*) saggregate, key, len, 0);
856 /* Exists in the array */
858 S_get_RV(aTHX_ sv, *svp);
860 /* XXX Can this branch ever happen? DAPM */
861 /* XXX assert("no such branch"); */
862 Perl_sharedsv_associate(aTHX_ sv, *svp);
866 /* Not in the array */
867 sv_setsv(sv, &PL_sv_undef);
873 /* Set magic for PERL_MAGIC_tiedelem(p) */
876 sharedsv_elem_mg_STORE(pTHX_ SV *sv, MAGIC *mg)
879 SV *saggregate = S_sharedsv_from_obj(aTHX_ mg->mg_obj);
881 /* Theory - SV itself is magically shared - and we have ordered the
882 magic such that by the time we get here it has been stored
883 to its shared counterpart
887 if (SvTYPE(saggregate) == SVt_PVAV) {
888 assert ( mg->mg_ptr == 0 );
890 svp = av_fetch((AV*) saggregate, mg->mg_len, 1);
892 char *key = mg->mg_ptr;
893 STRLEN len = mg->mg_len;
894 assert ( mg->mg_ptr != 0 );
895 if (mg->mg_len == HEf_SVKEY)
896 key = SvPV((SV *) mg->mg_ptr, len);
898 svp = hv_fetch((HV*) saggregate, key, len, 1);
901 Perl_sharedsv_associate(aTHX_ sv, *svp);
902 sharedsv_scalar_store(aTHX_ sv, *svp);
907 /* Clear magic for PERL_MAGIC_tiedelem(p) */
910 sharedsv_elem_mg_DELETE(pTHX_ SV *sv, MAGIC *mg)
914 SV *saggregate = S_sharedsv_from_obj(aTHX_ mg->mg_obj);
916 sharedsv_elem_mg_FETCH(aTHX_ sv, mg);
917 if ((shmg = mg_find(sv, PERL_MAGIC_shared_scalar)))
918 sharedsv_scalar_mg_get(aTHX_ sv, shmg);
919 if (SvTYPE(saggregate) == SVt_PVAV) {
921 av_delete((AV*) saggregate, mg->mg_len, G_DISCARD);
923 char *key = mg->mg_ptr;
924 STRLEN len = mg->mg_len;
925 assert ( mg->mg_ptr != 0 );
926 if (mg->mg_len == HEf_SVKEY)
927 key = SvPV((SV *) mg->mg_ptr, len);
929 hv_delete((HV*) saggregate, key, len, G_DISCARD);
936 /* Called during cloning of PERL_MAGIC_tiedelem(p) magic in new
940 sharedsv_elem_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
942 SvREFCNT_inc_void(S_sharedsv_from_obj(aTHX_ mg->mg_obj));
943 assert(mg->mg_flags & MGf_DUP);
947 MGVTBL sharedsv_elem_vtbl = {
948 sharedsv_elem_mg_FETCH, /* get */
949 sharedsv_elem_mg_STORE, /* set */
951 sharedsv_elem_mg_DELETE, /* clear */
954 sharedsv_elem_mg_dup, /* dup */
960 /* ------------ PERL_MAGIC_tied(P) functions -------------- */
962 /* Len magic for PERL_MAGIC_tied(P) */
965 sharedsv_array_mg_FETCHSIZE(pTHX_ SV *sv, MAGIC *mg)
968 SV *ssv = (SV *) mg->mg_ptr;
971 if (SvTYPE(ssv) == SVt_PVAV) {
972 val = av_len((AV*) ssv);
974 /* Not actually defined by tie API but ... */
975 val = HvKEYS((HV*) ssv);
981 /* Clear magic for PERL_MAGIC_tied(P) */
984 sharedsv_array_mg_CLEAR(pTHX_ SV *sv, MAGIC *mg)
987 SV *ssv = (SV *) mg->mg_ptr;
989 if (SvTYPE(ssv) == SVt_PVAV) {
998 /* Free magic for PERL_MAGIC_tied(P) */
1001 sharedsv_array_mg_free(pTHX_ SV *sv, MAGIC *mg)
1003 S_sharedsv_dec(aTHX_ (SV*)mg->mg_ptr);
1008 * Copy magic for PERL_MAGIC_tied(P)
1009 * This is called when perl is about to access an element of
1013 sharedsv_array_mg_copy(pTHX_ SV *sv, MAGIC* mg,
1014 SV *nsv, const char *name, int namlen)
1016 MAGIC *nmg = sv_magicext(nsv,mg->mg_obj,
1017 toLOWER(mg->mg_type),&sharedsv_elem_vtbl,
1019 nmg->mg_flags |= MGf_DUP;
1023 /* Called during cloning of PERL_MAGIC_tied(P) magic in new thread */
1026 sharedsv_array_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
1028 SvREFCNT_inc_void((SV*)mg->mg_ptr);
1029 assert(mg->mg_flags & MGf_DUP);
1033 MGVTBL sharedsv_array_vtbl = {
1036 sharedsv_array_mg_FETCHSIZE,/* len */
1037 sharedsv_array_mg_CLEAR, /* clear */
1038 sharedsv_array_mg_free, /* free */
1039 sharedsv_array_mg_copy, /* copy */
1040 sharedsv_array_mg_dup, /* dup */
1046 =for apidoc sharedsv_unlock
1048 Recursively unlocks a shared sv.
1053 Perl_sharedsv_unlock(pTHX_ SV *ssv)
1055 user_lock *ul = S_get_userlock(aTHX_ ssv, 0);
1057 recursive_lock_release(aTHX_ &ul->lock);
1060 =for apidoc sharedsv_lock
1062 Recursive locks on a sharedsv.
1063 Locks are dynamically scoped at the level of the first lock.
1068 Perl_sharedsv_lock(pTHX_ SV *ssv)
1073 ul = S_get_userlock(aTHX_ ssv, 1);
1074 recursive_lock_acquire(aTHX_ &ul->lock, __FILE__, __LINE__);
1077 /* Handles calls from lock() builtin via PL_lockhook */
1080 Perl_sharedsv_locksv(pTHX_ SV *sv)
1086 ssv = Perl_sharedsv_find(aTHX_ sv);
1088 croak("lock can only be used on shared values");
1089 Perl_sharedsv_lock(aTHX_ ssv);
1092 =head1 Shared SV Functions
1094 =for apidoc sharedsv_init
1096 Saves a space for keeping SVs wider than an interpreter.
1101 Perl_sharedsv_init(pTHX)
1104 /* This pair leaves us in shared context ... */
1105 PL_sharedsv_space = perl_alloc();
1106 perl_construct(PL_sharedsv_space);
1108 recursive_lock_init(aTHX_ &PL_sharedsv_lock);
1109 PL_lockhook = &Perl_sharedsv_locksv;
1110 PL_sharehook = &Perl_sharedsv_share;
1113 #endif /* USE_ITHREADS */
1115 MODULE = threads::shared PACKAGE = threads::shared::tie
1125 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1127 for (i = 1; i < items; i++) {
1128 SV* tmp = newSVsv(ST(i));
1131 stmp = S_sharedsv_new_shared(aTHX_ tmp);
1132 sharedsv_scalar_store(aTHX_ tmp, stmp);
1134 av_push((AV*) sobj, stmp);
1135 SvREFCNT_inc_void(stmp);
1142 UNSHIFT(SV *obj, ...)
1145 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1149 av_unshift((AV*)sobj, items - 1);
1151 for (i = 1; i < items; i++) {
1152 SV *tmp = newSVsv(ST(i));
1153 SV *stmp = S_sharedsv_new_shared(aTHX_ tmp);
1154 sharedsv_scalar_store(aTHX_ tmp, stmp);
1156 av_store((AV*) sobj, i - 1, stmp);
1157 SvREFCNT_inc_void(stmp);
1168 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1172 ssv = av_pop((AV*)sobj);
1174 ST(0) = sv_newmortal();
1175 Perl_sharedsv_associate(aTHX_ ST(0), ssv);
1178 /* XSRETURN(1); - implied */
1185 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1189 ssv = av_shift((AV*)sobj);
1191 ST(0) = sv_newmortal();
1192 Perl_sharedsv_associate(aTHX_ ST(0), ssv);
1195 /* XSRETURN(1); - implied */
1199 EXTEND(SV *obj, IV count)
1202 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1204 av_extend((AV*)sobj, count);
1209 STORESIZE(SV *obj,IV count)
1212 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1214 av_fill((AV*) sobj, count);
1219 EXISTS(SV *obj, SV *index)
1222 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1224 if (SvTYPE(sobj) == SVt_PVAV) {
1226 exists = av_exists((AV*) sobj, SvIV(index));
1229 char *key = SvPV(index,len);
1231 exists = hv_exists((HV*) sobj, key, len);
1234 ST(0) = (exists) ? &PL_sv_yes : &PL_sv_no;
1235 /* XSRETURN(1); - implied */
1242 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1248 hv_iterinit((HV*) sobj);
1249 entry = hv_iternext((HV*) sobj);
1251 key = hv_iterkey(entry,&len);
1253 ST(0) = sv_2mortal(newSVpv(key, len));
1256 ST(0) = &PL_sv_undef;
1259 /* XSRETURN(1); - implied */
1263 NEXTKEY(SV *obj, SV *oldkey)
1266 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1272 entry = hv_iternext((HV*) sobj);
1274 key = hv_iterkey(entry,&len);
1276 ST(0) = sv_2mortal(newSVpv(key, len));
1279 ST(0) = &PL_sv_undef;
1282 /* XSRETURN(1); - implied */
1285 MODULE = threads::shared PACKAGE = threads::shared
1298 ssv = Perl_sharedsv_find(aTHX_ ref);
1301 ST(0) = sv_2mortal(newSVuv(PTR2UV(ssv)));
1302 /* XSRETURN(1); - implied */
1314 ssv = Perl_sharedsv_find(aTHX_ ref);
1316 Perl_warn(aTHX_ "%" SVf " is not shared", ST(0));
1319 ST(0) = sv_2mortal(newSViv(SvREFCNT(ssv)));
1320 /* XSRETURN(1); - implied */
1328 Perl_croak(aTHX_ "Argument to share needs to be passed as ref");
1332 Perl_sharedsv_share(aTHX_ ref);
1333 ST(0) = sv_2mortal(newRV_inc(ref));
1334 /* XSRETURN(1); - implied */
1338 cond_wait(SV *ref_cond, SV *ref_lock = 0)
1339 PROTOTYPE: \[$@%];\[$@%]
1342 perl_cond* user_condition;
1346 if (!SvROK(ref_cond))
1347 Perl_croak(aTHX_ "Argument to cond_wait needs to be passed as ref");
1348 ref_cond = SvRV(ref_cond);
1349 if (SvROK(ref_cond))
1350 ref_cond = SvRV(ref_cond);
1351 ssv = Perl_sharedsv_find(aTHX_ ref_cond);
1353 Perl_croak(aTHX_ "cond_wait can only be used on shared values");
1354 ul = S_get_userlock(aTHX_ ssv, 1);
1356 user_condition = &ul->user_cond;
1357 if (ref_lock && (ref_cond != ref_lock)) {
1358 if (!SvROK(ref_lock))
1359 Perl_croak(aTHX_ "cond_wait lock needs to be passed as ref");
1360 ref_lock = SvRV(ref_lock);
1361 if (SvROK(ref_lock)) ref_lock = SvRV(ref_lock);
1362 ssv = Perl_sharedsv_find(aTHX_ ref_lock);
1364 Perl_croak(aTHX_ "cond_wait lock must be a shared value");
1365 ul = S_get_userlock(aTHX_ ssv, 1);
1367 if (ul->lock.owner != aTHX)
1368 croak("You need a lock before you can cond_wait");
1369 /* Stealing the members of the lock object worries me - NI-S */
1370 MUTEX_LOCK(&ul->lock.mutex);
1371 ul->lock.owner = NULL;
1372 locks = ul->lock.locks;
1375 /* Since we are releasing the lock here we need to tell other
1376 * people that is ok to go ahead and use it */
1377 COND_SIGNAL(&ul->lock.cond);
1378 COND_WAIT(user_condition, &ul->lock.mutex);
1379 while(ul->lock.owner != NULL) {
1380 /* OK -- must reacquire the lock */
1381 COND_WAIT(&ul->lock.cond, &ul->lock.mutex);
1383 ul->lock.owner = aTHX;
1384 ul->lock.locks = locks;
1385 MUTEX_UNLOCK(&ul->lock.mutex);
1389 cond_timedwait(SV *ref_cond, double abs, SV *ref_lock = 0)
1390 PROTOTYPE: \[$@%]$;\[$@%]
1393 perl_cond* user_condition;
1397 if (! SvROK(ref_cond))
1398 Perl_croak(aTHX_ "Argument to cond_timedwait needs to be passed as ref");
1399 ref_cond = SvRV(ref_cond);
1400 if (SvROK(ref_cond))
1401 ref_cond = SvRV(ref_cond);
1402 ssv = Perl_sharedsv_find(aTHX_ ref_cond);
1404 Perl_croak(aTHX_ "cond_timedwait can only be used on shared values");
1405 ul = S_get_userlock(aTHX_ ssv, 1);
1407 user_condition = &ul->user_cond;
1408 if (ref_lock && (ref_cond != ref_lock)) {
1409 if (! SvROK(ref_lock))
1410 Perl_croak(aTHX_ "cond_timedwait lock needs to be passed as ref");
1411 ref_lock = SvRV(ref_lock);
1412 if (SvROK(ref_lock)) ref_lock = SvRV(ref_lock);
1413 ssv = Perl_sharedsv_find(aTHX_ ref_lock);
1415 Perl_croak(aTHX_ "cond_timedwait lock must be a shared value");
1416 ul = S_get_userlock(aTHX_ ssv, 1);
1418 if (ul->lock.owner != aTHX)
1419 Perl_croak(aTHX_ "You need a lock before you can cond_wait");
1421 MUTEX_LOCK(&ul->lock.mutex);
1422 ul->lock.owner = NULL;
1423 locks = ul->lock.locks;
1425 /* Since we are releasing the lock here we need to tell other
1426 * people that is ok to go ahead and use it */
1427 COND_SIGNAL(&ul->lock.cond);
1428 RETVAL = Perl_sharedsv_cond_timedwait(user_condition, &ul->lock.mutex, abs);
1429 while (ul->lock.owner != NULL) {
1430 /* OK -- must reacquire the lock... */
1431 COND_WAIT(&ul->lock.cond, &ul->lock.mutex);
1433 ul->lock.owner = aTHX;
1434 ul->lock.locks = locks;
1435 MUTEX_UNLOCK(&ul->lock.mutex);
1444 cond_signal(SV *ref)
1451 Perl_croak(aTHX_ "Argument to cond_signal needs to be passed as ref");
1455 ssv = Perl_sharedsv_find(aTHX_ ref);
1457 Perl_croak(aTHX_ "cond_signal can only be used on shared values");
1458 ul = S_get_userlock(aTHX_ ssv, 1);
1459 if (ckWARN(WARN_THREADS) && ul->lock.owner != aTHX) {
1460 Perl_warner(aTHX_ packWARN(WARN_THREADS),
1461 "cond_signal() called on unlocked variable");
1463 COND_SIGNAL(&ul->user_cond);
1467 cond_broadcast(SV *ref)
1474 Perl_croak(aTHX_ "Argument to cond_broadcast needs to be passed as ref");
1478 ssv = Perl_sharedsv_find(aTHX_ ref);
1480 Perl_croak(aTHX_ "cond_broadcast can only be used on shared values");
1481 ul = S_get_userlock(aTHX_ ssv, 1);
1482 if (ckWARN(WARN_THREADS) && ul->lock.owner != aTHX) {
1483 Perl_warner(aTHX_ packWARN(WARN_THREADS),
1484 "cond_broadcast() called on unlocked variable");
1486 COND_BROADCAST(&ul->user_cond);
1490 bless(SV* ref, ...);
1497 stash = CopSTASH(PL_curcop);
1499 SV* classname = ST(1);
1504 ! SvGMAGICAL(classname) &&
1505 ! SvAMAGIC(classname) &&
1508 Perl_croak(aTHX_ "Attempt to bless into a reference");
1510 ptr = SvPV(classname, len);
1511 if (ckWARN(WARN_MISC) && len == 0) {
1512 Perl_warner(aTHX_ packWARN(WARN_MISC),
1513 "Explicit blessing to '' (assuming package main)");
1515 stash = gv_stashpvn(ptr, len, TRUE);
1517 SvREFCNT_inc_void(ref);
1518 (void)sv_bless(ref, stash);
1519 ST(0) = sv_2mortal(ref);
1520 ssv = Perl_sharedsv_find(aTHX_ ref);
1526 SV* fake_stash = newSVpv(HvNAME_get(stash), 0);
1527 (void)sv_bless(ssv, (HV*)fake_stash);
1532 /* XSRETURN(1); - implied */
1534 #endif /* USE_ITHREADS */
1539 Perl_sharedsv_init(aTHX);
1540 #endif /* USE_ITHREADS */