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