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 */
26 #define DEBUGME /* Debug mode, turns assertions on as well */
27 #define DASSERT /* Assertion mode */
30 #if 0 /* On NetWare USE_PERLIO is not used */
31 #define DEBUGME /* Debug mode, turns assertions on as well */
32 #define DASSERT /* Assertion mode */
37 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
38 * Provide them with the necessary defines so they can build with pre-5.004.
41 #ifndef PERLIO_IS_STDIO
43 #define PerlIO_getc(x) getc(x)
44 #define PerlIO_putc(f,x) putc(x,f)
45 #define PerlIO_read(x,y,z) fread(y,1,z,x)
46 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
47 #define PerlIO_stdoutf printf
48 #endif /* PERLIO_IS_STDIO */
49 #endif /* USE_PERLIO */
52 * Earlier versions of perl might be used, we can't assume they have the latest!
55 #ifndef PERL_VERSION /* For perls < 5.6 */
56 #define PERL_VERSION PATCHLEVEL
58 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
60 #if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
61 #define PL_sv_yes sv_yes
62 #define PL_sv_no sv_no
63 #define PL_sv_undef sv_undef
64 #if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
65 #define newSVpvn newSVpv
67 #endif /* PATCHLEVEL <= 4 */
68 #ifndef HvSHAREKEYS_off
69 #define HvSHAREKEYS_off(hv) /* Ignore */
71 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
72 #define AvFILLp AvFILL
74 typedef double NV; /* Older perls lack the NV type */
75 #define IVdf "ld" /* Various printf formats for Perl types */
79 #define INT2PTR(t,v) (t)(IV)(v)
80 #define PTR2UV(v) (unsigned long)(v)
81 #endif /* PERL_VERSION -- perls < 5.6 */
83 #ifndef NVef /* The following were not part of perl 5.6 */
84 #if defined(USE_LONG_DOUBLE) && \
85 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
86 #define NVef PERL_PRIeldbl
87 #define NVff PERL_PRIfldbl
88 #define NVgf PERL_PRIgldbl
97 # if (defined(__GNUC__) && defined(__cplusplus)) || defined(__INTEL_COMPILER)
98 # define PERL_UNUSED_DECL
100 # define PERL_UNUSED_DECL __attribute__((unused))
103 # define PERL_UNUSED_DECL
107 #define dNOOP extern int Perl___notused PERL_UNUSED_DECL
121 * TRACEME() will only output things when the $Storable::DEBUGME is true.
126 if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
127 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
134 #define ASSERT(x,y) \
137 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
138 __FILE__, __LINE__); \
139 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
150 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
152 #define SX_OBJECT C(0) /* Already stored object */
153 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
154 #define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
155 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
156 #define SX_REF C(4) /* Reference to object forthcoming */
157 #define SX_UNDEF C(5) /* Undefined scalar */
158 #define SX_INTEGER C(6) /* Integer forthcoming */
159 #define SX_DOUBLE C(7) /* Double forthcoming */
160 #define SX_BYTE C(8) /* (signed) byte forthcoming */
161 #define SX_NETINT C(9) /* Integer in network order forthcoming */
162 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
163 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
164 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
165 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
166 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
167 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
168 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
169 #define SX_BLESS C(17) /* Object is blessed */
170 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
171 #define SX_HOOK C(19) /* Stored via hook, user-defined */
172 #define SX_OVERLOAD C(20) /* Overloaded reference */
173 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
174 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
175 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
176 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
177 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
178 #define SX_CODE C(26) /* Code references as perl source code */
179 #define SX_WEAKREF C(27) /* Weak reference to object forthcoming */
180 #define SX_WEAKOVERLOAD C(28) /* Overloaded weak reference */
181 #define SX_ERROR C(29) /* Error */
184 * Those are only used to retrieve "old" pre-0.6 binary images.
186 #define SX_ITEM 'i' /* An array item introducer */
187 #define SX_IT_UNDEF 'I' /* Undefined array item */
188 #define SX_KEY 'k' /* A hash key introducer */
189 #define SX_VALUE 'v' /* A hash value introducer */
190 #define SX_VL_UNDEF 'V' /* Undefined hash value */
193 * Those are only used to retrieve "old" pre-0.7 binary images
196 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
197 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
198 #define SX_STORED 'X' /* End of object */
201 * Limits between short/long length representation.
204 #define LG_SCALAR 255 /* Large scalar length limit */
205 #define LG_BLESS 127 /* Large classname bless limit */
211 #define ST_STORE 0x1 /* Store operation */
212 #define ST_RETRIEVE 0x2 /* Retrieval operation */
213 #define ST_CLONE 0x4 /* Deep cloning operation */
216 * The following structure is used for hash table key retrieval. Since, when
217 * retrieving objects, we'll be facing blessed hash references, it's best
218 * to pre-allocate that buffer once and resize it as the need arises, never
219 * freeing it (keys will be saved away someplace else anyway, so even large
220 * keys are not enough a motivation to reclaim that space).
222 * This structure is also used for memory store/retrieve operations which
223 * happen in a fixed place before being malloc'ed elsewhere if persistency
224 * is required. Hence the aptr pointer.
227 char *arena; /* Will hold hash key strings, resized as needed */
228 STRLEN asiz; /* Size of aforementionned buffer */
229 char *aptr; /* Arena pointer, for in-place read/write ops */
230 char *aend; /* First invalid address */
235 * A hash table records the objects which have already been stored.
236 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
237 * an arbitrary sequence number) is used to identify them.
240 * An array table records the objects which have already been retrieved,
241 * as seen by the tag determind by counting the objects themselves. The
242 * reference to that retrieved object is kept in the table, and is returned
243 * when an SX_OBJECT is found bearing that same tag.
245 * The same processing is used to record "classname" for blessed objects:
246 * indexing by a hash at store time, and via an array at retrieve time.
249 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
252 * The following "thread-safe" related defines were contributed by
253 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
254 * only renamed things a little bit to ensure consistency with surrounding
255 * code. -- RAM, 14/09/1999
257 * The original patch suffered from the fact that the stcxt_t structure
258 * was global. Murray tried to minimize the impact on the code as much as
261 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
262 * on objects. Therefore, the notion of context needs to be generalized,
266 #define MY_VERSION "Storable(" XS_VERSION ")"
270 * Conditional UTF8 support.
274 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
275 #define HAS_UTF8_SCALARS
277 #define HAS_UTF8_HASHES
280 /* 5.6 perl has utf8 scalars but not hashes */
284 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
287 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
290 #define WEAKREF_CROAK() CROAK(("Cannot retrieve weak references in this perl"))
293 #ifdef HvPLACEHOLDERS
294 #define HAS_RESTRICTED_HASHES
296 #define HVhek_PLACEHOLD 0x200
297 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
301 #define HAS_HASH_KEY_FLAGS
305 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
306 * files remap tainted and dirty when threading is enabled. That's bad for
307 * perl to remap such common words. -- RAM, 29/09/00
311 typedef struct stcxt {
312 int entry; /* flags recursion */
313 int optype; /* type of traversal operation */
314 HV *hseen; /* which objects have been seen, store time */
315 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
316 AV *aseen; /* which objects have been seen, retrieve time */
317 IV where_is_undef; /* index in aseen of PL_sv_undef */
318 HV *hclass; /* which classnames have been seen, store time */
319 AV *aclass; /* which classnames have been seen, retrieve time */
320 HV *hook; /* cache for hook methods per class name */
321 IV tagnum; /* incremented at store time for each seen object */
322 IV classnum; /* incremented at store time for each seen classname */
323 int netorder; /* true if network order used */
324 int s_tainted; /* true if input source is tainted, at retrieve time */
325 int forgive_me; /* whether to be forgiving... */
326 int deparse; /* whether to deparse code refs */
327 SV *eval; /* whether to eval source code */
328 int canonical; /* whether to store hashes sorted by key */
329 #ifndef HAS_RESTRICTED_HASHES
330 int derestrict; /* whether to downgrade restrcted hashes */
333 int use_bytes; /* whether to bytes-ify utf8 */
335 int accept_future_minor; /* croak immediately on future minor versions? */
336 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
337 int membuf_ro; /* true means membuf is read-only and msaved is rw */
338 struct extendable keybuf; /* for hash key retrieval */
339 struct extendable membuf; /* for memory store/retrieve operations */
340 struct extendable msaved; /* where potentially valid mbuf is saved */
341 PerlIO *fio; /* where I/O are performed, NULL for memory */
342 int ver_major; /* major of version for retrieved object */
343 int ver_minor; /* minor of version for retrieved object */
344 SV *(**retrieve_vtbl)(pTHX_ struct stcxt *, char *); /* retrieve dispatch table */
345 SV *prev; /* contexts chained backwards in real recursion */
346 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
349 #define NEW_STORABLE_CXT_OBJ(cxt) \
351 SV *self = newSV(sizeof(stcxt_t) - 1); \
352 SV *my_sv = newRV_noinc(self); \
353 sv_bless(my_sv, gv_stashpv("Storable::Cxt", TRUE)); \
354 cxt = (stcxt_t *)SvPVX(self); \
355 Zero(cxt, 1, stcxt_t); \
356 cxt->my_sv = my_sv; \
359 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
361 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
363 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
364 #else /* >= perl5.004_68 */
366 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
367 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
368 #endif /* < perl5.004_68 */
370 #define dSTCXT_PTR(T,name) \
371 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
372 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
375 dSTCXT_PTR(stcxt_t *, cxt)
379 NEW_STORABLE_CXT_OBJ(cxt); \
380 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
382 #define SET_STCXT(x) \
385 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
388 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
390 static stcxt_t *Context_ptr = NULL;
391 #define dSTCXT stcxt_t *cxt = Context_ptr
392 #define SET_STCXT(x) Context_ptr = x
395 NEW_STORABLE_CXT_OBJ(cxt); \
399 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
403 * Croaking implies a memory leak, since we don't use setjmp/longjmp
404 * to catch the exit and free memory used during store or retrieve
405 * operations. This is not too difficult to fix, but I need to understand
406 * how Perl does it, and croaking is exceptional anyway, so I lack the
407 * motivation to do it.
409 * The current workaround is to mark the context as dirty when croaking,
410 * so that data structures can be freed whenever we renter Storable code
411 * (but only *then*: it's a workaround, not a fix).
413 * This is also imperfect, because we don't really know how far they trapped
414 * the croak(), and when we were recursing, we won't be able to clean anything
415 * but the topmost context stacked.
418 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
421 * End of "thread-safe" related definitions.
427 * Keep only the low 32 bits of a pointer (used for tags, which are not
432 #define LOW_32BITS(x) ((I32) (x))
434 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
440 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
441 * Used in the WLEN and RLEN macros.
445 #define oI(x) ((I32 *) ((char *) (x) + 4))
446 #define oS(x) ((x) - 4)
447 #define oC(x) (x = 0)
456 * key buffer handling
458 #define kbuf (cxt->keybuf).arena
459 #define ksiz (cxt->keybuf).asiz
463 TRACEME(("** allocating kbuf of 128 bytes")); \
464 New(10003, kbuf, 128, char); \
471 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
472 Renew(kbuf, x+1, char); \
478 * memory buffer handling
480 #define mbase (cxt->membuf).arena
481 #define msiz (cxt->membuf).asiz
482 #define mptr (cxt->membuf).aptr
483 #define mend (cxt->membuf).aend
485 #define MGROW (1 << 13)
486 #define MMASK (MGROW - 1)
488 #define round_mgrow(x) \
489 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
490 #define trunc_int(x) \
491 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
492 #define int_aligned(x) \
493 ((unsigned long) (x) == trunc_int(x))
495 #define MBUF_INIT(x) \
498 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
499 New(10003, mbase, MGROW, char); \
500 msiz = (STRLEN)MGROW; \
506 mend = mbase + msiz; \
509 #define MBUF_TRUNC(x) mptr = mbase + x
510 #define MBUF_SIZE() (mptr - mbase)
516 * Those macros are used in do_retrieve() to save the current memory
517 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
518 * data from a string.
520 #define MBUF_SAVE_AND_LOAD(in) \
522 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
523 cxt->membuf_ro = 1; \
524 TRACEME(("saving mbuf")); \
525 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
529 #define MBUF_RESTORE() \
531 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
532 cxt->membuf_ro = 0; \
533 TRACEME(("restoring mbuf")); \
534 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
538 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
539 * See store_scalar() for other usage of this workaround.
541 #define MBUF_LOAD(v) \
543 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
545 CROAK(("Not a scalar string")); \
546 mptr = mbase = SvPV(v, msiz); \
547 mend = mbase + msiz; \
550 #define MBUF_XTEND(x) \
552 int nsz = (int) round_mgrow((x)+msiz); \
553 int offset = mptr - mbase; \
554 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
555 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
557 Renew(mbase, nsz, char); \
559 mptr = mbase + offset; \
560 mend = mbase + nsz; \
563 #define MBUF_CHK(x) \
565 if ((mptr + (x)) > mend) \
569 #define MBUF_GETC(x) \
572 x = (int) (unsigned char) *mptr++; \
578 #define MBUF_GETINT(x) \
581 if ((mptr + 4) <= mend) { \
582 memcpy(oI(&x), mptr, 4); \
588 #define MBUF_GETINT(x) \
590 if ((mptr + sizeof(int)) <= mend) { \
591 if (int_aligned(mptr)) \
594 memcpy(&x, mptr, sizeof(int)); \
595 mptr += sizeof(int); \
601 #define MBUF_READ(x,s) \
603 if ((mptr + (s)) <= mend) { \
604 memcpy(x, mptr, s); \
610 #define MBUF_SAFEREAD(x,s,z) \
612 if ((mptr + (s)) <= mend) { \
613 memcpy(x, mptr, s); \
621 #define MBUF_PUTC(c) \
624 *mptr++ = (char) c; \
627 *mptr++ = (char) c; \
632 #define MBUF_PUTINT(i) \
635 memcpy(mptr, oI(&i), 4); \
639 #define MBUF_PUTINT(i) \
641 MBUF_CHK(sizeof(int)); \
642 if (int_aligned(mptr)) \
645 memcpy(mptr, &i, sizeof(int)); \
646 mptr += sizeof(int); \
650 #define MBUF_WRITE(x,s) \
653 memcpy(mptr, x, s); \
658 * Possible return values for sv_type().
662 #define svis_SCALAR 1
666 #define svis_TIED_ITEM 5
674 #define SHF_TYPE_MASK 0x03
675 #define SHF_LARGE_CLASSLEN 0x04
676 #define SHF_LARGE_STRLEN 0x08
677 #define SHF_LARGE_LISTLEN 0x10
678 #define SHF_IDX_CLASSNAME 0x20
679 #define SHF_NEED_RECURSE 0x40
680 #define SHF_HAS_LIST 0x80
683 * Types for SX_HOOK (last 2 bits in flags).
689 #define SHT_EXTRA 3 /* Read extra byte for type */
692 * The following are held in the "extra byte"...
695 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
696 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
697 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
700 * per hash flags for flagged hashes
703 #define SHV_RESTRICTED 0x01
706 * per key flags for flagged hashes
709 #define SHV_K_UTF8 0x01
710 #define SHV_K_WASUTF8 0x02
711 #define SHV_K_LOCKED 0x04
712 #define SHV_K_ISSV 0x08
713 #define SHV_K_PLACEHOLDER 0x10
716 * Before 0.6, the magic string was "perl-store" (binary version number 0).
718 * Since 0.6 introduced many binary incompatibilities, the magic string has
719 * been changed to "pst0" to allow an old image to be properly retrieved by
720 * a newer Storable, but ensure a newer image cannot be retrieved with an
723 * At 0.7, objects are given the ability to serialize themselves, and the
724 * set of markers is extended, backward compatibility is not jeopardized,
725 * so the binary version number could have remained unchanged. To correctly
726 * spot errors if a file making use of 0.7-specific extensions is given to
727 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
728 * a "minor" version, to better track this kind of evolution from now on.
731 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
732 static const char magicstr[] = "pst0"; /* Used as a magic number */
734 #define MAGICSTR_BYTES 'p','s','t','0'
735 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
737 /* 5.6.x introduced the ability to have IVs as long long.
738 However, Configure still defined BYTEORDER based on the size of a long.
739 Storable uses the BYTEORDER value as part of the header, but doesn't
740 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
741 with IV as long long on a platform that uses Configure (ie most things
742 except VMS and Windows) headers are identical for the different IV sizes,
743 despite the files containing some fields based on sizeof(IV)
745 5.8 is consistent - the following redifinition kludge is only needed on
746 5.6.x, but the interwork is needed on 5.8 while data survives in files
751 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
752 #ifndef NO_56_INTERWORK_KLUDGE
753 #define USE_56_INTERWORK_KLUDGE
755 #if BYTEORDER == 0x1234
757 #define BYTEORDER 0x12345678
759 #if BYTEORDER == 0x4321
761 #define BYTEORDER 0x87654321
766 #if BYTEORDER == 0x1234
767 #define BYTEORDER_BYTES '1','2','3','4'
769 #if BYTEORDER == 0x12345678
770 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
771 #ifdef USE_56_INTERWORK_KLUDGE
772 #define BYTEORDER_BYTES_56 '1','2','3','4'
775 #if BYTEORDER == 0x87654321
776 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
777 #ifdef USE_56_INTERWORK_KLUDGE
778 #define BYTEORDER_BYTES_56 '4','3','2','1'
781 #if BYTEORDER == 0x4321
782 #define BYTEORDER_BYTES '4','3','2','1'
784 #error Unknown byteorder. Please append your byteorder to Storable.xs
790 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
791 #ifdef USE_56_INTERWORK_KLUDGE
792 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
795 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
796 #define STORABLE_BIN_MINOR 7 /* Binary minor "version" */
798 #if (PATCHLEVEL <= 5)
799 #define STORABLE_BIN_WRITE_MINOR 4
802 * Perl 5.6.0 onwards can do weak references.
804 #define STORABLE_BIN_WRITE_MINOR 7
805 #endif /* (PATCHLEVEL <= 5) */
807 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
808 #define PL_sv_placeholder PL_sv_undef
812 * Useful store shortcuts...
816 * Note that if you put more than one mark for storing a particular
817 * type of thing, *and* in the retrieve_foo() function you mark both
818 * the thingy's you get off with SEEN(), you *must* increase the
819 * tagnum with cxt->tagnum++ along with this macro!
826 else if (PerlIO_putc(cxt->fio, x) == EOF) \
830 #define WRITE_I32(x) \
832 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
835 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
842 if (cxt->netorder) { \
843 int y = (int) htonl(x); \
846 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
851 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
856 #define WLEN(x) WRITE_I32(x)
863 else if (PerlIO_write(cxt->fio, x, y) != y) \
867 #define STORE_PV_LEN(pv, len, small, large) \
869 if (len <= LG_SCALAR) { \
870 unsigned char clen = (unsigned char) len; \
882 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
885 * Store &PL_sv_undef in arrays without recursing through store().
887 #define STORE_SV_UNDEF() \
890 PUTMARK(SX_SV_UNDEF); \
894 * Useful retrieve shortcuts...
898 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
904 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
908 #define READ_I32(x) \
910 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
914 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
924 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
927 x = (int) ntohl(x); \
930 #define RLEN(x) READ_I32(x)
937 else if (PerlIO_read(cxt->fio, x, y) != y) \
941 #define SAFEREAD(x,y,z) \
944 MBUF_SAFEREAD(x,y,z); \
945 else if (PerlIO_read(cxt->fio, x, y) != y) { \
952 * This macro is used at retrieve time, to remember where object 'y', bearing a
953 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
954 * we'll therefore know where it has been retrieved and will be able to
955 * share the same reference, as in the original stored memory image.
957 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
958 * on the objects given to STORABLE_thaw and expect that to be defined), and
959 * also for overloaded objects (for which we might not find the stash if the
960 * object is not blessed yet--this might occur for overloaded objects that
961 * refer to themselves indirectly: if we blessed upon return from a sub
962 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
963 * restored on it because the underlying object would not be blessed yet!).
965 * To achieve that, the class name of the last retrieved object is passed down
966 * recursively, and the first SEEN() call for which the class name is not NULL
967 * will bless the object.
969 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
971 #define SEEN(y,c,i) \
975 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
977 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
978 PTR2UV(y), SvREFCNT(y)-1)); \
980 BLESS((SV *) (y), c); \
984 * Bless `s' in `p', via a temporary reference, required by sv_bless().
990 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
991 stash = gv_stashpv((p), TRUE); \
992 ref = newRV_noinc(s); \
993 (void) sv_bless(ref, stash); \
994 SvRV_set(ref, NULL); \
998 * sort (used in store_hash) - conditionally use qsort when
999 * sortsv is not available ( <= 5.6.1 ).
1002 #if (PATCHLEVEL <= 6)
1004 #if defined(USE_ITHREADS)
1006 #define STORE_HASH_SORT \
1008 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
1009 SAVESPTR(orig_perl); \
1010 PERL_SET_CONTEXT(aTHX); \
1011 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
1014 #else /* ! USE_ITHREADS */
1016 #define STORE_HASH_SORT \
1017 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1019 #endif /* USE_ITHREADS */
1021 #else /* PATCHLEVEL > 6 */
1023 #define STORE_HASH_SORT \
1024 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1026 #endif /* PATCHLEVEL <= 6 */
1028 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1029 static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname);
1032 * Dynamic dispatching table for SV store.
1035 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1036 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1037 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1038 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1039 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1040 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1041 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1042 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1043 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1045 #define SV_STORE_TYPE (const int (* const)(pTHX_ stcxt_t *cxt, SV *sv))
1047 static const int (* const sv_store[])(pTHX_ stcxt_t *cxt, SV *sv) = {
1048 SV_STORE_TYPE store_ref, /* svis_REF */
1049 SV_STORE_TYPE store_scalar, /* svis_SCALAR */
1050 SV_STORE_TYPE store_array, /* svis_ARRAY */
1051 SV_STORE_TYPE store_hash, /* svis_HASH */
1052 SV_STORE_TYPE store_tied, /* svis_TIED */
1053 SV_STORE_TYPE store_tied_item, /* svis_TIED_ITEM */
1054 SV_STORE_TYPE store_code, /* svis_CODE */
1055 SV_STORE_TYPE store_other, /* svis_OTHER */
1058 #define SV_STORE(x) (*sv_store[x])
1061 * Dynamic dispatching tables for SV retrieval.
1064 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname);
1065 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname);
1066 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
1067 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
1068 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname);
1069 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname);
1070 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname);
1071 static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname);
1072 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname);
1073 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname);
1074 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname);
1075 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname);
1076 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname);
1077 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname);
1078 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname);
1079 static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname);
1081 #define SV_RETRIEVE_TYPE (const SV* (* const)(pTHX_ stcxt_t *cxt, char *cname))
1083 static const SV *(* const sv_old_retrieve[])(pTHX_ stcxt_t *cxt, char *cname) = {
1084 0, /* SX_OBJECT -- entry unused dynamically */
1085 SV_RETRIEVE_TYPE retrieve_lscalar, /* SX_LSCALAR */
1086 SV_RETRIEVE_TYPE old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1087 SV_RETRIEVE_TYPE old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1088 SV_RETRIEVE_TYPE retrieve_ref, /* SX_REF */
1089 SV_RETRIEVE_TYPE retrieve_undef, /* SX_UNDEF */
1090 SV_RETRIEVE_TYPE retrieve_integer, /* SX_INTEGER */
1091 SV_RETRIEVE_TYPE retrieve_double, /* SX_DOUBLE */
1092 SV_RETRIEVE_TYPE retrieve_byte, /* SX_BYTE */
1093 SV_RETRIEVE_TYPE retrieve_netint, /* SX_NETINT */
1094 SV_RETRIEVE_TYPE retrieve_scalar, /* SX_SCALAR */
1095 SV_RETRIEVE_TYPE retrieve_tied_array, /* SX_ARRAY */
1096 SV_RETRIEVE_TYPE retrieve_tied_hash, /* SX_HASH */
1097 SV_RETRIEVE_TYPE retrieve_tied_scalar, /* SX_SCALAR */
1098 SV_RETRIEVE_TYPE retrieve_other, /* SX_SV_UNDEF not supported */
1099 SV_RETRIEVE_TYPE retrieve_other, /* SX_SV_YES not supported */
1100 SV_RETRIEVE_TYPE retrieve_other, /* SX_SV_NO not supported */
1101 SV_RETRIEVE_TYPE retrieve_other, /* SX_BLESS not supported */
1102 SV_RETRIEVE_TYPE retrieve_other, /* SX_IX_BLESS not supported */
1103 SV_RETRIEVE_TYPE retrieve_other, /* SX_HOOK not supported */
1104 SV_RETRIEVE_TYPE retrieve_other, /* SX_OVERLOADED not supported */
1105 SV_RETRIEVE_TYPE retrieve_other, /* SX_TIED_KEY not supported */
1106 SV_RETRIEVE_TYPE retrieve_other, /* SX_TIED_IDX not supported */
1107 SV_RETRIEVE_TYPE retrieve_other, /* SX_UTF8STR not supported */
1108 SV_RETRIEVE_TYPE retrieve_other, /* SX_LUTF8STR not supported */
1109 SV_RETRIEVE_TYPE retrieve_other, /* SX_FLAG_HASH not supported */
1110 SV_RETRIEVE_TYPE retrieve_other, /* SX_CODE not supported */
1111 SV_RETRIEVE_TYPE retrieve_other, /* SX_WEAKREF not supported */
1112 SV_RETRIEVE_TYPE retrieve_other, /* SX_WEAKOVERLOAD not supported */
1113 SV_RETRIEVE_TYPE retrieve_other, /* SX_ERROR */
1116 static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
1117 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
1118 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname);
1119 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname);
1120 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname);
1121 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname);
1122 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname);
1123 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname);
1124 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname);
1125 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname);
1126 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname);
1127 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname);
1128 static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname);
1129 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, char *cname);
1130 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, char *cname);
1132 static const SV *(* const sv_retrieve[])(pTHX_ stcxt_t *cxt, char *cname) = {
1133 0, /* SX_OBJECT -- entry unused dynamically */
1134 SV_RETRIEVE_TYPE retrieve_lscalar, /* SX_LSCALAR */
1135 SV_RETRIEVE_TYPE retrieve_array, /* SX_ARRAY */
1136 SV_RETRIEVE_TYPE retrieve_hash, /* SX_HASH */
1137 SV_RETRIEVE_TYPE retrieve_ref, /* SX_REF */
1138 SV_RETRIEVE_TYPE retrieve_undef, /* SX_UNDEF */
1139 SV_RETRIEVE_TYPE retrieve_integer, /* SX_INTEGER */
1140 SV_RETRIEVE_TYPE retrieve_double, /* SX_DOUBLE */
1141 SV_RETRIEVE_TYPE retrieve_byte, /* SX_BYTE */
1142 SV_RETRIEVE_TYPE retrieve_netint, /* SX_NETINT */
1143 SV_RETRIEVE_TYPE retrieve_scalar, /* SX_SCALAR */
1144 SV_RETRIEVE_TYPE retrieve_tied_array, /* SX_ARRAY */
1145 SV_RETRIEVE_TYPE retrieve_tied_hash, /* SX_HASH */
1146 SV_RETRIEVE_TYPE retrieve_tied_scalar, /* SX_SCALAR */
1147 SV_RETRIEVE_TYPE retrieve_sv_undef, /* SX_SV_UNDEF */
1148 SV_RETRIEVE_TYPE retrieve_sv_yes, /* SX_SV_YES */
1149 SV_RETRIEVE_TYPE retrieve_sv_no, /* SX_SV_NO */
1150 SV_RETRIEVE_TYPE retrieve_blessed, /* SX_BLESS */
1151 SV_RETRIEVE_TYPE retrieve_idx_blessed, /* SX_IX_BLESS */
1152 SV_RETRIEVE_TYPE retrieve_hook, /* SX_HOOK */
1153 SV_RETRIEVE_TYPE retrieve_overloaded, /* SX_OVERLOAD */
1154 SV_RETRIEVE_TYPE retrieve_tied_key, /* SX_TIED_KEY */
1155 SV_RETRIEVE_TYPE retrieve_tied_idx, /* SX_TIED_IDX */
1156 SV_RETRIEVE_TYPE retrieve_utf8str, /* SX_UTF8STR */
1157 SV_RETRIEVE_TYPE retrieve_lutf8str, /* SX_LUTF8STR */
1158 SV_RETRIEVE_TYPE retrieve_flag_hash, /* SX_HASH */
1159 SV_RETRIEVE_TYPE retrieve_code, /* SX_CODE */
1160 SV_RETRIEVE_TYPE retrieve_weakref, /* SX_WEAKREF */
1161 SV_RETRIEVE_TYPE retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
1162 SV_RETRIEVE_TYPE retrieve_other, /* SX_ERROR */
1165 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1167 static SV *mbuf2sv(pTHX);
1170 *** Context management.
1176 * Called once per "thread" (interpreter) to initialize some global context.
1178 static void init_perinterp(pTHX)
1182 cxt->netorder = 0; /* true if network order used */
1183 cxt->forgive_me = -1; /* whether to be forgiving... */
1184 cxt->accept_future_minor = -1; /* would otherwise occur too late */
1190 * Called at the end of every context cleaning, to perform common reset
1193 static void reset_context(stcxt_t *cxt)
1197 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1201 * init_store_context
1203 * Initialize a new store context for real recursion.
1205 static void init_store_context(
1212 TRACEME(("init_store_context"));
1214 cxt->netorder = network_order;
1215 cxt->forgive_me = -1; /* Fetched from perl if needed */
1216 cxt->deparse = -1; /* Idem */
1217 cxt->eval = NULL; /* Idem */
1218 cxt->canonical = -1; /* Idem */
1219 cxt->tagnum = -1; /* Reset tag numbers */
1220 cxt->classnum = -1; /* Reset class numbers */
1221 cxt->fio = f; /* Where I/O are performed */
1222 cxt->optype = optype; /* A store, or a deep clone */
1223 cxt->entry = 1; /* No recursion yet */
1226 * The `hseen' table is used to keep track of each SV stored and their
1227 * associated tag numbers is special. It is "abused" because the
1228 * values stored are not real SV, just integers cast to (SV *),
1229 * which explains the freeing below.
1231 * It is also one possible bottlneck to achieve good storing speed,
1232 * so the "shared keys" optimization is turned off (unlikely to be
1233 * of any use here), and the hash table is "pre-extended". Together,
1234 * those optimizations increase the throughput by 12%.
1237 cxt->hseen = newHV(); /* Table where seen objects are stored */
1238 HvSHAREKEYS_off(cxt->hseen);
1241 * The following does not work well with perl5.004_04, and causes
1242 * a core dump later on, in a completely unrelated spot, which
1243 * makes me think there is a memory corruption going on.
1245 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1246 * it below does not make any difference. It seems to work fine
1247 * with perl5.004_68 but given the probable nature of the bug,
1248 * that does not prove anything.
1250 * It's a shame because increasing the amount of buckets raises
1251 * store() throughput by 5%, but until I figure this out, I can't
1252 * allow for this to go into production.
1254 * It is reported fixed in 5.005, hence the #if.
1256 #if PERL_VERSION >= 5
1257 #define HBUCKETS 4096 /* Buckets for %hseen */
1258 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1262 * The `hclass' hash uses the same settings as `hseen' above, but it is
1263 * used to assign sequential tags (numbers) to class names for blessed
1266 * We turn the shared key optimization on.
1269 cxt->hclass = newHV(); /* Where seen classnames are stored */
1271 #if PERL_VERSION >= 5
1272 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1276 * The `hook' hash table is used to keep track of the references on
1277 * the STORABLE_freeze hook routines, when found in some class name.
1279 * It is assumed that the inheritance tree will not be changed during
1280 * storing, and that no new method will be dynamically created by the
1284 cxt->hook = newHV(); /* Table where hooks are cached */
1287 * The `hook_seen' array keeps track of all the SVs returned by
1288 * STORABLE_freeze hooks for us to serialize, so that they are not
1289 * reclaimed until the end of the serialization process. Each SV is
1290 * only stored once, the first time it is seen.
1293 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1297 * clean_store_context
1299 * Clean store context by
1301 static void clean_store_context(pTHX_ stcxt_t *cxt)
1305 TRACEME(("clean_store_context"));
1307 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1310 * Insert real values into hashes where we stored faked pointers.
1314 hv_iterinit(cxt->hseen);
1315 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1316 HeVAL(he) = &PL_sv_undef;
1320 hv_iterinit(cxt->hclass);
1321 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1322 HeVAL(he) = &PL_sv_undef;
1326 * And now dispose of them...
1328 * The surrounding if() protection has been added because there might be
1329 * some cases where this routine is called more than once, during
1330 * exceptionnal events. This was reported by Marc Lehmann when Storable
1331 * is executed from mod_perl, and the fix was suggested by him.
1332 * -- RAM, 20/12/2000
1336 HV *hseen = cxt->hseen;
1339 sv_free((SV *) hseen);
1343 HV *hclass = cxt->hclass;
1346 sv_free((SV *) hclass);
1350 HV *hook = cxt->hook;
1353 sv_free((SV *) hook);
1356 if (cxt->hook_seen) {
1357 AV *hook_seen = cxt->hook_seen;
1359 av_undef(hook_seen);
1360 sv_free((SV *) hook_seen);
1363 cxt->forgive_me = -1; /* Fetched from perl if needed */
1364 cxt->deparse = -1; /* Idem */
1366 SvREFCNT_dec(cxt->eval);
1368 cxt->eval = NULL; /* Idem */
1369 cxt->canonical = -1; /* Idem */
1375 * init_retrieve_context
1377 * Initialize a new retrieve context for real recursion.
1379 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1381 TRACEME(("init_retrieve_context"));
1384 * The hook hash table is used to keep track of the references on
1385 * the STORABLE_thaw hook routines, when found in some class name.
1387 * It is assumed that the inheritance tree will not be changed during
1388 * storing, and that no new method will be dynamically created by the
1392 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1395 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1396 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1397 * the correspondance between the tags and the tag number used by the
1398 * new retrieve routines.
1401 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1404 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1405 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1406 cxt->aclass = newAV(); /* Where seen classnames are kept */
1407 cxt->tagnum = 0; /* Have to count objects... */
1408 cxt->classnum = 0; /* ...and class names as well */
1409 cxt->optype = optype;
1410 cxt->s_tainted = is_tainted;
1411 cxt->entry = 1; /* No recursion yet */
1412 #ifndef HAS_RESTRICTED_HASHES
1413 cxt->derestrict = -1; /* Fetched from perl if needed */
1415 #ifndef HAS_UTF8_ALL
1416 cxt->use_bytes = -1; /* Fetched from perl if needed */
1418 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1422 * clean_retrieve_context
1424 * Clean retrieve context by
1426 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1428 TRACEME(("clean_retrieve_context"));
1430 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1433 AV *aseen = cxt->aseen;
1436 sv_free((SV *) aseen);
1438 cxt->where_is_undef = -1;
1441 AV *aclass = cxt->aclass;
1444 sv_free((SV *) aclass);
1448 HV *hook = cxt->hook;
1451 sv_free((SV *) hook);
1455 HV *hseen = cxt->hseen;
1458 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1461 #ifndef HAS_RESTRICTED_HASHES
1462 cxt->derestrict = -1; /* Fetched from perl if needed */
1464 #ifndef HAS_UTF8_ALL
1465 cxt->use_bytes = -1; /* Fetched from perl if needed */
1467 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1475 * A workaround for the CROAK bug: cleanup the last context.
1477 static void clean_context(pTHX_ stcxt_t *cxt)
1479 TRACEME(("clean_context"));
1481 ASSERT(cxt->s_dirty, ("dirty context"));
1486 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1488 if (cxt->optype & ST_RETRIEVE)
1489 clean_retrieve_context(aTHX_ cxt);
1490 else if (cxt->optype & ST_STORE)
1491 clean_store_context(aTHX_ cxt);
1495 ASSERT(!cxt->s_dirty, ("context is clean"));
1496 ASSERT(cxt->entry == 0, ("context is reset"));
1502 * Allocate a new context and push it on top of the parent one.
1503 * This new context is made globally visible via SET_STCXT().
1505 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1509 TRACEME(("allocate_context"));
1511 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1513 NEW_STORABLE_CXT_OBJ(cxt);
1514 cxt->prev = parent_cxt->my_sv;
1517 ASSERT(!cxt->s_dirty, ("clean context"));
1525 * Free current context, which cannot be the "root" one.
1526 * Make the context underneath globally visible via SET_STCXT().
1528 static void free_context(pTHX_ stcxt_t *cxt)
1530 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1532 TRACEME(("free_context"));
1534 ASSERT(!cxt->s_dirty, ("clean context"));
1535 ASSERT(prev, ("not freeing root context"));
1537 SvREFCNT_dec(cxt->my_sv);
1540 ASSERT(cxt, ("context not void"));
1550 * Tells whether we're in the middle of a store operation.
1552 int is_storing(pTHX)
1556 return cxt->entry && (cxt->optype & ST_STORE);
1562 * Tells whether we're in the middle of a retrieve operation.
1564 int is_retrieving(pTHX)
1568 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1572 * last_op_in_netorder
1574 * Returns whether last operation was made using network order.
1576 * This is typically out-of-band information that might prove useful
1577 * to people wishing to convert native to network order data when used.
1579 int last_op_in_netorder(pTHX)
1583 return cxt->netorder;
1587 *** Hook lookup and calling routines.
1593 * A wrapper on gv_fetchmethod_autoload() which caches results.
1595 * Returns the routine reference as an SV*, or null if neither the package
1596 * nor its ancestors know about the method.
1598 static SV *pkg_fetchmeth(
1608 * The following code is the same as the one performed by UNIVERSAL::can
1612 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1613 if (gv && isGV(gv)) {
1614 sv = newRV((SV*) GvCV(gv));
1615 TRACEME(("%s->%s: 0x%"UVxf, HvNAME(pkg), method, PTR2UV(sv)));
1617 sv = newSVsv(&PL_sv_undef);
1618 TRACEME(("%s->%s: not found", HvNAME(pkg), method));
1622 * Cache the result, ignoring failure: if we can't store the value,
1623 * it just won't be cached.
1626 (void) hv_store(cache, HvNAME(pkg), strlen(HvNAME(pkg)), sv, 0);
1628 return SvOK(sv) ? sv : (SV *) 0;
1634 * Force cached value to be undef: hook ignored even if present.
1636 static void pkg_hide(
1642 (void) hv_store(cache,
1643 HvNAME(pkg), strlen(HvNAME(pkg)), newSVsv(&PL_sv_undef), 0);
1649 * Discard cached value: a whole fetch loop will be retried at next lookup.
1651 static void pkg_uncache(
1657 (void) hv_delete(cache, HvNAME(pkg), strlen(HvNAME(pkg)), G_DISCARD);
1663 * Our own "UNIVERSAL::can", which caches results.
1665 * Returns the routine reference as an SV*, or null if the object does not
1666 * know about the method.
1677 TRACEME(("pkg_can for %s->%s", HvNAME(pkg), method));
1680 * Look into the cache to see whether we already have determined
1681 * where the routine was, if any.
1683 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1684 * that only one hook (i.e. always the same) is cached in a given cache.
1687 svh = hv_fetch(cache, HvNAME(pkg), strlen(HvNAME(pkg)), FALSE);
1691 TRACEME(("cached %s->%s: not found", HvNAME(pkg), method));
1694 TRACEME(("cached %s->%s: 0x%"UVxf,
1695 HvNAME(pkg), method, PTR2UV(sv)));
1700 TRACEME(("not cached yet"));
1701 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1707 * Call routine as obj->hook(av) in scalar context.
1708 * Propagates the single returned value if not called in void context.
1710 static SV *scalar_call(
1722 TRACEME(("scalar_call (cloning=%d)", cloning));
1729 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1731 SV **ary = AvARRAY(av);
1732 int cnt = AvFILLp(av) + 1;
1734 XPUSHs(ary[0]); /* Frozen string */
1735 for (i = 1; i < cnt; i++) {
1736 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1737 i, PTR2UV(ary[i])));
1738 XPUSHs(sv_2mortal(newRV(ary[i])));
1743 TRACEME(("calling..."));
1744 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1745 TRACEME(("count = %d", count));
1751 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1764 * Call routine obj->hook(cloning) in list context.
1765 * Returns the list of returned values in an array.
1767 static AV *array_call(
1778 TRACEME(("array_call (cloning=%d)", cloning));
1784 XPUSHs(obj); /* Target object */
1785 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1788 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1793 for (i = count - 1; i >= 0; i--) {
1795 av_store(av, i, SvREFCNT_inc(sv));
1808 * Lookup the class name in the `hclass' table and either assign it a new ID
1809 * or return the existing one, by filling in `classnum'.
1811 * Return true if the class was known, false if the ID was just generated.
1813 static int known_class(
1816 char *name, /* Class name */
1817 int len, /* Name length */
1821 HV *hclass = cxt->hclass;
1823 TRACEME(("known_class (%s)", name));
1826 * Recall that we don't store pointers in this hash table, but tags.
1827 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1830 svh = hv_fetch(hclass, name, len, FALSE);
1832 *classnum = LOW_32BITS(*svh);
1837 * Unknown classname, we need to record it.
1841 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1842 CROAK(("Unable to record new classname"));
1844 *classnum = cxt->classnum;
1849 *** Sepcific store routines.
1855 * Store a reference.
1856 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1858 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1861 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1864 * Follow reference, and check if target is overloaded.
1870 TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1875 HV *stash = (HV *) SvSTASH(sv);
1876 if (stash && Gv_AMG(stash)) {
1877 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1878 PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1880 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1882 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1884 return store(aTHX_ cxt, sv);
1892 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1893 * The <data> section is omitted if <length> is 0.
1895 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1896 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1898 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
1903 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1905 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1908 * For efficiency, break the SV encapsulation by peaking at the flags
1909 * directly without using the Perl macros to avoid dereferencing
1910 * sv->sv_flags each time we wish to check the flags.
1913 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1914 if (sv == &PL_sv_undef) {
1915 TRACEME(("immortal undef"));
1916 PUTMARK(SX_SV_UNDEF);
1918 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
1925 * Always store the string representation of a scalar if it exists.
1926 * Gisle Aas provided me with this test case, better than a long speach:
1928 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1929 * SV = PVNV(0x80c8520)
1931 * FLAGS = (NOK,POK,pNOK,pPOK)
1934 * PV = 0x80c83d0 "abc"\0
1938 * Write SX_SCALAR, length, followed by the actual data.
1940 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
1941 * appropriate, followed by the actual (binary) data. A double
1942 * is written as a string if network order, for portability.
1944 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
1945 * The reason is that when the scalar value is tainted, the SvNOK(sv)
1948 * The test for a read-only scalar with both POK and NOK set is meant
1949 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
1950 * address comparison for each scalar we store.
1953 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
1955 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
1956 if (sv == &PL_sv_yes) {
1957 TRACEME(("immortal yes"));
1959 } else if (sv == &PL_sv_no) {
1960 TRACEME(("immortal no"));
1963 pv = SvPV(sv, len); /* We know it's SvPOK */
1964 goto string; /* Share code below */
1966 } else if (flags & SVf_POK) {
1967 /* public string - go direct to string read. */
1968 goto string_readlen;
1970 #if (PATCHLEVEL <= 6)
1971 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
1972 direct if NV flag is off. */
1973 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
1975 /* 5.7 rules are that if IV public flag is set, IV value is as
1976 good, if not better, than NV value. */
1982 * Will come here from below with iv set if double is an integer.
1986 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1988 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
1989 * (for example) and that ends up in the optimised small integer
1992 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
1993 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
1994 goto string_readlen;
1998 * Optimize small integers into a single byte, otherwise store as
1999 * a real integer (converted into network order if they asked).
2002 if (iv >= -128 && iv <= 127) {
2003 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
2006 TRACEME(("small integer stored as %d", siv));
2007 } else if (cxt->netorder) {
2009 TRACEME(("no htonl, fall back to string for integer"));
2010 goto string_readlen;
2018 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2019 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
2021 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
2022 /* Bigger than 32 bits. */
2023 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2024 goto string_readlen;
2028 niv = (I32) htonl((I32) iv);
2029 TRACEME(("using network order"));
2034 PUTMARK(SX_INTEGER);
2035 WRITE(&iv, sizeof(iv));
2038 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2039 } else if (flags & SVf_NOK) {
2041 #if (PATCHLEVEL <= 6)
2044 * Watch for number being an integer in disguise.
2046 if (nv == (NV) (iv = I_V(nv))) {
2047 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2048 goto integer; /* Share code above */
2053 if (SvIOK_notUV(sv)) {
2055 goto integer; /* Share code above */
2060 if (cxt->netorder) {
2061 TRACEME(("double %"NVff" stored as string", nv));
2062 goto string_readlen; /* Share code below */
2066 WRITE(&nv, sizeof(nv));
2068 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2070 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2071 I32 wlen; /* For 64-bit machines */
2077 * Will come here from above if it was readonly, POK and NOK but
2078 * neither &PL_sv_yes nor &PL_sv_no.
2082 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2084 STORE_UTF8STR(pv, wlen);
2086 STORE_SCALAR(pv, wlen);
2087 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2088 PTR2UV(sv), SvPVX(sv), (IV)len));
2090 CROAK(("Can't determine type of %s(0x%"UVxf")",
2091 sv_reftype(sv, FALSE),
2093 return 0; /* Ok, no recursion on scalars */
2101 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2102 * Each item is stored as <object>.
2104 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2107 I32 len = av_len(av) + 1;
2111 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2114 * Signal array by emitting SX_ARRAY, followed by the array length.
2119 TRACEME(("size = %d", len));
2122 * Now store each item recursively.
2125 for (i = 0; i < len; i++) {
2126 sav = av_fetch(av, i, 0);
2128 TRACEME(("(#%d) undef item", i));
2132 TRACEME(("(#%d) item", i));
2133 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2137 TRACEME(("ok (array)"));
2143 #if (PATCHLEVEL <= 6)
2149 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2152 sortcmp(const void *a, const void *b)
2154 #if defined(USE_ITHREADS)
2156 #endif /* USE_ITHREADS */
2157 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2160 #endif /* PATCHLEVEL <= 6 */
2165 * Store a hash table.
2167 * For a "normal" hash (not restricted, no utf8 keys):
2169 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2170 * Values are stored as <object>.
2171 * Keys are stored as <length> <data>, the <data> section being omitted
2174 * For a "fancy" hash (restricted or utf8 keys):
2176 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2178 * Values are stored as <object>.
2179 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2181 * Currently the only hash flag is "restriced"
2182 * Key flags are as for hv.h
2184 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2188 #ifdef HAS_RESTRICTED_HASHES
2197 int flagged_hash = ((SvREADONLY(hv)
2198 #ifdef HAS_HASH_KEY_FLAGS
2202 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2205 /* needs int cast for C++ compilers, doesn't it? */
2206 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2209 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2213 * Signal hash by emitting SX_HASH, followed by the table length.
2217 PUTMARK(SX_FLAG_HASH);
2218 PUTMARK(hash_flags);
2223 TRACEME(("size = %d", len));
2226 * Save possible iteration state via each() on that table.
2229 riter = HvRITER(hv);
2230 eiter = HvEITER(hv);
2234 * Now store each item recursively.
2236 * If canonical is defined to some true value then store each
2237 * key/value pair in sorted order otherwise the order is random.
2238 * Canonical order is irrelevant when a deep clone operation is performed.
2240 * Fetch the value from perl only once per store() operation, and only
2245 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2246 (cxt->canonical < 0 && (cxt->canonical =
2247 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2250 * Storing in order, sorted by key.
2251 * Run through the hash, building up an array of keys in a
2252 * mortal array, sort the array and then run through the
2258 /*av_extend (av, len);*/
2260 TRACEME(("using canonical order"));
2262 for (i = 0; i < len; i++) {
2263 #ifdef HAS_RESTRICTED_HASHES
2264 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2266 HE *he = hv_iternext(hv);
2268 SV *key = hv_iterkeysv(he);
2269 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2274 for (i = 0; i < len; i++) {
2275 #ifdef HAS_RESTRICTED_HASHES
2276 int placeholders = (int)HvPLACEHOLDERS(hv);
2278 unsigned char flags = 0;
2282 SV *key = av_shift(av);
2283 /* This will fail if key is a placeholder.
2284 Track how many placeholders we have, and error if we
2286 HE *he = hv_fetch_ent(hv, key, 0, 0);
2290 if (!(val = HeVAL(he))) {
2291 /* Internal error, not I/O error */
2295 #ifdef HAS_RESTRICTED_HASHES
2296 /* Should be a placeholder. */
2297 if (placeholders-- < 0) {
2298 /* This should not happen - number of
2299 retrieves should be identical to
2300 number of placeholders. */
2303 /* Value is never needed, and PL_sv_undef is
2304 more space efficient to store. */
2307 ("Flags not 0 but %d", flags));
2308 flags = SHV_K_PLACEHOLDER;
2315 * Store value first.
2318 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2320 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2325 * Keys are written after values to make sure retrieval
2326 * can be optimal in terms of memory usage, where keys are
2327 * read into a fixed unique buffer called kbuf.
2328 * See retrieve_hash() for details.
2331 /* Implementation of restricted hashes isn't nicely
2333 if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
2334 flags |= SHV_K_LOCKED;
2337 keyval = SvPV(key, keylen_tmp);
2338 keylen = keylen_tmp;
2339 #ifdef HAS_UTF8_HASHES
2340 /* If you build without optimisation on pre 5.6
2341 then nothing spots that SvUTF8(key) is always 0,
2342 so the block isn't optimised away, at which point
2343 the linker dislikes the reference to
2346 const char *keysave = keyval;
2347 bool is_utf8 = TRUE;
2349 /* Just casting the &klen to (STRLEN) won't work
2350 well if STRLEN and I32 are of different widths.
2352 keyval = (char*)bytes_from_utf8((U8*)keyval,
2356 /* If we were able to downgrade here, then than
2357 means that we have a key which only had chars
2358 0-255, but was utf8 encoded. */
2360 if (keyval != keysave) {
2361 keylen = keylen_tmp;
2362 flags |= SHV_K_WASUTF8;
2364 /* keylen_tmp can't have changed, so no need
2365 to assign back to keylen. */
2366 flags |= SHV_K_UTF8;
2373 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2375 /* This is a workaround for a bug in 5.8.0
2376 that causes the HEK_WASUTF8 flag to be
2377 set on an HEK without the hash being
2378 marked as having key flags. We just
2379 cross our fingers and drop the flag.
2381 assert (flags == 0 || flags == SHV_K_WASUTF8);
2382 TRACEME(("(#%d) key '%s'", i, keyval));
2386 WRITE(keyval, keylen);
2387 if (flags & SHV_K_WASUTF8)
2392 * Free up the temporary array
2401 * Storing in "random" order (in the order the keys are stored
2402 * within the hash). This is the default and will be faster!
2405 for (i = 0; i < len; i++) {
2408 unsigned char flags;
2409 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2410 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2412 HE *he = hv_iternext(hv);
2414 SV *val = (he ? hv_iterval(hv, he) : 0);
2419 return 1; /* Internal error, not I/O error */
2421 /* Implementation of restricted hashes isn't nicely
2424 = (((hash_flags & SHV_RESTRICTED)
2426 ? SHV_K_LOCKED : 0);
2428 if (val == &PL_sv_placeholder) {
2429 flags |= SHV_K_PLACEHOLDER;
2434 * Store value first.
2437 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2439 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2443 hek = HeKEY_hek(he);
2445 if (len == HEf_SVKEY) {
2446 /* This is somewhat sick, but the internal APIs are
2447 * such that XS code could put one of these in in
2449 * Maybe we should be capable of storing one if
2452 key_sv = HeKEY_sv(he);
2453 flags |= SHV_K_ISSV;
2455 /* Regular string key. */
2456 #ifdef HAS_HASH_KEY_FLAGS
2458 flags |= SHV_K_UTF8;
2459 if (HEK_WASUTF8(hek))
2460 flags |= SHV_K_WASUTF8;
2466 * Keys are written after values to make sure retrieval
2467 * can be optimal in terms of memory usage, where keys are
2468 * read into a fixed unique buffer called kbuf.
2469 * See retrieve_hash() for details.
2474 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2476 /* This is a workaround for a bug in 5.8.0
2477 that causes the HEK_WASUTF8 flag to be
2478 set on an HEK without the hash being
2479 marked as having key flags. We just
2480 cross our fingers and drop the flag.
2482 assert (flags == 0 || flags == SHV_K_WASUTF8);
2483 TRACEME(("(#%d) key '%s'", i, key));
2485 if (flags & SHV_K_ISSV) {
2486 store(aTHX_ cxt, key_sv);
2495 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2498 HvRITER(hv) = riter; /* Restore hash iterator state */
2499 HvEITER(hv) = eiter;
2507 * Store a code reference.
2509 * Layout is SX_CODE <length> followed by a scalar containing the perl
2510 * source code of the code reference.
2512 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2514 #if PERL_VERSION < 6
2516 * retrieve_code does not work with perl 5.005 or less
2518 return store_other(aTHX_ cxt, (SV*)cv);
2523 SV *text, *bdeparse;
2525 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2528 cxt->deparse == 0 ||
2529 (cxt->deparse < 0 && !(cxt->deparse =
2530 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2532 return store_other(aTHX_ cxt, (SV*)cv);
2536 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2537 * blessed code references.
2539 /* Ownership of both SVs is passed to load_module, which frees them. */
2540 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2546 * create the B::Deparse object
2550 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2552 count = call_method("new", G_SCALAR);
2555 CROAK(("Unexpected return value from B::Deparse::new\n"));
2559 * call the coderef2text method
2563 XPUSHs(bdeparse); /* XXX is this already mortal? */
2564 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2566 count = call_method("coderef2text", G_SCALAR);
2569 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2573 reallen = strlen(SvPV_nolen(text));
2576 * Empty code references or XS functions are deparsed as
2577 * "(prototype) ;" or ";".
2580 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2581 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2585 * Signal code by emitting SX_CODE.
2589 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2590 TRACEME(("size = %d", len));
2591 TRACEME(("code = %s", SvPV_nolen(text)));
2594 * Now store the source code.
2597 STORE_SCALAR(SvPV_nolen(text), len);
2602 TRACEME(("ok (code)"));
2611 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2612 * a special mark, followed by the underlying tied object. For instance, when
2613 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2614 * <hash object> stands for the serialization of the tied hash.
2616 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2621 int svt = SvTYPE(sv);
2624 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2627 * We have a small run-time penalty here because we chose to factorise
2628 * all tieds objects into the same routine, and not have a store_tied_hash,
2629 * a store_tied_array, etc...
2631 * Don't use a switch() statement, as most compilers don't optimize that
2632 * well for 2/3 values. An if() else if() cascade is just fine. We put
2633 * tied hashes first, as they are the most likely beasts.
2636 if (svt == SVt_PVHV) {
2637 TRACEME(("tied hash"));
2638 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2639 } else if (svt == SVt_PVAV) {
2640 TRACEME(("tied array"));
2641 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2643 TRACEME(("tied scalar"));
2644 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2648 if (!(mg = mg_find(sv, mtype)))
2649 CROAK(("No magic '%c' found while storing tied %s", mtype,
2650 (svt == SVt_PVHV) ? "hash" :
2651 (svt == SVt_PVAV) ? "array" : "scalar"));
2654 * The mg->mg_obj found by mg_find() above actually points to the
2655 * underlying tied Perl object implementation. For instance, if the
2656 * original SV was that of a tied array, then mg->mg_obj is an AV.
2658 * Note that we store the Perl object as-is. We don't call its FETCH
2659 * method along the way. At retrieval time, we won't call its STORE
2660 * method either, but the tieing magic will be re-installed. In itself,
2661 * that ensures that the tieing semantics are preserved since futher
2662 * accesses on the retrieved object will indeed call the magic methods...
2665 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2666 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2667 if ((ret = store(aTHX_ cxt, obj)))
2670 TRACEME(("ok (tied)"));
2678 * Stores a reference to an item within a tied structure:
2680 * . \$h{key}, stores both the (tied %h) object and 'key'.
2681 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2683 * Layout is therefore either:
2684 * SX_TIED_KEY <object> <key>
2685 * SX_TIED_IDX <object> <index>
2687 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2692 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2694 if (!(mg = mg_find(sv, 'p')))
2695 CROAK(("No magic 'p' found while storing reference to tied item"));
2698 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2702 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2703 PUTMARK(SX_TIED_KEY);
2704 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2706 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2709 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2711 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2714 I32 idx = mg->mg_len;
2716 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2717 PUTMARK(SX_TIED_IDX);
2718 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2720 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2723 TRACEME(("store_tied_item: storing IDX %d", idx));
2728 TRACEME(("ok (tied item)"));
2734 * store_hook -- dispatched manually, not via sv_store[]
2736 * The blessed SV is serialized by a hook.
2740 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2742 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2743 * the trailing part [] is present, the type of object (scalar, array or hash).
2744 * There is also a bit which says how the classname is stored between:
2749 * and when the <index> form is used (classname already seen), the "large
2750 * classname" bit in <flags> indicates how large the <index> is.
2752 * The serialized string returned by the hook is of length <len2> and comes
2753 * next. It is an opaque string for us.
2755 * Those <len3> object IDs which are listed last represent the extra references
2756 * not directly serialized by the hook, but which are linked to the object.
2758 * When recursion is mandated to resolve object-IDs not yet seen, we have
2759 * instead, with <header> being flags with bits set to indicate the object type
2760 * and that recursion was indeed needed:
2762 * SX_HOOK <header> <object> <header> <object> <flags>
2764 * that same header being repeated between serialized objects obtained through
2765 * recursion, until we reach flags indicating no recursion, at which point
2766 * we know we've resynchronized with a single layout, after <flags>.
2768 * When storing a blessed ref to a tied variable, the following format is
2771 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2773 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2774 * real object type is held in the <extra> flag. At the very end of the
2775 * serialization stream, the underlying magic object is serialized, just like
2776 * any other tied variable.
2778 static int store_hook(
2792 int count; /* really len3 + 1 */
2793 unsigned char flags;
2796 int recursed = 0; /* counts recursion */
2797 int obj_type; /* object type, on 2 bits */
2800 int clone = cxt->optype & ST_CLONE;
2801 char mtype = '\0'; /* for blessed ref to tied structures */
2802 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2804 TRACEME(("store_hook, classname \"%s\", tagged #%d", HvNAME(pkg), cxt->tagnum));
2807 * Determine object type on 2 bits.
2812 obj_type = SHT_SCALAR;
2815 obj_type = SHT_ARRAY;
2818 obj_type = SHT_HASH;
2822 * Produced by a blessed ref to a tied data structure, $o in the
2823 * following Perl code.
2827 * my $o = bless \%h, 'BAR';
2829 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2830 * (since we have only 2 bits in <flags> to store the type), and an
2831 * <extra> byte flag will be emitted after the FIRST <flags> in the
2832 * stream, carrying what we put in `eflags'.
2834 obj_type = SHT_EXTRA;
2835 switch (SvTYPE(sv)) {
2837 eflags = (unsigned char) SHT_THASH;
2841 eflags = (unsigned char) SHT_TARRAY;
2845 eflags = (unsigned char) SHT_TSCALAR;
2851 CROAK(("Unexpected object type (%d) in store_hook()", type));
2853 flags = SHF_NEED_RECURSE | obj_type;
2855 classname = HvNAME(pkg);
2856 len = strlen(classname);
2859 * To call the hook, we need to fake a call like:
2861 * $object->STORABLE_freeze($cloning);
2863 * but we don't have the $object here. For instance, if $object is
2864 * a blessed array, what we have in `sv' is the array, and we can't
2865 * call a method on those.
2867 * Therefore, we need to create a temporary reference to the object and
2868 * make the call on that reference.
2871 TRACEME(("about to call STORABLE_freeze on class %s", classname));
2873 ref = newRV_noinc(sv); /* Temporary reference */
2874 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2875 SvRV_set(ref, NULL);
2876 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2878 count = AvFILLp(av) + 1;
2879 TRACEME(("store_hook, array holds %d items", count));
2882 * If they return an empty list, it means they wish to ignore the
2883 * hook for this class (and not just this instance -- that's for them
2884 * to handle if they so wish).
2886 * Simply disable the cached entry for the hook (it won't be recomputed
2887 * since it's present in the cache) and recurse to store_blessed().
2892 * They must not change their mind in the middle of a serialization.
2895 if (hv_fetch(cxt->hclass, classname, len, FALSE))
2896 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2897 (cxt->optype & ST_CLONE) ? "cloning" : "storing", classname));
2899 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
2901 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2902 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", classname));
2904 return store_blessed(aTHX_ cxt, sv, type, pkg);
2908 * Get frozen string.
2912 pv = SvPV(ary[0], len2);
2913 /* We can't use pkg_can here because it only caches one method per
2916 GV* gv = gv_fetchmethod_autoload(pkg, "STORABLE_attach", FALSE);
2917 if (gv && isGV(gv)) {
2919 CROAK(("Freeze cannot return references if %s class is using STORABLE_attach", classname));
2925 * If they returned more than one item, we need to serialize some
2926 * extra references if not already done.
2928 * Loop over the array, starting at position #1, and for each item,
2929 * ensure it is a reference, serialize it if not already done, and
2930 * replace the entry with the tag ID of the corresponding serialized
2933 * We CHEAT by not calling av_fetch() and read directly within the
2937 for (i = 1; i < count; i++) {
2941 AV *av_hook = cxt->hook_seen;
2944 CROAK(("Item #%d returned by STORABLE_freeze "
2945 "for %s is not a reference", i, classname));
2946 xsv = SvRV(rsv); /* Follow ref to know what to look for */
2949 * Look in hseen and see if we have a tag already.
2950 * Serialize entry if not done already, and get its tag.
2953 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
2954 goto sv_seen; /* Avoid moving code too far to the right */
2956 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
2959 * We need to recurse to store that object and get it to be known
2960 * so that we can resolve the list of object-IDs at retrieve time.
2962 * The first time we do this, we need to emit the proper header
2963 * indicating that we recursed, and what the type of object is (the
2964 * object we're storing via a user-hook). Indeed, during retrieval,
2965 * we'll have to create the object before recursing to retrieve the
2966 * others, in case those would point back at that object.
2969 /* [SX_HOOK] <flags> [<extra>] <object>*/
2973 if (obj_type == SHT_EXTRA)
2978 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
2981 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
2983 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
2986 * It was the first time we serialized `xsv'.
2988 * Keep this SV alive until the end of the serialization: if we
2989 * disposed of it right now by decrementing its refcount, and it was
2990 * a temporary value, some next temporary value allocated during
2991 * another STORABLE_freeze might take its place, and we'd wrongly
2992 * assume that new SV was already serialized, based on its presence
2995 * Therefore, push it away in cxt->hook_seen.
2998 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
3002 * Dispose of the REF they returned. If we saved the `xsv' away
3003 * in the array of returned SVs, that will not cause the underlying
3004 * referenced SV to be reclaimed.
3007 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
3008 SvREFCNT_dec(rsv); /* Dispose of reference */
3011 * Replace entry with its tag (not a real SV, so no refcnt increment)
3015 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
3016 i-1, PTR2UV(xsv), PTR2UV(*svh)));
3020 * Allocate a class ID if not already done.
3022 * This needs to be done after the recursion above, since at retrieval
3023 * time, we'll see the inner objects first. Many thanks to
3024 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
3025 * proposed the right fix. -- RAM, 15/09/2000
3029 if (!known_class(aTHX_ cxt, classname, len, &classnum)) {
3030 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3031 classnum = -1; /* Mark: we must store classname */
3033 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3037 * Compute leading flags.
3041 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3042 flags |= SHF_LARGE_CLASSLEN;
3044 flags |= SHF_IDX_CLASSNAME;
3045 if (len2 > LG_SCALAR)
3046 flags |= SHF_LARGE_STRLEN;
3048 flags |= SHF_HAS_LIST;
3049 if (count > (LG_SCALAR + 1))
3050 flags |= SHF_LARGE_LISTLEN;
3053 * We're ready to emit either serialized form:
3055 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3056 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3058 * If we recursed, the SX_HOOK has already been emitted.
3061 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3062 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3063 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3065 /* SX_HOOK <flags> [<extra>] */
3069 if (obj_type == SHT_EXTRA)
3074 /* <len> <classname> or <index> */
3075 if (flags & SHF_IDX_CLASSNAME) {
3076 if (flags & SHF_LARGE_CLASSLEN)
3079 unsigned char cnum = (unsigned char) classnum;
3083 if (flags & SHF_LARGE_CLASSLEN)
3086 unsigned char clen = (unsigned char) len;
3089 WRITE(classname, len); /* Final \0 is omitted */
3092 /* <len2> <frozen-str> */
3093 if (flags & SHF_LARGE_STRLEN) {
3094 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3095 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3097 unsigned char clen = (unsigned char) len2;
3101 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3103 /* [<len3> <object-IDs>] */
3104 if (flags & SHF_HAS_LIST) {
3105 int len3 = count - 1;
3106 if (flags & SHF_LARGE_LISTLEN)
3109 unsigned char clen = (unsigned char) len3;
3114 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3115 * real pointer, rather a tag number, well under the 32-bit limit.
3118 for (i = 1; i < count; i++) {
3119 I32 tagval = htonl(LOW_32BITS(ary[i]));
3121 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3126 * Free the array. We need extra care for indices after 0, since they
3127 * don't hold real SVs but integers cast.
3131 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3136 * If object was tied, need to insert serialization of the magic object.
3139 if (obj_type == SHT_EXTRA) {
3142 if (!(mg = mg_find(sv, mtype))) {
3143 int svt = SvTYPE(sv);
3144 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3145 mtype, (svt == SVt_PVHV) ? "hash" :
3146 (svt == SVt_PVAV) ? "array" : "scalar"));
3149 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3150 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3156 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3164 * store_blessed -- dispatched manually, not via sv_store[]
3166 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3167 * of its ancestors. If there is, then redispatch to store_hook();
3169 * Otherwise, the blessed SV is stored using the following layout:
3171 * SX_BLESS <flag> <len> <classname> <object>
3173 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3174 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3175 * Otherwise, the low order bits give the length, thereby giving a compact
3176 * representation for class names less than 127 chars long.
3178 * Each <classname> seen is remembered and indexed, so that the next time
3179 * an object in the blessed in the same <classname> is stored, the following
3182 * SX_IX_BLESS <flag> <index> <object>
3184 * where <index> is the classname index, stored on 0 or 4 bytes depending
3185 * on the high-order bit in flag (same encoding as above for <len>).
3187 static int store_blessed(
3199 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME(pkg)));
3202 * Look for a hook for this blessed SV and redirect to store_hook()
3206 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3208 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3211 * This is a blessed SV without any serialization hook.
3214 classname = HvNAME(pkg);
3215 len = strlen(classname);
3217 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3218 PTR2UV(sv), class, cxt->tagnum));
3221 * Determine whether it is the first time we see that class name (in which
3222 * case it will be stored in the SX_BLESS form), or whether we already
3223 * saw that class name before (in which case the SX_IX_BLESS form will be
3227 if (known_class(aTHX_ cxt, classname, len, &classnum)) {
3228 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3229 PUTMARK(SX_IX_BLESS);
3230 if (classnum <= LG_BLESS) {
3231 unsigned char cnum = (unsigned char) classnum;
3234 unsigned char flag = (unsigned char) 0x80;
3239 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3241 if (len <= LG_BLESS) {
3242 unsigned char clen = (unsigned char) len;
3245 unsigned char flag = (unsigned char) 0x80;
3247 WLEN(len); /* Don't BER-encode, this should be rare */
3249 WRITE(classname, len); /* Final \0 is omitted */
3253 * Now emit the <object> part.
3256 return SV_STORE(type)(aTHX_ cxt, sv);
3262 * We don't know how to store the item we reached, so return an error condition.
3263 * (it's probably a GLOB, some CODE reference, etc...)
3265 * If they defined the `forgive_me' variable at the Perl level to some
3266 * true value, then don't croak, just warn, and store a placeholder string
3269 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3274 TRACEME(("store_other"));
3277 * Fetch the value from perl only once per store() operation.
3281 cxt->forgive_me == 0 ||
3282 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3283 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3285 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3287 warn("Can't store item %s(0x%"UVxf")",
3288 sv_reftype(sv, FALSE), PTR2UV(sv));
3291 * Store placeholder string as a scalar instead...
3294 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3295 PTR2UV(sv), (char) 0);
3298 STORE_SCALAR(buf, len);
3299 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3305 *** Store driving routines
3311 * WARNING: partially duplicates Perl's sv_reftype for speed.
3313 * Returns the type of the SV, identified by an integer. That integer
3314 * may then be used to index the dynamic routine dispatch table.
3316 static int sv_type(pTHX_ SV *sv)
3318 switch (SvTYPE(sv)) {
3323 * No need to check for ROK, that can't be set here since there
3324 * is no field capable of hodling the xrv_rv reference.
3332 * Starting from SVt_PV, it is possible to have the ROK flag
3333 * set, the pointer to the other SV being either stored in
3334 * the xrv_rv (in the case of a pure SVt_RV), or as the
3335 * xpv_pv field of an SVt_PV and its heirs.
3337 * However, those SV cannot be magical or they would be an
3338 * SVt_PVMG at least.
3340 return SvROK(sv) ? svis_REF : svis_SCALAR;
3342 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3343 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3344 return svis_TIED_ITEM;
3347 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3349 return SvROK(sv) ? svis_REF : svis_SCALAR;
3351 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3355 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3370 * Recursively store objects pointed to by the sv to the specified file.
3372 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3373 * object (one for which storage has started -- it may not be over if we have
3374 * a self-referenced structure). This data set forms a stored <object>.
3376 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3381 HV *hseen = cxt->hseen;
3383 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3386 * If object has already been stored, do not duplicate data.
3387 * Simply emit the SX_OBJECT marker followed by its tag data.
3388 * The tag is always written in network order.
3390 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3391 * real pointer, rather a tag number (watch the insertion code below).
3392 * That means it probably safe to assume it is well under the 32-bit limit,
3393 * and makes the truncation safe.
3394 * -- RAM, 14/09/1999
3397 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3401 if (sv == &PL_sv_undef) {
3402 /* We have seen PL_sv_undef before, but fake it as
3405 Not the simplest solution to making restricted
3406 hashes work on 5.8.0, but it does mean that
3407 repeated references to the one true undef will
3408 take up less space in the output file.
3410 /* Need to jump past the next hv_store, because on the
3411 second store of undef the old hash value will be
3412 SvREFCNT_dec()ed, and as Storable cheats horribly
3413 by storing non-SVs in the hash a SEGV will ensure.
3414 Need to increase the tag number so that the
3415 receiver has no idea what games we're up to. This
3416 special casing doesn't affect hooks that store
3417 undef, as the hook routine does its own lookup into
3418 hseen. Also this means that any references back
3419 to PL_sv_undef (from the pathological case of hooks
3420 storing references to it) will find the seen hash
3421 entry for the first time, as if we didn't have this
3422 hackery here. (That hseen lookup works even on 5.8.0
3423 because it's a key of &PL_sv_undef and a value
3424 which is a tag number, not a value which is
3428 goto undef_special_case;
3431 tagval = htonl(LOW_32BITS(*svh));
3433 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3441 * Allocate a new tag and associate it with the address of the sv being
3442 * stored, before recursing...
3444 * In order to avoid creating new SvIVs to hold the tagnum we just
3445 * cast the tagnum to an SV pointer and store that in the hash. This
3446 * means that we must clean up the hash manually afterwards, but gives
3447 * us a 15% throughput increase.
3452 if (!hv_store(hseen,
3453 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3457 * Store `sv' and everything beneath it, using appropriate routine.
3458 * Abort immediately if we get a non-zero status back.
3461 type = sv_type(aTHX_ sv);
3464 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3465 PTR2UV(sv), cxt->tagnum, type));
3468 HV *pkg = SvSTASH(sv);
3469 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3471 ret = SV_STORE(type)(aTHX_ cxt, sv);
3473 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3474 ret ? "FAILED" : "ok", PTR2UV(sv),
3475 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3483 * Write magic number and system information into the file.
3484 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3485 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3486 * All size and lenghts are written as single characters here.
3488 * Note that no byte ordering info is emitted when <network> is true, since
3489 * integers will be emitted in network order in that case.
3491 static int magic_write(pTHX_ stcxt_t *cxt)
3494 * Starting with 0.6, the "use_network_order" byte flag is also used to
3495 * indicate the version number of the binary image, encoded in the upper
3496 * bits. The bit 0 is always used to indicate network order.
3499 * Starting with 0.7, a full byte is dedicated to the minor version of
3500 * the binary format, which is incremented only when new markers are
3501 * introduced, for instance, but when backward compatibility is preserved.
3504 /* Make these at compile time. The WRITE() macro is sufficiently complex
3505 that it saves about 200 bytes doing it this way and only using it
3507 static const unsigned char network_file_header[] = {
3509 (STORABLE_BIN_MAJOR << 1) | 1,
3510 STORABLE_BIN_WRITE_MINOR
3512 static const unsigned char file_header[] = {
3514 (STORABLE_BIN_MAJOR << 1) | 0,
3515 STORABLE_BIN_WRITE_MINOR,
3516 /* sizeof the array includes the 0 byte at the end: */
3517 (char) sizeof (byteorderstr) - 1,
3519 (unsigned char) sizeof(int),
3520 (unsigned char) sizeof(long),
3521 (unsigned char) sizeof(char *),
3522 (unsigned char) sizeof(NV)
3524 #ifdef USE_56_INTERWORK_KLUDGE
3525 static const unsigned char file_header_56[] = {
3527 (STORABLE_BIN_MAJOR << 1) | 0,
3528 STORABLE_BIN_WRITE_MINOR,
3529 /* sizeof the array includes the 0 byte at the end: */
3530 (char) sizeof (byteorderstr_56) - 1,
3532 (unsigned char) sizeof(int),
3533 (unsigned char) sizeof(long),
3534 (unsigned char) sizeof(char *),
3535 (unsigned char) sizeof(NV)
3538 const unsigned char *header;
3541 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3543 if (cxt->netorder) {
3544 header = network_file_header;
3545 length = sizeof (network_file_header);
3547 #ifdef USE_56_INTERWORK_KLUDGE
3548 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3549 header = file_header_56;
3550 length = sizeof (file_header_56);
3554 header = file_header;
3555 length = sizeof (file_header);
3560 /* sizeof the array includes the 0 byte at the end. */
3561 header += sizeof (magicstr) - 1;
3562 length -= sizeof (magicstr) - 1;
3565 WRITE( (unsigned char*) header, length);
3567 if (!cxt->netorder) {
3568 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3569 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3570 (int) sizeof(int), (int) sizeof(long),
3571 (int) sizeof(char *), (int) sizeof(NV)));
3579 * Common code for store operations.
3581 * When memory store is requested (f = NULL) and a non null SV* is given in
3582 * `res', it is filled with a new SV created out of the memory buffer.
3584 * It is required to provide a non-null `res' when the operation type is not
3585 * dclone() and store() is performed to memory.
3587 static int do_store(
3598 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3599 ("must supply result SV pointer for real recursion to memory"));
3601 TRACEME(("do_store (optype=%d, netorder=%d)",
3602 optype, network_order));
3607 * Workaround for CROAK leak: if they enter with a "dirty" context,
3608 * free up memory for them now.
3612 clean_context(aTHX_ cxt);
3615 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3616 * re-enter store() via the hooks. We need to stack contexts.
3620 cxt = allocate_context(aTHX_ cxt);
3624 ASSERT(cxt->entry == 1, ("starting new recursion"));
3625 ASSERT(!cxt->s_dirty, ("clean context"));
3628 * Ensure sv is actually a reference. From perl, we called something
3630 * pstore(aTHX_ FILE, \@array);
3631 * so we must get the scalar value behing that reference.
3635 CROAK(("Not a reference"));
3636 sv = SvRV(sv); /* So follow it to know what to store */
3639 * If we're going to store to memory, reset the buffer.
3646 * Prepare context and emit headers.
3649 init_store_context(aTHX_ cxt, f, optype, network_order);
3651 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3652 return 0; /* Error */
3655 * Recursively store object...
3658 ASSERT(is_storing(aTHX), ("within store operation"));
3660 status = store(aTHX_ cxt, sv); /* Just do it! */
3663 * If they asked for a memory store and they provided an SV pointer,
3664 * make an SV string out of the buffer and fill their pointer.
3666 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3667 * an SV, since context cleanup might free the buffer if we did recurse.
3668 * (unless caller is dclone(), which is aware of that).
3671 if (!cxt->fio && res)
3672 *res = mbuf2sv(aTHX);
3677 * The "root" context is never freed, since it is meant to be always
3678 * handy for the common case where no recursion occurs at all (i.e.
3679 * we enter store() outside of any Storable code and leave it, period).
3680 * We know it's the "root" context because there's nothing stacked
3685 * When deep cloning, we don't free the context: doing so would force
3686 * us to copy the data in the memory buffer. Sicne we know we're
3687 * about to enter do_retrieve...
3690 clean_store_context(aTHX_ cxt);
3691 if (cxt->prev && !(cxt->optype & ST_CLONE))
3692 free_context(aTHX_ cxt);
3694 TRACEME(("do_store returns %d", status));
3702 * Store the transitive data closure of given object to disk.
3703 * Returns 0 on error, a true value otherwise.
3705 int pstore(pTHX_ PerlIO *f, SV *sv)
3707 TRACEME(("pstore"));
3708 return do_store(aTHX_ f, sv, 0, FALSE, (SV**) 0);
3715 * Same as pstore(), but network order is used for integers and doubles are
3716 * emitted as strings.
3718 int net_pstore(pTHX_ PerlIO *f, SV *sv)
3720 TRACEME(("net_pstore"));
3721 return do_store(aTHX_ f, sv, 0, TRUE, (SV**) 0);
3731 * Build a new SV out of the content of the internal memory buffer.
3733 static SV *mbuf2sv(pTHX)
3737 return newSVpv(mbase, MBUF_SIZE());
3743 * Store the transitive data closure of given object to memory.
3744 * Returns undef on error, a scalar value containing the data otherwise.
3746 SV *mstore(pTHX_ SV *sv)
3750 TRACEME(("mstore"));
3752 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, FALSE, &out))
3753 return &PL_sv_undef;
3761 * Same as mstore(), but network order is used for integers and doubles are
3762 * emitted as strings.
3764 SV *net_mstore(pTHX_ SV *sv)
3768 TRACEME(("net_mstore"));
3770 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, TRUE, &out))
3771 return &PL_sv_undef;
3777 *** Specific retrieve callbacks.
3783 * Return an error via croak, since it is not possible that we get here
3784 * under normal conditions, when facing a file produced via pstore().
3786 static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname)
3789 cxt->ver_major != STORABLE_BIN_MAJOR &&
3790 cxt->ver_minor != STORABLE_BIN_MINOR
3792 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3793 cxt->fio ? "file" : "string",
3794 cxt->ver_major, cxt->ver_minor,
3795 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3797 CROAK(("Corrupted storable %s (binary v%d.%d)",
3798 cxt->fio ? "file" : "string",
3799 cxt->ver_major, cxt->ver_minor));
3802 return (SV *) 0; /* Just in case */
3806 * retrieve_idx_blessed
3808 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3809 * <index> can be coded on either 1 or 5 bytes.
3811 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname)
3818 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3819 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3821 GETMARK(idx); /* Index coded on a single char? */
3826 * Fetch classname in `aclass'
3829 sva = av_fetch(cxt->aclass, idx, FALSE);
3831 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3833 classname = SvPVX(*sva); /* We know it's a PV, by construction */
3835 TRACEME(("class ID %d => %s", idx, classname));
3838 * Retrieve object and bless it.
3841 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3849 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3850 * <len> can be coded on either 1 or 5 bytes.
3852 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname)
3856 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3857 char *classname = buf;
3859 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3860 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3863 * Decode class name length and read that name.
3865 * Short classnames have two advantages: their length is stored on one
3866 * single byte, and the string can be read on the stack.
3869 GETMARK(len); /* Length coded on a single char? */
3872 TRACEME(("** allocating %d bytes for class name", len+1));
3873 New(10003, classname, len+1, char);
3875 READ(classname, len);
3876 classname[len] = '\0'; /* Mark string end */
3879 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3882 TRACEME(("new class name \"%s\" will bear ID = %d", classname, cxt->classnum));
3884 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len)))
3888 * Retrieve object and bless it.
3891 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3892 if (classname != buf)
3893 Safefree(classname);
3901 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3902 * with leading mark already read, as usual.
3904 * When recursion was involved during serialization of the object, there
3905 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
3906 * we reach a <flags> marker with the recursion bit cleared.
3908 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
3909 * is held in the <extra> byte, and if the object is tied, the serialized
3910 * magic object comes at the very end:
3912 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
3914 * This means the STORABLE_thaw hook will NOT get a tied variable during its
3915 * processing (since we won't have seen the magic object by the time the hook
3916 * is called). See comments below for why it was done that way.
3918 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname)
3921 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3922 char *classname = buf;
3933 int clone = cxt->optype & ST_CLONE;
3935 unsigned int extra_type = 0;
3937 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
3938 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3941 * Read flags, which tell us about the type, and whether we need to recurse.
3947 * Create the (empty) object, and mark it as seen.
3949 * This must be done now, because tags are incremented, and during
3950 * serialization, the object tag was affected before recursion could
3954 obj_type = flags & SHF_TYPE_MASK;
3960 sv = (SV *) newAV();
3963 sv = (SV *) newHV();
3967 * Read <extra> flag to know the type of the object.
3968 * Record associated magic type for later.
3970 GETMARK(extra_type);
3971 switch (extra_type) {
3977 sv = (SV *) newAV();
3981 sv = (SV *) newHV();
3985 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
3989 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
3991 SEEN(sv, 0, 0); /* Don't bless yet */
3994 * Whilst flags tell us to recurse, do so.
3996 * We don't need to remember the addresses returned by retrieval, because
3997 * all the references will be obtained through indirection via the object
3998 * tags in the object-ID list.
4000 * We need to decrement the reference count for these objects
4001 * because, if the user doesn't save a reference to them in the hook,
4002 * they must be freed when this context is cleaned.
4005 while (flags & SHF_NEED_RECURSE) {
4006 TRACEME(("retrieve_hook recursing..."));
4007 rv = retrieve(aTHX_ cxt, 0);
4011 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
4016 if (flags & SHF_IDX_CLASSNAME) {
4021 * Fetch index from `aclass'
4024 if (flags & SHF_LARGE_CLASSLEN)
4029 sva = av_fetch(cxt->aclass, idx, FALSE);
4031 CROAK(("Class name #%"IVdf" should have been seen already",
4034 classname = SvPVX(*sva); /* We know it's a PV, by construction */
4035 TRACEME(("class ID %d => %s", idx, classname));
4039 * Decode class name length and read that name.
4041 * NOTA BENE: even if the length is stored on one byte, we don't read
4042 * on the stack. Just like retrieve_blessed(), we limit the name to
4043 * LG_BLESS bytes. This is an arbitrary decision.
4046 if (flags & SHF_LARGE_CLASSLEN)
4051 if (len > LG_BLESS) {
4052 TRACEME(("** allocating %d bytes for class name", len+1));
4053 New(10003, classname, len+1, char);
4056 READ(classname, len);
4057 classname[len] = '\0'; /* Mark string end */
4060 * Record new classname.
4063 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len)))
4067 TRACEME(("class name: %s", classname));
4070 * Decode user-frozen string length and read it in an SV.
4072 * For efficiency reasons, we read data directly into the SV buffer.
4073 * To understand that code, read retrieve_scalar()
4076 if (flags & SHF_LARGE_STRLEN)
4081 frozen = NEWSV(10002, len2);
4083 SAFEREAD(SvPVX(frozen), len2, frozen);
4084 SvCUR_set(frozen, len2);
4085 *SvEND(frozen) = '\0';
4087 (void) SvPOK_only(frozen); /* Validates string pointer */
4088 if (cxt->s_tainted) /* Is input source tainted? */
4091 TRACEME(("frozen string: %d bytes", len2));
4094 * Decode object-ID list length, if present.
4097 if (flags & SHF_HAS_LIST) {
4098 if (flags & SHF_LARGE_LISTLEN)
4104 av_extend(av, len3 + 1); /* Leave room for [0] */
4105 AvFILLp(av) = len3; /* About to be filled anyway */
4109 TRACEME(("has %d object IDs to link", len3));
4112 * Read object-ID list into array.
4113 * Because we pre-extended it, we can cheat and fill it manually.
4115 * We read object tags and we can convert them into SV* on the fly
4116 * because we know all the references listed in there (as tags)
4117 * have been already serialized, hence we have a valid correspondance
4118 * between each of those tags and the recreated SV.
4122 SV **ary = AvARRAY(av);
4124 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
4131 svh = av_fetch(cxt->aseen, tag, FALSE);
4133 if (tag == cxt->where_is_undef) {
4134 /* av_fetch uses PL_sv_undef internally, hence this
4135 somewhat gruesome hack. */
4139 CROAK(("Object #%"IVdf" should have been retrieved already",
4144 ary[i] = SvREFCNT_inc(xsv);
4149 * Bless the object and look up the STORABLE_thaw hook.
4152 BLESS(sv, classname);
4154 /* Handle attach case; again can't use pkg_can because it only
4155 * caches one method */
4156 attach = gv_fetchmethod_autoload(SvSTASH(sv), "STORABLE_attach", FALSE);
4157 if (attach && isGV(attach)) {
4159 SV* attach_hook = newRV((SV*) GvCV(attach));
4162 CROAK(("STORABLE_attach called with unexpected references"));
4166 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4167 rv = newSVpv(classname, 0);
4168 attached = scalar_call(aTHX_ rv, attach_hook, clone, av, G_SCALAR);
4171 sv_derived_from(attached, classname))
4172 return SvRV(attached);
4173 CROAK(("STORABLE_attach did not return a %s object", classname));
4176 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4179 * Hook not found. Maybe they did not require the module where this
4180 * hook is defined yet?
4182 * If the require below succeeds, we'll be able to find the hook.
4183 * Still, it only works reliably when each class is defined in a
4187 SV *psv = newSVpvn("require ", 8);
4188 sv_catpv(psv, classname);
4190 TRACEME(("No STORABLE_thaw defined for objects of class %s", classname));
4191 TRACEME(("Going to require module '%s' with '%s'", classname, SvPVX(psv)));
4193 perl_eval_sv(psv, G_DISCARD);
4197 * We cache results of pkg_can, so we need to uncache before attempting
4201 pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4202 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4205 CROAK(("No STORABLE_thaw defined for objects of class %s "
4206 "(even after a \"require %s;\")", classname, classname));
4210 * If we don't have an `av' yet, prepare one.
4211 * Then insert the frozen string as item [0].
4219 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4224 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4226 * where $object is our blessed (empty) object, $cloning is a boolean
4227 * telling whether we're running a deep clone, $frozen is the frozen
4228 * string the user gave us in his serializing hook, and @refs, which may
4229 * be empty, is the list of extra references he returned along for us
4232 * In effect, the hook is an alternate creation routine for the class,
4233 * the object itself being already created by the runtime.
4236 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4237 classname, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4240 (void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
4247 SvREFCNT_dec(frozen);
4250 if (!(flags & SHF_IDX_CLASSNAME) && classname != buf)
4251 Safefree(classname);
4254 * If we had an <extra> type, then the object was not as simple, and
4255 * we need to restore extra magic now.
4261 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4263 rv = retrieve(aTHX_ cxt, 0); /* Retrieve <magic object> */
4265 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4266 PTR2UV(rv), PTR2UV(sv)));
4268 switch (extra_type) {
4270 sv_upgrade(sv, SVt_PVMG);
4273 sv_upgrade(sv, SVt_PVAV);
4274 AvREAL_off((AV *)sv);
4277 sv_upgrade(sv, SVt_PVHV);
4280 CROAK(("Forgot to deal with extra type %d", extra_type));
4285 * Adding the magic only now, well after the STORABLE_thaw hook was called
4286 * means the hook cannot know it deals with an object whose variable is
4287 * tied. But this is happening when retrieving $o in the following case:
4291 * my $o = bless \%h, 'BAR';
4293 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4294 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4295 * hash but a tied one should not matter at all, and remain transparent.
4296 * This means the magic must be restored by Storable AFTER the hook is
4299 * That looks very reasonable to me, but then I've come up with this
4300 * after a bug report from David Nesting, who was trying to store such
4301 * an object and caused Storable to fail. And unfortunately, it was
4302 * also the easiest way to retrofit support for blessed ref to tied objects
4303 * into the existing design. -- RAM, 17/02/2001
4306 sv_magic(sv, rv, mtype, Nullch, 0);
4307 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4315 * Retrieve reference to some other scalar.
4316 * Layout is SX_REF <object>, with SX_REF already read.
4318 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname)
4323 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4326 * We need to create the SV that holds the reference to the yet-to-retrieve
4327 * object now, so that we may record the address in the seen table.
4328 * Otherwise, if the object to retrieve references us, we won't be able
4329 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4330 * do the retrieve first and use rv = newRV(sv) since it will be too late
4331 * for SEEN() recording.
4334 rv = NEWSV(10002, 0);
4335 SEEN(rv, cname, 0); /* Will return if rv is null */
4336 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4338 return (SV *) 0; /* Failed */
4341 * WARNING: breaks RV encapsulation.
4343 * Now for the tricky part. We have to upgrade our existing SV, so that
4344 * it is now an RV on sv... Again, we cheat by duplicating the code
4345 * held in newSVrv(), since we already got our SV from retrieve().
4349 * SvRV(rv) = SvREFCNT_inc(sv);
4351 * here because the reference count we got from retrieve() above is
4352 * already correct: if the object was retrieved from the file, then
4353 * its reference count is one. Otherwise, if it was retrieved via
4354 * an SX_OBJECT indication, a ref count increment was done.
4358 /* No need to do anything, as rv will already be PVMG. */
4359 assert (SvTYPE(rv) >= SVt_RV);
4361 sv_upgrade(rv, SVt_RV);
4364 SvRV_set(rv, sv); /* $rv = \$sv */
4367 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4375 * Retrieve weak reference to some other scalar.
4376 * Layout is SX_WEAKREF <object>, with SX_WEAKREF already read.
4378 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, char *cname)
4382 TRACEME(("retrieve_weakref (#%d)", cxt->tagnum));
4384 sv = retrieve_ref(aTHX_ cxt, cname);
4396 * retrieve_overloaded
4398 * Retrieve reference to some other scalar with overloading.
4399 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4401 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname)
4407 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4410 * Same code as retrieve_ref(), duplicated to avoid extra call.
4413 rv = NEWSV(10002, 0);
4414 SEEN(rv, cname, 0); /* Will return if rv is null */
4415 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4417 return (SV *) 0; /* Failed */
4420 * WARNING: breaks RV encapsulation.
4423 sv_upgrade(rv, SVt_RV);
4424 SvRV_set(rv, sv); /* $rv = \$sv */
4428 * Restore overloading magic.
4431 stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
4433 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4434 ") (package <unknown>)",
4435 sv_reftype(sv, FALSE),
4438 if (!Gv_AMG(stash)) {
4439 SV *psv = newSVpvn("require ", 8);
4440 const char *package = HvNAME(stash);
4441 sv_catpv(psv, package);
4443 TRACEME(("No overloading defined for package %s", package));
4444 TRACEME(("Going to require module '%s' with '%s'", package, SvPVX(psv)));
4446 perl_eval_sv(psv, G_DISCARD);
4448 if (!Gv_AMG(stash)) {
4449 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4450 ") (package %s) (even after a \"require %s;\")",
4451 sv_reftype(sv, FALSE),
4459 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4465 * retrieve_weakoverloaded
4467 * Retrieve weak overloaded reference to some other scalar.
4468 * Layout is SX_WEAKOVERLOADED <object>, with SX_WEAKOVERLOADED already read.
4470 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, char *cname)
4474 TRACEME(("retrieve_weakoverloaded (#%d)", cxt->tagnum));
4476 sv = retrieve_overloaded(aTHX_ cxt, cname);
4488 * retrieve_tied_array
4490 * Retrieve tied array
4491 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4493 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname)
4498 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4500 tv = NEWSV(10002, 0);
4501 SEEN(tv, cname, 0); /* Will return if tv is null */
4502 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4504 return (SV *) 0; /* Failed */
4506 sv_upgrade(tv, SVt_PVAV);
4507 AvREAL_off((AV *)tv);
4508 sv_magic(tv, sv, 'P', Nullch, 0);
4509 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4511 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4517 * retrieve_tied_hash
4519 * Retrieve tied hash
4520 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4522 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname)
4527 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4529 tv = NEWSV(10002, 0);
4530 SEEN(tv, cname, 0); /* Will return if tv is null */
4531 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4533 return (SV *) 0; /* Failed */
4535 sv_upgrade(tv, SVt_PVHV);
4536 sv_magic(tv, sv, 'P', Nullch, 0);
4537 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4539 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4545 * retrieve_tied_scalar
4547 * Retrieve tied scalar
4548 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4550 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname)
4553 SV *sv, *obj = NULL;
4555 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4557 tv = NEWSV(10002, 0);
4558 SEEN(tv, cname, 0); /* Will return if rv is null */
4559 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4561 return (SV *) 0; /* Failed */
4563 else if (SvTYPE(sv) != SVt_NULL) {
4567 sv_upgrade(tv, SVt_PVMG);
4568 sv_magic(tv, obj, 'q', Nullch, 0);
4571 /* Undo refcnt inc from sv_magic() */
4575 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4583 * Retrieve reference to value in a tied hash.
4584 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4586 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname)
4592 TRACEME(("retrieve_tied_key (#%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 key = retrieve(aTHX_ cxt, 0); /* Retrieve <key> */
4602 return (SV *) 0; /* Failed */
4604 sv_upgrade(tv, SVt_PVMG);
4605 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4606 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4607 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4615 * Retrieve reference to value in a tied array.
4616 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4618 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname)
4624 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4626 tv = NEWSV(10002, 0);
4627 SEEN(tv, cname, 0); /* Will return if tv is null */
4628 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4630 return (SV *) 0; /* Failed */
4632 RLEN(idx); /* Retrieve <idx> */
4634 sv_upgrade(tv, SVt_PVMG);
4635 sv_magic(tv, sv, 'p', Nullch, idx);
4636 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4645 * Retrieve defined long (string) scalar.
4647 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4648 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4649 * was not stored on a single byte.
4651 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname)
4657 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4660 * Allocate an empty scalar of the suitable length.
4663 sv = NEWSV(10002, len);
4664 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4667 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4669 * Now, for efficiency reasons, read data directly inside the SV buffer,
4670 * and perform the SV final settings directly by duplicating the final
4671 * work done by sv_setpv. Since we're going to allocate lots of scalars
4672 * this way, it's worth the hassle and risk.
4675 SAFEREAD(SvPVX(sv), len, sv);
4676 SvCUR_set(sv, len); /* Record C string length */
4677 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4678 (void) SvPOK_only(sv); /* Validate string pointer */
4679 if (cxt->s_tainted) /* Is input source tainted? */
4680 SvTAINT(sv); /* External data cannot be trusted */
4682 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4683 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4691 * Retrieve defined short (string) scalar.
4693 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4694 * The scalar is "short" so <length> is single byte. If it is 0, there
4695 * is no <data> section.
4697 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname)
4703 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4706 * Allocate an empty scalar of the suitable length.
4709 sv = NEWSV(10002, len);
4710 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4713 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4718 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4719 * To make it defined with an empty length, upgrade it now...
4720 * Don't upgrade to a PV if the original type contains more
4721 * information than a scalar.
4723 if (SvTYPE(sv) <= SVt_PV) {
4724 sv_upgrade(sv, SVt_PV);
4727 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4728 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4731 * Now, for efficiency reasons, read data directly inside the SV buffer,
4732 * and perform the SV final settings directly by duplicating the final
4733 * work done by sv_setpv. Since we're going to allocate lots of scalars
4734 * this way, it's worth the hassle and risk.
4736 SAFEREAD(SvPVX(sv), len, sv);
4737 SvCUR_set(sv, len); /* Record C string length */
4738 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4739 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4742 (void) SvPOK_only(sv); /* Validate string pointer */
4743 if (cxt->s_tainted) /* Is input source tainted? */
4744 SvTAINT(sv); /* External data cannot be trusted */
4746 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4753 * Like retrieve_scalar(), but tag result as utf8.
4754 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4756 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname)
4760 TRACEME(("retrieve_utf8str"));
4762 sv = retrieve_scalar(aTHX_ cxt, cname);
4764 #ifdef HAS_UTF8_SCALARS
4767 if (cxt->use_bytes < 0)
4769 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4771 if (cxt->use_bytes == 0)
4782 * Like retrieve_lscalar(), but tag result as utf8.
4783 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4785 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname)
4789 TRACEME(("retrieve_lutf8str"));
4791 sv = retrieve_lscalar(aTHX_ cxt, cname);
4793 #ifdef HAS_UTF8_SCALARS
4796 if (cxt->use_bytes < 0)
4798 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4800 if (cxt->use_bytes == 0)
4810 * Retrieve defined integer.
4811 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4813 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname)
4818 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4820 READ(&iv, sizeof(iv));
4822 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4824 TRACEME(("integer %"IVdf, iv));
4825 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4833 * Retrieve defined integer in network order.
4834 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4836 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname)
4841 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4845 sv = newSViv((int) ntohl(iv));
4846 TRACEME(("network integer %d", (int) ntohl(iv)));
4849 TRACEME(("network integer (as-is) %d", iv));
4851 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4853 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
4861 * Retrieve defined double.
4862 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
4864 static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname)
4869 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
4871 READ(&nv, sizeof(nv));
4873 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4875 TRACEME(("double %"NVff, nv));
4876 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
4884 * Retrieve defined byte (small integer within the [-128, +127] range).
4885 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
4887 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname)
4891 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
4893 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
4896 TRACEME(("small integer read as %d", (unsigned char) siv));
4897 tmp = (unsigned char) siv - 128;
4899 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4901 TRACEME(("byte %d", tmp));
4902 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
4910 * Return the undefined value.
4912 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname)
4916 TRACEME(("retrieve_undef"));
4927 * Return the immortal undefined value.
4929 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname)
4931 SV *sv = &PL_sv_undef;
4933 TRACEME(("retrieve_sv_undef"));
4935 /* Special case PL_sv_undef, as av_fetch uses it internally to mark
4936 deleted elements, and will return NULL (fetch failed) whenever it
4938 if (cxt->where_is_undef == -1) {
4939 cxt->where_is_undef = cxt->tagnum;
4948 * Return the immortal yes value.
4950 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname)
4952 SV *sv = &PL_sv_yes;
4954 TRACEME(("retrieve_sv_yes"));
4963 * Return the immortal no value.
4965 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname)
4969 TRACEME(("retrieve_sv_no"));
4978 * Retrieve a whole array.
4979 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
4980 * Each item is stored as <object>.
4982 * When we come here, SX_ARRAY has been read already.
4984 static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname)
4991 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
4994 * Read length, and allocate array, then pre-extend it.
4998 TRACEME(("size = %d", len));
5000 SEEN(av, cname, 0); /* Will return if array not allocated nicely */
5004 return (SV *) av; /* No data follow if array is empty */
5007 * Now get each item in turn...
5010 for (i = 0; i < len; i++) {
5011 TRACEME(("(#%d) item", i));
5012 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5015 if (av_store(av, i, sv) == 0)
5019 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5027 * Retrieve a whole hash table.
5028 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5029 * Keys are stored as <length> <data>, the <data> section being omitted
5031 * Values are stored as <object>.
5033 * When we come here, SX_HASH has been read already.
5035 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname)
5043 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
5046 * Read length, allocate table.
5050 TRACEME(("size = %d", len));
5052 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5054 return (SV *) hv; /* No data follow if table empty */
5055 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5058 * Now get each key/value pair in turn...
5061 for (i = 0; i < len; i++) {
5066 TRACEME(("(#%d) value", i));
5067 sv = retrieve(aTHX_ cxt, 0);
5073 * Since we're reading into kbuf, we must ensure we're not
5074 * recursing between the read and the hv_store() where it's used.
5075 * Hence the key comes after the value.
5078 RLEN(size); /* Get key size */
5079 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5082 kbuf[size] = '\0'; /* Mark string end, just in case */
5083 TRACEME(("(#%d) key '%s'", i, kbuf));
5086 * Enter key/value pair into hash table.
5089 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5093 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5101 * Retrieve a whole hash table.
5102 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5103 * Keys are stored as <length> <data>, the <data> section being omitted
5105 * Values are stored as <object>.
5107 * When we come here, SX_HASH has been read already.
5109 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname)
5119 GETMARK(hash_flags);
5120 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
5122 * Read length, allocate table.
5125 #ifndef HAS_RESTRICTED_HASHES
5126 if (hash_flags & SHV_RESTRICTED) {
5127 if (cxt->derestrict < 0)
5129 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
5131 if (cxt->derestrict == 0)
5132 RESTRICTED_HASH_CROAK();
5137 TRACEME(("size = %d, flags = %d", len, hash_flags));
5139 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5141 return (SV *) hv; /* No data follow if table empty */
5142 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5145 * Now get each key/value pair in turn...
5148 for (i = 0; i < len; i++) {
5150 int store_flags = 0;
5155 TRACEME(("(#%d) value", i));
5156 sv = retrieve(aTHX_ cxt, 0);
5161 #ifdef HAS_RESTRICTED_HASHES
5162 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
5166 if (flags & SHV_K_ISSV) {
5167 /* XXX you can't set a placeholder with an SV key.
5168 Then again, you can't get an SV key.
5169 Without messing around beyond what the API is supposed to do.
5172 TRACEME(("(#%d) keysv, flags=%d", i, flags));
5173 keysv = retrieve(aTHX_ cxt, 0);
5177 if (!hv_store_ent(hv, keysv, sv, 0))
5182 * Since we're reading into kbuf, we must ensure we're not
5183 * recursing between the read and the hv_store() where it's used.
5184 * Hence the key comes after the value.
5187 if (flags & SHV_K_PLACEHOLDER) {
5189 sv = &PL_sv_placeholder;
5190 store_flags |= HVhek_PLACEHOLD;
5192 if (flags & SHV_K_UTF8) {
5193 #ifdef HAS_UTF8_HASHES
5194 store_flags |= HVhek_UTF8;
5196 if (cxt->use_bytes < 0)
5198 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
5200 if (cxt->use_bytes == 0)
5204 #ifdef HAS_UTF8_HASHES
5205 if (flags & SHV_K_WASUTF8)
5206 store_flags |= HVhek_WASUTF8;
5209 RLEN(size); /* Get key size */
5210 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5213 kbuf[size] = '\0'; /* Mark string end, just in case */
5214 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5215 flags, store_flags));
5218 * Enter key/value pair into hash table.
5221 #ifdef HAS_RESTRICTED_HASHES
5222 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5225 if (!(store_flags & HVhek_PLACEHOLD))
5226 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5231 #ifdef HAS_RESTRICTED_HASHES
5232 if (hash_flags & SHV_RESTRICTED)
5236 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5244 * Return a code reference.
5246 static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname)
5248 #if PERL_VERSION < 6
5249 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5252 int type, count, tagnum;
5254 SV *sv, *text, *sub;
5256 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5259 * Insert dummy SV in the aseen array so that we don't screw
5260 * up the tag numbers. We would just make the internal
5261 * scalar an untagged item in the stream, but
5262 * retrieve_scalar() calls SEEN(). So we just increase the
5265 tagnum = cxt->tagnum;
5270 * Retrieve the source of the code reference
5271 * as a small or large scalar
5277 text = retrieve_scalar(aTHX_ cxt, cname);
5280 text = retrieve_lscalar(aTHX_ cxt, cname);
5283 CROAK(("Unexpected type %d in retrieve_code\n", type));
5287 * prepend "sub " to the source
5290 sub = newSVpvn("sub ", 4);
5291 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5295 * evaluate the source to a code reference and use the CV value
5298 if (cxt->eval == NULL) {
5299 cxt->eval = perl_get_sv("Storable::Eval", TRUE);
5300 SvREFCNT_inc(cxt->eval);
5302 if (!SvTRUE(cxt->eval)) {
5304 cxt->forgive_me == 0 ||
5305 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5306 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
5308 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5311 /* fix up the dummy entry... */
5312 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5320 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5321 SV* errsv = get_sv("@", TRUE);
5322 sv_setpv(errsv, ""); /* clear $@ */
5324 XPUSHs(sv_2mortal(newSVsv(sub)));
5326 count = call_sv(cxt->eval, G_SCALAR);
5329 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5331 if (SvTRUE(errsv)) {
5332 CROAK(("code %s caused an error: %s",
5333 SvPV_nolen(sub), SvPV_nolen(errsv)));
5337 cv = eval_pv(SvPV_nolen(sub), TRUE);
5339 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5342 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5345 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5350 /* fix up the dummy entry... */
5351 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5358 * old_retrieve_array
5360 * Retrieve a whole array in pre-0.6 binary format.
5362 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5363 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5365 * When we come here, SX_ARRAY has been read already.
5367 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname)
5375 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5378 * Read length, and allocate array, then pre-extend it.
5382 TRACEME(("size = %d", len));
5384 SEEN(av, 0, 0); /* Will return if array not allocated nicely */
5388 return (SV *) av; /* No data follow if array is empty */
5391 * Now get each item in turn...
5394 for (i = 0; i < len; i++) {
5396 if (c == SX_IT_UNDEF) {
5397 TRACEME(("(#%d) undef item", i));
5398 continue; /* av_extend() already filled us with undef */
5401 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5402 TRACEME(("(#%d) item", i));
5403 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5406 if (av_store(av, i, sv) == 0)
5410 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5418 * Retrieve a whole hash table in pre-0.6 binary format.
5420 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5421 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5423 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5425 * When we come here, SX_HASH has been read already.
5427 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname)
5435 SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5437 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5440 * Read length, allocate table.
5444 TRACEME(("size = %d", len));
5446 SEEN(hv, 0, 0); /* Will return if table not allocated properly */
5448 return (SV *) hv; /* No data follow if table empty */
5449 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5452 * Now get each key/value pair in turn...
5455 for (i = 0; i < len; i++) {
5461 if (c == SX_VL_UNDEF) {
5462 TRACEME(("(#%d) undef value", i));
5464 * Due to a bug in hv_store(), it's not possible to pass
5465 * &PL_sv_undef to hv_store() as a value, otherwise the
5466 * associated key will not be creatable any more. -- RAM, 14/01/97
5469 sv_h_undef = newSVsv(&PL_sv_undef);
5470 sv = SvREFCNT_inc(sv_h_undef);
5471 } else if (c == SX_VALUE) {
5472 TRACEME(("(#%d) value", i));
5473 sv = retrieve(aTHX_ cxt, 0);
5477 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5481 * Since we're reading into kbuf, we must ensure we're not
5482 * recursing between the read and the hv_store() where it's used.
5483 * Hence the key comes after the value.
5488 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5489 RLEN(size); /* Get key size */
5490 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5493 kbuf[size] = '\0'; /* Mark string end, just in case */
5494 TRACEME(("(#%d) key '%s'", i, kbuf));
5497 * Enter key/value pair into hash table.
5500 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5504 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5510 *** Retrieval engine.
5516 * Make sure the stored data we're trying to retrieve has been produced
5517 * on an ILP compatible system with the same byteorder. It croaks out in
5518 * case an error is detected. [ILP = integer-long-pointer sizes]
5519 * Returns null if error is detected, &PL_sv_undef otherwise.
5521 * Note that there's no byte ordering info emitted when network order was
5522 * used at store time.
5524 static SV *magic_check(pTHX_ stcxt_t *cxt)
5526 /* The worst case for a malicious header would be old magic (which is
5527 longer), major, minor, byteorder length byte of 255, 255 bytes of
5528 garbage, sizeof int, long, pointer, NV.
5529 So the worse of that we can read is 255 bytes of garbage plus 4.
5530 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5531 compiling perl on a system with chars that are larger than 8 bits.
5532 (Even Crays aren't *that* perverse).
5534 unsigned char buf[4 + 255];
5535 unsigned char *current;
5538 int use_network_order;
5541 int version_minor = 0;
5543 TRACEME(("magic_check"));
5546 * The "magic number" is only for files, not when freezing in memory.
5550 /* This includes the '\0' at the end. I want to read the extra byte,
5551 which is usually going to be the major version number. */
5552 STRLEN len = sizeof(magicstr);
5555 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5557 /* Point at the byte after the byte we read. */
5558 current = buf + --len; /* Do the -- outside of macros. */
5560 if (memNE(buf, magicstr, len)) {
5562 * Try to read more bytes to check for the old magic number, which
5566 TRACEME(("trying for old magic number"));
5568 old_len = sizeof(old_magicstr) - 1;
5569 READ(current + 1, (SSize_t)(old_len - len));
5571 if (memNE(buf, old_magicstr, old_len))
5572 CROAK(("File is not a perl storable"));
5573 current = buf + old_len;
5575 use_network_order = *current;
5577 GETMARK(use_network_order);
5580 * Starting with 0.6, the "use_network_order" byte flag is also used to
5581 * indicate the version number of the binary, and therefore governs the
5582 * setting of sv_retrieve_vtbl. See magic_write().
5585 version_major = use_network_order >> 1;
5586 cxt->retrieve_vtbl = (SV*(**)()) (version_major ? sv_retrieve : sv_old_retrieve);
5588 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5592 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5593 * minor version of the protocol. See magic_write().
5596 if (version_major > 1)
5597 GETMARK(version_minor);
5599 cxt->ver_major = version_major;
5600 cxt->ver_minor = version_minor;
5602 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5605 * Inter-operability sanity check: we can't retrieve something stored
5606 * using a format more recent than ours, because we have no way to
5607 * know what has changed, and letting retrieval go would mean a probable
5608 * failure reporting a "corrupted" storable file.
5612 version_major > STORABLE_BIN_MAJOR ||
5613 (version_major == STORABLE_BIN_MAJOR &&
5614 version_minor > STORABLE_BIN_MINOR)
5617 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5618 STORABLE_BIN_MINOR));
5620 if (version_major == STORABLE_BIN_MAJOR) {
5621 TRACEME(("cxt->accept_future_minor is %d",
5622 cxt->accept_future_minor));
5623 if (cxt->accept_future_minor < 0)
5624 cxt->accept_future_minor
5625 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5628 if (cxt->accept_future_minor == 1)
5629 croak_now = 0; /* Don't croak yet. */
5632 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5633 version_major, version_minor,
5634 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5639 * If they stored using network order, there's no byte ordering
5640 * information to check.
5643 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5644 return &PL_sv_undef; /* No byte ordering info */
5646 /* In C truth is 1, falsehood is 0. Very convienient. */
5647 use_NV_size = version_major >= 2 && version_minor >= 2;
5650 length = c + 3 + use_NV_size;
5651 READ(buf, length); /* Not null-terminated */
5653 TRACEME(("byte order '%.*s' %d", c, buf, c));
5655 #ifdef USE_56_INTERWORK_KLUDGE
5656 /* No point in caching this in the context as we only need it once per
5657 retrieve, and we need to recheck it each read. */
5658 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5659 if ((c != (sizeof (byteorderstr_56) - 1))
5660 || memNE(buf, byteorderstr_56, c))
5661 CROAK(("Byte order is not compatible"));
5665 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5666 CROAK(("Byte order is not compatible"));
5672 if ((int) *current++ != sizeof(int))
5673 CROAK(("Integer size is not compatible"));
5676 if ((int) *current++ != sizeof(long))
5677 CROAK(("Long integer size is not compatible"));
5679 /* sizeof(char *) */
5680 if ((int) *current != sizeof(char *))
5681 CROAK(("Pointer size is not compatible"));
5685 if ((int) *++current != sizeof(NV))
5686 CROAK(("Double size is not compatible"));
5689 return &PL_sv_undef; /* OK */
5695 * Recursively retrieve objects from the specified file and return their
5696 * root SV (which may be an AV or an HV for what we care).
5697 * Returns null if there is a problem.
5699 static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname)
5705 TRACEME(("retrieve"));
5708 * Grab address tag which identifies the object if we are retrieving
5709 * an older format. Since the new binary format counts objects and no
5710 * longer explicitely tags them, we must keep track of the correspondance
5713 * The following section will disappear one day when the old format is
5714 * no longer supported, hence the final "goto" in the "if" block.
5717 if (cxt->hseen) { /* Retrieving old binary */
5719 if (cxt->netorder) {
5721 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5722 tag = (stag_t) nettag;
5724 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5727 if (type == SX_OBJECT) {
5729 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5731 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5733 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5736 * The following code is common with the SX_OBJECT case below.
5739 svh = av_fetch(cxt->aseen, tagn, FALSE);
5741 CROAK(("Object #%"IVdf" should have been retrieved already",
5744 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5745 SvREFCNT_inc(sv); /* One more reference to this same sv */
5746 return sv; /* The SV pointer where object was retrieved */
5750 * Map new object, but don't increase tagnum. This will be done
5751 * by each of the retrieve_* functions when they call SEEN().
5753 * The mapping associates the "tag" initially present with a unique
5754 * tag number. See test for SX_OBJECT above to see how this is perused.
5757 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5758 newSViv(cxt->tagnum), 0))
5765 * Regular post-0.6 binary format.
5770 TRACEME(("retrieve type = %d", type));
5773 * Are we dealing with an object we should have already retrieved?
5776 if (type == SX_OBJECT) {
5780 svh = av_fetch(cxt->aseen, tag, FALSE);
5782 CROAK(("Object #%"IVdf" should have been retrieved already",
5785 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5786 SvREFCNT_inc(sv); /* One more reference to this same sv */
5787 return sv; /* The SV pointer where object was retrieved */
5788 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5789 if (cxt->accept_future_minor < 0)
5790 cxt->accept_future_minor
5791 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5794 if (cxt->accept_future_minor == 1) {
5795 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5796 "This Storable is v%d.%d and can only handle data types up to %d",
5797 cxt->ver_major, cxt->ver_minor, type,
5798 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5802 first_time: /* Will disappear when support for old format is dropped */
5805 * Okay, first time through for this one.
5808 sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
5810 return (SV *) 0; /* Failed */
5813 * Old binary formats (pre-0.7).
5815 * Final notifications, ended by SX_STORED may now follow.
5816 * Currently, the only pertinent notification to apply on the
5817 * freshly retrieved object is either:
5818 * SX_CLASS <char-len> <classname> for short classnames.
5819 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5820 * Class name is then read into the key buffer pool used by
5821 * hash table key retrieval.
5824 if (cxt->ver_major < 2) {
5825 while ((type = GETCHAR()) != SX_STORED) {
5829 GETMARK(len); /* Length coded on a single char */
5831 case SX_LG_CLASS: /* Length coded on a regular integer */
5836 return (SV *) 0; /* Failed */
5838 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5841 kbuf[len] = '\0'; /* Mark string end */
5846 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5847 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
5855 * Retrieve data held in file and return the root object.
5856 * Common routine for pretrieve and mretrieve.
5858 static SV *do_retrieve(
5866 int is_tainted; /* Is input source tainted? */
5867 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
5869 TRACEME(("do_retrieve (optype = 0x%x)", optype));
5871 optype |= ST_RETRIEVE;
5874 * Sanity assertions for retrieve dispatch tables.
5877 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
5878 ("old and new retrieve dispatch table have same size"));
5879 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
5880 ("SX_ERROR entry correctly initialized in old dispatch table"));
5881 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
5882 ("SX_ERROR entry correctly initialized in new dispatch table"));
5885 * Workaround for CROAK leak: if they enter with a "dirty" context,
5886 * free up memory for them now.
5890 clean_context(aTHX_ cxt);
5893 * Now that STORABLE_xxx hooks exist, it is possible that they try to
5894 * re-enter retrieve() via the hooks.
5898 cxt = allocate_context(aTHX_ cxt);
5902 ASSERT(cxt->entry == 1, ("starting new recursion"));
5903 ASSERT(!cxt->s_dirty, ("clean context"));
5908 * Data is loaded into the memory buffer when f is NULL, unless `in' is
5909 * also NULL, in which case we're expecting the data to already lie
5910 * in the buffer (dclone case).
5913 KBUFINIT(); /* Allocate hash key reading pool once */
5919 const char *orig = SvPV(in, length);
5921 /* This is quite deliberate. I want the UTF8 routines
5922 to encounter the '\0' which perl adds at the end
5923 of all scalars, so that any new string also has
5926 STRLEN klen_tmp = length + 1;
5927 bool is_utf8 = TRUE;
5929 /* Just casting the &klen to (STRLEN) won't work
5930 well if STRLEN and I32 are of different widths.
5932 asbytes = (char*)bytes_from_utf8((U8*)orig,
5936 CROAK(("Frozen string corrupt - contains characters outside 0-255"));
5938 if (asbytes != orig) {
5939 /* String has been converted.
5940 There is no need to keep any reference to
5942 in = sv_newmortal();
5943 /* We donate the SV the malloc()ed string
5944 bytes_from_utf8 returned us. */
5945 SvUPGRADE(in, SVt_PV);
5947 SvPV_set(in, asbytes);
5948 SvLEN_set(in, klen_tmp);
5949 SvCUR_set(in, klen_tmp - 1);
5953 MBUF_SAVE_AND_LOAD(in);
5957 * Magic number verifications.
5959 * This needs to be done before calling init_retrieve_context()
5960 * since the format indication in the file are necessary to conduct
5961 * some of the initializations.
5964 cxt->fio = f; /* Where I/O are performed */
5966 if (!magic_check(aTHX_ cxt))
5967 CROAK(("Magic number checking on storable %s failed",
5968 cxt->fio ? "file" : "string"));
5970 TRACEME(("data stored in %s format",
5971 cxt->netorder ? "net order" : "native"));
5974 * Check whether input source is tainted, so that we don't wrongly
5975 * taint perfectly good values...
5977 * We assume file input is always tainted. If both `f' and `in' are
5978 * NULL, then we come from dclone, and tainted is already filled in
5979 * the context. That's a kludge, but the whole dclone() thing is
5980 * already quite a kludge anyway! -- RAM, 15/09/2000.
5983 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
5984 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
5985 init_retrieve_context(aTHX_ cxt, optype, is_tainted);
5987 ASSERT(is_retrieving(aTHX), ("within retrieve operation"));
5989 sv = retrieve(aTHX_ cxt, 0); /* Recursively retrieve object, get root SV */
5998 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
6001 * The "root" context is never freed.
6004 clean_retrieve_context(aTHX_ cxt);
6005 if (cxt->prev) /* This context was stacked */
6006 free_context(aTHX_ cxt); /* It was not the "root" context */
6009 * Prepare returned value.
6013 TRACEME(("retrieve ERROR"));
6014 #if (PATCHLEVEL <= 4)
6015 /* perl 5.00405 seems to screw up at this point with an
6016 'attempt to modify a read only value' error reported in the
6017 eval { $self = pretrieve(*FILE) } in _retrieve.
6018 I can't see what the cause of this error is, but I suspect a
6019 bug in 5.004, as it seems to be capable of issuing spurious
6020 errors or core dumping with matches on $@. I'm not going to
6021 spend time on what could be a fruitless search for the cause,
6022 so here's a bodge. If you're running 5.004 and don't like
6023 this inefficiency, either upgrade to a newer perl, or you are
6024 welcome to find the problem and send in a patch.
6028 return &PL_sv_undef; /* Something went wrong, return undef */
6032 TRACEME(("retrieve got %s(0x%"UVxf")",
6033 sv_reftype(sv, FALSE), PTR2UV(sv)));
6036 * Backward compatibility with Storable-0.5@9 (which we know we
6037 * are retrieving if hseen is non-null): don't create an extra RV
6038 * for objects since we special-cased it at store time.
6040 * Build a reference to the SV returned by pretrieve even if it is
6041 * already one and not a scalar, for consistency reasons.
6044 if (pre_06_fmt) { /* Was not handling overloading by then */
6046 TRACEME(("fixing for old formats -- pre 0.6"));
6047 if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
6048 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
6054 * If reference is overloaded, restore behaviour.
6056 * NB: minor glitch here: normally, overloaded refs are stored specially
6057 * so that we can croak when behaviour cannot be re-installed, and also
6058 * avoid testing for overloading magic at each reference retrieval.
6060 * Unfortunately, the root reference is implicitely stored, so we must
6061 * check for possible overloading now. Furthermore, if we don't restore
6062 * overloading, we cannot croak as if the original ref was, because we
6063 * have no way to determine whether it was an overloaded ref or not in
6066 * It's a pity that overloading magic is attached to the rv, and not to
6067 * the underlying sv as blessing is.
6071 HV *stash = (HV *) SvSTASH(sv);
6072 SV *rv = newRV_noinc(sv);
6073 if (stash && Gv_AMG(stash)) {
6075 TRACEME(("restored overloading on root reference"));
6077 TRACEME(("ended do_retrieve() with an object"));
6081 TRACEME(("regular do_retrieve() end"));
6083 return newRV_noinc(sv);
6089 * Retrieve data held in file and return the root object, undef on error.
6091 SV *pretrieve(pTHX_ PerlIO *f)
6093 TRACEME(("pretrieve"));
6094 return do_retrieve(aTHX_ f, Nullsv, 0);
6100 * Retrieve data held in scalar and return the root object, undef on error.
6102 SV *mretrieve(pTHX_ SV *sv)
6104 TRACEME(("mretrieve"));
6105 return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
6115 * Deep clone: returns a fresh copy of the original referenced SV tree.
6117 * This is achieved by storing the object in memory and restoring from
6118 * there. Not that efficient, but it should be faster than doing it from
6121 SV *dclone(pTHX_ SV *sv)
6125 stcxt_t *real_context;
6128 TRACEME(("dclone"));
6131 * Workaround for CROAK leak: if they enter with a "dirty" context,
6132 * free up memory for them now.
6136 clean_context(aTHX_ cxt);
6139 * do_store() optimizes for dclone by not freeing its context, should
6140 * we need to allocate one because we're deep cloning from a hook.
6143 if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
6144 return &PL_sv_undef; /* Error during store */
6147 * Because of the above optimization, we have to refresh the context,
6148 * since a new one could have been allocated and stacked by do_store().
6151 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
6152 cxt = real_context; /* And we need this temporary... */
6155 * Now, `cxt' may refer to a new context.
6158 ASSERT(!cxt->s_dirty, ("clean context"));
6159 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
6162 TRACEME(("dclone stored %d bytes", size));
6166 * Since we're passing do_retrieve() both a NULL file and sv, we need
6167 * to pre-compute the taintedness of the input by setting cxt->tainted
6168 * to whatever state our own input string was. -- RAM, 15/09/2000
6170 * do_retrieve() will free non-root context.
6173 cxt->s_tainted = SvTAINTED(sv);
6174 out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
6176 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
6186 * The Perl IO GV object distinguishes between input and output for sockets
6187 * but not for plain files. To allow Storable to transparently work on
6188 * plain files and sockets transparently, we have to ask xsubpp to fetch the
6189 * right object for us. Hence the OutputStream and InputStream declarations.
6191 * Before perl 5.004_05, those entries in the standard typemap are not
6192 * defined in perl include files, so we do that here.
6195 #ifndef OutputStream
6196 #define OutputStream PerlIO *
6197 #define InputStream PerlIO *
6198 #endif /* !OutputStream */
6200 MODULE = Storable PACKAGE = Storable::Cxt
6206 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
6210 if (!cxt->membuf_ro && mbase)
6212 if (cxt->membuf_ro && (cxt->msaved).arena)
6213 Safefree((cxt->msaved).arena);
6216 MODULE = Storable PACKAGE = Storable
6221 init_perinterp(aTHX);
6222 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
6224 /* Only disable the used only once warning if we are in debugging mode. */
6225 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
6227 #ifdef USE_56_INTERWORK_KLUDGE
6228 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
6234 init_perinterp(aTHX);
6241 RETVAL = pstore(aTHX_ f, obj);
6250 RETVAL = net_pstore(aTHX_ f, obj);
6258 RETVAL = mstore(aTHX_ obj);
6266 RETVAL = net_mstore(aTHX_ obj);
6274 RETVAL = pretrieve(aTHX_ f);
6282 RETVAL = mretrieve(aTHX_ sv);
6290 RETVAL = dclone(aTHX_ sv);
6295 last_op_in_netorder()
6297 RETVAL = last_op_in_netorder(aTHX);
6304 RETVAL = is_storing(aTHX);
6311 RETVAL = is_retrieving(aTHX);