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 Arthur Bergman arthur@contiller.se
13 * pulled in the (an)other direction by Nick Ing-Simmons nick@ing-simmons.net
17 * Shared variables are implemented by a scheme similar to tieing.
18 * Each thread has a proxy SV with attached magic -- "private SVs" --
19 * which all point to a single SV in a separate shared interpreter
20 * (PL_sharedsv_space) -- "shared SVs".
22 * The shared SV holds the variable's true values, and its state is
23 * copied between the shared and private SVs with the usual
24 * mg_get()/mg_set() arrangement.
26 * Aggregates (AVs and HVs) are implemented using tie magic, except that
27 * the vtable used is one defined in this file rather than the standard one.
28 * This means that where a tie function like is FETCH is normally invoked by
29 * the tie magic's mg_get() function, we completely bypass the calling of a
30 * perl-level function, and directly call C-level code to handle it. On
31 * the other hand. calls to functions like PUSH are done directly by code
32 * in av.c etc, which we can't bypass. So the best we can do is to provide
33 * XS versions of these functions. We also have to attach a tie object,
34 * blessed into the class threads::shared::tie, to keep the method-calling
37 * Access to aggregate elements is done the usual tied way by returning a
38 * proxy PVLV element with attached element magic.
40 * Pointers to the shared SV are squirrelled away in the mg->mg_ptr field
41 * of magic (with mg_len == 0), and in the IV2PTR(SvIV(sv)) field of tied
42 * object SVs. These pointers have to be hidden like this because they
43 * cross interpreter boundaries, and we don't want sv_clear() and friends
46 * The three basic shared types look like the following:
50 * Shared scalar (my $s : shared):
52 * SV = PVMG(0x7ba238) at 0x7387a8
53 * FLAGS = (PADMY,GMG,SMG)
55 * MG_TYPE = PERL_MAGIC_shared_scalar(n)
56 * MG_PTR = 0x810358 <<<< pointer to the shared SV
60 * Shared aggregate (my @a : shared; my %h : shared):
62 * SV = PVAV(0x7175d0) at 0x738708
65 * MG_TYPE = PERL_MAGIC_tied(P)
66 * MG_OBJ = 0x7136e0 <<<< ref to the tied object
67 * SV = RV(0x7136f0) at 0x7136e0
69 * SV = PVMG(0x7ba238) at 0x738640 <<<< the tied object
70 * FLAGS = (OBJECT,IOK,pIOK)
71 * IV = 8455000 <<<< pointer to the shared AV
72 * STASH = 0x80abf0 "threads::shared::tie"
73 * MG_PTR = 0x810358 "" <<<< another pointer to the shared AV
78 * Aggregate element (my @a : shared; $a[0])
80 * SV = PVLV(0x77f628) at 0x713550
81 * FLAGS = (GMG,SMG,RMG,pIOK)
83 * MG_TYPE = PERL_MAGIC_shared_scalar(n)
84 * MG_PTR = 0x8103c0 "" <<<< pointer to the shared element
86 * MG_TYPE = PERL_MAGIC_tiedelem(p)
87 * MG_OBJ = 0x7136e0 <<<< ref to the tied object
88 * SV = RV(0x7136f0) at 0x7136e0
90 * SV = PVMG(0x7ba278) at 0x738660 <<<< the tied object
91 * FLAGS = (OBJECT,IOK,pIOK)
92 * IV = 8455064 <<<< pointer to the shared AV
93 * STASH = 0x80ac30 "threads::shared::tie"
96 * Note that PERL_MAGIC_tiedelem(p) magic doesn't have a pointer to a
97 * shared SV in mg_ptr; instead this is used to store the hash key,
98 * if any, like normal tied elements. Note also that element SVs may have
99 * pointers to both the shared aggregate and the shared element
104 * if a shared variable is used as a perl-level lock or condition
105 * variable, then PERL_MAGIC_ext magic is attached to the associated
106 * *shared* SV, whose mg_ptr field points to a malloced structure
107 * containing the necessary mutexes and condition variables.
111 * In this file, any variable name prefixed with 's', eg ssv, stmp or sobj,
112 * usually represents a shared SV which correspondis to a private SV named
113 * without the prefix, eg sv, tmp or obj.
116 #define PERL_NO_GET_CONTEXT
124 * The shared things need an intepreter to live in ...
126 PerlInterpreter *PL_sharedsv_space; /* The shared sv space */
127 /* To access shared space we fake aTHX in this scope and thread's context */
129 /* bug #24255: we include ENTER+SAVETMPS/FREETMPS+LEAVE with
130 * SHARED_CONTEXT/CALLER_CONTEXT macros, so that any mortals etc created
131 * while in the shared interpreter context don't languish */
133 #define SHARED_CONTEXT \
135 PERL_SET_CONTEXT((aTHX = PL_sharedsv_space)); \
140 /* So we need a way to switch back to the caller's context... */
141 /* So we declare _another_ copy of the aTHX variable ... */
142 #define dTHXc PerlInterpreter *caller_perl = aTHX
144 /* and use it to switch back */
145 #define CALLER_CONTEXT \
149 PERL_SET_CONTEXT((aTHX = caller_perl)); \
153 * Only one thread at a time is allowed to mess with shared space.
159 PerlInterpreter *owner;
168 recursive_lock_t PL_sharedsv_lock; /* Mutex protecting the shared sv space */
171 recursive_lock_init(pTHX_ recursive_lock_t *lock)
173 Zero(lock,1,recursive_lock_t);
174 MUTEX_INIT(&lock->mutex);
175 COND_INIT(&lock->cond);
179 recursive_lock_destroy(pTHX_ recursive_lock_t *lock)
181 MUTEX_DESTROY(&lock->mutex);
182 COND_DESTROY(&lock->cond);
186 recursive_lock_release(pTHX_ recursive_lock_t *lock)
188 MUTEX_LOCK(&lock->mutex);
189 if (lock->owner != aTHX) {
190 MUTEX_UNLOCK(&lock->mutex);
193 if (--lock->locks == 0) {
195 COND_SIGNAL(&lock->cond);
198 MUTEX_UNLOCK(&lock->mutex);
202 recursive_lock_acquire(pTHX_ recursive_lock_t *lock,char *file,int line)
205 MUTEX_LOCK(&lock->mutex);
206 if (lock->owner == aTHX) {
210 while (lock->owner) {
212 Perl_warn(aTHX_ " %p waiting - owned by %p %s:%d\n",
213 aTHX, lock->owner, lock->file, lock->line);
215 COND_WAIT(&lock->cond,&lock->mutex);
224 MUTEX_UNLOCK(&lock->mutex);
225 SAVEDESTRUCTOR_X(recursive_lock_release,lock);
228 #define ENTER_LOCK STMT_START { \
230 recursive_lock_acquire(aTHX_ &PL_sharedsv_lock, __FILE__, __LINE__); \
233 /* the unlocking is done automatically at scope exit */
234 #define LEAVE_LOCK LEAVE
237 /* A common idiom is to acquire access and switch in ... */
238 #define SHARED_EDIT STMT_START { \
243 /* then switch out and release access. */
244 #define SHARED_RELEASE STMT_START { \
251 This structure is attached (using ext magic) to any shared SV that
252 is used by user-level locking or condition code
256 recursive_lock_t lock; /* for user-levl locks */
257 perl_cond user_cond; /* For user-level conditions */
260 /* magic used for attaching user_lock structs to shared SVs
262 The vtable used has just one entry - when the SV goes away
263 we free the memory for the above.
267 sharedsv_userlock_free(pTHX_ SV *sv, MAGIC *mg)
269 user_lock *ul = (user_lock *) mg->mg_ptr;
270 assert(aTHX == PL_sharedsv_space);
272 recursive_lock_destroy(aTHX_ &ul->lock);
273 COND_DESTROY(&ul->user_cond);
274 PerlMemShared_free(ul);
280 MGVTBL sharedsv_uesrlock_vtbl = {
285 sharedsv_userlock_free, /* free */
291 /* Access to shared things is heavily based on MAGIC - in mg.h/mg.c/sv.c sense */
293 /* In any thread that has access to a shared thing there is a "proxy"
294 for it in its own space which has 'MAGIC' associated which accesses
298 MGVTBL sharedsv_scalar_vtbl; /* scalars have this vtable */
299 MGVTBL sharedsv_array_vtbl; /* hashes and arrays have this - like 'tie' */
300 MGVTBL sharedsv_elem_vtbl; /* elements of hashes and arrays have this
301 _AS WELL AS_ the scalar magic:
302 The sharedsv_elem_vtbl associates the element with the array/hash and
303 the sharedsv_scalar_vtbl associates it with the value
307 /* get shared aggregate SV pointed to by threads::shared::tie magic object */
310 S_sharedsv_from_obj(pTHX_ SV *sv)
312 return SvROK(sv) ? INT2PTR(SV *, SvIV(SvRV(sv))) : NULL;
316 /* Return the user_lock structure (if any) associated with a shared SV.
317 * If create is true, create one if it doesn't exist */
320 S_get_userlock(pTHX_ SV* ssv, bool create)
323 user_lock *ul = NULL;
326 /* XXX redsign the storage of user locks so we dont need a global
327 * lock to access them ???? DAPM */
329 mg = mg_find(ssv, PERL_MAGIC_ext);
331 ul = (user_lock*)(mg->mg_ptr);
335 ul = (user_lock *) PerlMemShared_malloc(sizeof(user_lock));
336 Zero(ul, 1, user_lock);
337 /* attach to shared SV using ext magic */
338 sv_magicext(ssv, NULL, PERL_MAGIC_ext, &sharedsv_uesrlock_vtbl,
340 recursive_lock_init(aTHX_ &ul->lock);
341 COND_INIT(&ul->user_cond);
349 =for apidoc sharedsv_find
351 Given a private side SV tries to find if the SV has a shared backend,
352 by looking for the magic.
357 Perl_sharedsv_find(pTHX_ SV *sv)
360 if (SvTYPE(sv) >= SVt_PVMG) {
364 if ((mg = mg_find(sv, PERL_MAGIC_tied))
365 && mg->mg_virtual == &sharedsv_array_vtbl) {
366 return (SV *) mg->mg_ptr;
370 /* This should work for elements as well as they
371 * have scalar magic as well as their element magic
373 if ((mg = mg_find(sv, PERL_MAGIC_shared_scalar))
374 && mg->mg_virtual == &sharedsv_scalar_vtbl) {
375 return (SV *) mg->mg_ptr;
380 /* Just for tidyness of API also handle tie objects */
381 if (SvROK(sv) && sv_derived_from(sv, "threads::shared::tie")) {
382 return S_sharedsv_from_obj(aTHX_ sv);
388 /* associate a private SV with a shared SV by pointing the appropriate
389 * magics at it. Assumes lock is held */
392 Perl_sharedsv_associate(pTHX_ SV *sv, SV *ssv)
397 /* If we are asked for any private ops we need a thread */
398 assert ( aTHX != PL_sharedsv_space );
400 /* To avoid need for recursive locks require caller to hold lock */
401 assert ( PL_sharedsv_lock.owner == aTHX );
406 if (!(mg = mg_find(sv, PERL_MAGIC_tied))
407 || mg->mg_virtual != &sharedsv_array_vtbl
408 || (SV*) mg->mg_ptr != ssv)
411 sv_setref_iv(obj, "threads::shared::tie",PTR2IV(ssv));
413 sv_unmagic(sv, PERL_MAGIC_tied);
415 mg = sv_magicext(sv, obj, PERL_MAGIC_tied, &sharedsv_array_vtbl,
417 mg->mg_flags |= (MGf_COPY|MGf_DUP);
424 if ((SvTYPE(sv) < SVt_PVMG)
425 || !(mg = mg_find(sv, PERL_MAGIC_shared_scalar))
426 || mg->mg_virtual != &sharedsv_scalar_vtbl
427 || (SV*) mg->mg_ptr != ssv)
430 sv_unmagic(sv, PERL_MAGIC_shared_scalar);
432 mg = sv_magicext(sv, Nullsv, PERL_MAGIC_shared_scalar,
433 &sharedsv_scalar_vtbl, (char *)ssv, 0);
434 mg->mg_flags |= (MGf_DUP|MGf_LOCAL);
439 assert ( Perl_sharedsv_find(aTHX_ sv) == ssv );
443 /* Given a private SV, create and return an associated shared SV.
444 * Assumes lock is held */
447 S_sharedsv_new_shared(pTHX_ SV *sv)
452 assert(PL_sharedsv_lock.owner == aTHX);
453 assert(aTHX != PL_sharedsv_space);
457 SvREFCNT(ssv) = 0; /* will be upped to 1 by Perl_sharedsv_associate */
458 sv_upgrade(ssv, SvTYPE(sv));
460 Perl_sharedsv_associate(aTHX_ sv, ssv);
465 /* Given a shared SV, create and return an associated private SV.
466 * Assumes lock is held */
469 S_sharedsv_new_private(pTHX_ SV *ssv)
473 assert(PL_sharedsv_lock.owner == aTHX);
474 assert(aTHX != PL_sharedsv_space);
477 sv_upgrade(sv, SvTYPE(ssv));
478 Perl_sharedsv_associate(aTHX_ sv, ssv);
483 /* a threadsafe version of SvREFCNT_dec(ssv) */
486 S_sharedsv_dec(pTHX_ SV* ssv)
491 if (SvREFCNT(ssv) > 1) {
492 /* no side effects, so can do it lightweight */
504 /* implements Perl-level share() and :shared */
507 Perl_sharedsv_share(pTHX_ SV *sv)
511 Perl_croak(aTHX_ "Cannot share globs yet");
515 Perl_croak(aTHX_ "Cannot share subs yet");
520 (void) S_sharedsv_new_shared(aTHX_ sv);
527 #if defined(WIN32) || defined(OS2)
528 # define ABS2RELMILLI(abs) \
530 abs -= (double)time(NULL); \
531 if (abs > 0) { abs *= 1000; } \
534 #endif /* WIN32 || OS2 */
536 /* do OS-specific condition timed wait */
539 Perl_sharedsv_cond_timedwait(perl_cond *cond, perl_mutex *mut, double abs)
541 #if defined(NETWARE) || defined(FAKE_THREADS) || defined(I_MACH_CTHREADS)
542 Perl_croak_nocontext("cond_timedwait not supported on this platform");
551 /* See comments in win32/win32thread.h COND_WAIT vis-a-vis race */
552 switch (WaitForSingleObject(cond->sem, (DWORD)abs)) {
553 case WAIT_OBJECT_0: got_it = 1; break;
554 case WAIT_TIMEOUT: break;
556 /* WAIT_FAILED? WAIT_ABANDONED? others? */
557 Perl_croak_nocontext("panic: cond_timedwait (%ld)",GetLastError());
570 if ((rc = DosResetEventSem(*cond,&n_a)) && (rc != ERROR_ALREADY_RESET))
571 Perl_rc = rc, croak_with_os2error("panic: cond_timedwait-reset");
573 if (CheckOSError(DosWaitEventSem(*cond,abs))
574 && (rc != ERROR_INTERRUPT))
575 croak_with_os2error("panic: cond_timedwait");
576 if (rc == ERROR_INTERRUPT) errno = EINTR;
579 # else /* hope you're I_PTHREAD! */
583 ts.tv_sec = (long)abs;
584 abs -= (NV)ts.tv_sec;
585 ts.tv_nsec = (long)(abs * 1000000000.0);
587 switch (pthread_cond_timedwait(cond, mut, &ts)) {
588 case 0: got_it = 1; break;
589 case ETIMEDOUT: break;
592 if (errno == ETIMEDOUT || errno == EAGAIN)
596 Perl_croak_nocontext("panic: cond_timedwait");
602 #endif /* NETWARE || FAKE_THREADS || I_MACH_CTHREADS */
606 /* given a shared RV, copy it's value to a private RV, also coping the
607 * object status of the referent.
608 * If the private side is already an appropriate RV->SV combination, keep
613 S_get_RV(pTHX_ SV *sv, SV *ssv) {
614 SV *sobj = SvRV(ssv);
617 && ((obj = SvRV(sv)))
618 && (Perl_sharedsv_find(aTHX_ obj) == sobj)
619 && (SvTYPE(obj) == SvTYPE(sobj))
623 /* can't reuse obj */
625 SvREFCNT_dec(SvRV(sv));
628 assert(SvTYPE(sv) >= SVt_RV);
629 sv_setsv_nomg(sv, &PL_sv_undef);
632 obj = S_sharedsv_new_private(aTHX_ SvRV(ssv));
637 /* remove any old blessing */
638 SvREFCNT_dec(SvSTASH(obj));
641 if (SvOBJECT(sobj)) {
642 /* add any new old blessing */
644 char* stash_ptr = SvPV((SV*) SvSTASH(sobj), len);
645 HV* stash = gv_stashpvn(stash_ptr, len, TRUE);
647 SvSTASH_set(obj, (HV*)SvREFCNT_inc(stash));
652 /* ------------ PERL_MAGIC_shared_scalar(n) functions -------------- */
654 /* get magic for PERL_MAGIC_shared_scalar(n) */
657 sharedsv_scalar_mg_get(pTHX_ SV *sv, MAGIC *mg)
659 SV *ssv = (SV *) mg->mg_ptr;
664 S_get_RV(aTHX_ sv, ssv);
667 sv_setsv_nomg(sv, ssv);
673 /* copy the contents of a private SV to a shared SV:
674 * used by various mg_set()-type functions.
675 * Assumes lock is held */
678 sharedsv_scalar_store(pTHX_ SV *sv, SV *ssv)
683 assert(PL_sharedsv_lock.owner == aTHX);
686 SV *sobj = Perl_sharedsv_find(aTHX_ obj);
689 SvUPGRADE(ssv, SVt_RV);
690 sv_setsv_nomg(ssv, &PL_sv_undef);
692 SvRV_set(ssv, SvREFCNT_inc(sobj));
695 SV* fake_stash = newSVpv(HvNAME_get(SvSTASH(obj)),0);
697 SvSTASH_set(sobj, (HV*)fake_stash);
708 sv_setsv_nomg(ssv, sv);
710 SV* fake_stash = newSVpv(HvNAME_get(SvSTASH(sv)),0);
712 SvSTASH_set(ssv, (HV*)fake_stash);
717 Perl_croak(aTHX_ "Invalid value for shared scalar");
721 /* set magic for PERL_MAGIC_shared_scalar(n) */
724 sharedsv_scalar_mg_set(pTHX_ SV *sv, MAGIC *mg)
726 SV *ssv = (SV*)(mg->mg_ptr);
729 if (SvTYPE(ssv) < SvTYPE(sv)) {
732 sv_upgrade(ssv, SvTYPE(sv));
735 sharedsv_scalar_store(aTHX_ sv, ssv);
740 /* free magic for PERL_MAGIC_shared_scalar(n) */
743 sharedsv_scalar_mg_free(pTHX_ SV *sv, MAGIC *mg)
745 S_sharedsv_dec(aTHX_ (SV*)mg->mg_ptr);
750 * Called during cloning of PERL_MAGIC_shared_scalar(n) magic in new thread
753 sharedsv_scalar_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
755 SvREFCNT_inc(mg->mg_ptr);
760 * Called during local $shared
763 sharedsv_scalar_mg_local(pTHX_ SV* nsv, MAGIC *mg)
766 SV *ssv = (SV *) mg->mg_ptr;
772 nmg = sv_magicext(nsv, mg->mg_obj, mg->mg_type, mg->mg_virtual,
773 mg->mg_ptr, mg->mg_len);
774 nmg->mg_flags = mg->mg_flags;
775 nmg->mg_private = mg->mg_private;
780 MGVTBL sharedsv_scalar_vtbl = {
781 sharedsv_scalar_mg_get, /* get */
782 sharedsv_scalar_mg_set, /* set */
785 sharedsv_scalar_mg_free, /* free */
787 sharedsv_scalar_mg_dup, /* dup */
788 sharedsv_scalar_mg_local /* local */
791 /* ------------ PERL_MAGIC_tiedelem(p) functions -------------- */
793 /* get magic for PERL_MAGIC_tiedelem(p) */
796 sharedsv_elem_mg_FETCH(pTHX_ SV *sv, MAGIC *mg)
799 SV *saggregate = S_sharedsv_from_obj(aTHX_ mg->mg_obj);
803 if (SvTYPE(saggregate) == SVt_PVAV) {
804 assert ( mg->mg_ptr == 0 );
806 svp = av_fetch((AV*) saggregate, mg->mg_len, 0);
809 char *key = mg->mg_ptr;
810 STRLEN len = mg->mg_len;
811 assert ( mg->mg_ptr != 0 );
812 if (mg->mg_len == HEf_SVKEY) {
813 key = SvPV((SV *) mg->mg_ptr, len);
816 svp = hv_fetch((HV*) saggregate, key, len, 0);
820 /* Exists in the array */
822 S_get_RV(aTHX_ sv, *svp);
825 /* XXX can this branch ever happen? DAPM */
826 /* XXX assert("no such branch"); */
827 Perl_sharedsv_associate(aTHX_ sv, *svp);
832 /* Not in the array */
833 sv_setsv(sv, &PL_sv_undef);
839 /* set magic for PERL_MAGIC_tiedelem(p) */
842 sharedsv_elem_mg_STORE(pTHX_ SV *sv, MAGIC *mg)
845 SV *saggregate = S_sharedsv_from_obj(aTHX_ mg->mg_obj);
847 /* Theory - SV itself is magically shared - and we have ordered the
848 magic such that by the time we get here it has been stored
849 to its shared counterpart
853 if (SvTYPE(saggregate) == SVt_PVAV) {
854 assert ( mg->mg_ptr == 0 );
856 svp = av_fetch((AV*) saggregate, mg->mg_len, 1);
859 char *key = mg->mg_ptr;
860 STRLEN len = mg->mg_len;
861 assert ( mg->mg_ptr != 0 );
862 if (mg->mg_len == HEf_SVKEY)
863 key = SvPV((SV *) mg->mg_ptr, len);
865 svp = hv_fetch((HV*) saggregate, key, len, 1);
868 Perl_sharedsv_associate(aTHX_ sv, *svp);
869 sharedsv_scalar_store(aTHX_ sv, *svp);
874 /* clear magic for PERL_MAGIC_tiedelem(p) */
877 sharedsv_elem_mg_DELETE(pTHX_ SV *sv, MAGIC *mg)
881 SV *saggregate = S_sharedsv_from_obj(aTHX_ mg->mg_obj);
883 sharedsv_elem_mg_FETCH(aTHX_ sv, mg);
884 if ((shmg = mg_find(sv, PERL_MAGIC_shared_scalar)))
885 sharedsv_scalar_mg_get(aTHX_ sv, shmg);
886 if (SvTYPE(saggregate) == SVt_PVAV) {
888 av_delete((AV*) saggregate, mg->mg_len, G_DISCARD);
891 char *key = mg->mg_ptr;
892 STRLEN len = mg->mg_len;
893 assert ( mg->mg_ptr != 0 );
894 if (mg->mg_len == HEf_SVKEY)
895 key = SvPV((SV *) mg->mg_ptr, len);
897 hv_delete((HV*) saggregate, key, len, G_DISCARD);
904 /* Called during cloning of PERL_MAGIC_tiedelem(p) magic in new
908 sharedsv_elem_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
910 SvREFCNT_inc(S_sharedsv_from_obj(aTHX_ mg->mg_obj));
911 assert(mg->mg_flags & MGf_DUP);
915 MGVTBL sharedsv_elem_vtbl = {
916 sharedsv_elem_mg_FETCH, /* get */
917 sharedsv_elem_mg_STORE, /* set */
919 sharedsv_elem_mg_DELETE, /* clear */
922 sharedsv_elem_mg_dup, /* dup */
926 /* ------------ PERL_MAGIC_tied(P) functions -------------- */
928 /* len magic for PERL_MAGIC_tied(P) */
931 sharedsv_array_mg_FETCHSIZE(pTHX_ SV *sv, MAGIC *mg)
934 SV *ssv = (SV *) mg->mg_ptr;
937 if (SvTYPE(ssv) == SVt_PVAV) {
938 val = av_len((AV*) ssv);
941 /* not actually defined by tie API but ... */
942 val = HvKEYS((HV*) ssv);
948 /* clear magic for PERL_MAGIC_tied(P) */
951 sharedsv_array_mg_CLEAR(pTHX_ SV *sv, MAGIC *mg)
954 SV *ssv = (SV *) mg->mg_ptr;
956 if (SvTYPE(ssv) == SVt_PVAV) {
966 /* free magic for PERL_MAGIC_tied(P) */
969 sharedsv_array_mg_free(pTHX_ SV *sv, MAGIC *mg)
971 S_sharedsv_dec(aTHX_ (SV*)mg->mg_ptr);
976 * copy magic for PERL_MAGIC_tied(P)
977 * This is called when perl is about to access an element of
981 sharedsv_array_mg_copy(pTHX_ SV *sv, MAGIC* mg,
982 SV *nsv, const char *name, int namlen)
984 MAGIC *nmg = sv_magicext(nsv,mg->mg_obj,
985 toLOWER(mg->mg_type),&sharedsv_elem_vtbl,
987 nmg->mg_flags |= MGf_DUP;
991 /* Called during cloning of PERL_MAGIC_tied(P) magic in new thread */
994 sharedsv_array_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
996 SvREFCNT_inc((SV*)mg->mg_ptr);
997 assert(mg->mg_flags & MGf_DUP);
1001 MGVTBL sharedsv_array_vtbl = {
1004 sharedsv_array_mg_FETCHSIZE, /* len */
1005 sharedsv_array_mg_CLEAR, /* clear */
1006 sharedsv_array_mg_free, /* free */
1007 sharedsv_array_mg_copy, /* copy */
1008 sharedsv_array_mg_dup, /* dup */
1012 =for apidoc sharedsv_unlock
1014 Recursively unlocks a shared sv.
1019 Perl_sharedsv_unlock(pTHX_ SV *ssv)
1021 user_lock *ul = S_get_userlock(aTHX_ ssv, 0);
1023 recursive_lock_release(aTHX_ &ul->lock);
1026 =for apidoc sharedsv_lock
1028 Recursive locks on a sharedsv.
1029 Locks are dynamically scoped at the level of the first lock.
1034 Perl_sharedsv_lock(pTHX_ SV *ssv)
1039 ul = S_get_userlock(aTHX_ ssv, 1);
1040 recursive_lock_acquire(aTHX_ &ul->lock, __FILE__, __LINE__);
1043 /* handles calls from lock() builtin via PL_lockhook */
1046 Perl_sharedsv_locksv(pTHX_ SV *sv)
1052 ssv = Perl_sharedsv_find(aTHX_ sv);
1054 croak("lock can only be used on shared values");
1055 Perl_sharedsv_lock(aTHX_ ssv);
1058 =head1 Shared SV Functions
1060 =for apidoc sharedsv_init
1062 Saves a space for keeping SVs wider than an interpreter,
1067 Perl_sharedsv_init(pTHX)
1070 /* This pair leaves us in shared context ... */
1071 PL_sharedsv_space = perl_alloc();
1072 perl_construct(PL_sharedsv_space);
1074 recursive_lock_init(aTHX_ &PL_sharedsv_lock);
1075 PL_lockhook = &Perl_sharedsv_locksv;
1076 PL_sharehook = &Perl_sharedsv_share;
1079 #endif /* USE_ITHREADS */
1081 MODULE = threads::shared PACKAGE = threads::shared::tie
1091 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1093 for(i = 1; i < items; i++) {
1094 SV* tmp = newSVsv(ST(i));
1097 stmp = S_sharedsv_new_shared(aTHX_ tmp);
1098 sharedsv_scalar_store(aTHX_ tmp, stmp);
1100 av_push((AV*) sobj, stmp);
1107 UNSHIFT(SV *obj, ...)
1110 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1114 av_unshift((AV*)sobj, items - 1);
1116 for(i = 1; i < items; i++) {
1117 SV *tmp = newSVsv(ST(i));
1118 SV *stmp = S_sharedsv_new_shared(aTHX_ tmp);
1119 sharedsv_scalar_store(aTHX_ tmp, stmp);
1121 av_store((AV*) sobj, i - 1, stmp);
1132 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1136 ssv = av_pop((AV*)sobj);
1138 ST(0) = sv_newmortal();
1139 Perl_sharedsv_associate(aTHX_ ST(0), ssv);
1148 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1152 ssv = av_shift((AV*)sobj);
1154 ST(0) = sv_newmortal();
1155 Perl_sharedsv_associate(aTHX_ ST(0), ssv);
1161 EXTEND(SV *obj, IV count)
1164 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1166 av_extend((AV*)sobj, count);
1170 STORESIZE(SV *obj,IV count)
1173 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1175 av_fill((AV*) sobj, count);
1182 EXISTS(SV *obj, SV *index)
1185 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1187 if (SvTYPE(sobj) == SVt_PVAV) {
1189 exists = av_exists((AV*) sobj, SvIV(index));
1193 char *key = SvPV(index,len);
1195 exists = hv_exists((HV*) sobj, key, len);
1198 ST(0) = (exists) ? &PL_sv_yes : &PL_sv_no;
1206 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1212 hv_iterinit((HV*) sobj);
1213 entry = hv_iternext((HV*) sobj);
1215 key = hv_iterkey(entry,&len);
1217 ST(0) = sv_2mortal(newSVpv(key, len));
1220 ST(0) = &PL_sv_undef;
1226 NEXTKEY(SV *obj, SV *oldkey)
1229 SV *sobj = S_sharedsv_from_obj(aTHX_ obj);
1235 entry = hv_iternext((HV*) sobj);
1237 key = hv_iterkey(entry,&len);
1239 ST(0) = sv_2mortal(newSVpv(key, len));
1242 ST(0) = &PL_sv_undef;
1247 MODULE = threads::shared PACKAGE = threads::shared
1259 if( (ssv = Perl_sharedsv_find(aTHX_ ref)) ){
1260 ST(0) = sv_2mortal(newSViv(PTR2IV(ssv)));
1274 if( (ssv = Perl_sharedsv_find(aTHX_ ref)) ) {
1275 ST(0) = sv_2mortal(newSViv(SvREFCNT(ssv)));
1279 Perl_warn(aTHX_ "%" SVf " is not shared",ST(0));
1288 Perl_croak(aTHX_ "Argument to share needs to be passed as ref");
1292 Perl_sharedsv_share(aTHX_ ref);
1293 RETVAL = newRV(ref);
1298 lock_enabled(SV *ref)
1303 Perl_croak(aTHX_ "Argument to lock needs to be passed as ref");
1307 ssv = Perl_sharedsv_find(aTHX_ ref);
1309 croak("lock can only be used on shared values");
1310 Perl_sharedsv_lock(aTHX_ ssv);
1313 cond_wait_enabled(SV *ref_cond, SV *ref_lock = 0)
1314 PROTOTYPE: \[$@%];\[$@%]
1317 perl_cond* user_condition;
1323 if (!ref_lock || ref_lock == ref_cond) same = 1;
1325 if(!SvROK(ref_cond))
1326 Perl_croak(aTHX_ "Argument to cond_wait needs to be passed as ref");
1327 ref_cond = SvRV(ref_cond);
1329 ref_cond = SvRV(ref_cond);
1330 ssv = Perl_sharedsv_find(aTHX_ ref_cond);
1332 croak("cond_wait can only be used on shared values");
1333 ul = S_get_userlock(aTHX_ ssv, 1);
1335 user_condition = &ul->user_cond;
1337 if (!SvROK(ref_lock))
1338 Perl_croak(aTHX_ "cond_wait lock needs to be passed as ref");
1339 ref_lock = SvRV(ref_lock);
1340 if (SvROK(ref_lock)) ref_lock = SvRV(ref_lock);
1341 ssv = Perl_sharedsv_find(aTHX_ ref_lock);
1343 croak("cond_wait lock must be a shared value");
1344 ul = S_get_userlock(aTHX_ ssv, 1);
1346 if(ul->lock.owner != aTHX)
1347 croak("You need a lock before you can cond_wait");
1348 /* Stealing the members of the lock object worries me - NI-S */
1349 MUTEX_LOCK(&ul->lock.mutex);
1350 ul->lock.owner = NULL;
1351 locks = ul->lock.locks;
1354 /* since we are releasing the lock here we need to tell other
1355 people that is ok to go ahead and use it */
1356 COND_SIGNAL(&ul->lock.cond);
1357 COND_WAIT(user_condition, &ul->lock.mutex);
1358 while(ul->lock.owner != NULL) {
1359 /* OK -- must reacquire the lock */
1360 COND_WAIT(&ul->lock.cond, &ul->lock.mutex);
1362 ul->lock.owner = aTHX;
1363 ul->lock.locks = locks;
1364 MUTEX_UNLOCK(&ul->lock.mutex);
1367 cond_timedwait_enabled(SV *ref_cond, double abs, SV *ref_lock = 0)
1368 PROTOTYPE: \[$@%]$;\[$@%]
1371 perl_cond* user_condition;
1377 if (!ref_lock || ref_cond == ref_lock) same = 1;
1379 if(!SvROK(ref_cond))
1380 Perl_croak(aTHX_ "Argument to cond_timedwait needs to be passed as ref");
1381 ref_cond = SvRV(ref_cond);
1383 ref_cond = SvRV(ref_cond);
1384 ssv = Perl_sharedsv_find(aTHX_ ref_cond);
1386 croak("cond_timedwait can only be used on shared values");
1387 ul = S_get_userlock(aTHX_ ssv, 1);
1389 user_condition = &ul->user_cond;
1391 if (!SvROK(ref_lock))
1392 Perl_croak(aTHX_ "cond_timedwait lock needs to be passed as ref");
1393 ref_lock = SvRV(ref_lock);
1394 if (SvROK(ref_lock)) ref_lock = SvRV(ref_lock);
1395 ssv = Perl_sharedsv_find(aTHX_ ref_lock);
1397 croak("cond_timedwait lock must be a shared value");
1398 ul = S_get_userlock(aTHX_ ssv, 1);
1400 if(ul->lock.owner != aTHX)
1401 croak("You need a lock before you can cond_wait");
1403 MUTEX_LOCK(&ul->lock.mutex);
1404 ul->lock.owner = NULL;
1405 locks = ul->lock.locks;
1407 /* since we are releasing the lock here we need to tell other
1408 people that is ok to go ahead and use it */
1409 COND_SIGNAL(&ul->lock.cond);
1410 RETVAL = Perl_sharedsv_cond_timedwait(user_condition, &ul->lock.mutex, abs);
1411 while (ul->lock.owner != NULL) {
1412 /* OK -- must reacquire the lock... */
1413 COND_WAIT(&ul->lock.cond, &ul->lock.mutex);
1415 ul->lock.owner = aTHX;
1416 ul->lock.locks = locks;
1417 MUTEX_UNLOCK(&ul->lock.mutex);
1425 cond_signal_enabled(SV *ref)
1432 Perl_croak(aTHX_ "Argument to cond_signal needs to be passed as ref");
1436 ssv = Perl_sharedsv_find(aTHX_ ref);
1438 croak("cond_signal can only be used on shared values");
1439 ul = S_get_userlock(aTHX_ ssv, 1);
1440 if (ckWARN(WARN_THREADS) && ul->lock.owner != aTHX)
1441 Perl_warner(aTHX_ packWARN(WARN_THREADS),
1442 "cond_signal() called on unlocked variable");
1443 COND_SIGNAL(&ul->user_cond);
1446 cond_broadcast_enabled(SV *ref)
1453 Perl_croak(aTHX_ "Argument to cond_broadcast needs to be passed as ref");
1457 ssv = Perl_sharedsv_find(aTHX_ ref);
1459 croak("cond_broadcast can only be used on shared values");
1460 ul = S_get_userlock(aTHX_ ssv, 1);
1461 if (ckWARN(WARN_THREADS) && ul->lock.owner != aTHX)
1462 Perl_warner(aTHX_ packWARN(WARN_THREADS),
1463 "cond_broadcast() called on unlocked variable");
1464 COND_BROADCAST(&ul->user_cond);
1468 bless(SV* ref, ...);
1475 stash = CopSTASH(PL_curcop);
1477 SV* classname = ST(1);
1481 if (classname && !SvGMAGICAL(classname) &&
1482 !SvAMAGIC(classname) && SvROK(classname))
1483 Perl_croak(aTHX_ "Attempt to bless into a reference");
1484 ptr = SvPV(classname,len);
1485 if (ckWARN(WARN_MISC) && len == 0)
1486 Perl_warner(aTHX_ packWARN(WARN_MISC),
1487 "Explicit blessing to '' (assuming package main)");
1488 stash = gv_stashpvn(ptr, len, TRUE);
1491 (void)sv_bless(ref, stash);
1493 ssv = Perl_sharedsv_find(aTHX_ ref);
1499 SV* fake_stash = newSVpv(HvNAME_get(stash),0);
1500 (void)sv_bless(ssv,(HV*)fake_stash);
1509 #endif /* USE_ITHREADS */
1514 Perl_sharedsv_init(aTHX);
1515 #endif /* USE_ITHREADS */