2 * Store and retrieve mechanism.
4 * Copyright (c) 1995-2000, Raphael Manfredi
6 * You may redistribute only under the same terms as Perl 5, as specified
7 * in the README file that comes with the distribution.
11 #define PERL_NO_GET_CONTEXT /* we want efficiency */
17 #include <patchlevel.h> /* Perl's one, needed since 5.6 */
20 #if !defined(PERL_VERSION) || PERL_VERSION < 8
21 #include "ppport.h" /* handle old perls */
25 #define DEBUGME /* Debug mode, turns assertions on as well */
26 #define DASSERT /* Assertion mode */
30 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
31 * Provide them with the necessary defines so they can build with pre-5.004.
34 #ifndef PERLIO_IS_STDIO
36 #define PerlIO_getc(x) getc(x)
37 #define PerlIO_putc(f,x) putc(x,f)
38 #define PerlIO_read(x,y,z) fread(y,1,z,x)
39 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
40 #define PerlIO_stdoutf printf
41 #endif /* PERLIO_IS_STDIO */
42 #endif /* USE_PERLIO */
45 * Earlier versions of perl might be used, we can't assume they have the latest!
48 #ifndef PERL_VERSION /* For perls < 5.6 */
49 #define PERL_VERSION PATCHLEVEL
51 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
53 #if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
54 #define PL_sv_yes sv_yes
55 #define PL_sv_no sv_no
56 #define PL_sv_undef sv_undef
57 #if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
58 #define newSVpvn newSVpv
60 #endif /* PATCHLEVEL <= 4 */
61 #ifndef HvSHAREKEYS_off
62 #define HvSHAREKEYS_off(hv) /* Ignore */
64 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
65 #define AvFILLp AvFILL
67 typedef double NV; /* Older perls lack the NV type */
68 #define IVdf "ld" /* Various printf formats for Perl types */
72 #define INT2PTR(t,v) (t)(IV)(v)
73 #define PTR2UV(v) (unsigned long)(v)
74 #endif /* PERL_VERSION -- perls < 5.6 */
76 #ifndef NVef /* The following were not part of perl 5.6 */
77 #if defined(USE_LONG_DOUBLE) && \
78 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
79 #define NVef PERL_PRIeldbl
80 #define NVff PERL_PRIfldbl
81 #define NVgf PERL_PRIgldbl
90 #define SvRV_set(sv, val) \
92 assert(SvTYPE(sv) >= SVt_RV); \
93 (((XRV*)SvANY(sv))->xrv_rv = (val)); \
97 #ifndef PERL_UNUSED_DECL
99 # if (defined(__GNUC__) && defined(__cplusplus)) || defined(__INTEL_COMPILER)
100 # define PERL_UNUSED_DECL
102 # define PERL_UNUSED_DECL __attribute__((unused))
105 # define PERL_UNUSED_DECL
110 #define dNOOP extern int Perl___notused PERL_UNUSED_DECL
118 # define HvRITER_set(hv,r) (HvRITER(hv) = r)
121 # define HvEITER_set(hv,r) (HvEITER(hv) = r)
125 # define HvRITER_get HvRITER
128 # define HvEITER_get HvEITER
132 #define HvNAME_get HvNAME
135 #ifndef HvPLACEHOLDERS_get
136 # define HvPLACEHOLDERS_get HvPLACEHOLDERS
146 * TRACEME() will only output things when the $Storable::DEBUGME is true.
151 if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
152 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
159 #define ASSERT(x,y) \
162 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
163 __FILE__, __LINE__); \
164 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
175 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
177 #define SX_OBJECT C(0) /* Already stored object */
178 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
179 #define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
180 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
181 #define SX_REF C(4) /* Reference to object forthcoming */
182 #define SX_UNDEF C(5) /* Undefined scalar */
183 #define SX_INTEGER C(6) /* Integer forthcoming */
184 #define SX_DOUBLE C(7) /* Double forthcoming */
185 #define SX_BYTE C(8) /* (signed) byte forthcoming */
186 #define SX_NETINT C(9) /* Integer in network order forthcoming */
187 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
188 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
189 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
190 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
191 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
192 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
193 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
194 #define SX_BLESS C(17) /* Object is blessed */
195 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
196 #define SX_HOOK C(19) /* Stored via hook, user-defined */
197 #define SX_OVERLOAD C(20) /* Overloaded reference */
198 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
199 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
200 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
201 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
202 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
203 #define SX_CODE C(26) /* Code references as perl source code */
204 #define SX_WEAKREF C(27) /* Weak reference to object forthcoming */
205 #define SX_WEAKOVERLOAD C(28) /* Overloaded weak reference */
206 #define SX_ERROR C(29) /* Error */
209 * Those are only used to retrieve "old" pre-0.6 binary images.
211 #define SX_ITEM 'i' /* An array item introducer */
212 #define SX_IT_UNDEF 'I' /* Undefined array item */
213 #define SX_KEY 'k' /* A hash key introducer */
214 #define SX_VALUE 'v' /* A hash value introducer */
215 #define SX_VL_UNDEF 'V' /* Undefined hash value */
218 * Those are only used to retrieve "old" pre-0.7 binary images
221 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
222 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
223 #define SX_STORED 'X' /* End of object */
226 * Limits between short/long length representation.
229 #define LG_SCALAR 255 /* Large scalar length limit */
230 #define LG_BLESS 127 /* Large classname bless limit */
236 #define ST_STORE 0x1 /* Store operation */
237 #define ST_RETRIEVE 0x2 /* Retrieval operation */
238 #define ST_CLONE 0x4 /* Deep cloning operation */
241 * The following structure is used for hash table key retrieval. Since, when
242 * retrieving objects, we'll be facing blessed hash references, it's best
243 * to pre-allocate that buffer once and resize it as the need arises, never
244 * freeing it (keys will be saved away someplace else anyway, so even large
245 * keys are not enough a motivation to reclaim that space).
247 * This structure is also used for memory store/retrieve operations which
248 * happen in a fixed place before being malloc'ed elsewhere if persistency
249 * is required. Hence the aptr pointer.
252 char *arena; /* Will hold hash key strings, resized as needed */
253 STRLEN asiz; /* Size of aforementionned buffer */
254 char *aptr; /* Arena pointer, for in-place read/write ops */
255 char *aend; /* First invalid address */
260 * A hash table records the objects which have already been stored.
261 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
262 * an arbitrary sequence number) is used to identify them.
265 * An array table records the objects which have already been retrieved,
266 * as seen by the tag determind by counting the objects themselves. The
267 * reference to that retrieved object is kept in the table, and is returned
268 * when an SX_OBJECT is found bearing that same tag.
270 * The same processing is used to record "classname" for blessed objects:
271 * indexing by a hash at store time, and via an array at retrieve time.
274 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
277 * The following "thread-safe" related defines were contributed by
278 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
279 * only renamed things a little bit to ensure consistency with surrounding
280 * code. -- RAM, 14/09/1999
282 * The original patch suffered from the fact that the stcxt_t structure
283 * was global. Murray tried to minimize the impact on the code as much as
286 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
287 * on objects. Therefore, the notion of context needs to be generalized,
291 #define MY_VERSION "Storable(" XS_VERSION ")"
295 * Conditional UTF8 support.
299 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
300 #define HAS_UTF8_SCALARS
302 #define HAS_UTF8_HASHES
305 /* 5.6 perl has utf8 scalars but not hashes */
309 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
312 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
315 #define WEAKREF_CROAK() CROAK(("Cannot retrieve weak references in this perl"))
318 #ifdef HvPLACEHOLDERS
319 #define HAS_RESTRICTED_HASHES
321 #define HVhek_PLACEHOLD 0x200
322 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
326 #define HAS_HASH_KEY_FLAGS
330 #define USE_PTR_TABLE
334 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
335 * files remap tainted and dirty when threading is enabled. That's bad for
336 * perl to remap such common words. -- RAM, 29/09/00
340 typedef struct stcxt {
341 int entry; /* flags recursion */
342 int optype; /* type of traversal operation */
343 /* which objects have been seen, store time.
344 tags are numbers, which are cast to (SV *) and stored directly */
346 /* use pseen if we have ptr_tables. We have to store tag+1, because
347 tag numbers start at 0, and we can't store (SV *) 0 in a ptr_table
348 without it being confused for a fetch lookup failure. */
349 struct ptr_tbl *pseen;
350 /* Still need hseen for the 0.6 file format code. */
353 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
354 AV *aseen; /* which objects have been seen, retrieve time */
355 IV where_is_undef; /* index in aseen of PL_sv_undef */
356 HV *hclass; /* which classnames have been seen, store time */
357 AV *aclass; /* which classnames have been seen, retrieve time */
358 HV *hook; /* cache for hook methods per class name */
359 IV tagnum; /* incremented at store time for each seen object */
360 IV classnum; /* incremented at store time for each seen classname */
361 int netorder; /* true if network order used */
362 int s_tainted; /* true if input source is tainted, at retrieve time */
363 int forgive_me; /* whether to be forgiving... */
364 int deparse; /* whether to deparse code refs */
365 SV *eval; /* whether to eval source code */
366 int canonical; /* whether to store hashes sorted by key */
367 #ifndef HAS_RESTRICTED_HASHES
368 int derestrict; /* whether to downgrade restrcted hashes */
371 int use_bytes; /* whether to bytes-ify utf8 */
373 int accept_future_minor; /* croak immediately on future minor versions? */
374 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
375 int membuf_ro; /* true means membuf is read-only and msaved is rw */
376 struct extendable keybuf; /* for hash key retrieval */
377 struct extendable membuf; /* for memory store/retrieve operations */
378 struct extendable msaved; /* where potentially valid mbuf is saved */
379 PerlIO *fio; /* where I/O are performed, NULL for memory */
380 int ver_major; /* major of version for retrieved object */
381 int ver_minor; /* minor of version for retrieved object */
382 SV *(**retrieve_vtbl)(pTHX_ struct stcxt *, const char *); /* retrieve dispatch table */
383 SV *prev; /* contexts chained backwards in real recursion */
384 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
387 #define NEW_STORABLE_CXT_OBJ(cxt) \
389 SV *self = newSV(sizeof(stcxt_t) - 1); \
390 SV *my_sv = newRV_noinc(self); \
391 sv_bless(my_sv, gv_stashpv("Storable::Cxt", TRUE)); \
392 cxt = (stcxt_t *)SvPVX(self); \
393 Zero(cxt, 1, stcxt_t); \
394 cxt->my_sv = my_sv; \
397 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
399 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
401 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
402 #else /* >= perl5.004_68 */
404 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
405 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
406 #endif /* < perl5.004_68 */
408 #define dSTCXT_PTR(T,name) \
409 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
410 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
413 dSTCXT_PTR(stcxt_t *, cxt)
417 NEW_STORABLE_CXT_OBJ(cxt); \
418 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
420 #define SET_STCXT(x) \
423 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
426 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
428 static stcxt_t *Context_ptr = NULL;
429 #define dSTCXT stcxt_t *cxt = Context_ptr
430 #define SET_STCXT(x) Context_ptr = x
433 NEW_STORABLE_CXT_OBJ(cxt); \
437 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
441 * Croaking implies a memory leak, since we don't use setjmp/longjmp
442 * to catch the exit and free memory used during store or retrieve
443 * operations. This is not too difficult to fix, but I need to understand
444 * how Perl does it, and croaking is exceptional anyway, so I lack the
445 * motivation to do it.
447 * The current workaround is to mark the context as dirty when croaking,
448 * so that data structures can be freed whenever we renter Storable code
449 * (but only *then*: it's a workaround, not a fix).
451 * This is also imperfect, because we don't really know how far they trapped
452 * the croak(), and when we were recursing, we won't be able to clean anything
453 * but the topmost context stacked.
456 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
459 * End of "thread-safe" related definitions.
465 * Keep only the low 32 bits of a pointer (used for tags, which are not
470 #define LOW_32BITS(x) ((I32) (x))
472 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
478 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
479 * Used in the WLEN and RLEN macros.
483 #define oI(x) ((I32 *) ((char *) (x) + 4))
484 #define oS(x) ((x) - 4)
485 #define oC(x) (x = 0)
494 * key buffer handling
496 #define kbuf (cxt->keybuf).arena
497 #define ksiz (cxt->keybuf).asiz
501 TRACEME(("** allocating kbuf of 128 bytes")); \
502 New(10003, kbuf, 128, char); \
509 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
510 Renew(kbuf, x+1, char); \
516 * memory buffer handling
518 #define mbase (cxt->membuf).arena
519 #define msiz (cxt->membuf).asiz
520 #define mptr (cxt->membuf).aptr
521 #define mend (cxt->membuf).aend
523 #define MGROW (1 << 13)
524 #define MMASK (MGROW - 1)
526 #define round_mgrow(x) \
527 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
528 #define trunc_int(x) \
529 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
530 #define int_aligned(x) \
531 ((unsigned long) (x) == trunc_int(x))
533 #define MBUF_INIT(x) \
536 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
537 New(10003, mbase, MGROW, char); \
538 msiz = (STRLEN)MGROW; \
544 mend = mbase + msiz; \
547 #define MBUF_TRUNC(x) mptr = mbase + x
548 #define MBUF_SIZE() (mptr - mbase)
554 * Those macros are used in do_retrieve() to save the current memory
555 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
556 * data from a string.
558 #define MBUF_SAVE_AND_LOAD(in) \
560 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
561 cxt->membuf_ro = 1; \
562 TRACEME(("saving mbuf")); \
563 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
567 #define MBUF_RESTORE() \
569 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
570 cxt->membuf_ro = 0; \
571 TRACEME(("restoring mbuf")); \
572 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
576 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
577 * See store_scalar() for other usage of this workaround.
579 #define MBUF_LOAD(v) \
581 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
583 CROAK(("Not a scalar string")); \
584 mptr = mbase = SvPV(v, msiz); \
585 mend = mbase + msiz; \
588 #define MBUF_XTEND(x) \
590 int nsz = (int) round_mgrow((x)+msiz); \
591 int offset = mptr - mbase; \
592 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
593 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
595 Renew(mbase, nsz, char); \
597 mptr = mbase + offset; \
598 mend = mbase + nsz; \
601 #define MBUF_CHK(x) \
603 if ((mptr + (x)) > mend) \
607 #define MBUF_GETC(x) \
610 x = (int) (unsigned char) *mptr++; \
616 #define MBUF_GETINT(x) \
619 if ((mptr + 4) <= mend) { \
620 memcpy(oI(&x), mptr, 4); \
626 #define MBUF_GETINT(x) \
628 if ((mptr + sizeof(int)) <= mend) { \
629 if (int_aligned(mptr)) \
632 memcpy(&x, mptr, sizeof(int)); \
633 mptr += sizeof(int); \
639 #define MBUF_READ(x,s) \
641 if ((mptr + (s)) <= mend) { \
642 memcpy(x, mptr, s); \
648 #define MBUF_SAFEREAD(x,s,z) \
650 if ((mptr + (s)) <= mend) { \
651 memcpy(x, mptr, s); \
659 #define MBUF_PUTC(c) \
662 *mptr++ = (char) c; \
665 *mptr++ = (char) c; \
670 #define MBUF_PUTINT(i) \
673 memcpy(mptr, oI(&i), 4); \
677 #define MBUF_PUTINT(i) \
679 MBUF_CHK(sizeof(int)); \
680 if (int_aligned(mptr)) \
683 memcpy(mptr, &i, sizeof(int)); \
684 mptr += sizeof(int); \
688 #define MBUF_WRITE(x,s) \
691 memcpy(mptr, x, s); \
696 * Possible return values for sv_type().
700 #define svis_SCALAR 1
704 #define svis_TIED_ITEM 5
712 #define SHF_TYPE_MASK 0x03
713 #define SHF_LARGE_CLASSLEN 0x04
714 #define SHF_LARGE_STRLEN 0x08
715 #define SHF_LARGE_LISTLEN 0x10
716 #define SHF_IDX_CLASSNAME 0x20
717 #define SHF_NEED_RECURSE 0x40
718 #define SHF_HAS_LIST 0x80
721 * Types for SX_HOOK (last 2 bits in flags).
727 #define SHT_EXTRA 3 /* Read extra byte for type */
730 * The following are held in the "extra byte"...
733 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
734 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
735 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
738 * per hash flags for flagged hashes
741 #define SHV_RESTRICTED 0x01
744 * per key flags for flagged hashes
747 #define SHV_K_UTF8 0x01
748 #define SHV_K_WASUTF8 0x02
749 #define SHV_K_LOCKED 0x04
750 #define SHV_K_ISSV 0x08
751 #define SHV_K_PLACEHOLDER 0x10
754 * Before 0.6, the magic string was "perl-store" (binary version number 0).
756 * Since 0.6 introduced many binary incompatibilities, the magic string has
757 * been changed to "pst0" to allow an old image to be properly retrieved by
758 * a newer Storable, but ensure a newer image cannot be retrieved with an
761 * At 0.7, objects are given the ability to serialize themselves, and the
762 * set of markers is extended, backward compatibility is not jeopardized,
763 * so the binary version number could have remained unchanged. To correctly
764 * spot errors if a file making use of 0.7-specific extensions is given to
765 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
766 * a "minor" version, to better track this kind of evolution from now on.
769 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
770 static const char magicstr[] = "pst0"; /* Used as a magic number */
772 #define MAGICSTR_BYTES 'p','s','t','0'
773 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
775 /* 5.6.x introduced the ability to have IVs as long long.
776 However, Configure still defined BYTEORDER based on the size of a long.
777 Storable uses the BYTEORDER value as part of the header, but doesn't
778 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
779 with IV as long long on a platform that uses Configure (ie most things
780 except VMS and Windows) headers are identical for the different IV sizes,
781 despite the files containing some fields based on sizeof(IV)
783 5.8 is consistent - the following redifinition kludge is only needed on
784 5.6.x, but the interwork is needed on 5.8 while data survives in files
789 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
790 #ifndef NO_56_INTERWORK_KLUDGE
791 #define USE_56_INTERWORK_KLUDGE
793 #if BYTEORDER == 0x1234
795 #define BYTEORDER 0x12345678
797 #if BYTEORDER == 0x4321
799 #define BYTEORDER 0x87654321
804 #if BYTEORDER == 0x1234
805 #define BYTEORDER_BYTES '1','2','3','4'
807 #if BYTEORDER == 0x12345678
808 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
809 #ifdef USE_56_INTERWORK_KLUDGE
810 #define BYTEORDER_BYTES_56 '1','2','3','4'
813 #if BYTEORDER == 0x87654321
814 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
815 #ifdef USE_56_INTERWORK_KLUDGE
816 #define BYTEORDER_BYTES_56 '4','3','2','1'
819 #if BYTEORDER == 0x4321
820 #define BYTEORDER_BYTES '4','3','2','1'
822 #error Unknown byteorder. Please append your byteorder to Storable.xs
828 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
829 #ifdef USE_56_INTERWORK_KLUDGE
830 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
833 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
834 #define STORABLE_BIN_MINOR 7 /* Binary minor "version" */
836 #if (PATCHLEVEL <= 5)
837 #define STORABLE_BIN_WRITE_MINOR 4
840 * Perl 5.6.0 onwards can do weak references.
842 #define STORABLE_BIN_WRITE_MINOR 7
843 #endif /* (PATCHLEVEL <= 5) */
845 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
846 #define PL_sv_placeholder PL_sv_undef
850 * Useful store shortcuts...
854 * Note that if you put more than one mark for storing a particular
855 * type of thing, *and* in the retrieve_foo() function you mark both
856 * the thingy's you get off with SEEN(), you *must* increase the
857 * tagnum with cxt->tagnum++ along with this macro!
864 else if (PerlIO_putc(cxt->fio, x) == EOF) \
868 #define WRITE_I32(x) \
870 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
873 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
880 if (cxt->netorder) { \
881 int y = (int) htonl(x); \
884 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
889 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
894 #define WLEN(x) WRITE_I32(x)
901 else if (PerlIO_write(cxt->fio, x, y) != y) \
905 #define STORE_PV_LEN(pv, len, small, large) \
907 if (len <= LG_SCALAR) { \
908 unsigned char clen = (unsigned char) len; \
920 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
923 * Store &PL_sv_undef in arrays without recursing through store().
925 #define STORE_SV_UNDEF() \
928 PUTMARK(SX_SV_UNDEF); \
932 * Useful retrieve shortcuts...
936 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
942 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
946 #define READ_I32(x) \
948 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
952 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
962 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
965 x = (int) ntohl(x); \
968 #define RLEN(x) READ_I32(x)
975 else if (PerlIO_read(cxt->fio, x, y) != y) \
979 #define SAFEREAD(x,y,z) \
982 MBUF_SAFEREAD(x,y,z); \
983 else if (PerlIO_read(cxt->fio, x, y) != y) { \
990 * This macro is used at retrieve time, to remember where object 'y', bearing a
991 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
992 * we'll therefore know where it has been retrieved and will be able to
993 * share the same reference, as in the original stored memory image.
995 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
996 * on the objects given to STORABLE_thaw and expect that to be defined), and
997 * also for overloaded objects (for which we might not find the stash if the
998 * object is not blessed yet--this might occur for overloaded objects that
999 * refer to themselves indirectly: if we blessed upon return from a sub
1000 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
1001 * restored on it because the underlying object would not be blessed yet!).
1003 * To achieve that, the class name of the last retrieved object is passed down
1004 * recursively, and the first SEEN() call for which the class name is not NULL
1005 * will bless the object.
1007 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
1009 #define SEEN(y,c,i) \
1013 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
1015 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
1016 PTR2UV(y), SvREFCNT(y)-1)); \
1018 BLESS((SV *) (y), c); \
1022 * Bless `s' in `p', via a temporary reference, required by sv_bless().
1024 #define BLESS(s,p) \
1028 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
1029 stash = gv_stashpv((p), TRUE); \
1030 ref = newRV_noinc(s); \
1031 (void) sv_bless(ref, stash); \
1032 SvRV_set(ref, NULL); \
1033 SvREFCNT_dec(ref); \
1036 * sort (used in store_hash) - conditionally use qsort when
1037 * sortsv is not available ( <= 5.6.1 ).
1040 #if (PATCHLEVEL <= 6)
1042 #if defined(USE_ITHREADS)
1044 #define STORE_HASH_SORT \
1046 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
1047 SAVESPTR(orig_perl); \
1048 PERL_SET_CONTEXT(aTHX); \
1049 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
1052 #else /* ! USE_ITHREADS */
1054 #define STORE_HASH_SORT \
1055 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1057 #endif /* USE_ITHREADS */
1059 #else /* PATCHLEVEL > 6 */
1061 #define STORE_HASH_SORT \
1062 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1064 #endif /* PATCHLEVEL <= 6 */
1066 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1067 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname);
1070 * Dynamic dispatching table for SV store.
1073 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1074 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1075 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1076 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1077 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1078 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1079 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1080 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1081 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1083 typedef int (*sv_store_t)(pTHX_ stcxt_t *cxt, SV *sv);
1085 static const sv_store_t sv_store[] = {
1086 (sv_store_t)store_ref, /* svis_REF */
1087 (sv_store_t)store_scalar, /* svis_SCALAR */
1088 (sv_store_t)store_array, /* svis_ARRAY */
1089 (sv_store_t)store_hash, /* svis_HASH */
1090 (sv_store_t)store_tied, /* svis_TIED */
1091 (sv_store_t)store_tied_item, /* svis_TIED_ITEM */
1092 (sv_store_t)store_code, /* svis_CODE */
1093 (sv_store_t)store_other, /* svis_OTHER */
1096 #define SV_STORE(x) (*sv_store[x])
1099 * Dynamic dispatching tables for SV retrieval.
1102 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname);
1103 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname);
1104 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1105 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1106 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname);
1107 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname);
1108 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname);
1109 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname);
1110 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname);
1111 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname);
1112 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1113 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname);
1114 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname);
1115 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname);
1116 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1117 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname);
1119 typedef SV* (*sv_retrieve_t)(pTHX_ stcxt_t *cxt, const char *name);
1121 static const sv_retrieve_t sv_old_retrieve[] = {
1122 0, /* SX_OBJECT -- entry unused dynamically */
1123 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1124 (sv_retrieve_t)old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1125 (sv_retrieve_t)old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1126 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1127 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1128 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1129 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1130 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1131 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1132 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1133 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1134 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1135 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1136 (sv_retrieve_t)retrieve_other, /* SX_SV_UNDEF not supported */
1137 (sv_retrieve_t)retrieve_other, /* SX_SV_YES not supported */
1138 (sv_retrieve_t)retrieve_other, /* SX_SV_NO not supported */
1139 (sv_retrieve_t)retrieve_other, /* SX_BLESS not supported */
1140 (sv_retrieve_t)retrieve_other, /* SX_IX_BLESS not supported */
1141 (sv_retrieve_t)retrieve_other, /* SX_HOOK not supported */
1142 (sv_retrieve_t)retrieve_other, /* SX_OVERLOADED not supported */
1143 (sv_retrieve_t)retrieve_other, /* SX_TIED_KEY not supported */
1144 (sv_retrieve_t)retrieve_other, /* SX_TIED_IDX not supported */
1145 (sv_retrieve_t)retrieve_other, /* SX_UTF8STR not supported */
1146 (sv_retrieve_t)retrieve_other, /* SX_LUTF8STR not supported */
1147 (sv_retrieve_t)retrieve_other, /* SX_FLAG_HASH not supported */
1148 (sv_retrieve_t)retrieve_other, /* SX_CODE not supported */
1149 (sv_retrieve_t)retrieve_other, /* SX_WEAKREF not supported */
1150 (sv_retrieve_t)retrieve_other, /* SX_WEAKOVERLOAD not supported */
1151 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1154 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1155 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1156 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname);
1157 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname);
1158 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname);
1159 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1160 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1161 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname);
1162 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname);
1163 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname);
1164 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname);
1165 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname);
1166 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname);
1167 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname);
1168 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname);
1170 static const sv_retrieve_t sv_retrieve[] = {
1171 0, /* SX_OBJECT -- entry unused dynamically */
1172 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1173 (sv_retrieve_t)retrieve_array, /* SX_ARRAY */
1174 (sv_retrieve_t)retrieve_hash, /* SX_HASH */
1175 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1176 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1177 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1178 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1179 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1180 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1181 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1182 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1183 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1184 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1185 (sv_retrieve_t)retrieve_sv_undef, /* SX_SV_UNDEF */
1186 (sv_retrieve_t)retrieve_sv_yes, /* SX_SV_YES */
1187 (sv_retrieve_t)retrieve_sv_no, /* SX_SV_NO */
1188 (sv_retrieve_t)retrieve_blessed, /* SX_BLESS */
1189 (sv_retrieve_t)retrieve_idx_blessed, /* SX_IX_BLESS */
1190 (sv_retrieve_t)retrieve_hook, /* SX_HOOK */
1191 (sv_retrieve_t)retrieve_overloaded, /* SX_OVERLOAD */
1192 (sv_retrieve_t)retrieve_tied_key, /* SX_TIED_KEY */
1193 (sv_retrieve_t)retrieve_tied_idx, /* SX_TIED_IDX */
1194 (sv_retrieve_t)retrieve_utf8str, /* SX_UTF8STR */
1195 (sv_retrieve_t)retrieve_lutf8str, /* SX_LUTF8STR */
1196 (sv_retrieve_t)retrieve_flag_hash, /* SX_HASH */
1197 (sv_retrieve_t)retrieve_code, /* SX_CODE */
1198 (sv_retrieve_t)retrieve_weakref, /* SX_WEAKREF */
1199 (sv_retrieve_t)retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
1200 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1203 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1205 static SV *mbuf2sv(pTHX);
1208 *** Context management.
1214 * Called once per "thread" (interpreter) to initialize some global context.
1216 static void init_perinterp(pTHX)
1220 cxt->netorder = 0; /* true if network order used */
1221 cxt->forgive_me = -1; /* whether to be forgiving... */
1222 cxt->accept_future_minor = -1; /* would otherwise occur too late */
1228 * Called at the end of every context cleaning, to perform common reset
1231 static void reset_context(stcxt_t *cxt)
1235 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1239 * init_store_context
1241 * Initialize a new store context for real recursion.
1243 static void init_store_context(
1250 TRACEME(("init_store_context"));
1252 cxt->netorder = network_order;
1253 cxt->forgive_me = -1; /* Fetched from perl if needed */
1254 cxt->deparse = -1; /* Idem */
1255 cxt->eval = NULL; /* Idem */
1256 cxt->canonical = -1; /* Idem */
1257 cxt->tagnum = -1; /* Reset tag numbers */
1258 cxt->classnum = -1; /* Reset class numbers */
1259 cxt->fio = f; /* Where I/O are performed */
1260 cxt->optype = optype; /* A store, or a deep clone */
1261 cxt->entry = 1; /* No recursion yet */
1264 * The `hseen' table is used to keep track of each SV stored and their
1265 * associated tag numbers is special. It is "abused" because the
1266 * values stored are not real SV, just integers cast to (SV *),
1267 * which explains the freeing below.
1269 * It is also one possible bottlneck to achieve good storing speed,
1270 * so the "shared keys" optimization is turned off (unlikely to be
1271 * of any use here), and the hash table is "pre-extended". Together,
1272 * those optimizations increase the throughput by 12%.
1275 #ifdef USE_PTR_TABLE
1276 cxt->pseen = ptr_table_new();
1279 cxt->hseen = newHV(); /* Table where seen objects are stored */
1280 HvSHAREKEYS_off(cxt->hseen);
1283 * The following does not work well with perl5.004_04, and causes
1284 * a core dump later on, in a completely unrelated spot, which
1285 * makes me think there is a memory corruption going on.
1287 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1288 * it below does not make any difference. It seems to work fine
1289 * with perl5.004_68 but given the probable nature of the bug,
1290 * that does not prove anything.
1292 * It's a shame because increasing the amount of buckets raises
1293 * store() throughput by 5%, but until I figure this out, I can't
1294 * allow for this to go into production.
1296 * It is reported fixed in 5.005, hence the #if.
1298 #if PERL_VERSION >= 5
1299 #define HBUCKETS 4096 /* Buckets for %hseen */
1300 #ifndef USE_PTR_TABLE
1301 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1306 * The `hclass' hash uses the same settings as `hseen' above, but it is
1307 * used to assign sequential tags (numbers) to class names for blessed
1310 * We turn the shared key optimization on.
1313 cxt->hclass = newHV(); /* Where seen classnames are stored */
1315 #if PERL_VERSION >= 5
1316 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1320 * The `hook' hash table is used to keep track of the references on
1321 * the STORABLE_freeze hook routines, when found in some class name.
1323 * It is assumed that the inheritance tree will not be changed during
1324 * storing, and that no new method will be dynamically created by the
1328 cxt->hook = newHV(); /* Table where hooks are cached */
1331 * The `hook_seen' array keeps track of all the SVs returned by
1332 * STORABLE_freeze hooks for us to serialize, so that they are not
1333 * reclaimed until the end of the serialization process. Each SV is
1334 * only stored once, the first time it is seen.
1337 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1341 * clean_store_context
1343 * Clean store context by
1345 static void clean_store_context(pTHX_ stcxt_t *cxt)
1349 TRACEME(("clean_store_context"));
1351 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1354 * Insert real values into hashes where we stored faked pointers.
1357 #ifndef USE_PTR_TABLE
1359 hv_iterinit(cxt->hseen);
1360 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1361 HeVAL(he) = &PL_sv_undef;
1366 hv_iterinit(cxt->hclass);
1367 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1368 HeVAL(he) = &PL_sv_undef;
1372 * And now dispose of them...
1374 * The surrounding if() protection has been added because there might be
1375 * some cases where this routine is called more than once, during
1376 * exceptionnal events. This was reported by Marc Lehmann when Storable
1377 * is executed from mod_perl, and the fix was suggested by him.
1378 * -- RAM, 20/12/2000
1381 #ifdef USE_PTR_TABLE
1383 struct ptr_tbl *pseen = cxt->pseen;
1385 ptr_table_free(pseen);
1387 assert(!cxt->hseen);
1390 HV *hseen = cxt->hseen;
1393 sv_free((SV *) hseen);
1398 HV *hclass = cxt->hclass;
1401 sv_free((SV *) hclass);
1405 HV *hook = cxt->hook;
1408 sv_free((SV *) hook);
1411 if (cxt->hook_seen) {
1412 AV *hook_seen = cxt->hook_seen;
1414 av_undef(hook_seen);
1415 sv_free((SV *) hook_seen);
1418 cxt->forgive_me = -1; /* Fetched from perl if needed */
1419 cxt->deparse = -1; /* Idem */
1421 SvREFCNT_dec(cxt->eval);
1423 cxt->eval = NULL; /* Idem */
1424 cxt->canonical = -1; /* Idem */
1430 * init_retrieve_context
1432 * Initialize a new retrieve context for real recursion.
1434 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1436 TRACEME(("init_retrieve_context"));
1439 * The hook hash table is used to keep track of the references on
1440 * the STORABLE_thaw hook routines, when found in some class name.
1442 * It is assumed that the inheritance tree will not be changed during
1443 * storing, and that no new method will be dynamically created by the
1447 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1449 #ifdef USE_PTR_TABLE
1454 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1455 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1456 * the correspondance between the tags and the tag number used by the
1457 * new retrieve routines.
1460 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1463 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1464 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1465 cxt->aclass = newAV(); /* Where seen classnames are kept */
1466 cxt->tagnum = 0; /* Have to count objects... */
1467 cxt->classnum = 0; /* ...and class names as well */
1468 cxt->optype = optype;
1469 cxt->s_tainted = is_tainted;
1470 cxt->entry = 1; /* No recursion yet */
1471 #ifndef HAS_RESTRICTED_HASHES
1472 cxt->derestrict = -1; /* Fetched from perl if needed */
1474 #ifndef HAS_UTF8_ALL
1475 cxt->use_bytes = -1; /* Fetched from perl if needed */
1477 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1481 * clean_retrieve_context
1483 * Clean retrieve context by
1485 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1487 TRACEME(("clean_retrieve_context"));
1489 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1492 AV *aseen = cxt->aseen;
1495 sv_free((SV *) aseen);
1497 cxt->where_is_undef = -1;
1500 AV *aclass = cxt->aclass;
1503 sv_free((SV *) aclass);
1507 HV *hook = cxt->hook;
1510 sv_free((SV *) hook);
1514 HV *hseen = cxt->hseen;
1517 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1520 #ifndef HAS_RESTRICTED_HASHES
1521 cxt->derestrict = -1; /* Fetched from perl if needed */
1523 #ifndef HAS_UTF8_ALL
1524 cxt->use_bytes = -1; /* Fetched from perl if needed */
1526 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1534 * A workaround for the CROAK bug: cleanup the last context.
1536 static void clean_context(pTHX_ stcxt_t *cxt)
1538 TRACEME(("clean_context"));
1540 ASSERT(cxt->s_dirty, ("dirty context"));
1545 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1547 if (cxt->optype & ST_RETRIEVE)
1548 clean_retrieve_context(aTHX_ cxt);
1549 else if (cxt->optype & ST_STORE)
1550 clean_store_context(aTHX_ cxt);
1554 ASSERT(!cxt->s_dirty, ("context is clean"));
1555 ASSERT(cxt->entry == 0, ("context is reset"));
1561 * Allocate a new context and push it on top of the parent one.
1562 * This new context is made globally visible via SET_STCXT().
1564 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1568 TRACEME(("allocate_context"));
1570 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1572 NEW_STORABLE_CXT_OBJ(cxt);
1573 cxt->prev = parent_cxt->my_sv;
1576 ASSERT(!cxt->s_dirty, ("clean context"));
1584 * Free current context, which cannot be the "root" one.
1585 * Make the context underneath globally visible via SET_STCXT().
1587 static void free_context(pTHX_ stcxt_t *cxt)
1589 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1591 TRACEME(("free_context"));
1593 ASSERT(!cxt->s_dirty, ("clean context"));
1594 ASSERT(prev, ("not freeing root context"));
1596 SvREFCNT_dec(cxt->my_sv);
1599 ASSERT(cxt, ("context not void"));
1609 * Tells whether we're in the middle of a store operation.
1611 static int is_storing(pTHX)
1615 return cxt->entry && (cxt->optype & ST_STORE);
1621 * Tells whether we're in the middle of a retrieve operation.
1623 static int is_retrieving(pTHX)
1627 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1631 * last_op_in_netorder
1633 * Returns whether last operation was made using network order.
1635 * This is typically out-of-band information that might prove useful
1636 * to people wishing to convert native to network order data when used.
1638 static int last_op_in_netorder(pTHX)
1642 return cxt->netorder;
1646 *** Hook lookup and calling routines.
1652 * A wrapper on gv_fetchmethod_autoload() which caches results.
1654 * Returns the routine reference as an SV*, or null if neither the package
1655 * nor its ancestors know about the method.
1657 static SV *pkg_fetchmeth(
1665 const char *hvname = HvNAME_get(pkg);
1669 * The following code is the same as the one performed by UNIVERSAL::can
1673 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1674 if (gv && isGV(gv)) {
1675 sv = newRV((SV*) GvCV(gv));
1676 TRACEME(("%s->%s: 0x%"UVxf, hvname, method, PTR2UV(sv)));
1678 sv = newSVsv(&PL_sv_undef);
1679 TRACEME(("%s->%s: not found", hvname, method));
1683 * Cache the result, ignoring failure: if we can't store the value,
1684 * it just won't be cached.
1687 (void) hv_store(cache, hvname, strlen(hvname), sv, 0);
1689 return SvOK(sv) ? sv : (SV *) 0;
1695 * Force cached value to be undef: hook ignored even if present.
1697 static void pkg_hide(
1703 const char *hvname = HvNAME_get(pkg);
1704 (void) hv_store(cache,
1705 hvname, strlen(hvname), newSVsv(&PL_sv_undef), 0);
1711 * Discard cached value: a whole fetch loop will be retried at next lookup.
1713 static void pkg_uncache(
1719 const char *hvname = HvNAME_get(pkg);
1720 (void) hv_delete(cache, hvname, strlen(hvname), G_DISCARD);
1726 * Our own "UNIVERSAL::can", which caches results.
1728 * Returns the routine reference as an SV*, or null if the object does not
1729 * know about the method.
1739 const char *hvname = HvNAME_get(pkg);
1741 TRACEME(("pkg_can for %s->%s", hvname, method));
1744 * Look into the cache to see whether we already have determined
1745 * where the routine was, if any.
1747 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1748 * that only one hook (i.e. always the same) is cached in a given cache.
1751 svh = hv_fetch(cache, hvname, strlen(hvname), FALSE);
1755 TRACEME(("cached %s->%s: not found", hvname, method));
1758 TRACEME(("cached %s->%s: 0x%"UVxf,
1759 hvname, method, PTR2UV(sv)));
1764 TRACEME(("not cached yet"));
1765 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1771 * Call routine as obj->hook(av) in scalar context.
1772 * Propagates the single returned value if not called in void context.
1774 static SV *scalar_call(
1786 TRACEME(("scalar_call (cloning=%d)", cloning));
1793 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1795 SV **ary = AvARRAY(av);
1796 int cnt = AvFILLp(av) + 1;
1798 XPUSHs(ary[0]); /* Frozen string */
1799 for (i = 1; i < cnt; i++) {
1800 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1801 i, PTR2UV(ary[i])));
1802 XPUSHs(sv_2mortal(newRV(ary[i])));
1807 TRACEME(("calling..."));
1808 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1809 TRACEME(("count = %d", count));
1815 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1828 * Call routine obj->hook(cloning) in list context.
1829 * Returns the list of returned values in an array.
1831 static AV *array_call(
1842 TRACEME(("array_call (cloning=%d)", cloning));
1848 XPUSHs(obj); /* Target object */
1849 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1852 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1857 for (i = count - 1; i >= 0; i--) {
1859 av_store(av, i, SvREFCNT_inc(sv));
1872 * Lookup the class name in the `hclass' table and either assign it a new ID
1873 * or return the existing one, by filling in `classnum'.
1875 * Return true if the class was known, false if the ID was just generated.
1877 static int known_class(
1880 char *name, /* Class name */
1881 int len, /* Name length */
1885 HV *hclass = cxt->hclass;
1887 TRACEME(("known_class (%s)", name));
1890 * Recall that we don't store pointers in this hash table, but tags.
1891 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1894 svh = hv_fetch(hclass, name, len, FALSE);
1896 *classnum = LOW_32BITS(*svh);
1901 * Unknown classname, we need to record it.
1905 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1906 CROAK(("Unable to record new classname"));
1908 *classnum = cxt->classnum;
1913 *** Sepcific store routines.
1919 * Store a reference.
1920 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1922 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1925 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1928 * Follow reference, and check if target is overloaded.
1934 TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1939 HV *stash = (HV *) SvSTASH(sv);
1940 if (stash && Gv_AMG(stash)) {
1941 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1942 PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1944 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1946 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1948 return store(aTHX_ cxt, sv);
1956 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1957 * The <data> section is omitted if <length> is 0.
1959 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1960 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1962 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
1967 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1969 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1972 * For efficiency, break the SV encapsulation by peaking at the flags
1973 * directly without using the Perl macros to avoid dereferencing
1974 * sv->sv_flags each time we wish to check the flags.
1977 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1978 if (sv == &PL_sv_undef) {
1979 TRACEME(("immortal undef"));
1980 PUTMARK(SX_SV_UNDEF);
1982 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
1989 * Always store the string representation of a scalar if it exists.
1990 * Gisle Aas provided me with this test case, better than a long speach:
1992 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1993 * SV = PVNV(0x80c8520)
1995 * FLAGS = (NOK,POK,pNOK,pPOK)
1998 * PV = 0x80c83d0 "abc"\0
2002 * Write SX_SCALAR, length, followed by the actual data.
2004 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
2005 * appropriate, followed by the actual (binary) data. A double
2006 * is written as a string if network order, for portability.
2008 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
2009 * The reason is that when the scalar value is tainted, the SvNOK(sv)
2012 * The test for a read-only scalar with both POK and NOK set is meant
2013 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
2014 * address comparison for each scalar we store.
2017 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
2019 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
2020 if (sv == &PL_sv_yes) {
2021 TRACEME(("immortal yes"));
2023 } else if (sv == &PL_sv_no) {
2024 TRACEME(("immortal no"));
2027 pv = SvPV(sv, len); /* We know it's SvPOK */
2028 goto string; /* Share code below */
2030 } else if (flags & SVf_POK) {
2031 /* public string - go direct to string read. */
2032 goto string_readlen;
2034 #if (PATCHLEVEL <= 6)
2035 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
2036 direct if NV flag is off. */
2037 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
2039 /* 5.7 rules are that if IV public flag is set, IV value is as
2040 good, if not better, than NV value. */
2046 * Will come here from below with iv set if double is an integer.
2050 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2052 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
2053 * (for example) and that ends up in the optimised small integer
2056 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
2057 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
2058 goto string_readlen;
2062 * Optimize small integers into a single byte, otherwise store as
2063 * a real integer (converted into network order if they asked).
2066 if (iv >= -128 && iv <= 127) {
2067 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
2070 TRACEME(("small integer stored as %d", siv));
2071 } else if (cxt->netorder) {
2073 TRACEME(("no htonl, fall back to string for integer"));
2074 goto string_readlen;
2082 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2083 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
2085 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
2086 /* Bigger than 32 bits. */
2087 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2088 goto string_readlen;
2092 niv = (I32) htonl((I32) iv);
2093 TRACEME(("using network order"));
2098 PUTMARK(SX_INTEGER);
2099 WRITE(&iv, sizeof(iv));
2102 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2103 } else if (flags & SVf_NOK) {
2105 #if (PATCHLEVEL <= 6)
2108 * Watch for number being an integer in disguise.
2110 if (nv == (NV) (iv = I_V(nv))) {
2111 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2112 goto integer; /* Share code above */
2117 if (SvIOK_notUV(sv)) {
2119 goto integer; /* Share code above */
2124 if (cxt->netorder) {
2125 TRACEME(("double %"NVff" stored as string", nv));
2126 goto string_readlen; /* Share code below */
2130 WRITE(&nv, sizeof(nv));
2132 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2134 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2135 I32 wlen; /* For 64-bit machines */
2141 * Will come here from above if it was readonly, POK and NOK but
2142 * neither &PL_sv_yes nor &PL_sv_no.
2146 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2148 STORE_UTF8STR(pv, wlen);
2150 STORE_SCALAR(pv, wlen);
2151 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2152 PTR2UV(sv), SvPVX(sv), (IV)len));
2154 CROAK(("Can't determine type of %s(0x%"UVxf")",
2155 sv_reftype(sv, FALSE),
2157 return 0; /* Ok, no recursion on scalars */
2165 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2166 * Each item is stored as <object>.
2168 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2171 I32 len = av_len(av) + 1;
2175 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2178 * Signal array by emitting SX_ARRAY, followed by the array length.
2183 TRACEME(("size = %d", len));
2186 * Now store each item recursively.
2189 for (i = 0; i < len; i++) {
2190 sav = av_fetch(av, i, 0);
2192 TRACEME(("(#%d) undef item", i));
2196 TRACEME(("(#%d) item", i));
2197 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2201 TRACEME(("ok (array)"));
2207 #if (PATCHLEVEL <= 6)
2213 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2216 sortcmp(const void *a, const void *b)
2218 #if defined(USE_ITHREADS)
2220 #endif /* USE_ITHREADS */
2221 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2224 #endif /* PATCHLEVEL <= 6 */
2229 * Store a hash table.
2231 * For a "normal" hash (not restricted, no utf8 keys):
2233 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2234 * Values are stored as <object>.
2235 * Keys are stored as <length> <data>, the <data> section being omitted
2238 * For a "fancy" hash (restricted or utf8 keys):
2240 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2242 * Values are stored as <object>.
2243 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2245 * Currently the only hash flag is "restriced"
2246 * Key flags are as for hv.h
2248 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2252 #ifdef HAS_RESTRICTED_HASHES
2261 int flagged_hash = ((SvREADONLY(hv)
2262 #ifdef HAS_HASH_KEY_FLAGS
2266 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2269 /* needs int cast for C++ compilers, doesn't it? */
2270 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2273 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2277 * Signal hash by emitting SX_HASH, followed by the table length.
2281 PUTMARK(SX_FLAG_HASH);
2282 PUTMARK(hash_flags);
2287 TRACEME(("size = %d", len));
2290 * Save possible iteration state via each() on that table.
2293 riter = HvRITER_get(hv);
2294 eiter = HvEITER_get(hv);
2298 * Now store each item recursively.
2300 * If canonical is defined to some true value then store each
2301 * key/value pair in sorted order otherwise the order is random.
2302 * Canonical order is irrelevant when a deep clone operation is performed.
2304 * Fetch the value from perl only once per store() operation, and only
2309 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2310 (cxt->canonical < 0 && (cxt->canonical =
2311 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2314 * Storing in order, sorted by key.
2315 * Run through the hash, building up an array of keys in a
2316 * mortal array, sort the array and then run through the
2322 /*av_extend (av, len);*/
2324 TRACEME(("using canonical order"));
2326 for (i = 0; i < len; i++) {
2327 #ifdef HAS_RESTRICTED_HASHES
2328 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2330 HE *he = hv_iternext(hv);
2332 SV *key = hv_iterkeysv(he);
2333 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2338 for (i = 0; i < len; i++) {
2339 #ifdef HAS_RESTRICTED_HASHES
2340 int placeholders = (int)HvPLACEHOLDERS_get(hv);
2342 unsigned char flags = 0;
2346 SV *key = av_shift(av);
2347 /* This will fail if key is a placeholder.
2348 Track how many placeholders we have, and error if we
2350 HE *he = hv_fetch_ent(hv, key, 0, 0);
2354 if (!(val = HeVAL(he))) {
2355 /* Internal error, not I/O error */
2359 #ifdef HAS_RESTRICTED_HASHES
2360 /* Should be a placeholder. */
2361 if (placeholders-- < 0) {
2362 /* This should not happen - number of
2363 retrieves should be identical to
2364 number of placeholders. */
2367 /* Value is never needed, and PL_sv_undef is
2368 more space efficient to store. */
2371 ("Flags not 0 but %d", flags));
2372 flags = SHV_K_PLACEHOLDER;
2379 * Store value first.
2382 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2384 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2389 * Keys are written after values to make sure retrieval
2390 * can be optimal in terms of memory usage, where keys are
2391 * read into a fixed unique buffer called kbuf.
2392 * See retrieve_hash() for details.
2395 /* Implementation of restricted hashes isn't nicely
2397 if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
2398 flags |= SHV_K_LOCKED;
2401 keyval = SvPV(key, keylen_tmp);
2402 keylen = keylen_tmp;
2403 #ifdef HAS_UTF8_HASHES
2404 /* If you build without optimisation on pre 5.6
2405 then nothing spots that SvUTF8(key) is always 0,
2406 so the block isn't optimised away, at which point
2407 the linker dislikes the reference to
2410 const char *keysave = keyval;
2411 bool is_utf8 = TRUE;
2413 /* Just casting the &klen to (STRLEN) won't work
2414 well if STRLEN and I32 are of different widths.
2416 keyval = (char*)bytes_from_utf8((U8*)keyval,
2420 /* If we were able to downgrade here, then than
2421 means that we have a key which only had chars
2422 0-255, but was utf8 encoded. */
2424 if (keyval != keysave) {
2425 keylen = keylen_tmp;
2426 flags |= SHV_K_WASUTF8;
2428 /* keylen_tmp can't have changed, so no need
2429 to assign back to keylen. */
2430 flags |= SHV_K_UTF8;
2437 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2439 /* This is a workaround for a bug in 5.8.0
2440 that causes the HEK_WASUTF8 flag to be
2441 set on an HEK without the hash being
2442 marked as having key flags. We just
2443 cross our fingers and drop the flag.
2445 assert (flags == 0 || flags == SHV_K_WASUTF8);
2446 TRACEME(("(#%d) key '%s'", i, keyval));
2450 WRITE(keyval, keylen);
2451 if (flags & SHV_K_WASUTF8)
2456 * Free up the temporary array
2465 * Storing in "random" order (in the order the keys are stored
2466 * within the hash). This is the default and will be faster!
2469 for (i = 0; i < len; i++) {
2472 unsigned char flags;
2473 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2474 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2476 HE *he = hv_iternext(hv);
2478 SV *val = (he ? hv_iterval(hv, he) : 0);
2483 return 1; /* Internal error, not I/O error */
2485 /* Implementation of restricted hashes isn't nicely
2488 = (((hash_flags & SHV_RESTRICTED)
2490 ? SHV_K_LOCKED : 0);
2492 if (val == &PL_sv_placeholder) {
2493 flags |= SHV_K_PLACEHOLDER;
2498 * Store value first.
2501 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2503 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2507 hek = HeKEY_hek(he);
2509 if (len == HEf_SVKEY) {
2510 /* This is somewhat sick, but the internal APIs are
2511 * such that XS code could put one of these in in
2513 * Maybe we should be capable of storing one if
2516 key_sv = HeKEY_sv(he);
2517 flags |= SHV_K_ISSV;
2519 /* Regular string key. */
2520 #ifdef HAS_HASH_KEY_FLAGS
2522 flags |= SHV_K_UTF8;
2523 if (HEK_WASUTF8(hek))
2524 flags |= SHV_K_WASUTF8;
2530 * Keys are written after values to make sure retrieval
2531 * can be optimal in terms of memory usage, where keys are
2532 * read into a fixed unique buffer called kbuf.
2533 * See retrieve_hash() for details.
2538 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2540 /* This is a workaround for a bug in 5.8.0
2541 that causes the HEK_WASUTF8 flag to be
2542 set on an HEK without the hash being
2543 marked as having key flags. We just
2544 cross our fingers and drop the flag.
2546 assert (flags == 0 || flags == SHV_K_WASUTF8);
2547 TRACEME(("(#%d) key '%s'", i, key));
2549 if (flags & SHV_K_ISSV) {
2550 store(aTHX_ cxt, key_sv);
2559 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2562 HvRITER_set(hv, riter); /* Restore hash iterator state */
2563 HvEITER_set(hv, eiter);
2571 * Store a code reference.
2573 * Layout is SX_CODE <length> followed by a scalar containing the perl
2574 * source code of the code reference.
2576 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2578 #if PERL_VERSION < 6
2580 * retrieve_code does not work with perl 5.005 or less
2582 return store_other(aTHX_ cxt, (SV*)cv);
2587 SV *text, *bdeparse;
2589 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2592 cxt->deparse == 0 ||
2593 (cxt->deparse < 0 && !(cxt->deparse =
2594 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2596 return store_other(aTHX_ cxt, (SV*)cv);
2600 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2601 * blessed code references.
2603 /* Ownership of both SVs is passed to load_module, which frees them. */
2604 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2610 * create the B::Deparse object
2614 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2616 count = call_method("new", G_SCALAR);
2619 CROAK(("Unexpected return value from B::Deparse::new\n"));
2623 * call the coderef2text method
2627 XPUSHs(bdeparse); /* XXX is this already mortal? */
2628 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2630 count = call_method("coderef2text", G_SCALAR);
2633 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2637 reallen = strlen(SvPV_nolen(text));
2640 * Empty code references or XS functions are deparsed as
2641 * "(prototype) ;" or ";".
2644 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2645 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2649 * Signal code by emitting SX_CODE.
2653 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2654 TRACEME(("size = %d", len));
2655 TRACEME(("code = %s", SvPV_nolen(text)));
2658 * Now store the source code.
2661 STORE_SCALAR(SvPV_nolen(text), len);
2666 TRACEME(("ok (code)"));
2675 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2676 * a special mark, followed by the underlying tied object. For instance, when
2677 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2678 * <hash object> stands for the serialization of the tied hash.
2680 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2685 int svt = SvTYPE(sv);
2688 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2691 * We have a small run-time penalty here because we chose to factorise
2692 * all tieds objects into the same routine, and not have a store_tied_hash,
2693 * a store_tied_array, etc...
2695 * Don't use a switch() statement, as most compilers don't optimize that
2696 * well for 2/3 values. An if() else if() cascade is just fine. We put
2697 * tied hashes first, as they are the most likely beasts.
2700 if (svt == SVt_PVHV) {
2701 TRACEME(("tied hash"));
2702 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2703 } else if (svt == SVt_PVAV) {
2704 TRACEME(("tied array"));
2705 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2707 TRACEME(("tied scalar"));
2708 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2712 if (!(mg = mg_find(sv, mtype)))
2713 CROAK(("No magic '%c' found while storing tied %s", mtype,
2714 (svt == SVt_PVHV) ? "hash" :
2715 (svt == SVt_PVAV) ? "array" : "scalar"));
2718 * The mg->mg_obj found by mg_find() above actually points to the
2719 * underlying tied Perl object implementation. For instance, if the
2720 * original SV was that of a tied array, then mg->mg_obj is an AV.
2722 * Note that we store the Perl object as-is. We don't call its FETCH
2723 * method along the way. At retrieval time, we won't call its STORE
2724 * method either, but the tieing magic will be re-installed. In itself,
2725 * that ensures that the tieing semantics are preserved since futher
2726 * accesses on the retrieved object will indeed call the magic methods...
2729 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2730 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2731 if ((ret = store(aTHX_ cxt, obj)))
2734 TRACEME(("ok (tied)"));
2742 * Stores a reference to an item within a tied structure:
2744 * . \$h{key}, stores both the (tied %h) object and 'key'.
2745 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2747 * Layout is therefore either:
2748 * SX_TIED_KEY <object> <key>
2749 * SX_TIED_IDX <object> <index>
2751 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2756 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2758 if (!(mg = mg_find(sv, 'p')))
2759 CROAK(("No magic 'p' found while storing reference to tied item"));
2762 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2766 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2767 PUTMARK(SX_TIED_KEY);
2768 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2770 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2773 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2775 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2778 I32 idx = mg->mg_len;
2780 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2781 PUTMARK(SX_TIED_IDX);
2782 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2784 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2787 TRACEME(("store_tied_item: storing IDX %d", idx));
2792 TRACEME(("ok (tied item)"));
2798 * store_hook -- dispatched manually, not via sv_store[]
2800 * The blessed SV is serialized by a hook.
2804 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2806 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2807 * the trailing part [] is present, the type of object (scalar, array or hash).
2808 * There is also a bit which says how the classname is stored between:
2813 * and when the <index> form is used (classname already seen), the "large
2814 * classname" bit in <flags> indicates how large the <index> is.
2816 * The serialized string returned by the hook is of length <len2> and comes
2817 * next. It is an opaque string for us.
2819 * Those <len3> object IDs which are listed last represent the extra references
2820 * not directly serialized by the hook, but which are linked to the object.
2822 * When recursion is mandated to resolve object-IDs not yet seen, we have
2823 * instead, with <header> being flags with bits set to indicate the object type
2824 * and that recursion was indeed needed:
2826 * SX_HOOK <header> <object> <header> <object> <flags>
2828 * that same header being repeated between serialized objects obtained through
2829 * recursion, until we reach flags indicating no recursion, at which point
2830 * we know we've resynchronized with a single layout, after <flags>.
2832 * When storing a blessed ref to a tied variable, the following format is
2835 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2837 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2838 * real object type is held in the <extra> flag. At the very end of the
2839 * serialization stream, the underlying magic object is serialized, just like
2840 * any other tied variable.
2842 static int store_hook(
2856 int count; /* really len3 + 1 */
2857 unsigned char flags;
2860 int recursed = 0; /* counts recursion */
2861 int obj_type; /* object type, on 2 bits */
2864 int clone = cxt->optype & ST_CLONE;
2865 char mtype = '\0'; /* for blessed ref to tied structures */
2866 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2868 TRACEME(("store_hook, classname \"%s\", tagged #%d", HvNAME_get(pkg), cxt->tagnum));
2871 * Determine object type on 2 bits.
2876 obj_type = SHT_SCALAR;
2879 obj_type = SHT_ARRAY;
2882 obj_type = SHT_HASH;
2886 * Produced by a blessed ref to a tied data structure, $o in the
2887 * following Perl code.
2891 * my $o = bless \%h, 'BAR';
2893 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2894 * (since we have only 2 bits in <flags> to store the type), and an
2895 * <extra> byte flag will be emitted after the FIRST <flags> in the
2896 * stream, carrying what we put in `eflags'.
2898 obj_type = SHT_EXTRA;
2899 switch (SvTYPE(sv)) {
2901 eflags = (unsigned char) SHT_THASH;
2905 eflags = (unsigned char) SHT_TARRAY;
2909 eflags = (unsigned char) SHT_TSCALAR;
2915 CROAK(("Unexpected object type (%d) in store_hook()", type));
2917 flags = SHF_NEED_RECURSE | obj_type;
2919 classname = HvNAME_get(pkg);
2920 len = strlen(classname);
2923 * To call the hook, we need to fake a call like:
2925 * $object->STORABLE_freeze($cloning);
2927 * but we don't have the $object here. For instance, if $object is
2928 * a blessed array, what we have in `sv' is the array, and we can't
2929 * call a method on those.
2931 * Therefore, we need to create a temporary reference to the object and
2932 * make the call on that reference.
2935 TRACEME(("about to call STORABLE_freeze on class %s", classname));
2937 ref = newRV_noinc(sv); /* Temporary reference */
2938 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2939 SvRV_set(ref, NULL);
2940 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2942 count = AvFILLp(av) + 1;
2943 TRACEME(("store_hook, array holds %d items", count));
2946 * If they return an empty list, it means they wish to ignore the
2947 * hook for this class (and not just this instance -- that's for them
2948 * to handle if they so wish).
2950 * Simply disable the cached entry for the hook (it won't be recomputed
2951 * since it's present in the cache) and recurse to store_blessed().
2956 * They must not change their mind in the middle of a serialization.
2959 if (hv_fetch(cxt->hclass, classname, len, FALSE))
2960 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2961 (cxt->optype & ST_CLONE) ? "cloning" : "storing", classname));
2963 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
2965 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2966 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", classname));
2968 return store_blessed(aTHX_ cxt, sv, type, pkg);
2972 * Get frozen string.
2976 pv = SvPV(ary[0], len2);
2977 /* We can't use pkg_can here because it only caches one method per
2980 GV* gv = gv_fetchmethod_autoload(pkg, "STORABLE_attach", FALSE);
2981 if (gv && isGV(gv)) {
2983 CROAK(("Freeze cannot return references if %s class is using STORABLE_attach", classname));
2989 * If they returned more than one item, we need to serialize some
2990 * extra references if not already done.
2992 * Loop over the array, starting at position #1, and for each item,
2993 * ensure it is a reference, serialize it if not already done, and
2994 * replace the entry with the tag ID of the corresponding serialized
2997 * We CHEAT by not calling av_fetch() and read directly within the
3001 for (i = 1; i < count; i++) {
3002 #ifdef USE_PTR_TABLE
3010 AV *av_hook = cxt->hook_seen;
3013 CROAK(("Item #%d returned by STORABLE_freeze "
3014 "for %s is not a reference", i, classname));
3015 xsv = SvRV(rsv); /* Follow ref to know what to look for */
3018 * Look in hseen and see if we have a tag already.
3019 * Serialize entry if not done already, and get its tag.
3022 #ifdef USE_PTR_TABLE
3023 /* Fakery needed because ptr_table_fetch returns zero for a
3024 failure, whereas the existing code assumes that it can
3025 safely store a tag zero. So for ptr_tables we store tag+1
3027 if ((fake_tag = ptr_table_fetch(cxt->pseen, xsv)))
3028 goto sv_seen; /* Avoid moving code too far to the right */
3030 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
3031 goto sv_seen; /* Avoid moving code too far to the right */
3034 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
3037 * We need to recurse to store that object and get it to be known
3038 * so that we can resolve the list of object-IDs at retrieve time.
3040 * The first time we do this, we need to emit the proper header
3041 * indicating that we recursed, and what the type of object is (the
3042 * object we're storing via a user-hook). Indeed, during retrieval,
3043 * we'll have to create the object before recursing to retrieve the
3044 * others, in case those would point back at that object.
3047 /* [SX_HOOK] <flags> [<extra>] <object>*/
3051 if (obj_type == SHT_EXTRA)
3056 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
3059 #ifdef USE_PTR_TABLE
3060 fake_tag = ptr_table_fetch(cxt->pseen, xsv);
3062 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3064 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
3066 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3069 * It was the first time we serialized `xsv'.
3071 * Keep this SV alive until the end of the serialization: if we
3072 * disposed of it right now by decrementing its refcount, and it was
3073 * a temporary value, some next temporary value allocated during
3074 * another STORABLE_freeze might take its place, and we'd wrongly
3075 * assume that new SV was already serialized, based on its presence
3078 * Therefore, push it away in cxt->hook_seen.
3081 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
3085 * Dispose of the REF they returned. If we saved the `xsv' away
3086 * in the array of returned SVs, that will not cause the underlying
3087 * referenced SV to be reclaimed.
3090 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
3091 SvREFCNT_dec(rsv); /* Dispose of reference */
3094 * Replace entry with its tag (not a real SV, so no refcnt increment)
3097 #ifdef USE_PTR_TABLE
3098 tag = (SV *)--fake_tag;
3103 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
3104 i-1, PTR2UV(xsv), PTR2UV(tag)));
3108 * Allocate a class ID if not already done.
3110 * This needs to be done after the recursion above, since at retrieval
3111 * time, we'll see the inner objects first. Many thanks to
3112 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
3113 * proposed the right fix. -- RAM, 15/09/2000
3117 if (!known_class(aTHX_ cxt, classname, len, &classnum)) {
3118 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3119 classnum = -1; /* Mark: we must store classname */
3121 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3125 * Compute leading flags.
3129 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3130 flags |= SHF_LARGE_CLASSLEN;
3132 flags |= SHF_IDX_CLASSNAME;
3133 if (len2 > LG_SCALAR)
3134 flags |= SHF_LARGE_STRLEN;
3136 flags |= SHF_HAS_LIST;
3137 if (count > (LG_SCALAR + 1))
3138 flags |= SHF_LARGE_LISTLEN;
3141 * We're ready to emit either serialized form:
3143 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3144 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3146 * If we recursed, the SX_HOOK has already been emitted.
3149 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3150 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3151 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3153 /* SX_HOOK <flags> [<extra>] */
3157 if (obj_type == SHT_EXTRA)
3162 /* <len> <classname> or <index> */
3163 if (flags & SHF_IDX_CLASSNAME) {
3164 if (flags & SHF_LARGE_CLASSLEN)
3167 unsigned char cnum = (unsigned char) classnum;
3171 if (flags & SHF_LARGE_CLASSLEN)
3174 unsigned char clen = (unsigned char) len;
3177 WRITE(classname, len); /* Final \0 is omitted */
3180 /* <len2> <frozen-str> */
3181 if (flags & SHF_LARGE_STRLEN) {
3182 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3183 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3185 unsigned char clen = (unsigned char) len2;
3189 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3191 /* [<len3> <object-IDs>] */
3192 if (flags & SHF_HAS_LIST) {
3193 int len3 = count - 1;
3194 if (flags & SHF_LARGE_LISTLEN)
3197 unsigned char clen = (unsigned char) len3;
3202 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3203 * real pointer, rather a tag number, well under the 32-bit limit.
3206 for (i = 1; i < count; i++) {
3207 I32 tagval = htonl(LOW_32BITS(ary[i]));
3209 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3214 * Free the array. We need extra care for indices after 0, since they
3215 * don't hold real SVs but integers cast.
3219 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3224 * If object was tied, need to insert serialization of the magic object.
3227 if (obj_type == SHT_EXTRA) {
3230 if (!(mg = mg_find(sv, mtype))) {
3231 int svt = SvTYPE(sv);
3232 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3233 mtype, (svt == SVt_PVHV) ? "hash" :
3234 (svt == SVt_PVAV) ? "array" : "scalar"));
3237 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3238 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3244 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3252 * store_blessed -- dispatched manually, not via sv_store[]
3254 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3255 * of its ancestors. If there is, then redispatch to store_hook();
3257 * Otherwise, the blessed SV is stored using the following layout:
3259 * SX_BLESS <flag> <len> <classname> <object>
3261 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3262 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3263 * Otherwise, the low order bits give the length, thereby giving a compact
3264 * representation for class names less than 127 chars long.
3266 * Each <classname> seen is remembered and indexed, so that the next time
3267 * an object in the blessed in the same <classname> is stored, the following
3270 * SX_IX_BLESS <flag> <index> <object>
3272 * where <index> is the classname index, stored on 0 or 4 bytes depending
3273 * on the high-order bit in flag (same encoding as above for <len>).
3275 static int store_blessed(
3287 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME_get(pkg)));
3290 * Look for a hook for this blessed SV and redirect to store_hook()
3294 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3296 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3299 * This is a blessed SV without any serialization hook.
3302 classname = HvNAME_get(pkg);
3303 len = strlen(classname);
3305 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3306 PTR2UV(sv), classname, cxt->tagnum));
3309 * Determine whether it is the first time we see that class name (in which
3310 * case it will be stored in the SX_BLESS form), or whether we already
3311 * saw that class name before (in which case the SX_IX_BLESS form will be
3315 if (known_class(aTHX_ cxt, classname, len, &classnum)) {
3316 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3317 PUTMARK(SX_IX_BLESS);
3318 if (classnum <= LG_BLESS) {
3319 unsigned char cnum = (unsigned char) classnum;
3322 unsigned char flag = (unsigned char) 0x80;
3327 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3329 if (len <= LG_BLESS) {
3330 unsigned char clen = (unsigned char) len;
3333 unsigned char flag = (unsigned char) 0x80;
3335 WLEN(len); /* Don't BER-encode, this should be rare */
3337 WRITE(classname, len); /* Final \0 is omitted */
3341 * Now emit the <object> part.
3344 return SV_STORE(type)(aTHX_ cxt, sv);
3350 * We don't know how to store the item we reached, so return an error condition.
3351 * (it's probably a GLOB, some CODE reference, etc...)
3353 * If they defined the `forgive_me' variable at the Perl level to some
3354 * true value, then don't croak, just warn, and store a placeholder string
3357 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3362 TRACEME(("store_other"));
3365 * Fetch the value from perl only once per store() operation.
3369 cxt->forgive_me == 0 ||
3370 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3371 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3373 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3375 warn("Can't store item %s(0x%"UVxf")",
3376 sv_reftype(sv, FALSE), PTR2UV(sv));
3379 * Store placeholder string as a scalar instead...
3382 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3383 PTR2UV(sv), (char) 0);
3386 STORE_SCALAR(buf, len);
3387 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3393 *** Store driving routines
3399 * WARNING: partially duplicates Perl's sv_reftype for speed.
3401 * Returns the type of the SV, identified by an integer. That integer
3402 * may then be used to index the dynamic routine dispatch table.
3404 static int sv_type(pTHX_ SV *sv)
3406 switch (SvTYPE(sv)) {
3411 * No need to check for ROK, that can't be set here since there
3412 * is no field capable of hodling the xrv_rv reference.
3420 * Starting from SVt_PV, it is possible to have the ROK flag
3421 * set, the pointer to the other SV being either stored in
3422 * the xrv_rv (in the case of a pure SVt_RV), or as the
3423 * xpv_pv field of an SVt_PV and its heirs.
3425 * However, those SV cannot be magical or they would be an
3426 * SVt_PVMG at least.
3428 return SvROK(sv) ? svis_REF : svis_SCALAR;
3430 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3431 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3432 return svis_TIED_ITEM;
3435 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3437 return SvROK(sv) ? svis_REF : svis_SCALAR;
3439 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3443 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3458 * Recursively store objects pointed to by the sv to the specified file.
3460 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3461 * object (one for which storage has started -- it may not be over if we have
3462 * a self-referenced structure). This data set forms a stored <object>.
3464 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3469 #ifdef USE_PTR_TABLE
3470 struct ptr_tbl *pseen = cxt->pseen;
3472 HV *hseen = cxt->hseen;
3475 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3478 * If object has already been stored, do not duplicate data.
3479 * Simply emit the SX_OBJECT marker followed by its tag data.
3480 * The tag is always written in network order.
3482 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3483 * real pointer, rather a tag number (watch the insertion code below).
3484 * That means it probably safe to assume it is well under the 32-bit limit,
3485 * and makes the truncation safe.
3486 * -- RAM, 14/09/1999
3489 #ifdef USE_PTR_TABLE
3490 svh = ptr_table_fetch(pseen, sv);
3492 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3497 if (sv == &PL_sv_undef) {
3498 /* We have seen PL_sv_undef before, but fake it as
3501 Not the simplest solution to making restricted
3502 hashes work on 5.8.0, but it does mean that
3503 repeated references to the one true undef will
3504 take up less space in the output file.
3506 /* Need to jump past the next hv_store, because on the
3507 second store of undef the old hash value will be
3508 SvREFCNT_dec()ed, and as Storable cheats horribly
3509 by storing non-SVs in the hash a SEGV will ensure.
3510 Need to increase the tag number so that the
3511 receiver has no idea what games we're up to. This
3512 special casing doesn't affect hooks that store
3513 undef, as the hook routine does its own lookup into
3514 hseen. Also this means that any references back
3515 to PL_sv_undef (from the pathological case of hooks
3516 storing references to it) will find the seen hash
3517 entry for the first time, as if we didn't have this
3518 hackery here. (That hseen lookup works even on 5.8.0
3519 because it's a key of &PL_sv_undef and a value
3520 which is a tag number, not a value which is
3524 goto undef_special_case;
3527 #ifdef USE_PTR_TABLE
3528 tagval = htonl(LOW_32BITS(((char *)svh)-1));
3530 tagval = htonl(LOW_32BITS(*svh));
3533 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3541 * Allocate a new tag and associate it with the address of the sv being
3542 * stored, before recursing...
3544 * In order to avoid creating new SvIVs to hold the tagnum we just
3545 * cast the tagnum to an SV pointer and store that in the hash. This
3546 * means that we must clean up the hash manually afterwards, but gives
3547 * us a 15% throughput increase.
3552 #ifdef USE_PTR_TABLE
3553 ptr_table_store(pseen, sv, INT2PTR(SV*, 1 + cxt->tagnum));
3555 if (!hv_store(hseen,
3556 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3561 * Store `sv' and everything beneath it, using appropriate routine.
3562 * Abort immediately if we get a non-zero status back.
3565 type = sv_type(aTHX_ sv);
3568 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3569 PTR2UV(sv), cxt->tagnum, type));
3572 HV *pkg = SvSTASH(sv);
3573 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3575 ret = SV_STORE(type)(aTHX_ cxt, sv);
3577 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3578 ret ? "FAILED" : "ok", PTR2UV(sv),
3579 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3587 * Write magic number and system information into the file.
3588 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3589 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3590 * All size and lenghts are written as single characters here.
3592 * Note that no byte ordering info is emitted when <network> is true, since
3593 * integers will be emitted in network order in that case.
3595 static int magic_write(pTHX_ stcxt_t *cxt)
3598 * Starting with 0.6, the "use_network_order" byte flag is also used to
3599 * indicate the version number of the binary image, encoded in the upper
3600 * bits. The bit 0 is always used to indicate network order.
3603 * Starting with 0.7, a full byte is dedicated to the minor version of
3604 * the binary format, which is incremented only when new markers are
3605 * introduced, for instance, but when backward compatibility is preserved.
3608 /* Make these at compile time. The WRITE() macro is sufficiently complex
3609 that it saves about 200 bytes doing it this way and only using it
3611 static const unsigned char network_file_header[] = {
3613 (STORABLE_BIN_MAJOR << 1) | 1,
3614 STORABLE_BIN_WRITE_MINOR
3616 static const unsigned char file_header[] = {
3618 (STORABLE_BIN_MAJOR << 1) | 0,
3619 STORABLE_BIN_WRITE_MINOR,
3620 /* sizeof the array includes the 0 byte at the end: */
3621 (char) sizeof (byteorderstr) - 1,
3623 (unsigned char) sizeof(int),
3624 (unsigned char) sizeof(long),
3625 (unsigned char) sizeof(char *),
3626 (unsigned char) sizeof(NV)
3628 #ifdef USE_56_INTERWORK_KLUDGE
3629 static const unsigned char file_header_56[] = {
3631 (STORABLE_BIN_MAJOR << 1) | 0,
3632 STORABLE_BIN_WRITE_MINOR,
3633 /* sizeof the array includes the 0 byte at the end: */
3634 (char) sizeof (byteorderstr_56) - 1,
3636 (unsigned char) sizeof(int),
3637 (unsigned char) sizeof(long),
3638 (unsigned char) sizeof(char *),
3639 (unsigned char) sizeof(NV)
3642 const unsigned char *header;
3645 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3647 if (cxt->netorder) {
3648 header = network_file_header;
3649 length = sizeof (network_file_header);
3651 #ifdef USE_56_INTERWORK_KLUDGE
3652 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3653 header = file_header_56;
3654 length = sizeof (file_header_56);
3658 header = file_header;
3659 length = sizeof (file_header);
3664 /* sizeof the array includes the 0 byte at the end. */
3665 header += sizeof (magicstr) - 1;
3666 length -= sizeof (magicstr) - 1;
3669 WRITE( (unsigned char*) header, length);
3671 if (!cxt->netorder) {
3672 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3673 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3674 (int) sizeof(int), (int) sizeof(long),
3675 (int) sizeof(char *), (int) sizeof(NV)));
3683 * Common code for store operations.
3685 * When memory store is requested (f = NULL) and a non null SV* is given in
3686 * `res', it is filled with a new SV created out of the memory buffer.
3688 * It is required to provide a non-null `res' when the operation type is not
3689 * dclone() and store() is performed to memory.
3691 static int do_store(
3702 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3703 ("must supply result SV pointer for real recursion to memory"));
3705 TRACEME(("do_store (optype=%d, netorder=%d)",
3706 optype, network_order));
3711 * Workaround for CROAK leak: if they enter with a "dirty" context,
3712 * free up memory for them now.
3716 clean_context(aTHX_ cxt);
3719 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3720 * re-enter store() via the hooks. We need to stack contexts.
3724 cxt = allocate_context(aTHX_ cxt);
3728 ASSERT(cxt->entry == 1, ("starting new recursion"));
3729 ASSERT(!cxt->s_dirty, ("clean context"));
3732 * Ensure sv is actually a reference. From perl, we called something
3734 * pstore(aTHX_ FILE, \@array);
3735 * so we must get the scalar value behing that reference.
3739 CROAK(("Not a reference"));
3740 sv = SvRV(sv); /* So follow it to know what to store */
3743 * If we're going to store to memory, reset the buffer.
3750 * Prepare context and emit headers.
3753 init_store_context(aTHX_ cxt, f, optype, network_order);
3755 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3756 return 0; /* Error */
3759 * Recursively store object...
3762 ASSERT(is_storing(aTHX), ("within store operation"));
3764 status = store(aTHX_ cxt, sv); /* Just do it! */
3767 * If they asked for a memory store and they provided an SV pointer,
3768 * make an SV string out of the buffer and fill their pointer.
3770 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3771 * an SV, since context cleanup might free the buffer if we did recurse.
3772 * (unless caller is dclone(), which is aware of that).
3775 if (!cxt->fio && res)
3776 *res = mbuf2sv(aTHX);
3781 * The "root" context is never freed, since it is meant to be always
3782 * handy for the common case where no recursion occurs at all (i.e.
3783 * we enter store() outside of any Storable code and leave it, period).
3784 * We know it's the "root" context because there's nothing stacked
3789 * When deep cloning, we don't free the context: doing so would force
3790 * us to copy the data in the memory buffer. Sicne we know we're
3791 * about to enter do_retrieve...
3794 clean_store_context(aTHX_ cxt);
3795 if (cxt->prev && !(cxt->optype & ST_CLONE))
3796 free_context(aTHX_ cxt);
3798 TRACEME(("do_store returns %d", status));
3806 * Store the transitive data closure of given object to disk.
3807 * Returns 0 on error, a true value otherwise.
3809 static int pstore(pTHX_ PerlIO *f, SV *sv)
3811 TRACEME(("pstore"));
3812 return do_store(aTHX_ f, sv, 0, FALSE, (SV**) 0);
3819 * Same as pstore(), but network order is used for integers and doubles are
3820 * emitted as strings.
3822 static int net_pstore(pTHX_ PerlIO *f, SV *sv)
3824 TRACEME(("net_pstore"));
3825 return do_store(aTHX_ f, sv, 0, TRUE, (SV**) 0);
3835 * Build a new SV out of the content of the internal memory buffer.
3837 static SV *mbuf2sv(pTHX)
3841 return newSVpv(mbase, MBUF_SIZE());
3847 * Store the transitive data closure of given object to memory.
3848 * Returns undef on error, a scalar value containing the data otherwise.
3850 static SV *mstore(pTHX_ SV *sv)
3854 TRACEME(("mstore"));
3856 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, FALSE, &out))
3857 return &PL_sv_undef;
3865 * Same as mstore(), but network order is used for integers and doubles are
3866 * emitted as strings.
3868 static SV *net_mstore(pTHX_ SV *sv)
3872 TRACEME(("net_mstore"));
3874 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, TRUE, &out))
3875 return &PL_sv_undef;
3881 *** Specific retrieve callbacks.
3887 * Return an error via croak, since it is not possible that we get here
3888 * under normal conditions, when facing a file produced via pstore().
3890 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname)
3893 cxt->ver_major != STORABLE_BIN_MAJOR &&
3894 cxt->ver_minor != STORABLE_BIN_MINOR
3896 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3897 cxt->fio ? "file" : "string",
3898 cxt->ver_major, cxt->ver_minor,
3899 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3901 CROAK(("Corrupted storable %s (binary v%d.%d)",
3902 cxt->fio ? "file" : "string",
3903 cxt->ver_major, cxt->ver_minor));
3906 return (SV *) 0; /* Just in case */
3910 * retrieve_idx_blessed
3912 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3913 * <index> can be coded on either 1 or 5 bytes.
3915 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3918 const char *classname;
3922 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3923 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3925 GETMARK(idx); /* Index coded on a single char? */
3930 * Fetch classname in `aclass'
3933 sva = av_fetch(cxt->aclass, idx, FALSE);
3935 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3937 classname = SvPVX(*sva); /* We know it's a PV, by construction */
3939 TRACEME(("class ID %d => %s", idx, classname));
3942 * Retrieve object and bless it.
3945 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3953 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3954 * <len> can be coded on either 1 or 5 bytes.
3956 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3960 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3961 char *classname = buf;
3963 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3964 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3967 * Decode class name length and read that name.
3969 * Short classnames have two advantages: their length is stored on one
3970 * single byte, and the string can be read on the stack.
3973 GETMARK(len); /* Length coded on a single char? */
3976 TRACEME(("** allocating %d bytes for class name", len+1));
3977 New(10003, classname, len+1, char);
3979 READ(classname, len);
3980 classname[len] = '\0'; /* Mark string end */
3983 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3986 TRACEME(("new class name \"%s\" will bear ID = %d", classname, cxt->classnum));
3988 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len)))
3992 * Retrieve object and bless it.
3995 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3996 if (classname != buf)
3997 Safefree(classname);
4005 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
4006 * with leading mark already read, as usual.
4008 * When recursion was involved during serialization of the object, there
4009 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
4010 * we reach a <flags> marker with the recursion bit cleared.
4012 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
4013 * is held in the <extra> byte, and if the object is tied, the serialized
4014 * magic object comes at the very end:
4016 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
4018 * This means the STORABLE_thaw hook will NOT get a tied variable during its
4019 * processing (since we won't have seen the magic object by the time the hook
4020 * is called). See comments below for why it was done that way.
4022 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname)
4025 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
4026 char *classname = buf;
4037 int clone = cxt->optype & ST_CLONE;
4039 unsigned int extra_type = 0;
4041 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
4042 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
4045 * Read flags, which tell us about the type, and whether we need to recurse.
4051 * Create the (empty) object, and mark it as seen.
4053 * This must be done now, because tags are incremented, and during
4054 * serialization, the object tag was affected before recursion could
4058 obj_type = flags & SHF_TYPE_MASK;
4064 sv = (SV *) newAV();
4067 sv = (SV *) newHV();
4071 * Read <extra> flag to know the type of the object.
4072 * Record associated magic type for later.
4074 GETMARK(extra_type);
4075 switch (extra_type) {
4081 sv = (SV *) newAV();
4085 sv = (SV *) newHV();
4089 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4093 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4095 SEEN(sv, 0, 0); /* Don't bless yet */
4098 * Whilst flags tell us to recurse, do so.
4100 * We don't need to remember the addresses returned by retrieval, because
4101 * all the references will be obtained through indirection via the object
4102 * tags in the object-ID list.
4104 * We need to decrement the reference count for these objects
4105 * because, if the user doesn't save a reference to them in the hook,
4106 * they must be freed when this context is cleaned.
4109 while (flags & SHF_NEED_RECURSE) {
4110 TRACEME(("retrieve_hook recursing..."));
4111 rv = retrieve(aTHX_ cxt, 0);
4115 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
4120 if (flags & SHF_IDX_CLASSNAME) {
4125 * Fetch index from `aclass'
4128 if (flags & SHF_LARGE_CLASSLEN)
4133 sva = av_fetch(cxt->aclass, idx, FALSE);
4135 CROAK(("Class name #%"IVdf" should have been seen already",
4138 classname = SvPVX(*sva); /* We know it's a PV, by construction */
4139 TRACEME(("class ID %d => %s", idx, classname));
4143 * Decode class name length and read that name.
4145 * NOTA BENE: even if the length is stored on one byte, we don't read
4146 * on the stack. Just like retrieve_blessed(), we limit the name to
4147 * LG_BLESS bytes. This is an arbitrary decision.
4150 if (flags & SHF_LARGE_CLASSLEN)
4155 if (len > LG_BLESS) {
4156 TRACEME(("** allocating %d bytes for class name", len+1));
4157 New(10003, classname, len+1, char);
4160 READ(classname, len);
4161 classname[len] = '\0'; /* Mark string end */
4164 * Record new classname.
4167 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len)))
4171 TRACEME(("class name: %s", classname));
4174 * Decode user-frozen string length and read it in an SV.
4176 * For efficiency reasons, we read data directly into the SV buffer.
4177 * To understand that code, read retrieve_scalar()
4180 if (flags & SHF_LARGE_STRLEN)
4185 frozen = NEWSV(10002, len2);
4187 SAFEREAD(SvPVX(frozen), len2, frozen);
4188 SvCUR_set(frozen, len2);
4189 *SvEND(frozen) = '\0';
4191 (void) SvPOK_only(frozen); /* Validates string pointer */
4192 if (cxt->s_tainted) /* Is input source tainted? */
4195 TRACEME(("frozen string: %d bytes", len2));
4198 * Decode object-ID list length, if present.
4201 if (flags & SHF_HAS_LIST) {
4202 if (flags & SHF_LARGE_LISTLEN)
4208 av_extend(av, len3 + 1); /* Leave room for [0] */
4209 AvFILLp(av) = len3; /* About to be filled anyway */
4213 TRACEME(("has %d object IDs to link", len3));
4216 * Read object-ID list into array.
4217 * Because we pre-extended it, we can cheat and fill it manually.
4219 * We read object tags and we can convert them into SV* on the fly
4220 * because we know all the references listed in there (as tags)
4221 * have been already serialized, hence we have a valid correspondance
4222 * between each of those tags and the recreated SV.
4226 SV **ary = AvARRAY(av);
4228 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
4235 svh = av_fetch(cxt->aseen, tag, FALSE);
4237 if (tag == cxt->where_is_undef) {
4238 /* av_fetch uses PL_sv_undef internally, hence this
4239 somewhat gruesome hack. */
4243 CROAK(("Object #%"IVdf" should have been retrieved already",
4248 ary[i] = SvREFCNT_inc(xsv);
4253 * Bless the object and look up the STORABLE_thaw hook.
4256 BLESS(sv, classname);
4258 /* Handle attach case; again can't use pkg_can because it only
4259 * caches one method */
4260 attach = gv_fetchmethod_autoload(SvSTASH(sv), "STORABLE_attach", FALSE);
4261 if (attach && isGV(attach)) {
4263 SV* attach_hook = newRV((SV*) GvCV(attach));
4266 CROAK(("STORABLE_attach called with unexpected references"));
4270 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4271 rv = newSVpv(classname, 0);
4272 attached = scalar_call(aTHX_ rv, attach_hook, clone, av, G_SCALAR);
4275 sv_derived_from(attached, classname))
4276 return SvRV(attached);
4277 CROAK(("STORABLE_attach did not return a %s object", classname));
4280 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4283 * Hook not found. Maybe they did not require the module where this
4284 * hook is defined yet?
4286 * If the load below succeeds, we'll be able to find the hook.
4287 * Still, it only works reliably when each class is defined in a
4291 TRACEME(("No STORABLE_thaw defined for objects of class %s", classname));
4292 TRACEME(("Going to load module '%s'", classname));
4293 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(classname, 0), Nullsv);
4296 * We cache results of pkg_can, so we need to uncache before attempting
4300 pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4301 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4304 CROAK(("No STORABLE_thaw defined for objects of class %s "
4305 "(even after a \"require %s;\")", classname, classname));
4309 * If we don't have an `av' yet, prepare one.
4310 * Then insert the frozen string as item [0].
4318 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4323 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4325 * where $object is our blessed (empty) object, $cloning is a boolean
4326 * telling whether we're running a deep clone, $frozen is the frozen
4327 * string the user gave us in his serializing hook, and @refs, which may
4328 * be empty, is the list of extra references he returned along for us
4331 * In effect, the hook is an alternate creation routine for the class,
4332 * the object itself being already created by the runtime.
4335 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4336 classname, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4339 (void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
4346 SvREFCNT_dec(frozen);
4349 if (!(flags & SHF_IDX_CLASSNAME) && classname != buf)
4350 Safefree(classname);
4353 * If we had an <extra> type, then the object was not as simple, and
4354 * we need to restore extra magic now.
4360 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4362 rv = retrieve(aTHX_ cxt, 0); /* Retrieve <magic object> */
4364 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4365 PTR2UV(rv), PTR2UV(sv)));
4367 switch (extra_type) {
4369 sv_upgrade(sv, SVt_PVMG);
4372 sv_upgrade(sv, SVt_PVAV);
4373 AvREAL_off((AV *)sv);
4376 sv_upgrade(sv, SVt_PVHV);
4379 CROAK(("Forgot to deal with extra type %d", extra_type));
4384 * Adding the magic only now, well after the STORABLE_thaw hook was called
4385 * means the hook cannot know it deals with an object whose variable is
4386 * tied. But this is happening when retrieving $o in the following case:
4390 * my $o = bless \%h, 'BAR';
4392 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4393 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4394 * hash but a tied one should not matter at all, and remain transparent.
4395 * This means the magic must be restored by Storable AFTER the hook is
4398 * That looks very reasonable to me, but then I've come up with this
4399 * after a bug report from David Nesting, who was trying to store such
4400 * an object and caused Storable to fail. And unfortunately, it was
4401 * also the easiest way to retrofit support for blessed ref to tied objects
4402 * into the existing design. -- RAM, 17/02/2001
4405 sv_magic(sv, rv, mtype, Nullch, 0);
4406 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4414 * Retrieve reference to some other scalar.
4415 * Layout is SX_REF <object>, with SX_REF already read.
4417 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname)
4422 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4425 * We need to create the SV that holds the reference to the yet-to-retrieve
4426 * object now, so that we may record the address in the seen table.
4427 * Otherwise, if the object to retrieve references us, we won't be able
4428 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4429 * do the retrieve first and use rv = newRV(sv) since it will be too late
4430 * for SEEN() recording.
4433 rv = NEWSV(10002, 0);
4434 SEEN(rv, cname, 0); /* Will return if rv is null */
4435 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4437 return (SV *) 0; /* Failed */
4440 * WARNING: breaks RV encapsulation.
4442 * Now for the tricky part. We have to upgrade our existing SV, so that
4443 * it is now an RV on sv... Again, we cheat by duplicating the code
4444 * held in newSVrv(), since we already got our SV from retrieve().
4448 * SvRV(rv) = SvREFCNT_inc(sv);
4450 * here because the reference count we got from retrieve() above is
4451 * already correct: if the object was retrieved from the file, then
4452 * its reference count is one. Otherwise, if it was retrieved via
4453 * an SX_OBJECT indication, a ref count increment was done.
4457 /* No need to do anything, as rv will already be PVMG. */
4458 assert (SvTYPE(rv) >= SVt_RV);
4460 sv_upgrade(rv, SVt_RV);
4463 SvRV_set(rv, sv); /* $rv = \$sv */
4466 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4474 * Retrieve weak reference to some other scalar.
4475 * Layout is SX_WEAKREF <object>, with SX_WEAKREF already read.
4477 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname)
4481 TRACEME(("retrieve_weakref (#%d)", cxt->tagnum));
4483 sv = retrieve_ref(aTHX_ cxt, cname);
4495 * retrieve_overloaded
4497 * Retrieve reference to some other scalar with overloading.
4498 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4500 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname)
4506 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4509 * Same code as retrieve_ref(), duplicated to avoid extra call.
4512 rv = NEWSV(10002, 0);
4513 SEEN(rv, cname, 0); /* Will return if rv is null */
4514 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4516 return (SV *) 0; /* Failed */
4519 * WARNING: breaks RV encapsulation.
4522 sv_upgrade(rv, SVt_RV);
4523 SvRV_set(rv, sv); /* $rv = \$sv */
4527 * Restore overloading magic.
4530 stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
4532 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4533 ") (package <unknown>)",
4534 sv_reftype(sv, FALSE),
4537 if (!Gv_AMG(stash)) {
4538 const char *package = HvNAME_get(stash);
4539 TRACEME(("No overloading defined for package %s", package));
4540 TRACEME(("Going to load module '%s'", package));
4541 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(package, 0), Nullsv);
4542 if (!Gv_AMG(stash)) {
4543 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4544 ") (package %s) (even after a \"require %s;\")",
4545 sv_reftype(sv, FALSE),
4553 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4559 * retrieve_weakoverloaded
4561 * Retrieve weak overloaded reference to some other scalar.
4562 * Layout is SX_WEAKOVERLOADED <object>, with SX_WEAKOVERLOADED already read.
4564 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname)
4568 TRACEME(("retrieve_weakoverloaded (#%d)", cxt->tagnum));
4570 sv = retrieve_overloaded(aTHX_ cxt, cname);
4582 * retrieve_tied_array
4584 * Retrieve tied array
4585 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4587 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname)
4592 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4594 tv = NEWSV(10002, 0);
4595 SEEN(tv, cname, 0); /* Will return if tv is null */
4596 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4598 return (SV *) 0; /* Failed */
4600 sv_upgrade(tv, SVt_PVAV);
4601 AvREAL_off((AV *)tv);
4602 sv_magic(tv, sv, 'P', Nullch, 0);
4603 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4605 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4611 * retrieve_tied_hash
4613 * Retrieve tied hash
4614 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4616 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname)
4621 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4623 tv = NEWSV(10002, 0);
4624 SEEN(tv, cname, 0); /* Will return if tv is null */
4625 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4627 return (SV *) 0; /* Failed */
4629 sv_upgrade(tv, SVt_PVHV);
4630 sv_magic(tv, sv, 'P', Nullch, 0);
4631 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4633 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4639 * retrieve_tied_scalar
4641 * Retrieve tied scalar
4642 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4644 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4647 SV *sv, *obj = NULL;
4649 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4651 tv = NEWSV(10002, 0);
4652 SEEN(tv, cname, 0); /* Will return if rv is null */
4653 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4655 return (SV *) 0; /* Failed */
4657 else if (SvTYPE(sv) != SVt_NULL) {
4661 sv_upgrade(tv, SVt_PVMG);
4662 sv_magic(tv, obj, 'q', Nullch, 0);
4665 /* Undo refcnt inc from sv_magic() */
4669 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4677 * Retrieve reference to value in a tied hash.
4678 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4680 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname)
4686 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4688 tv = NEWSV(10002, 0);
4689 SEEN(tv, cname, 0); /* Will return if tv is null */
4690 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4692 return (SV *) 0; /* Failed */
4694 key = retrieve(aTHX_ cxt, 0); /* Retrieve <key> */
4696 return (SV *) 0; /* Failed */
4698 sv_upgrade(tv, SVt_PVMG);
4699 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4700 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4701 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4709 * Retrieve reference to value in a tied array.
4710 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4712 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname)
4718 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4720 tv = NEWSV(10002, 0);
4721 SEEN(tv, cname, 0); /* Will return if tv is null */
4722 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4724 return (SV *) 0; /* Failed */
4726 RLEN(idx); /* Retrieve <idx> */
4728 sv_upgrade(tv, SVt_PVMG);
4729 sv_magic(tv, sv, 'p', Nullch, idx);
4730 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4739 * Retrieve defined long (string) scalar.
4741 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4742 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4743 * was not stored on a single byte.
4745 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname)
4751 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4754 * Allocate an empty scalar of the suitable length.
4757 sv = NEWSV(10002, len);
4758 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4761 sv_setpvn(sv, "", 0);
4766 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4768 * Now, for efficiency reasons, read data directly inside the SV buffer,
4769 * and perform the SV final settings directly by duplicating the final
4770 * work done by sv_setpv. Since we're going to allocate lots of scalars
4771 * this way, it's worth the hassle and risk.
4774 SAFEREAD(SvPVX(sv), len, sv);
4775 SvCUR_set(sv, len); /* Record C string length */
4776 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4777 (void) SvPOK_only(sv); /* Validate string pointer */
4778 if (cxt->s_tainted) /* Is input source tainted? */
4779 SvTAINT(sv); /* External data cannot be trusted */
4781 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4782 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4790 * Retrieve defined short (string) scalar.
4792 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4793 * The scalar is "short" so <length> is single byte. If it is 0, there
4794 * is no <data> section.
4796 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4802 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4805 * Allocate an empty scalar of the suitable length.
4808 sv = NEWSV(10002, len);
4809 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4812 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4817 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4818 * To make it defined with an empty length, upgrade it now...
4819 * Don't upgrade to a PV if the original type contains more
4820 * information than a scalar.
4822 if (SvTYPE(sv) <= SVt_PV) {
4823 sv_upgrade(sv, SVt_PV);
4826 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4827 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4830 * Now, for efficiency reasons, read data directly inside the SV buffer,
4831 * and perform the SV final settings directly by duplicating the final
4832 * work done by sv_setpv. Since we're going to allocate lots of scalars
4833 * this way, it's worth the hassle and risk.
4835 SAFEREAD(SvPVX(sv), len, sv);
4836 SvCUR_set(sv, len); /* Record C string length */
4837 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4838 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4841 (void) SvPOK_only(sv); /* Validate string pointer */
4842 if (cxt->s_tainted) /* Is input source tainted? */
4843 SvTAINT(sv); /* External data cannot be trusted */
4845 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4852 * Like retrieve_scalar(), but tag result as utf8.
4853 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4855 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname)
4859 TRACEME(("retrieve_utf8str"));
4861 sv = retrieve_scalar(aTHX_ cxt, cname);
4863 #ifdef HAS_UTF8_SCALARS
4866 if (cxt->use_bytes < 0)
4868 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4870 if (cxt->use_bytes == 0)
4881 * Like retrieve_lscalar(), but tag result as utf8.
4882 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4884 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname)
4888 TRACEME(("retrieve_lutf8str"));
4890 sv = retrieve_lscalar(aTHX_ cxt, cname);
4892 #ifdef HAS_UTF8_SCALARS
4895 if (cxt->use_bytes < 0)
4897 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4899 if (cxt->use_bytes == 0)
4909 * Retrieve defined integer.
4910 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4912 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname)
4917 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4919 READ(&iv, sizeof(iv));
4921 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4923 TRACEME(("integer %"IVdf, iv));
4924 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4932 * Retrieve defined integer in network order.
4933 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4935 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname)
4940 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4944 sv = newSViv((int) ntohl(iv));
4945 TRACEME(("network integer %d", (int) ntohl(iv)));
4948 TRACEME(("network integer (as-is) %d", iv));
4950 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4952 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
4960 * Retrieve defined double.
4961 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
4963 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname)
4968 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
4970 READ(&nv, sizeof(nv));
4972 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4974 TRACEME(("double %"NVff, nv));
4975 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
4983 * Retrieve defined byte (small integer within the [-128, +127] range).
4984 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
4986 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname)
4990 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
4992 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
4995 TRACEME(("small integer read as %d", (unsigned char) siv));
4996 tmp = (unsigned char) siv - 128;
4998 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5000 TRACEME(("byte %d", tmp));
5001 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
5009 * Return the undefined value.
5011 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname)
5015 TRACEME(("retrieve_undef"));
5026 * Return the immortal undefined value.
5028 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname)
5030 SV *sv = &PL_sv_undef;
5032 TRACEME(("retrieve_sv_undef"));
5034 /* Special case PL_sv_undef, as av_fetch uses it internally to mark
5035 deleted elements, and will return NULL (fetch failed) whenever it
5037 if (cxt->where_is_undef == -1) {
5038 cxt->where_is_undef = cxt->tagnum;
5047 * Return the immortal yes value.
5049 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname)
5051 SV *sv = &PL_sv_yes;
5053 TRACEME(("retrieve_sv_yes"));
5062 * Return the immortal no value.
5064 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname)
5068 TRACEME(("retrieve_sv_no"));
5077 * Retrieve a whole array.
5078 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5079 * Each item is stored as <object>.
5081 * When we come here, SX_ARRAY has been read already.
5083 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5090 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
5093 * Read length, and allocate array, then pre-extend it.
5097 TRACEME(("size = %d", len));
5099 SEEN(av, cname, 0); /* Will return if array not allocated nicely */
5103 return (SV *) av; /* No data follow if array is empty */
5106 * Now get each item in turn...
5109 for (i = 0; i < len; i++) {
5110 TRACEME(("(#%d) item", i));
5111 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5114 if (av_store(av, i, sv) == 0)
5118 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5126 * Retrieve a whole hash table.
5127 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5128 * Keys are stored as <length> <data>, the <data> section being omitted
5130 * Values are stored as <object>.
5132 * When we come here, SX_HASH has been read already.
5134 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5142 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
5145 * Read length, allocate table.
5149 TRACEME(("size = %d", len));
5151 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5153 return (SV *) hv; /* No data follow if table empty */
5154 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5157 * Now get each key/value pair in turn...
5160 for (i = 0; i < len; i++) {
5165 TRACEME(("(#%d) value", i));
5166 sv = retrieve(aTHX_ cxt, 0);
5172 * Since we're reading into kbuf, we must ensure we're not
5173 * recursing between the read and the hv_store() where it's used.
5174 * Hence the key comes after the value.
5177 RLEN(size); /* Get key size */
5178 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5181 kbuf[size] = '\0'; /* Mark string end, just in case */
5182 TRACEME(("(#%d) key '%s'", i, kbuf));
5185 * Enter key/value pair into hash table.
5188 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5192 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5200 * Retrieve a whole hash table.
5201 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5202 * Keys are stored as <length> <data>, the <data> section being omitted
5204 * Values are stored as <object>.
5206 * When we come here, SX_HASH has been read already.
5208 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname)
5218 GETMARK(hash_flags);
5219 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
5221 * Read length, allocate table.
5224 #ifndef HAS_RESTRICTED_HASHES
5225 if (hash_flags & SHV_RESTRICTED) {
5226 if (cxt->derestrict < 0)
5228 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
5230 if (cxt->derestrict == 0)
5231 RESTRICTED_HASH_CROAK();
5236 TRACEME(("size = %d, flags = %d", len, hash_flags));
5238 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5240 return (SV *) hv; /* No data follow if table empty */
5241 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5244 * Now get each key/value pair in turn...
5247 for (i = 0; i < len; i++) {
5249 int store_flags = 0;
5254 TRACEME(("(#%d) value", i));
5255 sv = retrieve(aTHX_ cxt, 0);
5260 #ifdef HAS_RESTRICTED_HASHES
5261 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
5265 if (flags & SHV_K_ISSV) {
5266 /* XXX you can't set a placeholder with an SV key.
5267 Then again, you can't get an SV key.
5268 Without messing around beyond what the API is supposed to do.
5271 TRACEME(("(#%d) keysv, flags=%d", i, flags));
5272 keysv = retrieve(aTHX_ cxt, 0);
5276 if (!hv_store_ent(hv, keysv, sv, 0))
5281 * Since we're reading into kbuf, we must ensure we're not
5282 * recursing between the read and the hv_store() where it's used.
5283 * Hence the key comes after the value.
5286 if (flags & SHV_K_PLACEHOLDER) {
5288 sv = &PL_sv_placeholder;
5289 store_flags |= HVhek_PLACEHOLD;
5291 if (flags & SHV_K_UTF8) {
5292 #ifdef HAS_UTF8_HASHES
5293 store_flags |= HVhek_UTF8;
5295 if (cxt->use_bytes < 0)
5297 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
5299 if (cxt->use_bytes == 0)
5303 #ifdef HAS_UTF8_HASHES
5304 if (flags & SHV_K_WASUTF8)
5305 store_flags |= HVhek_WASUTF8;
5308 RLEN(size); /* Get key size */
5309 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5312 kbuf[size] = '\0'; /* Mark string end, just in case */
5313 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5314 flags, store_flags));
5317 * Enter key/value pair into hash table.
5320 #ifdef HAS_RESTRICTED_HASHES
5321 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5324 if (!(store_flags & HVhek_PLACEHOLD))
5325 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5330 #ifdef HAS_RESTRICTED_HASHES
5331 if (hash_flags & SHV_RESTRICTED)
5335 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5343 * Return a code reference.
5345 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname)
5347 #if PERL_VERSION < 6
5348 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5351 int type, count, tagnum;
5353 SV *sv, *text, *sub;
5355 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5358 * Insert dummy SV in the aseen array so that we don't screw
5359 * up the tag numbers. We would just make the internal
5360 * scalar an untagged item in the stream, but
5361 * retrieve_scalar() calls SEEN(). So we just increase the
5364 tagnum = cxt->tagnum;
5369 * Retrieve the source of the code reference
5370 * as a small or large scalar
5376 text = retrieve_scalar(aTHX_ cxt, cname);
5379 text = retrieve_lscalar(aTHX_ cxt, cname);
5382 CROAK(("Unexpected type %d in retrieve_code\n", type));
5386 * prepend "sub " to the source
5389 sub = newSVpvn("sub ", 4);
5390 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5394 * evaluate the source to a code reference and use the CV value
5397 if (cxt->eval == NULL) {
5398 cxt->eval = perl_get_sv("Storable::Eval", TRUE);
5399 SvREFCNT_inc(cxt->eval);
5401 if (!SvTRUE(cxt->eval)) {
5403 cxt->forgive_me == 0 ||
5404 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5405 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
5407 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5410 /* fix up the dummy entry... */
5411 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5419 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5420 SV* errsv = get_sv("@", TRUE);
5421 sv_setpvn(errsv, "", 0); /* clear $@ */
5423 XPUSHs(sv_2mortal(newSVsv(sub)));
5425 count = call_sv(cxt->eval, G_SCALAR);
5428 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5430 if (SvTRUE(errsv)) {
5431 CROAK(("code %s caused an error: %s",
5432 SvPV_nolen(sub), SvPV_nolen(errsv)));
5436 cv = eval_pv(SvPV_nolen(sub), TRUE);
5438 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5441 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5444 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5449 /* fix up the dummy entry... */
5450 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5457 * old_retrieve_array
5459 * Retrieve a whole array in pre-0.6 binary format.
5461 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5462 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5464 * When we come here, SX_ARRAY has been read already.
5466 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5474 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5477 * Read length, and allocate array, then pre-extend it.
5481 TRACEME(("size = %d", len));
5483 SEEN(av, 0, 0); /* Will return if array not allocated nicely */
5487 return (SV *) av; /* No data follow if array is empty */
5490 * Now get each item in turn...
5493 for (i = 0; i < len; i++) {
5495 if (c == SX_IT_UNDEF) {
5496 TRACEME(("(#%d) undef item", i));
5497 continue; /* av_extend() already filled us with undef */
5500 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5501 TRACEME(("(#%d) item", i));
5502 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5505 if (av_store(av, i, sv) == 0)
5509 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5517 * Retrieve a whole hash table in pre-0.6 binary format.
5519 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5520 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5522 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5524 * When we come here, SX_HASH has been read already.
5526 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5534 SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5536 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5539 * Read length, allocate table.
5543 TRACEME(("size = %d", len));
5545 SEEN(hv, 0, 0); /* Will return if table not allocated properly */
5547 return (SV *) hv; /* No data follow if table empty */
5548 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5551 * Now get each key/value pair in turn...
5554 for (i = 0; i < len; i++) {
5560 if (c == SX_VL_UNDEF) {
5561 TRACEME(("(#%d) undef value", i));
5563 * Due to a bug in hv_store(), it's not possible to pass
5564 * &PL_sv_undef to hv_store() as a value, otherwise the
5565 * associated key will not be creatable any more. -- RAM, 14/01/97
5568 sv_h_undef = newSVsv(&PL_sv_undef);
5569 sv = SvREFCNT_inc(sv_h_undef);
5570 } else if (c == SX_VALUE) {
5571 TRACEME(("(#%d) value", i));
5572 sv = retrieve(aTHX_ cxt, 0);
5576 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5580 * Since we're reading into kbuf, we must ensure we're not
5581 * recursing between the read and the hv_store() where it's used.
5582 * Hence the key comes after the value.
5587 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5588 RLEN(size); /* Get key size */
5589 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5592 kbuf[size] = '\0'; /* Mark string end, just in case */
5593 TRACEME(("(#%d) key '%s'", i, kbuf));
5596 * Enter key/value pair into hash table.
5599 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5603 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5609 *** Retrieval engine.
5615 * Make sure the stored data we're trying to retrieve has been produced
5616 * on an ILP compatible system with the same byteorder. It croaks out in
5617 * case an error is detected. [ILP = integer-long-pointer sizes]
5618 * Returns null if error is detected, &PL_sv_undef otherwise.
5620 * Note that there's no byte ordering info emitted when network order was
5621 * used at store time.
5623 static SV *magic_check(pTHX_ stcxt_t *cxt)
5625 /* The worst case for a malicious header would be old magic (which is
5626 longer), major, minor, byteorder length byte of 255, 255 bytes of
5627 garbage, sizeof int, long, pointer, NV.
5628 So the worse of that we can read is 255 bytes of garbage plus 4.
5629 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5630 compiling perl on a system with chars that are larger than 8 bits.
5631 (Even Crays aren't *that* perverse).
5633 unsigned char buf[4 + 255];
5634 unsigned char *current;
5637 int use_network_order;
5641 int version_minor = 0;
5643 TRACEME(("magic_check"));
5646 * The "magic number" is only for files, not when freezing in memory.
5650 /* This includes the '\0' at the end. I want to read the extra byte,
5651 which is usually going to be the major version number. */
5652 STRLEN len = sizeof(magicstr);
5655 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5657 /* Point at the byte after the byte we read. */
5658 current = buf + --len; /* Do the -- outside of macros. */
5660 if (memNE(buf, magicstr, len)) {
5662 * Try to read more bytes to check for the old magic number, which
5666 TRACEME(("trying for old magic number"));
5668 old_len = sizeof(old_magicstr) - 1;
5669 READ(current + 1, (SSize_t)(old_len - len));
5671 if (memNE(buf, old_magicstr, old_len))
5672 CROAK(("File is not a perl storable"));
5674 current = buf + old_len;
5676 use_network_order = *current;
5678 GETMARK(use_network_order);
5681 * Starting with 0.6, the "use_network_order" byte flag is also used to
5682 * indicate the version number of the binary, and therefore governs the
5683 * setting of sv_retrieve_vtbl. See magic_write().
5685 if (old_magic && use_network_order > 1) {
5686 /* 0.1 dump - use_network_order is really byte order length */
5690 version_major = use_network_order >> 1;
5692 cxt->retrieve_vtbl = (SV*(**)(pTHX_ stcxt_t *cxt, const char *cname)) (version_major > 0 ? sv_retrieve : sv_old_retrieve);
5694 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5698 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5699 * minor version of the protocol. See magic_write().
5702 if (version_major > 1)
5703 GETMARK(version_minor);
5705 cxt->ver_major = version_major;
5706 cxt->ver_minor = version_minor;
5708 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5711 * Inter-operability sanity check: we can't retrieve something stored
5712 * using a format more recent than ours, because we have no way to
5713 * know what has changed, and letting retrieval go would mean a probable
5714 * failure reporting a "corrupted" storable file.
5718 version_major > STORABLE_BIN_MAJOR ||
5719 (version_major == STORABLE_BIN_MAJOR &&
5720 version_minor > STORABLE_BIN_MINOR)
5723 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5724 STORABLE_BIN_MINOR));
5726 if (version_major == STORABLE_BIN_MAJOR) {
5727 TRACEME(("cxt->accept_future_minor is %d",
5728 cxt->accept_future_minor));
5729 if (cxt->accept_future_minor < 0)
5730 cxt->accept_future_minor
5731 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5734 if (cxt->accept_future_minor == 1)
5735 croak_now = 0; /* Don't croak yet. */
5738 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5739 version_major, version_minor,
5740 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5745 * If they stored using network order, there's no byte ordering
5746 * information to check.
5749 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5750 return &PL_sv_undef; /* No byte ordering info */
5752 /* In C truth is 1, falsehood is 0. Very convienient. */
5753 use_NV_size = version_major >= 2 && version_minor >= 2;
5755 if (version_major >= 0) {
5759 c = use_network_order;
5761 length = c + 3 + use_NV_size;
5762 READ(buf, length); /* Not null-terminated */
5764 TRACEME(("byte order '%.*s' %d", c, buf, c));
5766 #ifdef USE_56_INTERWORK_KLUDGE
5767 /* No point in caching this in the context as we only need it once per
5768 retrieve, and we need to recheck it each read. */
5769 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5770 if ((c != (sizeof (byteorderstr_56) - 1))
5771 || memNE(buf, byteorderstr_56, c))
5772 CROAK(("Byte order is not compatible"));
5776 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5777 CROAK(("Byte order is not compatible"));
5783 if ((int) *current++ != sizeof(int))
5784 CROAK(("Integer size is not compatible"));
5787 if ((int) *current++ != sizeof(long))
5788 CROAK(("Long integer size is not compatible"));
5790 /* sizeof(char *) */
5791 if ((int) *current != sizeof(char *))
5792 CROAK(("Pointer size is not compatible"));
5796 if ((int) *++current != sizeof(NV))
5797 CROAK(("Double size is not compatible"));
5800 return &PL_sv_undef; /* OK */
5806 * Recursively retrieve objects from the specified file and return their
5807 * root SV (which may be an AV or an HV for what we care).
5808 * Returns null if there is a problem.
5810 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname)
5816 TRACEME(("retrieve"));
5819 * Grab address tag which identifies the object if we are retrieving
5820 * an older format. Since the new binary format counts objects and no
5821 * longer explicitely tags them, we must keep track of the correspondance
5824 * The following section will disappear one day when the old format is
5825 * no longer supported, hence the final "goto" in the "if" block.
5828 if (cxt->hseen) { /* Retrieving old binary */
5830 if (cxt->netorder) {
5832 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5833 tag = (stag_t) nettag;
5835 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5838 if (type == SX_OBJECT) {
5840 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5842 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5844 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5847 * The following code is common with the SX_OBJECT case below.
5850 svh = av_fetch(cxt->aseen, tagn, FALSE);
5852 CROAK(("Object #%"IVdf" should have been retrieved already",
5855 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5856 SvREFCNT_inc(sv); /* One more reference to this same sv */
5857 return sv; /* The SV pointer where object was retrieved */
5861 * Map new object, but don't increase tagnum. This will be done
5862 * by each of the retrieve_* functions when they call SEEN().
5864 * The mapping associates the "tag" initially present with a unique
5865 * tag number. See test for SX_OBJECT above to see how this is perused.
5868 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5869 newSViv(cxt->tagnum), 0))
5876 * Regular post-0.6 binary format.
5881 TRACEME(("retrieve type = %d", type));
5884 * Are we dealing with an object we should have already retrieved?
5887 if (type == SX_OBJECT) {
5891 svh = av_fetch(cxt->aseen, tag, FALSE);
5893 CROAK(("Object #%"IVdf" should have been retrieved already",
5896 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5897 SvREFCNT_inc(sv); /* One more reference to this same sv */
5898 return sv; /* The SV pointer where object was retrieved */
5899 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5900 if (cxt->accept_future_minor < 0)
5901 cxt->accept_future_minor
5902 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5905 if (cxt->accept_future_minor == 1) {
5906 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5907 "This Storable is v%d.%d and can only handle data types up to %d",
5908 cxt->ver_major, cxt->ver_minor, type,
5909 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5913 first_time: /* Will disappear when support for old format is dropped */
5916 * Okay, first time through for this one.
5919 sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
5921 return (SV *) 0; /* Failed */
5924 * Old binary formats (pre-0.7).
5926 * Final notifications, ended by SX_STORED may now follow.
5927 * Currently, the only pertinent notification to apply on the
5928 * freshly retrieved object is either:
5929 * SX_CLASS <char-len> <classname> for short classnames.
5930 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5931 * Class name is then read into the key buffer pool used by
5932 * hash table key retrieval.
5935 if (cxt->ver_major < 2) {
5936 while ((type = GETCHAR()) != SX_STORED) {
5940 GETMARK(len); /* Length coded on a single char */
5942 case SX_LG_CLASS: /* Length coded on a regular integer */
5947 return (SV *) 0; /* Failed */
5949 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5952 kbuf[len] = '\0'; /* Mark string end */
5957 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5958 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
5966 * Retrieve data held in file and return the root object.
5967 * Common routine for pretrieve and mretrieve.
5969 static SV *do_retrieve(
5977 int is_tainted; /* Is input source tainted? */
5978 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
5980 TRACEME(("do_retrieve (optype = 0x%x)", optype));
5982 optype |= ST_RETRIEVE;
5985 * Sanity assertions for retrieve dispatch tables.
5988 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
5989 ("old and new retrieve dispatch table have same size"));
5990 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
5991 ("SX_ERROR entry correctly initialized in old dispatch table"));
5992 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
5993 ("SX_ERROR entry correctly initialized in new dispatch table"));
5996 * Workaround for CROAK leak: if they enter with a "dirty" context,
5997 * free up memory for them now.
6001 clean_context(aTHX_ cxt);
6004 * Now that STORABLE_xxx hooks exist, it is possible that they try to
6005 * re-enter retrieve() via the hooks.
6009 cxt = allocate_context(aTHX_ cxt);
6013 ASSERT(cxt->entry == 1, ("starting new recursion"));
6014 ASSERT(!cxt->s_dirty, ("clean context"));
6019 * Data is loaded into the memory buffer when f is NULL, unless `in' is
6020 * also NULL, in which case we're expecting the data to already lie
6021 * in the buffer (dclone case).
6024 KBUFINIT(); /* Allocate hash key reading pool once */
6030 const char *orig = SvPV(in, length);
6032 /* This is quite deliberate. I want the UTF8 routines
6033 to encounter the '\0' which perl adds at the end
6034 of all scalars, so that any new string also has
6037 STRLEN klen_tmp = length + 1;
6038 bool is_utf8 = TRUE;
6040 /* Just casting the &klen to (STRLEN) won't work
6041 well if STRLEN and I32 are of different widths.
6043 asbytes = (char*)bytes_from_utf8((U8*)orig,
6047 CROAK(("Frozen string corrupt - contains characters outside 0-255"));
6049 if (asbytes != orig) {
6050 /* String has been converted.
6051 There is no need to keep any reference to
6053 in = sv_newmortal();
6054 /* We donate the SV the malloc()ed string
6055 bytes_from_utf8 returned us. */
6056 SvUPGRADE(in, SVt_PV);
6058 SvPV_set(in, asbytes);
6059 SvLEN_set(in, klen_tmp);
6060 SvCUR_set(in, klen_tmp - 1);
6064 MBUF_SAVE_AND_LOAD(in);
6068 * Magic number verifications.
6070 * This needs to be done before calling init_retrieve_context()
6071 * since the format indication in the file are necessary to conduct
6072 * some of the initializations.
6075 cxt->fio = f; /* Where I/O are performed */
6077 if (!magic_check(aTHX_ cxt))
6078 CROAK(("Magic number checking on storable %s failed",
6079 cxt->fio ? "file" : "string"));
6081 TRACEME(("data stored in %s format",
6082 cxt->netorder ? "net order" : "native"));
6085 * Check whether input source is tainted, so that we don't wrongly
6086 * taint perfectly good values...
6088 * We assume file input is always tainted. If both `f' and `in' are
6089 * NULL, then we come from dclone, and tainted is already filled in
6090 * the context. That's a kludge, but the whole dclone() thing is
6091 * already quite a kludge anyway! -- RAM, 15/09/2000.
6094 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
6095 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
6096 init_retrieve_context(aTHX_ cxt, optype, is_tainted);
6098 ASSERT(is_retrieving(aTHX), ("within retrieve operation"));
6100 sv = retrieve(aTHX_ cxt, 0); /* Recursively retrieve object, get root SV */
6109 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
6112 * The "root" context is never freed.
6115 clean_retrieve_context(aTHX_ cxt);
6116 if (cxt->prev) /* This context was stacked */
6117 free_context(aTHX_ cxt); /* It was not the "root" context */
6120 * Prepare returned value.
6124 TRACEME(("retrieve ERROR"));
6125 #if (PATCHLEVEL <= 4)
6126 /* perl 5.00405 seems to screw up at this point with an
6127 'attempt to modify a read only value' error reported in the
6128 eval { $self = pretrieve(*FILE) } in _retrieve.
6129 I can't see what the cause of this error is, but I suspect a
6130 bug in 5.004, as it seems to be capable of issuing spurious
6131 errors or core dumping with matches on $@. I'm not going to
6132 spend time on what could be a fruitless search for the cause,
6133 so here's a bodge. If you're running 5.004 and don't like
6134 this inefficiency, either upgrade to a newer perl, or you are
6135 welcome to find the problem and send in a patch.
6139 return &PL_sv_undef; /* Something went wrong, return undef */
6143 TRACEME(("retrieve got %s(0x%"UVxf")",
6144 sv_reftype(sv, FALSE), PTR2UV(sv)));
6147 * Backward compatibility with Storable-0.5@9 (which we know we
6148 * are retrieving if hseen is non-null): don't create an extra RV
6149 * for objects since we special-cased it at store time.
6151 * Build a reference to the SV returned by pretrieve even if it is
6152 * already one and not a scalar, for consistency reasons.
6155 if (pre_06_fmt) { /* Was not handling overloading by then */
6157 TRACEME(("fixing for old formats -- pre 0.6"));
6158 if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
6159 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
6165 * If reference is overloaded, restore behaviour.
6167 * NB: minor glitch here: normally, overloaded refs are stored specially
6168 * so that we can croak when behaviour cannot be re-installed, and also
6169 * avoid testing for overloading magic at each reference retrieval.
6171 * Unfortunately, the root reference is implicitely stored, so we must
6172 * check for possible overloading now. Furthermore, if we don't restore
6173 * overloading, we cannot croak as if the original ref was, because we
6174 * have no way to determine whether it was an overloaded ref or not in
6177 * It's a pity that overloading magic is attached to the rv, and not to
6178 * the underlying sv as blessing is.
6182 HV *stash = (HV *) SvSTASH(sv);
6183 SV *rv = newRV_noinc(sv);
6184 if (stash && Gv_AMG(stash)) {
6186 TRACEME(("restored overloading on root reference"));
6188 TRACEME(("ended do_retrieve() with an object"));
6192 TRACEME(("regular do_retrieve() end"));
6194 return newRV_noinc(sv);
6200 * Retrieve data held in file and return the root object, undef on error.
6202 static SV *pretrieve(pTHX_ PerlIO *f)
6204 TRACEME(("pretrieve"));
6205 return do_retrieve(aTHX_ f, Nullsv, 0);
6211 * Retrieve data held in scalar and return the root object, undef on error.
6213 static SV *mretrieve(pTHX_ SV *sv)
6215 TRACEME(("mretrieve"));
6216 return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
6226 * Deep clone: returns a fresh copy of the original referenced SV tree.
6228 * This is achieved by storing the object in memory and restoring from
6229 * there. Not that efficient, but it should be faster than doing it from
6232 static SV *dclone(pTHX_ SV *sv)
6236 stcxt_t *real_context;
6239 TRACEME(("dclone"));
6242 * Workaround for CROAK leak: if they enter with a "dirty" context,
6243 * free up memory for them now.
6247 clean_context(aTHX_ cxt);
6250 * Tied elements seem to need special handling.
6253 if (SvTYPE(sv) == SVt_PVLV && SvRMAGICAL(sv) && mg_find(sv, 'p')) {
6258 * do_store() optimizes for dclone by not freeing its context, should
6259 * we need to allocate one because we're deep cloning from a hook.
6262 if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
6263 return &PL_sv_undef; /* Error during store */
6266 * Because of the above optimization, we have to refresh the context,
6267 * since a new one could have been allocated and stacked by do_store().
6270 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
6271 cxt = real_context; /* And we need this temporary... */
6274 * Now, `cxt' may refer to a new context.
6277 ASSERT(!cxt->s_dirty, ("clean context"));
6278 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
6281 TRACEME(("dclone stored %d bytes", size));
6285 * Since we're passing do_retrieve() both a NULL file and sv, we need
6286 * to pre-compute the taintedness of the input by setting cxt->tainted
6287 * to whatever state our own input string was. -- RAM, 15/09/2000
6289 * do_retrieve() will free non-root context.
6292 cxt->s_tainted = SvTAINTED(sv);
6293 out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
6295 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
6305 * The Perl IO GV object distinguishes between input and output for sockets
6306 * but not for plain files. To allow Storable to transparently work on
6307 * plain files and sockets transparently, we have to ask xsubpp to fetch the
6308 * right object for us. Hence the OutputStream and InputStream declarations.
6310 * Before perl 5.004_05, those entries in the standard typemap are not
6311 * defined in perl include files, so we do that here.
6314 #ifndef OutputStream
6315 #define OutputStream PerlIO *
6316 #define InputStream PerlIO *
6317 #endif /* !OutputStream */
6319 MODULE = Storable PACKAGE = Storable::Cxt
6325 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
6329 if (!cxt->membuf_ro && mbase)
6331 if (cxt->membuf_ro && (cxt->msaved).arena)
6332 Safefree((cxt->msaved).arena);
6335 MODULE = Storable PACKAGE = Storable
6341 HV *stash = gv_stashpvn("Storable", 8, TRUE);
6342 newCONSTSUB(stash, "BIN_MAJOR", newSViv(STORABLE_BIN_MAJOR));
6343 newCONSTSUB(stash, "BIN_MINOR", newSViv(STORABLE_BIN_MINOR));
6344 newCONSTSUB(stash, "BIN_WRITE_MINOR", newSViv(STORABLE_BIN_WRITE_MINOR));
6346 init_perinterp(aTHX);
6347 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
6349 /* Only disable the used only once warning if we are in debugging mode. */
6350 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
6352 #ifdef USE_56_INTERWORK_KLUDGE
6353 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
6360 init_perinterp(aTHX);
6367 RETVAL = pstore(aTHX_ f, obj);
6376 RETVAL = net_pstore(aTHX_ f, obj);
6384 RETVAL = mstore(aTHX_ obj);
6392 RETVAL = net_mstore(aTHX_ obj);
6400 RETVAL = pretrieve(aTHX_ f);
6408 RETVAL = mretrieve(aTHX_ sv);
6416 RETVAL = dclone(aTHX_ sv);
6421 last_op_in_netorder()
6423 RETVAL = last_op_in_netorder(aTHX);
6430 RETVAL = is_storing(aTHX);
6437 RETVAL = is_retrieving(aTHX);