2 * Store and retrieve mechanism.
6 * $Id: Storable.xs,v 1.0.1.10 2001/08/28 21:52:14 ram Exp $
8 * Copyright (c) 1995-2000, Raphael Manfredi
10 * You may redistribute only under the same terms as Perl 5, as specified
11 * in the README file that comes with the distribution.
17 #include <patchlevel.h> /* Perl's one, needed since 5.6 */
22 #define DEBUGME /* Debug mode, turns assertions on as well */
23 #define DASSERT /* Assertion mode */
26 #if 0 /* On NetWare USE_PERLIO is not used */
27 #define DEBUGME /* Debug mode, turns assertions on as well */
28 #define DASSERT /* Assertion mode */
33 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
34 * Provide them with the necessary defines so they can build with pre-5.004.
37 #ifndef PERLIO_IS_STDIO
39 #define PerlIO_getc(x) getc(x)
40 #define PerlIO_putc(f,x) putc(x,f)
41 #define PerlIO_read(x,y,z) fread(y,1,z,x)
42 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
43 #define PerlIO_stdoutf printf
44 #endif /* PERLIO_IS_STDIO */
45 #endif /* USE_PERLIO */
48 * Earlier versions of perl might be used, we can't assume they have the latest!
51 #ifndef PERL_VERSION /* For perls < 5.6 */
52 #define PERL_VERSION PATCHLEVEL
54 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
56 #if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
57 #define PL_sv_yes sv_yes
58 #define PL_sv_no sv_no
59 #define PL_sv_undef sv_undef
60 #if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
61 #define newSVpvn newSVpv
63 #endif /* PATCHLEVEL <= 4 */
64 #ifndef HvSHAREKEYS_off
65 #define HvSHAREKEYS_off(hv) /* Ignore */
67 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
68 #define AvFILLp AvFILL
70 typedef double NV; /* Older perls lack the NV type */
71 #define IVdf "ld" /* Various printf formats for Perl types */
75 #define INT2PTR(t,v) (t)(IV)(v)
76 #define PTR2UV(v) (unsigned long)(v)
77 #endif /* PERL_VERSION -- perls < 5.6 */
79 #ifndef NVef /* The following were not part of perl 5.6 */
80 #if defined(USE_LONG_DOUBLE) && \
81 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
82 #define NVef PERL_PRIeldbl
83 #define NVff PERL_PRIfldbl
84 #define NVgf PERL_PRIgldbl
99 * TRACEME() will only output things when the $Storable::DEBUGME is true.
104 if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
105 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
112 #define ASSERT(x,y) \
115 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
116 __FILE__, __LINE__); \
117 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
128 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
130 #define SX_OBJECT C(0) /* Already stored object */
131 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
132 #define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
133 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
134 #define SX_REF C(4) /* Reference to object forthcoming */
135 #define SX_UNDEF C(5) /* Undefined scalar */
136 #define SX_INTEGER C(6) /* Integer forthcoming */
137 #define SX_DOUBLE C(7) /* Double forthcoming */
138 #define SX_BYTE C(8) /* (signed) byte forthcoming */
139 #define SX_NETINT C(9) /* Integer in network order forthcoming */
140 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
141 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
142 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
143 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
144 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
145 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
146 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
147 #define SX_BLESS C(17) /* Object is blessed */
148 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
149 #define SX_HOOK C(19) /* Stored via hook, user-defined */
150 #define SX_OVERLOAD C(20) /* Overloaded reference */
151 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
152 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
153 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
154 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
155 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
156 #define SX_ERROR C(26) /* Error */
159 * Those are only used to retrieve "old" pre-0.6 binary images.
161 #define SX_ITEM 'i' /* An array item introducer */
162 #define SX_IT_UNDEF 'I' /* Undefined array item */
163 #define SX_KEY 'k' /* A hash key introducer */
164 #define SX_VALUE 'v' /* A hash value introducer */
165 #define SX_VL_UNDEF 'V' /* Undefined hash value */
168 * Those are only used to retrieve "old" pre-0.7 binary images
171 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
172 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
173 #define SX_STORED 'X' /* End of object */
176 * Limits between short/long length representation.
179 #define LG_SCALAR 255 /* Large scalar length limit */
180 #define LG_BLESS 127 /* Large classname bless limit */
186 #define ST_STORE 0x1 /* Store operation */
187 #define ST_RETRIEVE 0x2 /* Retrieval operation */
188 #define ST_CLONE 0x4 /* Deep cloning operation */
191 * The following structure is used for hash table key retrieval. Since, when
192 * retrieving objects, we'll be facing blessed hash references, it's best
193 * to pre-allocate that buffer once and resize it as the need arises, never
194 * freeing it (keys will be saved away someplace else anyway, so even large
195 * keys are not enough a motivation to reclaim that space).
197 * This structure is also used for memory store/retrieve operations which
198 * happen in a fixed place before being malloc'ed elsewhere if persistency
199 * is required. Hence the aptr pointer.
202 char *arena; /* Will hold hash key strings, resized as needed */
203 STRLEN asiz; /* Size of aforementionned buffer */
204 char *aptr; /* Arena pointer, for in-place read/write ops */
205 char *aend; /* First invalid address */
210 * A hash table records the objects which have already been stored.
211 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
212 * an arbitrary sequence number) is used to identify them.
215 * An array table records the objects which have already been retrieved,
216 * as seen by the tag determind by counting the objects themselves. The
217 * reference to that retrieved object is kept in the table, and is returned
218 * when an SX_OBJECT is found bearing that same tag.
220 * The same processing is used to record "classname" for blessed objects:
221 * indexing by a hash at store time, and via an array at retrieve time.
224 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
227 * The following "thread-safe" related defines were contributed by
228 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
229 * only renamed things a little bit to ensure consistency with surrounding
230 * code. -- RAM, 14/09/1999
232 * The original patch suffered from the fact that the stcxt_t structure
233 * was global. Murray tried to minimize the impact on the code as much as
236 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
237 * on objects. Therefore, the notion of context needs to be generalized,
241 #define MY_VERSION "Storable(" XS_VERSION ")"
245 * Conditional UTF8 support.
249 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
250 #define HAS_UTF8_SCALARS
252 #define HAS_UTF8_HASHES
255 /* 5.6 perl has utf8 scalars but not hashes */
259 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
262 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
265 #ifdef HvPLACEHOLDERS
266 #define HAS_RESTRICTED_HASHES
268 #define HVhek_PLACEHOLD 0x200
269 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
273 #define HAS_HASH_KEY_FLAGS
277 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
278 * files remap tainted and dirty when threading is enabled. That's bad for
279 * perl to remap such common words. -- RAM, 29/09/00
282 typedef struct stcxt {
283 int entry; /* flags recursion */
284 int optype; /* type of traversal operation */
285 HV *hseen; /* which objects have been seen, store time */
286 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
287 AV *aseen; /* which objects have been seen, retrieve time */
288 HV *hclass; /* which classnames have been seen, store time */
289 AV *aclass; /* which classnames have been seen, retrieve time */
290 HV *hook; /* cache for hook methods per class name */
291 IV tagnum; /* incremented at store time for each seen object */
292 IV classnum; /* incremented at store time for each seen classname */
293 int netorder; /* true if network order used */
294 int s_tainted; /* true if input source is tainted, at retrieve time */
295 int forgive_me; /* whether to be forgiving... */
296 int canonical; /* whether to store hashes sorted by key */
297 #ifndef HAS_RESTRICTED_HASHES
298 int derestrict; /* whether to downgrade restrcted hashes */
301 int use_bytes; /* whether to bytes-ify utf8 */
303 int accept_future_minor; /* croak immediately on future minor versions? */
304 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
305 int membuf_ro; /* true means membuf is read-only and msaved is rw */
306 struct extendable keybuf; /* for hash key retrieval */
307 struct extendable membuf; /* for memory store/retrieve operations */
308 struct extendable msaved; /* where potentially valid mbuf is saved */
309 PerlIO *fio; /* where I/O are performed, NULL for memory */
310 int ver_major; /* major of version for retrieved object */
311 int ver_minor; /* minor of version for retrieved object */
312 SV *(**retrieve_vtbl)(); /* retrieve dispatch table */
313 SV *prev; /* contexts chained backwards in real recursion */
314 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
317 #define NEW_STORABLE_CXT_OBJ(cxt) \
319 SV *self = newSV(sizeof(stcxt_t) - 1); \
320 SV *my_sv = newRV_noinc(self); \
321 sv_bless(my_sv, gv_stashpv("Storable::Cxt", TRUE)); \
322 cxt = (stcxt_t *)SvPVX(self); \
323 Zero(cxt, 1, stcxt_t); \
324 cxt->my_sv = my_sv; \
327 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
329 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
331 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
332 #else /* >= perl5.004_68 */
334 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
335 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
336 #endif /* < perl5.004_68 */
338 #define dSTCXT_PTR(T,name) \
339 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
340 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
343 dSTCXT_PTR(stcxt_t *, cxt)
347 NEW_STORABLE_CXT_OBJ(cxt); \
348 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
350 #define SET_STCXT(x) \
353 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
356 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
358 static stcxt_t Context;
359 static stcxt_t *Context_ptr = &Context;
360 #define dSTCXT stcxt_t *cxt = Context_ptr
363 NEW_STORABLE_CXT_OBJ(cxt)
365 #define SET_STCXT(x) Context_ptr = x
367 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
371 * Croaking implies a memory leak, since we don't use setjmp/longjmp
372 * to catch the exit and free memory used during store or retrieve
373 * operations. This is not too difficult to fix, but I need to understand
374 * how Perl does it, and croaking is exceptional anyway, so I lack the
375 * motivation to do it.
377 * The current workaround is to mark the context as dirty when croaking,
378 * so that data structures can be freed whenever we renter Storable code
379 * (but only *then*: it's a workaround, not a fix).
381 * This is also imperfect, because we don't really know how far they trapped
382 * the croak(), and when we were recursing, we won't be able to clean anything
383 * but the topmost context stacked.
386 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
389 * End of "thread-safe" related definitions.
395 * Keep only the low 32 bits of a pointer (used for tags, which are not
400 #define LOW_32BITS(x) ((I32) (x))
402 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
408 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
409 * Used in the WLEN and RLEN macros.
413 #define oI(x) ((I32 *) ((char *) (x) + 4))
414 #define oS(x) ((x) - 4)
415 #define oC(x) (x = 0)
424 * key buffer handling
426 #define kbuf (cxt->keybuf).arena
427 #define ksiz (cxt->keybuf).asiz
431 TRACEME(("** allocating kbuf of 128 bytes")); \
432 New(10003, kbuf, 128, char); \
439 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
440 Renew(kbuf, x+1, char); \
446 * memory buffer handling
448 #define mbase (cxt->membuf).arena
449 #define msiz (cxt->membuf).asiz
450 #define mptr (cxt->membuf).aptr
451 #define mend (cxt->membuf).aend
453 #define MGROW (1 << 13)
454 #define MMASK (MGROW - 1)
456 #define round_mgrow(x) \
457 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
458 #define trunc_int(x) \
459 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
460 #define int_aligned(x) \
461 ((unsigned long) (x) == trunc_int(x))
463 #define MBUF_INIT(x) \
466 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
467 New(10003, mbase, MGROW, char); \
474 mend = mbase + msiz; \
477 #define MBUF_TRUNC(x) mptr = mbase + x
478 #define MBUF_SIZE() (mptr - mbase)
484 * Those macros are used in do_retrieve() to save the current memory
485 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
486 * data from a string.
488 #define MBUF_SAVE_AND_LOAD(in) \
490 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
491 cxt->membuf_ro = 1; \
492 TRACEME(("saving mbuf")); \
493 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
497 #define MBUF_RESTORE() \
499 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
500 cxt->membuf_ro = 0; \
501 TRACEME(("restoring mbuf")); \
502 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
506 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
507 * See store_scalar() for other usage of this workaround.
509 #define MBUF_LOAD(v) \
511 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
513 CROAK(("Not a scalar string")); \
514 mptr = mbase = SvPV(v, msiz); \
515 mend = mbase + msiz; \
518 #define MBUF_XTEND(x) \
520 int nsz = (int) round_mgrow((x)+msiz); \
521 int offset = mptr - mbase; \
522 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
523 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
525 Renew(mbase, nsz, char); \
527 mptr = mbase + offset; \
528 mend = mbase + nsz; \
531 #define MBUF_CHK(x) \
533 if ((mptr + (x)) > mend) \
537 #define MBUF_GETC(x) \
540 x = (int) (unsigned char) *mptr++; \
546 #define MBUF_GETINT(x) \
549 if ((mptr + 4) <= mend) { \
550 memcpy(oI(&x), mptr, 4); \
556 #define MBUF_GETINT(x) \
558 if ((mptr + sizeof(int)) <= mend) { \
559 if (int_aligned(mptr)) \
562 memcpy(&x, mptr, sizeof(int)); \
563 mptr += sizeof(int); \
569 #define MBUF_READ(x,s) \
571 if ((mptr + (s)) <= mend) { \
572 memcpy(x, mptr, s); \
578 #define MBUF_SAFEREAD(x,s,z) \
580 if ((mptr + (s)) <= mend) { \
581 memcpy(x, mptr, s); \
589 #define MBUF_PUTC(c) \
592 *mptr++ = (char) c; \
595 *mptr++ = (char) c; \
600 #define MBUF_PUTINT(i) \
603 memcpy(mptr, oI(&i), 4); \
607 #define MBUF_PUTINT(i) \
609 MBUF_CHK(sizeof(int)); \
610 if (int_aligned(mptr)) \
613 memcpy(mptr, &i, sizeof(int)); \
614 mptr += sizeof(int); \
618 #define MBUF_WRITE(x,s) \
621 memcpy(mptr, x, s); \
626 * Possible return values for sv_type().
630 #define svis_SCALAR 1
634 #define svis_TIED_ITEM 5
641 #define SHF_TYPE_MASK 0x03
642 #define SHF_LARGE_CLASSLEN 0x04
643 #define SHF_LARGE_STRLEN 0x08
644 #define SHF_LARGE_LISTLEN 0x10
645 #define SHF_IDX_CLASSNAME 0x20
646 #define SHF_NEED_RECURSE 0x40
647 #define SHF_HAS_LIST 0x80
650 * Types for SX_HOOK (last 2 bits in flags).
656 #define SHT_EXTRA 3 /* Read extra byte for type */
659 * The following are held in the "extra byte"...
662 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
663 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
664 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
667 * per hash flags for flagged hashes
670 #define SHV_RESTRICTED 0x01
673 * per key flags for flagged hashes
676 #define SHV_K_UTF8 0x01
677 #define SHV_K_WASUTF8 0x02
678 #define SHV_K_LOCKED 0x04
679 #define SHV_K_ISSV 0x08
680 #define SHV_K_PLACEHOLDER 0x10
683 * Before 0.6, the magic string was "perl-store" (binary version number 0).
685 * Since 0.6 introduced many binary incompatibilities, the magic string has
686 * been changed to "pst0" to allow an old image to be properly retrieved by
687 * a newer Storable, but ensure a newer image cannot be retrieved with an
690 * At 0.7, objects are given the ability to serialize themselves, and the
691 * set of markers is extended, backward compatibility is not jeopardized,
692 * so the binary version number could have remained unchanged. To correctly
693 * spot errors if a file making use of 0.7-specific extensions is given to
694 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
695 * a "minor" version, to better track this kind of evolution from now on.
698 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
699 static const char magicstr[] = "pst0"; /* Used as a magic number */
701 #define MAGICSTR_BYTES 'p','s','t','0'
702 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
704 /* 5.6.x introduced the ability to have IVs as long long.
705 However, Configure still defined BYTEORDER based on the size of a long.
706 Storable uses the BYTEORDER value as part of the header, but doesn't
707 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
708 with IV as long long on a platform that uses Configure (ie most things
709 except VMS and Windows) headers are identical for the different IV sizes,
710 despite the files containing some fields based on sizeof(IV)
712 5.8 is consistent - the following redifinition kludge is only needed on
713 5.6.x, but the interwork is needed on 5.8 while data survives in files
718 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
719 #ifndef NO_56_INTERWORK_KLUDGE
720 #define USE_56_INTERWORK_KLUDGE
722 #if BYTEORDER == 0x1234
724 #define BYTEORDER 0x12345678
726 #if BYTEORDER == 0x4321
728 #define BYTEORDER 0x87654321
733 #if BYTEORDER == 0x1234
734 #define BYTEORDER_BYTES '1','2','3','4'
736 #if BYTEORDER == 0x12345678
737 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
738 #ifdef USE_56_INTERWORK_KLUDGE
739 #define BYTEORDER_BYTES_56 '1','2','3','4'
742 #if BYTEORDER == 0x87654321
743 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
744 #ifdef USE_56_INTERWORK_KLUDGE
745 #define BYTEORDER_BYTES_56 '4','3','2','1'
748 #if BYTEORDER == 0x4321
749 #define BYTEORDER_BYTES '4','3','2','1'
751 #error Unknown byteoder. Please append your byteorder to Storable.xs
757 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
758 #ifdef USE_56_INTERWORK_KLUDGE
759 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
762 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
763 #define STORABLE_BIN_MINOR 5 /* Binary minor "version" */
765 /* If we aren't 5.7.3 or later, we won't be writing out files that use the
766 * new flagged hash introdued in 2.5, so put 2.4 in the binary header to
767 * maximise ease of interoperation with older Storables.
768 * Could we write 2.3s if we're on 5.005_03? NWC
770 #if (PATCHLEVEL <= 6)
771 #define STORABLE_BIN_WRITE_MINOR 4
774 * As of perl 5.7.3, utf8 hash key is introduced.
775 * So this must change -- dankogai
777 #define STORABLE_BIN_WRITE_MINOR 5
778 #endif /* (PATCHLEVEL <= 6) */
781 * Useful store shortcuts...
788 else if (PerlIO_putc(cxt->fio, x) == EOF) \
792 #define WRITE_I32(x) \
794 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
797 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
804 if (cxt->netorder) { \
805 int y = (int) htonl(x); \
808 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
813 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
818 #define WLEN(x) WRITE_I32(x)
825 else if (PerlIO_write(cxt->fio, x, y) != y) \
829 #define STORE_PV_LEN(pv, len, small, large) \
831 if (len <= LG_SCALAR) { \
832 unsigned char clen = (unsigned char) len; \
844 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
847 * Store undef in arrays and hashes without recursing through store().
849 #define STORE_UNDEF() \
856 * Useful retrieve shortcuts...
860 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
866 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
870 #define READ_I32(x) \
872 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
876 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
886 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
889 x = (int) ntohl(x); \
892 #define RLEN(x) READ_I32(x)
899 else if (PerlIO_read(cxt->fio, x, y) != y) \
903 #define SAFEREAD(x,y,z) \
906 MBUF_SAFEREAD(x,y,z); \
907 else if (PerlIO_read(cxt->fio, x, y) != y) { \
914 * This macro is used at retrieve time, to remember where object 'y', bearing a
915 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
916 * we'll therefore know where it has been retrieved and will be able to
917 * share the same reference, as in the original stored memory image.
919 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
920 * on the objects given to STORABLE_thaw and expect that to be defined), and
921 * also for overloaded objects (for which we might not find the stash if the
922 * object is not blessed yet--this might occur for overloaded objects that
923 * refer to themselves indirectly: if we blessed upon return from a sub
924 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
925 * restored on it because the underlying object would not be blessed yet!).
927 * To achieve that, the class name of the last retrieved object is passed down
928 * recursively, and the first SEEN() call for which the class name is not NULL
929 * will bless the object.
935 if (av_store(cxt->aseen, cxt->tagnum++, SvREFCNT_inc(y)) == 0) \
937 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
938 PTR2UV(y), SvREFCNT(y)-1)); \
940 BLESS((SV *) (y), c); \
944 * Bless `s' in `p', via a temporary reference, required by sv_bless().
950 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
951 stash = gv_stashpv((p), TRUE); \
952 ref = newRV_noinc(s); \
953 (void) sv_bless(ref, stash); \
959 static SV *retrieve(stcxt_t *cxt, char *cname);
962 * Dynamic dispatching table for SV store.
965 static int store_ref(stcxt_t *cxt, SV *sv);
966 static int store_scalar(stcxt_t *cxt, SV *sv);
967 static int store_array(stcxt_t *cxt, AV *av);
968 static int store_hash(stcxt_t *cxt, HV *hv);
969 static int store_tied(stcxt_t *cxt, SV *sv);
970 static int store_tied_item(stcxt_t *cxt, SV *sv);
971 static int store_other(stcxt_t *cxt, SV *sv);
972 static int store_blessed(stcxt_t *cxt, SV *sv, int type, HV *pkg);
974 static int (*sv_store[])(stcxt_t *cxt, SV *sv) = {
975 store_ref, /* svis_REF */
976 store_scalar, /* svis_SCALAR */
977 (int (*)(stcxt_t *cxt, SV *sv)) store_array, /* svis_ARRAY */
978 (int (*)(stcxt_t *cxt, SV *sv)) store_hash, /* svis_HASH */
979 store_tied, /* svis_TIED */
980 store_tied_item, /* svis_TIED_ITEM */
981 store_other, /* svis_OTHER */
984 #define SV_STORE(x) (*sv_store[x])
987 * Dynamic dispatching tables for SV retrieval.
990 static SV *retrieve_lscalar(stcxt_t *cxt, char *cname);
991 static SV *retrieve_lutf8str(stcxt_t *cxt, char *cname);
992 static SV *old_retrieve_array(stcxt_t *cxt, char *cname);
993 static SV *old_retrieve_hash(stcxt_t *cxt, char *cname);
994 static SV *retrieve_ref(stcxt_t *cxt, char *cname);
995 static SV *retrieve_undef(stcxt_t *cxt, char *cname);
996 static SV *retrieve_integer(stcxt_t *cxt, char *cname);
997 static SV *retrieve_double(stcxt_t *cxt, char *cname);
998 static SV *retrieve_byte(stcxt_t *cxt, char *cname);
999 static SV *retrieve_netint(stcxt_t *cxt, char *cname);
1000 static SV *retrieve_scalar(stcxt_t *cxt, char *cname);
1001 static SV *retrieve_utf8str(stcxt_t *cxt, char *cname);
1002 static SV *retrieve_tied_array(stcxt_t *cxt, char *cname);
1003 static SV *retrieve_tied_hash(stcxt_t *cxt, char *cname);
1004 static SV *retrieve_tied_scalar(stcxt_t *cxt, char *cname);
1005 static SV *retrieve_other(stcxt_t *cxt, char *cname);
1007 static SV *(*sv_old_retrieve[])(stcxt_t *cxt, char *cname) = {
1008 0, /* SX_OBJECT -- entry unused dynamically */
1009 retrieve_lscalar, /* SX_LSCALAR */
1010 old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1011 old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1012 retrieve_ref, /* SX_REF */
1013 retrieve_undef, /* SX_UNDEF */
1014 retrieve_integer, /* SX_INTEGER */
1015 retrieve_double, /* SX_DOUBLE */
1016 retrieve_byte, /* SX_BYTE */
1017 retrieve_netint, /* SX_NETINT */
1018 retrieve_scalar, /* SX_SCALAR */
1019 retrieve_tied_array, /* SX_ARRAY */
1020 retrieve_tied_hash, /* SX_HASH */
1021 retrieve_tied_scalar, /* SX_SCALAR */
1022 retrieve_other, /* SX_SV_UNDEF not supported */
1023 retrieve_other, /* SX_SV_YES not supported */
1024 retrieve_other, /* SX_SV_NO not supported */
1025 retrieve_other, /* SX_BLESS not supported */
1026 retrieve_other, /* SX_IX_BLESS not supported */
1027 retrieve_other, /* SX_HOOK not supported */
1028 retrieve_other, /* SX_OVERLOADED not supported */
1029 retrieve_other, /* SX_TIED_KEY not supported */
1030 retrieve_other, /* SX_TIED_IDX not supported */
1031 retrieve_other, /* SX_UTF8STR not supported */
1032 retrieve_other, /* SX_LUTF8STR not supported */
1033 retrieve_other, /* SX_FLAG_HASH not supported */
1034 retrieve_other, /* SX_ERROR */
1037 static SV *retrieve_array(stcxt_t *cxt, char *cname);
1038 static SV *retrieve_hash(stcxt_t *cxt, char *cname);
1039 static SV *retrieve_sv_undef(stcxt_t *cxt, char *cname);
1040 static SV *retrieve_sv_yes(stcxt_t *cxt, char *cname);
1041 static SV *retrieve_sv_no(stcxt_t *cxt, char *cname);
1042 static SV *retrieve_blessed(stcxt_t *cxt, char *cname);
1043 static SV *retrieve_idx_blessed(stcxt_t *cxt, char *cname);
1044 static SV *retrieve_hook(stcxt_t *cxt, char *cname);
1045 static SV *retrieve_overloaded(stcxt_t *cxt, char *cname);
1046 static SV *retrieve_tied_key(stcxt_t *cxt, char *cname);
1047 static SV *retrieve_tied_idx(stcxt_t *cxt, char *cname);
1048 static SV *retrieve_flag_hash(stcxt_t *cxt, char *cname);
1050 static SV *(*sv_retrieve[])(stcxt_t *cxt, char *cname) = {
1051 0, /* SX_OBJECT -- entry unused dynamically */
1052 retrieve_lscalar, /* SX_LSCALAR */
1053 retrieve_array, /* SX_ARRAY */
1054 retrieve_hash, /* SX_HASH */
1055 retrieve_ref, /* SX_REF */
1056 retrieve_undef, /* SX_UNDEF */
1057 retrieve_integer, /* SX_INTEGER */
1058 retrieve_double, /* SX_DOUBLE */
1059 retrieve_byte, /* SX_BYTE */
1060 retrieve_netint, /* SX_NETINT */
1061 retrieve_scalar, /* SX_SCALAR */
1062 retrieve_tied_array, /* SX_ARRAY */
1063 retrieve_tied_hash, /* SX_HASH */
1064 retrieve_tied_scalar, /* SX_SCALAR */
1065 retrieve_sv_undef, /* SX_SV_UNDEF */
1066 retrieve_sv_yes, /* SX_SV_YES */
1067 retrieve_sv_no, /* SX_SV_NO */
1068 retrieve_blessed, /* SX_BLESS */
1069 retrieve_idx_blessed, /* SX_IX_BLESS */
1070 retrieve_hook, /* SX_HOOK */
1071 retrieve_overloaded, /* SX_OVERLOAD */
1072 retrieve_tied_key, /* SX_TIED_KEY */
1073 retrieve_tied_idx, /* SX_TIED_IDX */
1074 retrieve_utf8str, /* SX_UTF8STR */
1075 retrieve_lutf8str, /* SX_LUTF8STR */
1076 retrieve_flag_hash, /* SX_HASH */
1077 retrieve_other, /* SX_ERROR */
1080 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1082 static SV *mbuf2sv(void);
1085 *** Context management.
1091 * Called once per "thread" (interpreter) to initialize some global context.
1093 static void init_perinterp(void)
1097 cxt->netorder = 0; /* true if network order used */
1098 cxt->forgive_me = -1; /* whether to be forgiving... */
1104 * Called at the end of every context cleaning, to perform common reset
1107 static void reset_context(stcxt_t *cxt)
1111 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1115 * init_store_context
1117 * Initialize a new store context for real recursion.
1119 static void init_store_context(
1125 TRACEME(("init_store_context"));
1127 cxt->netorder = network_order;
1128 cxt->forgive_me = -1; /* Fetched from perl if needed */
1129 cxt->canonical = -1; /* Idem */
1130 cxt->tagnum = -1; /* Reset tag numbers */
1131 cxt->classnum = -1; /* Reset class numbers */
1132 cxt->fio = f; /* Where I/O are performed */
1133 cxt->optype = optype; /* A store, or a deep clone */
1134 cxt->entry = 1; /* No recursion yet */
1137 * The `hseen' table is used to keep track of each SV stored and their
1138 * associated tag numbers is special. It is "abused" because the
1139 * values stored are not real SV, just integers cast to (SV *),
1140 * which explains the freeing below.
1142 * It is also one possible bottlneck to achieve good storing speed,
1143 * so the "shared keys" optimization is turned off (unlikely to be
1144 * of any use here), and the hash table is "pre-extended". Together,
1145 * those optimizations increase the throughput by 12%.
1148 cxt->hseen = newHV(); /* Table where seen objects are stored */
1149 HvSHAREKEYS_off(cxt->hseen);
1152 * The following does not work well with perl5.004_04, and causes
1153 * a core dump later on, in a completely unrelated spot, which
1154 * makes me think there is a memory corruption going on.
1156 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1157 * it below does not make any difference. It seems to work fine
1158 * with perl5.004_68 but given the probable nature of the bug,
1159 * that does not prove anything.
1161 * It's a shame because increasing the amount of buckets raises
1162 * store() throughput by 5%, but until I figure this out, I can't
1163 * allow for this to go into production.
1165 * It is reported fixed in 5.005, hence the #if.
1167 #if PERL_VERSION >= 5
1168 #define HBUCKETS 4096 /* Buckets for %hseen */
1169 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1173 * The `hclass' hash uses the same settings as `hseen' above, but it is
1174 * used to assign sequential tags (numbers) to class names for blessed
1177 * We turn the shared key optimization on.
1180 cxt->hclass = newHV(); /* Where seen classnames are stored */
1182 #if PERL_VERSION >= 5
1183 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1187 * The `hook' hash table is used to keep track of the references on
1188 * the STORABLE_freeze hook routines, when found in some class name.
1190 * It is assumed that the inheritance tree will not be changed during
1191 * storing, and that no new method will be dynamically created by the
1195 cxt->hook = newHV(); /* Table where hooks are cached */
1198 * The `hook_seen' array keeps track of all the SVs returned by
1199 * STORABLE_freeze hooks for us to serialize, so that they are not
1200 * reclaimed until the end of the serialization process. Each SV is
1201 * only stored once, the first time it is seen.
1204 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1208 * clean_store_context
1210 * Clean store context by
1212 static void clean_store_context(stcxt_t *cxt)
1216 TRACEME(("clean_store_context"));
1218 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1221 * Insert real values into hashes where we stored faked pointers.
1225 hv_iterinit(cxt->hseen);
1226 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1227 HeVAL(he) = &PL_sv_undef;
1231 hv_iterinit(cxt->hclass);
1232 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1233 HeVAL(he) = &PL_sv_undef;
1237 * And now dispose of them...
1239 * The surrounding if() protection has been added because there might be
1240 * some cases where this routine is called more than once, during
1241 * exceptionnal events. This was reported by Marc Lehmann when Storable
1242 * is executed from mod_perl, and the fix was suggested by him.
1243 * -- RAM, 20/12/2000
1247 HV *hseen = cxt->hseen;
1250 sv_free((SV *) hseen);
1254 HV *hclass = cxt->hclass;
1257 sv_free((SV *) hclass);
1261 HV *hook = cxt->hook;
1264 sv_free((SV *) hook);
1267 if (cxt->hook_seen) {
1268 AV *hook_seen = cxt->hook_seen;
1270 av_undef(hook_seen);
1271 sv_free((SV *) hook_seen);
1274 cxt->forgive_me = -1; /* Fetched from perl if needed */
1275 cxt->canonical = -1; /* Idem */
1281 * init_retrieve_context
1283 * Initialize a new retrieve context for real recursion.
1285 static void init_retrieve_context(stcxt_t *cxt, int optype, int is_tainted)
1287 TRACEME(("init_retrieve_context"));
1290 * The hook hash table is used to keep track of the references on
1291 * the STORABLE_thaw hook routines, when found in some class name.
1293 * It is assumed that the inheritance tree will not be changed during
1294 * storing, and that no new method will be dynamically created by the
1298 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1301 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1302 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1303 * the correspondance between the tags and the tag number used by the
1304 * new retrieve routines.
1307 cxt->hseen = ((cxt->retrieve_vtbl == sv_old_retrieve) ? newHV() : 0);
1309 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1310 cxt->aclass = newAV(); /* Where seen classnames are kept */
1311 cxt->tagnum = 0; /* Have to count objects... */
1312 cxt->classnum = 0; /* ...and class names as well */
1313 cxt->optype = optype;
1314 cxt->s_tainted = is_tainted;
1315 cxt->entry = 1; /* No recursion yet */
1316 #ifndef HAS_RESTRICTED_HASHES
1317 cxt->derestrict = -1; /* Fetched from perl if needed */
1319 #ifndef HAS_UTF8_ALL
1320 cxt->use_bytes = -1; /* Fetched from perl if needed */
1322 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1326 * clean_retrieve_context
1328 * Clean retrieve context by
1330 static void clean_retrieve_context(stcxt_t *cxt)
1332 TRACEME(("clean_retrieve_context"));
1334 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1337 AV *aseen = cxt->aseen;
1340 sv_free((SV *) aseen);
1344 AV *aclass = cxt->aclass;
1347 sv_free((SV *) aclass);
1351 HV *hook = cxt->hook;
1354 sv_free((SV *) hook);
1358 HV *hseen = cxt->hseen;
1361 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1364 #ifndef HAS_RESTRICTED_HASHES
1365 cxt->derestrict = -1; /* Fetched from perl if needed */
1367 #ifndef HAS_UTF8_ALL
1368 cxt->use_bytes = -1; /* Fetched from perl if needed */
1370 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1378 * A workaround for the CROAK bug: cleanup the last context.
1380 static void clean_context(stcxt_t *cxt)
1382 TRACEME(("clean_context"));
1384 ASSERT(cxt->s_dirty, ("dirty context"));
1389 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1391 if (cxt->optype & ST_RETRIEVE)
1392 clean_retrieve_context(cxt);
1393 else if (cxt->optype & ST_STORE)
1394 clean_store_context(cxt);
1398 ASSERT(!cxt->s_dirty, ("context is clean"));
1399 ASSERT(cxt->entry == 0, ("context is reset"));
1405 * Allocate a new context and push it on top of the parent one.
1406 * This new context is made globally visible via SET_STCXT().
1408 static stcxt_t *allocate_context(parent_cxt)
1409 stcxt_t *parent_cxt;
1413 TRACEME(("allocate_context"));
1415 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1417 NEW_STORABLE_CXT_OBJ(cxt);
1418 cxt->prev = parent_cxt->my_sv;
1421 ASSERT(!cxt->s_dirty, ("clean context"));
1429 * Free current context, which cannot be the "root" one.
1430 * Make the context underneath globally visible via SET_STCXT().
1432 static void free_context(cxt)
1435 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1437 TRACEME(("free_context"));
1439 ASSERT(!cxt->s_dirty, ("clean context"));
1440 ASSERT(prev, ("not freeing root context"));
1442 SvREFCNT_dec(cxt->my_sv);
1445 ASSERT(cxt, ("context not void"));
1455 * Tells whether we're in the middle of a store operation.
1457 int is_storing(void)
1461 return cxt->entry && (cxt->optype & ST_STORE);
1467 * Tells whether we're in the middle of a retrieve operation.
1469 int is_retrieving(void)
1473 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1477 * last_op_in_netorder
1479 * Returns whether last operation was made using network order.
1481 * This is typically out-of-band information that might prove useful
1482 * to people wishing to convert native to network order data when used.
1484 int last_op_in_netorder(void)
1488 return cxt->netorder;
1492 *** Hook lookup and calling routines.
1498 * A wrapper on gv_fetchmethod_autoload() which caches results.
1500 * Returns the routine reference as an SV*, or null if neither the package
1501 * nor its ancestors know about the method.
1503 static SV *pkg_fetchmeth(
1512 * The following code is the same as the one performed by UNIVERSAL::can
1516 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1517 if (gv && isGV(gv)) {
1518 sv = newRV((SV*) GvCV(gv));
1519 TRACEME(("%s->%s: 0x%"UVxf, HvNAME(pkg), method, PTR2UV(sv)));
1521 sv = newSVsv(&PL_sv_undef);
1522 TRACEME(("%s->%s: not found", HvNAME(pkg), method));
1526 * Cache the result, ignoring failure: if we can't store the value,
1527 * it just won't be cached.
1530 (void) hv_store(cache, HvNAME(pkg), strlen(HvNAME(pkg)), sv, 0);
1532 return SvOK(sv) ? sv : (SV *) 0;
1538 * Force cached value to be undef: hook ignored even if present.
1540 static void pkg_hide(
1545 (void) hv_store(cache,
1546 HvNAME(pkg), strlen(HvNAME(pkg)), newSVsv(&PL_sv_undef), 0);
1552 * Discard cached value: a whole fetch loop will be retried at next lookup.
1554 static void pkg_uncache(
1559 (void) hv_delete(cache, HvNAME(pkg), strlen(HvNAME(pkg)), G_DISCARD);
1565 * Our own "UNIVERSAL::can", which caches results.
1567 * Returns the routine reference as an SV*, or null if the object does not
1568 * know about the method.
1578 TRACEME(("pkg_can for %s->%s", HvNAME(pkg), method));
1581 * Look into the cache to see whether we already have determined
1582 * where the routine was, if any.
1584 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1585 * that only one hook (i.e. always the same) is cached in a given cache.
1588 svh = hv_fetch(cache, HvNAME(pkg), strlen(HvNAME(pkg)), FALSE);
1592 TRACEME(("cached %s->%s: not found", HvNAME(pkg), method));
1595 TRACEME(("cached %s->%s: 0x%"UVxf,
1596 HvNAME(pkg), method, PTR2UV(sv)));
1601 TRACEME(("not cached yet"));
1602 return pkg_fetchmeth(cache, pkg, method); /* Fetch and cache */
1608 * Call routine as obj->hook(av) in scalar context.
1609 * Propagates the single returned value if not called in void context.
1611 static SV *scalar_call(
1622 TRACEME(("scalar_call (cloning=%d)", cloning));
1629 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1631 SV **ary = AvARRAY(av);
1632 int cnt = AvFILLp(av) + 1;
1634 XPUSHs(ary[0]); /* Frozen string */
1635 for (i = 1; i < cnt; i++) {
1636 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1637 i, PTR2UV(ary[i])));
1638 XPUSHs(sv_2mortal(newRV(ary[i])));
1643 TRACEME(("calling..."));
1644 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1645 TRACEME(("count = %d", count));
1651 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1664 * Call routine obj->hook(cloning) in list context.
1665 * Returns the list of returned values in an array.
1667 static AV *array_call(
1677 TRACEME(("array_call (cloning=%d)", cloning));
1683 XPUSHs(obj); /* Target object */
1684 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1687 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1692 for (i = count - 1; i >= 0; i--) {
1694 av_store(av, i, SvREFCNT_inc(sv));
1707 * Lookup the class name in the `hclass' table and either assign it a new ID
1708 * or return the existing one, by filling in `classnum'.
1710 * Return true if the class was known, false if the ID was just generated.
1712 static int known_class(
1714 char *name, /* Class name */
1715 int len, /* Name length */
1719 HV *hclass = cxt->hclass;
1721 TRACEME(("known_class (%s)", name));
1724 * Recall that we don't store pointers in this hash table, but tags.
1725 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1728 svh = hv_fetch(hclass, name, len, FALSE);
1730 *classnum = LOW_32BITS(*svh);
1735 * Unknown classname, we need to record it.
1739 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1740 CROAK(("Unable to record new classname"));
1742 *classnum = cxt->classnum;
1747 *** Sepcific store routines.
1753 * Store a reference.
1754 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1756 static int store_ref(stcxt_t *cxt, SV *sv)
1758 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1761 * Follow reference, and check if target is overloaded.
1767 HV *stash = (HV *) SvSTASH(sv);
1768 if (stash && Gv_AMG(stash)) {
1769 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1770 PUTMARK(SX_OVERLOAD);
1776 return store(cxt, sv);
1784 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1785 * The <data> section is omitted if <length> is 0.
1787 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1788 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1790 static int store_scalar(stcxt_t *cxt, SV *sv)
1795 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1797 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1800 * For efficiency, break the SV encapsulation by peaking at the flags
1801 * directly without using the Perl macros to avoid dereferencing
1802 * sv->sv_flags each time we wish to check the flags.
1805 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1806 if (sv == &PL_sv_undef) {
1807 TRACEME(("immortal undef"));
1808 PUTMARK(SX_SV_UNDEF);
1810 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
1817 * Always store the string representation of a scalar if it exists.
1818 * Gisle Aas provided me with this test case, better than a long speach:
1820 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1821 * SV = PVNV(0x80c8520)
1823 * FLAGS = (NOK,POK,pNOK,pPOK)
1826 * PV = 0x80c83d0 "abc"\0
1830 * Write SX_SCALAR, length, followed by the actual data.
1832 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
1833 * appropriate, followed by the actual (binary) data. A double
1834 * is written as a string if network order, for portability.
1836 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
1837 * The reason is that when the scalar value is tainted, the SvNOK(sv)
1840 * The test for a read-only scalar with both POK and NOK set is meant
1841 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
1842 * address comparison for each scalar we store.
1845 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
1847 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
1848 if (sv == &PL_sv_yes) {
1849 TRACEME(("immortal yes"));
1851 } else if (sv == &PL_sv_no) {
1852 TRACEME(("immortal no"));
1855 pv = SvPV(sv, len); /* We know it's SvPOK */
1856 goto string; /* Share code below */
1858 } else if (flags & SVf_POK) {
1859 /* public string - go direct to string read. */
1860 goto string_readlen;
1862 #if (PATCHLEVEL <= 6)
1863 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
1864 direct if NV flag is off. */
1865 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
1867 /* 5.7 rules are that if IV public flag is set, IV value is as
1868 good, if not better, than NV value. */
1874 * Will come here from below with iv set if double is an integer.
1878 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1880 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
1881 * (for example) and that ends up in the optimised small integer
1884 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
1885 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
1886 goto string_readlen;
1890 * Optimize small integers into a single byte, otherwise store as
1891 * a real integer (converted into network order if they asked).
1894 if (iv >= -128 && iv <= 127) {
1895 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
1898 TRACEME(("small integer stored as %d", siv));
1899 } else if (cxt->netorder) {
1901 TRACEME(("no htonl, fall back to string for integer"));
1902 goto string_readlen;
1910 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1911 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
1913 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
1914 /* Bigger than 32 bits. */
1915 TRACEME(("large network order integer as string, value = %"IVdf, iv));
1916 goto string_readlen;
1920 niv = (I32) htonl((I32) iv);
1921 TRACEME(("using network order"));
1926 PUTMARK(SX_INTEGER);
1927 WRITE(&iv, sizeof(iv));
1930 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
1931 } else if (flags & SVf_NOK) {
1933 #if (PATCHLEVEL <= 6)
1936 * Watch for number being an integer in disguise.
1938 if (nv == (NV) (iv = I_V(nv))) {
1939 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
1940 goto integer; /* Share code above */
1947 goto integer; /* Share code above */
1952 if (cxt->netorder) {
1953 TRACEME(("double %"NVff" stored as string", nv));
1954 goto string_readlen; /* Share code below */
1958 WRITE(&nv, sizeof(nv));
1960 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
1962 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
1963 I32 wlen; /* For 64-bit machines */
1969 * Will come here from above if it was readonly, POK and NOK but
1970 * neither &PL_sv_yes nor &PL_sv_no.
1974 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
1976 STORE_UTF8STR(pv, wlen);
1978 STORE_SCALAR(pv, wlen);
1979 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
1980 PTR2UV(sv), SvPVX(sv), (IV)len));
1982 CROAK(("Can't determine type of %s(0x%"UVxf")",
1983 sv_reftype(sv, FALSE),
1985 return 0; /* Ok, no recursion on scalars */
1993 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
1994 * Each item is stored as <object>.
1996 static int store_array(stcxt_t *cxt, AV *av)
1999 I32 len = av_len(av) + 1;
2003 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2006 * Signal array by emitting SX_ARRAY, followed by the array length.
2011 TRACEME(("size = %d", len));
2014 * Now store each item recursively.
2017 for (i = 0; i < len; i++) {
2018 sav = av_fetch(av, i, 0);
2020 TRACEME(("(#%d) undef item", i));
2024 TRACEME(("(#%d) item", i));
2025 if ((ret = store(cxt, *sav))) /* Extra () for -Wall, grr... */
2029 TRACEME(("ok (array)"));
2038 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2041 sortcmp(const void *a, const void *b)
2043 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2050 * Store a hash table.
2052 * For a "normal" hash (not restricted, no utf8 keys):
2054 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2055 * Values are stored as <object>.
2056 * Keys are stored as <length> <data>, the <data> section being omitted
2059 * For a "fancy" hash (restricted or utf8 keys):
2061 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2063 * Values are stored as <object>.
2064 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2066 * Currently the only hash flag is "restriced"
2067 * Key flags are as for hv.h
2069 static int store_hash(stcxt_t *cxt, HV *hv)
2072 #ifdef HAS_RESTRICTED_HASHES
2081 int flagged_hash = ((SvREADONLY(hv)
2082 #ifdef HAS_HASH_KEY_FLAGS
2086 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2089 /* needs int cast for C++ compilers, doesn't it? */
2090 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2093 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2097 * Signal hash by emitting SX_HASH, followed by the table length.
2101 PUTMARK(SX_FLAG_HASH);
2102 PUTMARK(hash_flags);
2107 TRACEME(("size = %d", len));
2110 * Save possible iteration state via each() on that table.
2113 riter = HvRITER(hv);
2114 eiter = HvEITER(hv);
2118 * Now store each item recursively.
2120 * If canonical is defined to some true value then store each
2121 * key/value pair in sorted order otherwise the order is random.
2122 * Canonical order is irrelevant when a deep clone operation is performed.
2124 * Fetch the value from perl only once per store() operation, and only
2129 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2130 (cxt->canonical < 0 && (cxt->canonical =
2131 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2134 * Storing in order, sorted by key.
2135 * Run through the hash, building up an array of keys in a
2136 * mortal array, sort the array and then run through the
2142 /*av_extend (av, len);*/
2144 TRACEME(("using canonical order"));
2146 for (i = 0; i < len; i++) {
2147 #ifdef HAS_RESTRICTED_HASHES
2148 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2150 HE *he = hv_iternext(hv);
2152 SV *key = hv_iterkeysv(he);
2153 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2156 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
2158 for (i = 0; i < len; i++) {
2159 unsigned char flags;
2163 SV *key = av_shift(av);
2164 HE *he = hv_fetch_ent(hv, key, 0, 0);
2165 SV *val = HeVAL(he);
2167 return 1; /* Internal error, not I/O error */
2170 * Store value first.
2173 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2175 if ((ret = store(cxt, val))) /* Extra () for -Wall, grr... */
2180 * Keys are written after values to make sure retrieval
2181 * can be optimal in terms of memory usage, where keys are
2182 * read into a fixed unique buffer called kbuf.
2183 * See retrieve_hash() for details.
2186 /* Implementation of restricted hashes isn't nicely
2189 = (((hash_flags & SHV_RESTRICTED)
2191 ? SHV_K_LOCKED : 0);
2192 if (val == &PL_sv_undef)
2193 flags |= SHV_K_PLACEHOLDER;
2195 keyval = SvPV(key, keylen_tmp);
2196 keylen = keylen_tmp;
2197 #ifdef HAS_UTF8_HASHES
2198 /* If you build without optimisation on pre 5.6
2199 then nothing spots that SvUTF8(key) is always 0,
2200 so the block isn't optimised away, at which point
2201 the linker dislikes the reference to
2204 const char *keysave = keyval;
2205 bool is_utf8 = TRUE;
2207 /* Just casting the &klen to (STRLEN) won't work
2208 well if STRLEN and I32 are of different widths.
2210 keyval = (char*)bytes_from_utf8((U8*)keyval,
2214 /* If we were able to downgrade here, then than
2215 means that we have a key which only had chars
2216 0-255, but was utf8 encoded. */
2218 if (keyval != keysave) {
2219 keylen = keylen_tmp;
2220 flags |= SHV_K_WASUTF8;
2222 /* keylen_tmp can't have changed, so no need
2223 to assign back to keylen. */
2224 flags |= SHV_K_UTF8;
2231 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2233 assert (flags == 0);
2234 TRACEME(("(#%d) key '%s'", i, keyval));
2238 WRITE(keyval, keylen);
2239 if (flags & SHV_K_WASUTF8)
2244 * Free up the temporary array
2253 * Storing in "random" order (in the order the keys are stored
2254 * within the the hash). This is the default and will be faster!
2257 for (i = 0; i < len; i++) {
2260 unsigned char flags;
2261 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2262 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2264 HE *he = hv_iternext(hv);
2266 SV *val = (he ? hv_iterval(hv, he) : 0);
2271 return 1; /* Internal error, not I/O error */
2274 * Store value first.
2277 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2279 if ((ret = store(cxt, val))) /* Extra () for -Wall, grr... */
2282 /* Implementation of restricted hashes isn't nicely
2285 = (((hash_flags & SHV_RESTRICTED)
2287 ? SHV_K_LOCKED : 0);
2288 if (val == &PL_sv_undef)
2289 flags |= SHV_K_PLACEHOLDER;
2291 hek = HeKEY_hek(he);
2293 if (len == HEf_SVKEY) {
2294 /* This is somewhat sick, but the internal APIs are
2295 * such that XS code could put one of these in in
2297 * Maybe we should be capable of storing one if
2300 key_sv = HeKEY_sv(he);
2301 flags |= SHV_K_ISSV;
2303 /* Regular string key. */
2304 #ifdef HAS_HASH_KEY_FLAGS
2306 flags |= SHV_K_UTF8;
2307 if (HEK_WASUTF8(hek))
2308 flags |= SHV_K_WASUTF8;
2314 * Keys are written after values to make sure retrieval
2315 * can be optimal in terms of memory usage, where keys are
2316 * read into a fixed unique buffer called kbuf.
2317 * See retrieve_hash() for details.
2322 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2324 assert (flags == 0);
2325 TRACEME(("(#%d) key '%s'", i, key));
2327 if (flags & SHV_K_ISSV) {
2337 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2340 HvRITER(hv) = riter; /* Restore hash iterator state */
2341 HvEITER(hv) = eiter;
2349 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2350 * a special mark, followed by the underlying tied object. For instance, when
2351 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2352 * <hash object> stands for the serialization of the tied hash.
2354 static int store_tied(stcxt_t *cxt, SV *sv)
2358 int svt = SvTYPE(sv);
2361 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2364 * We have a small run-time penalty here because we chose to factorise
2365 * all tieds objects into the same routine, and not have a store_tied_hash,
2366 * a store_tied_array, etc...
2368 * Don't use a switch() statement, as most compilers don't optimize that
2369 * well for 2/3 values. An if() else if() cascade is just fine. We put
2370 * tied hashes first, as they are the most likely beasts.
2373 if (svt == SVt_PVHV) {
2374 TRACEME(("tied hash"));
2375 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2376 } else if (svt == SVt_PVAV) {
2377 TRACEME(("tied array"));
2378 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2380 TRACEME(("tied scalar"));
2381 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2385 if (!(mg = mg_find(sv, mtype)))
2386 CROAK(("No magic '%c' found while storing tied %s", mtype,
2387 (svt == SVt_PVHV) ? "hash" :
2388 (svt == SVt_PVAV) ? "array" : "scalar"));
2391 * The mg->mg_obj found by mg_find() above actually points to the
2392 * underlying tied Perl object implementation. For instance, if the
2393 * original SV was that of a tied array, then mg->mg_obj is an AV.
2395 * Note that we store the Perl object as-is. We don't call its FETCH
2396 * method along the way. At retrieval time, we won't call its STORE
2397 * method either, but the tieing magic will be re-installed. In itself,
2398 * that ensures that the tieing semantics are preserved since futher
2399 * accesses on the retrieved object will indeed call the magic methods...
2402 if ((ret = store(cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2405 TRACEME(("ok (tied)"));
2413 * Stores a reference to an item within a tied structure:
2415 * . \$h{key}, stores both the (tied %h) object and 'key'.
2416 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2418 * Layout is therefore either:
2419 * SX_TIED_KEY <object> <key>
2420 * SX_TIED_IDX <object> <index>
2422 static int store_tied_item(stcxt_t *cxt, SV *sv)
2427 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2429 if (!(mg = mg_find(sv, 'p')))
2430 CROAK(("No magic 'p' found while storing reference to tied item"));
2433 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2437 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2438 PUTMARK(SX_TIED_KEY);
2439 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2441 if ((ret = store(cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2444 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2446 if ((ret = store(cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2449 I32 idx = mg->mg_len;
2451 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2452 PUTMARK(SX_TIED_IDX);
2453 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2455 if ((ret = store(cxt, mg->mg_obj))) /* Idem, for -Wall */
2458 TRACEME(("store_tied_item: storing IDX %d", idx));
2463 TRACEME(("ok (tied item)"));
2469 * store_hook -- dispatched manually, not via sv_store[]
2471 * The blessed SV is serialized by a hook.
2475 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2477 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2478 * the trailing part [] is present, the type of object (scalar, array or hash).
2479 * There is also a bit which says how the classname is stored between:
2484 * and when the <index> form is used (classname already seen), the "large
2485 * classname" bit in <flags> indicates how large the <index> is.
2487 * The serialized string returned by the hook is of length <len2> and comes
2488 * next. It is an opaque string for us.
2490 * Those <len3> object IDs which are listed last represent the extra references
2491 * not directly serialized by the hook, but which are linked to the object.
2493 * When recursion is mandated to resolve object-IDs not yet seen, we have
2494 * instead, with <header> being flags with bits set to indicate the object type
2495 * and that recursion was indeed needed:
2497 * SX_HOOK <header> <object> <header> <object> <flags>
2499 * that same header being repeated between serialized objects obtained through
2500 * recursion, until we reach flags indicating no recursion, at which point
2501 * we know we've resynchronized with a single layout, after <flags>.
2503 * When storing a blessed ref to a tied variable, the following format is
2506 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2508 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2509 * real object type is held in the <extra> flag. At the very end of the
2510 * serialization stream, the underlying magic object is serialized, just like
2511 * any other tied variable.
2513 static int store_hook(
2526 int count; /* really len3 + 1 */
2527 unsigned char flags;
2530 int recursed = 0; /* counts recursion */
2531 int obj_type; /* object type, on 2 bits */
2534 int clone = cxt->optype & ST_CLONE;
2535 char mtype = '\0'; /* for blessed ref to tied structures */
2536 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2538 TRACEME(("store_hook, class \"%s\", tagged #%d", HvNAME(pkg), cxt->tagnum));
2541 * Determine object type on 2 bits.
2546 obj_type = SHT_SCALAR;
2549 obj_type = SHT_ARRAY;
2552 obj_type = SHT_HASH;
2556 * Produced by a blessed ref to a tied data structure, $o in the
2557 * following Perl code.
2561 * my $o = bless \%h, 'BAR';
2563 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2564 * (since we have only 2 bits in <flags> to store the type), and an
2565 * <extra> byte flag will be emitted after the FIRST <flags> in the
2566 * stream, carrying what we put in `eflags'.
2568 obj_type = SHT_EXTRA;
2569 switch (SvTYPE(sv)) {
2571 eflags = (unsigned char) SHT_THASH;
2575 eflags = (unsigned char) SHT_TARRAY;
2579 eflags = (unsigned char) SHT_TSCALAR;
2585 CROAK(("Unexpected object type (%d) in store_hook()", type));
2587 flags = SHF_NEED_RECURSE | obj_type;
2589 class = HvNAME(pkg);
2590 len = strlen(class);
2593 * To call the hook, we need to fake a call like:
2595 * $object->STORABLE_freeze($cloning);
2597 * but we don't have the $object here. For instance, if $object is
2598 * a blessed array, what we have in `sv' is the array, and we can't
2599 * call a method on those.
2601 * Therefore, we need to create a temporary reference to the object and
2602 * make the call on that reference.
2605 TRACEME(("about to call STORABLE_freeze on class %s", class));
2607 ref = newRV_noinc(sv); /* Temporary reference */
2608 av = array_call(ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2610 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2612 count = AvFILLp(av) + 1;
2613 TRACEME(("store_hook, array holds %d items", count));
2616 * If they return an empty list, it means they wish to ignore the
2617 * hook for this class (and not just this instance -- that's for them
2618 * to handle if they so wish).
2620 * Simply disable the cached entry for the hook (it won't be recomputed
2621 * since it's present in the cache) and recurse to store_blessed().
2626 * They must not change their mind in the middle of a serialization.
2629 if (hv_fetch(cxt->hclass, class, len, FALSE))
2630 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2631 (cxt->optype & ST_CLONE) ? "cloning" : "storing", class));
2633 pkg_hide(cxt->hook, pkg, "STORABLE_freeze");
2635 ASSERT(!pkg_can(cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2636 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", class));
2638 return store_blessed(cxt, sv, type, pkg);
2642 * Get frozen string.
2646 pv = SvPV(ary[0], len2);
2649 * If they returned more than one item, we need to serialize some
2650 * extra references if not already done.
2652 * Loop over the array, starting at postion #1, and for each item,
2653 * ensure it is a reference, serialize it if not already done, and
2654 * replace the entry with the tag ID of the corresponding serialized
2657 * We CHEAT by not calling av_fetch() and read directly within the
2661 for (i = 1; i < count; i++) {
2665 AV *av_hook = cxt->hook_seen;
2668 CROAK(("Item #%d returned by STORABLE_freeze "
2669 "for %s is not a reference", i, class));
2670 xsv = SvRV(rsv); /* Follow ref to know what to look for */
2673 * Look in hseen and see if we have a tag already.
2674 * Serialize entry if not done already, and get its tag.
2677 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
2678 goto sv_seen; /* Avoid moving code too far to the right */
2680 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
2683 * We need to recurse to store that object and get it to be known
2684 * so that we can resolve the list of object-IDs at retrieve time.
2686 * The first time we do this, we need to emit the proper header
2687 * indicating that we recursed, and what the type of object is (the
2688 * object we're storing via a user-hook). Indeed, during retrieval,
2689 * we'll have to create the object before recursing to retrieve the
2690 * others, in case those would point back at that object.
2693 /* [SX_HOOK] <flags> [<extra>] <object>*/
2697 if (obj_type == SHT_EXTRA)
2702 if ((ret = store(cxt, xsv))) /* Given by hook for us to store */
2705 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
2707 CROAK(("Could not serialize item #%d from hook in %s", i, class));
2710 * It was the first time we serialized `xsv'.
2712 * Keep this SV alive until the end of the serialization: if we
2713 * disposed of it right now by decrementing its refcount, and it was
2714 * a temporary value, some next temporary value allocated during
2715 * another STORABLE_freeze might take its place, and we'd wrongly
2716 * assume that new SV was already serialized, based on its presence
2719 * Therefore, push it away in cxt->hook_seen.
2722 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
2726 * Dispose of the REF they returned. If we saved the `xsv' away
2727 * in the array of returned SVs, that will not cause the underlying
2728 * referenced SV to be reclaimed.
2731 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
2732 SvREFCNT_dec(rsv); /* Dispose of reference */
2735 * Replace entry with its tag (not a real SV, so no refcnt increment)
2739 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
2740 i-1, PTR2UV(xsv), PTR2UV(*svh)));
2744 * Allocate a class ID if not already done.
2746 * This needs to be done after the recursion above, since at retrieval
2747 * time, we'll see the inner objects first. Many thanks to
2748 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
2749 * proposed the right fix. -- RAM, 15/09/2000
2752 if (!known_class(cxt, class, len, &classnum)) {
2753 TRACEME(("first time we see class %s, ID = %d", class, classnum));
2754 classnum = -1; /* Mark: we must store classname */
2756 TRACEME(("already seen class %s, ID = %d", class, classnum));
2760 * Compute leading flags.
2764 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
2765 flags |= SHF_LARGE_CLASSLEN;
2767 flags |= SHF_IDX_CLASSNAME;
2768 if (len2 > LG_SCALAR)
2769 flags |= SHF_LARGE_STRLEN;
2771 flags |= SHF_HAS_LIST;
2772 if (count > (LG_SCALAR + 1))
2773 flags |= SHF_LARGE_LISTLEN;
2776 * We're ready to emit either serialized form:
2778 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2779 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
2781 * If we recursed, the SX_HOOK has already been emitted.
2784 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
2785 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
2786 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
2788 /* SX_HOOK <flags> [<extra>] */
2792 if (obj_type == SHT_EXTRA)
2797 /* <len> <classname> or <index> */
2798 if (flags & SHF_IDX_CLASSNAME) {
2799 if (flags & SHF_LARGE_CLASSLEN)
2802 unsigned char cnum = (unsigned char) classnum;
2806 if (flags & SHF_LARGE_CLASSLEN)
2809 unsigned char clen = (unsigned char) len;
2812 WRITE(class, len); /* Final \0 is omitted */
2815 /* <len2> <frozen-str> */
2816 if (flags & SHF_LARGE_STRLEN) {
2817 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
2818 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
2820 unsigned char clen = (unsigned char) len2;
2824 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
2826 /* [<len3> <object-IDs>] */
2827 if (flags & SHF_HAS_LIST) {
2828 int len3 = count - 1;
2829 if (flags & SHF_LARGE_LISTLEN)
2832 unsigned char clen = (unsigned char) len3;
2837 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
2838 * real pointer, rather a tag number, well under the 32-bit limit.
2841 for (i = 1; i < count; i++) {
2842 I32 tagval = htonl(LOW_32BITS(ary[i]));
2844 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
2849 * Free the array. We need extra care for indices after 0, since they
2850 * don't hold real SVs but integers cast.
2854 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
2859 * If object was tied, need to insert serialization of the magic object.
2862 if (obj_type == SHT_EXTRA) {
2865 if (!(mg = mg_find(sv, mtype))) {
2866 int svt = SvTYPE(sv);
2867 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
2868 mtype, (svt == SVt_PVHV) ? "hash" :
2869 (svt == SVt_PVAV) ? "array" : "scalar"));
2872 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
2873 PTR2UV(mg->mg_obj), PTR2UV(sv)));
2879 if ((ret = store(cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2887 * store_blessed -- dispatched manually, not via sv_store[]
2889 * Check whether there is a STORABLE_xxx hook defined in the class or in one
2890 * of its ancestors. If there is, then redispatch to store_hook();
2892 * Otherwise, the blessed SV is stored using the following layout:
2894 * SX_BLESS <flag> <len> <classname> <object>
2896 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
2897 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
2898 * Otherwise, the low order bits give the length, thereby giving a compact
2899 * representation for class names less than 127 chars long.
2901 * Each <classname> seen is remembered and indexed, so that the next time
2902 * an object in the blessed in the same <classname> is stored, the following
2905 * SX_IX_BLESS <flag> <index> <object>
2907 * where <index> is the classname index, stored on 0 or 4 bytes depending
2908 * on the high-order bit in flag (same encoding as above for <len>).
2910 static int store_blessed(
2921 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME(pkg)));
2924 * Look for a hook for this blessed SV and redirect to store_hook()
2928 hook = pkg_can(cxt->hook, pkg, "STORABLE_freeze");
2930 return store_hook(cxt, sv, type, pkg, hook);
2933 * This is a blessed SV without any serialization hook.
2936 class = HvNAME(pkg);
2937 len = strlen(class);
2939 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
2940 PTR2UV(sv), class, cxt->tagnum));
2943 * Determine whether it is the first time we see that class name (in which
2944 * case it will be stored in the SX_BLESS form), or whether we already
2945 * saw that class name before (in which case the SX_IX_BLESS form will be
2949 if (known_class(cxt, class, len, &classnum)) {
2950 TRACEME(("already seen class %s, ID = %d", class, classnum));
2951 PUTMARK(SX_IX_BLESS);
2952 if (classnum <= LG_BLESS) {
2953 unsigned char cnum = (unsigned char) classnum;
2956 unsigned char flag = (unsigned char) 0x80;
2961 TRACEME(("first time we see class %s, ID = %d", class, classnum));
2963 if (len <= LG_BLESS) {
2964 unsigned char clen = (unsigned char) len;
2967 unsigned char flag = (unsigned char) 0x80;
2969 WLEN(len); /* Don't BER-encode, this should be rare */
2971 WRITE(class, len); /* Final \0 is omitted */
2975 * Now emit the <object> part.
2978 return SV_STORE(type)(cxt, sv);
2984 * We don't know how to store the item we reached, so return an error condition.
2985 * (it's probably a GLOB, some CODE reference, etc...)
2987 * If they defined the `forgive_me' variable at the Perl level to some
2988 * true value, then don't croak, just warn, and store a placeholder string
2991 static int store_other(stcxt_t *cxt, SV *sv)
2994 static char buf[80];
2996 TRACEME(("store_other"));
2999 * Fetch the value from perl only once per store() operation.
3003 cxt->forgive_me == 0 ||
3004 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3005 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3007 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3009 warn("Can't store item %s(0x%"UVxf")",
3010 sv_reftype(sv, FALSE), PTR2UV(sv));
3013 * Store placeholder string as a scalar instead...
3016 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3017 PTR2UV(sv), (char) 0);
3020 STORE_SCALAR(buf, len);
3021 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3027 *** Store driving routines
3033 * WARNING: partially duplicates Perl's sv_reftype for speed.
3035 * Returns the type of the SV, identified by an integer. That integer
3036 * may then be used to index the dynamic routine dispatch table.
3038 static int sv_type(SV *sv)
3040 switch (SvTYPE(sv)) {
3045 * No need to check for ROK, that can't be set here since there
3046 * is no field capable of hodling the xrv_rv reference.
3054 * Starting from SVt_PV, it is possible to have the ROK flag
3055 * set, the pointer to the other SV being either stored in
3056 * the xrv_rv (in the case of a pure SVt_RV), or as the
3057 * xpv_pv field of an SVt_PV and its heirs.
3059 * However, those SV cannot be magical or they would be an
3060 * SVt_PVMG at least.
3062 return SvROK(sv) ? svis_REF : svis_SCALAR;
3064 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3065 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3066 return svis_TIED_ITEM;
3069 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3071 return SvROK(sv) ? svis_REF : svis_SCALAR;
3073 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3077 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3090 * Recursively store objects pointed to by the sv to the specified file.
3092 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3093 * object (one for which storage has started -- it may not be over if we have
3094 * a self-referenced structure). This data set forms a stored <object>.
3096 static int store(stcxt_t *cxt, SV *sv)
3101 HV *hseen = cxt->hseen;
3103 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3106 * If object has already been stored, do not duplicate data.
3107 * Simply emit the SX_OBJECT marker followed by its tag data.
3108 * The tag is always written in network order.
3110 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3111 * real pointer, rather a tag number (watch the insertion code below).
3112 * That means it pobably safe to assume it is well under the 32-bit limit,
3113 * and makes the truncation safe.
3114 * -- RAM, 14/09/1999
3117 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3119 I32 tagval = htonl(LOW_32BITS(*svh));
3121 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3129 * Allocate a new tag and associate it with the address of the sv being
3130 * stored, before recursing...
3132 * In order to avoid creating new SvIVs to hold the tagnum we just
3133 * cast the tagnum to an SV pointer and store that in the hash. This
3134 * means that we must clean up the hash manually afterwards, but gives
3135 * us a 15% throughput increase.
3140 if (!hv_store(hseen,
3141 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3145 * Store `sv' and everything beneath it, using appropriate routine.
3146 * Abort immediately if we get a non-zero status back.
3151 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3152 PTR2UV(sv), cxt->tagnum, type));
3155 HV *pkg = SvSTASH(sv);
3156 ret = store_blessed(cxt, sv, type, pkg);
3158 ret = SV_STORE(type)(cxt, sv);
3160 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3161 ret ? "FAILED" : "ok", PTR2UV(sv),
3162 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3170 * Write magic number and system information into the file.
3171 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3172 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3173 * All size and lenghts are written as single characters here.
3175 * Note that no byte ordering info is emitted when <network> is true, since
3176 * integers will be emitted in network order in that case.
3178 static int magic_write(stcxt_t *cxt)
3181 * Starting with 0.6, the "use_network_order" byte flag is also used to
3182 * indicate the version number of the binary image, encoded in the upper
3183 * bits. The bit 0 is always used to indicate network order.
3186 * Starting with 0.7, a full byte is dedicated to the minor version of
3187 * the binary format, which is incremented only when new markers are
3188 * introduced, for instance, but when backward compatibility is preserved.
3191 /* Make these at compile time. The WRITE() macro is sufficiently complex
3192 that it saves about 200 bytes doing it this way and only using it
3194 static const unsigned char network_file_header[] = {
3196 (STORABLE_BIN_MAJOR << 1) | 1,
3197 STORABLE_BIN_WRITE_MINOR
3199 static const unsigned char file_header[] = {
3201 (STORABLE_BIN_MAJOR << 1) | 0,
3202 STORABLE_BIN_WRITE_MINOR,
3203 /* sizeof the array includes the 0 byte at the end: */
3204 (char) sizeof (byteorderstr) - 1,
3206 (unsigned char) sizeof(int),
3207 (unsigned char) sizeof(long),
3208 (unsigned char) sizeof(char *),
3209 (unsigned char) sizeof(NV)
3211 #ifdef USE_56_INTERWORK_KLUDGE
3212 static const unsigned char file_header_56[] = {
3214 (STORABLE_BIN_MAJOR << 1) | 0,
3215 STORABLE_BIN_WRITE_MINOR,
3216 /* sizeof the array includes the 0 byte at the end: */
3217 (char) sizeof (byteorderstr_56) - 1,
3219 (unsigned char) sizeof(int),
3220 (unsigned char) sizeof(long),
3221 (unsigned char) sizeof(char *),
3222 (unsigned char) sizeof(NV)
3225 const unsigned char *header;
3228 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3230 if (cxt->netorder) {
3231 header = network_file_header;
3232 length = sizeof (network_file_header);
3234 #ifdef USE_56_INTERWORK_KLUDGE
3235 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3236 header = file_header_56;
3237 length = sizeof (file_header_56);
3241 header = file_header;
3242 length = sizeof (file_header);
3247 /* sizeof the array includes the 0 byte at the end. */
3248 header += sizeof (magicstr) - 1;
3249 length -= sizeof (magicstr) - 1;
3252 WRITE(header, length);
3254 if (!cxt->netorder) {
3255 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3256 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3257 (int) sizeof(int), (int) sizeof(long),
3258 (int) sizeof(char *), (int) sizeof(NV)));
3266 * Common code for store operations.
3268 * When memory store is requested (f = NULL) and a non null SV* is given in
3269 * `res', it is filled with a new SV created out of the memory buffer.
3271 * It is required to provide a non-null `res' when the operation type is not
3272 * dclone() and store() is performed to memory.
3274 static int do_store(
3284 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3285 ("must supply result SV pointer for real recursion to memory"));
3287 TRACEME(("do_store (optype=%d, netorder=%d)",
3288 optype, network_order));
3293 * Workaround for CROAK leak: if they enter with a "dirty" context,
3294 * free up memory for them now.
3301 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3302 * re-enter store() via the hooks. We need to stack contexts.
3306 cxt = allocate_context(cxt);
3310 ASSERT(cxt->entry == 1, ("starting new recursion"));
3311 ASSERT(!cxt->s_dirty, ("clean context"));
3314 * Ensure sv is actually a reference. From perl, we called something
3316 * pstore(FILE, \@array);
3317 * so we must get the scalar value behing that reference.
3321 CROAK(("Not a reference"));
3322 sv = SvRV(sv); /* So follow it to know what to store */
3325 * If we're going to store to memory, reset the buffer.
3332 * Prepare context and emit headers.
3335 init_store_context(cxt, f, optype, network_order);
3337 if (-1 == magic_write(cxt)) /* Emit magic and ILP info */
3338 return 0; /* Error */
3341 * Recursively store object...
3344 ASSERT(is_storing(), ("within store operation"));
3346 status = store(cxt, sv); /* Just do it! */
3349 * If they asked for a memory store and they provided an SV pointer,
3350 * make an SV string out of the buffer and fill their pointer.
3352 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3353 * an SV, since context cleanup might free the buffer if we did recurse.
3354 * (unless caller is dclone(), which is aware of that).
3357 if (!cxt->fio && res)
3363 * The "root" context is never freed, since it is meant to be always
3364 * handy for the common case where no recursion occurs at all (i.e.
3365 * we enter store() outside of any Storable code and leave it, period).
3366 * We know it's the "root" context because there's nothing stacked
3371 * When deep cloning, we don't free the context: doing so would force
3372 * us to copy the data in the memory buffer. Sicne we know we're
3373 * about to enter do_retrieve...
3376 clean_store_context(cxt);
3377 if (cxt->prev && !(cxt->optype & ST_CLONE))
3380 TRACEME(("do_store returns %d", status));
3388 * Store the transitive data closure of given object to disk.
3389 * Returns 0 on error, a true value otherwise.
3391 int pstore(PerlIO *f, SV *sv)
3393 TRACEME(("pstore"));
3394 return do_store(f, sv, 0, FALSE, (SV**) 0);
3401 * Same as pstore(), but network order is used for integers and doubles are
3402 * emitted as strings.
3404 int net_pstore(PerlIO *f, SV *sv)
3406 TRACEME(("net_pstore"));
3407 return do_store(f, sv, 0, TRUE, (SV**) 0);
3417 * Build a new SV out of the content of the internal memory buffer.
3419 static SV *mbuf2sv(void)
3423 return newSVpv(mbase, MBUF_SIZE());
3429 * Store the transitive data closure of given object to memory.
3430 * Returns undef on error, a scalar value containing the data otherwise.
3436 TRACEME(("mstore"));
3438 if (!do_store((PerlIO*) 0, sv, 0, FALSE, &out))
3439 return &PL_sv_undef;
3447 * Same as mstore(), but network order is used for integers and doubles are
3448 * emitted as strings.
3450 SV *net_mstore(SV *sv)
3454 TRACEME(("net_mstore"));
3456 if (!do_store((PerlIO*) 0, sv, 0, TRUE, &out))
3457 return &PL_sv_undef;
3463 *** Specific retrieve callbacks.
3469 * Return an error via croak, since it is not possible that we get here
3470 * under normal conditions, when facing a file produced via pstore().
3472 static SV *retrieve_other(stcxt_t *cxt, char *cname)
3475 cxt->ver_major != STORABLE_BIN_MAJOR &&
3476 cxt->ver_minor != STORABLE_BIN_MINOR
3478 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3479 cxt->fio ? "file" : "string",
3480 cxt->ver_major, cxt->ver_minor,
3481 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3483 CROAK(("Corrupted storable %s (binary v%d.%d)",
3484 cxt->fio ? "file" : "string",
3485 cxt->ver_major, cxt->ver_minor));
3488 return (SV *) 0; /* Just in case */
3492 * retrieve_idx_blessed
3494 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3495 * <index> can be coded on either 1 or 5 bytes.
3497 static SV *retrieve_idx_blessed(stcxt_t *cxt, char *cname)
3504 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3505 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3507 GETMARK(idx); /* Index coded on a single char? */
3512 * Fetch classname in `aclass'
3515 sva = av_fetch(cxt->aclass, idx, FALSE);
3517 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3519 class = SvPVX(*sva); /* We know it's a PV, by construction */
3521 TRACEME(("class ID %d => %s", idx, class));
3524 * Retrieve object and bless it.
3527 sv = retrieve(cxt, class); /* First SV which is SEEN will be blessed */
3535 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3536 * <len> can be coded on either 1 or 5 bytes.
3538 static SV *retrieve_blessed(stcxt_t *cxt, char *cname)
3542 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3545 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3546 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3549 * Decode class name length and read that name.
3551 * Short classnames have two advantages: their length is stored on one
3552 * single byte, and the string can be read on the stack.
3555 GETMARK(len); /* Length coded on a single char? */
3558 TRACEME(("** allocating %d bytes for class name", len+1));
3559 New(10003, class, len+1, char);
3562 class[len] = '\0'; /* Mark string end */
3565 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3568 TRACEME(("new class name \"%s\" will bear ID = %d", class, cxt->classnum));
3570 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
3574 * Retrieve object and bless it.
3577 sv = retrieve(cxt, class); /* First SV which is SEEN will be blessed */
3587 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3588 * with leading mark already read, as usual.
3590 * When recursion was involved during serialization of the object, there
3591 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
3592 * we reach a <flags> marker with the recursion bit cleared.
3594 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
3595 * is held in the <extra> byte, and if the object is tied, the serialized
3596 * magic object comes at the very end:
3598 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
3600 * This means the STORABLE_thaw hook will NOT get a tied variable during its
3601 * processing (since we won't have seen the magic object by the time the hook
3602 * is called). See comments below for why it was done that way.
3604 static SV *retrieve_hook(stcxt_t *cxt, char *cname)
3607 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3618 int clone = cxt->optype & ST_CLONE;
3620 unsigned int extra_type = 0;
3622 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
3623 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3626 * Read flags, which tell us about the type, and whether we need to recurse.
3632 * Create the (empty) object, and mark it as seen.
3634 * This must be done now, because tags are incremented, and during
3635 * serialization, the object tag was affected before recursion could
3639 obj_type = flags & SHF_TYPE_MASK;
3645 sv = (SV *) newAV();
3648 sv = (SV *) newHV();
3652 * Read <extra> flag to know the type of the object.
3653 * Record associated magic type for later.
3655 GETMARK(extra_type);
3656 switch (extra_type) {
3662 sv = (SV *) newAV();
3666 sv = (SV *) newHV();
3670 return retrieve_other(cxt, 0); /* Let it croak */
3674 return retrieve_other(cxt, 0); /* Let it croak */
3676 SEEN(sv, 0); /* Don't bless yet */
3679 * Whilst flags tell us to recurse, do so.
3681 * We don't need to remember the addresses returned by retrieval, because
3682 * all the references will be obtained through indirection via the object
3683 * tags in the object-ID list.
3686 while (flags & SHF_NEED_RECURSE) {
3687 TRACEME(("retrieve_hook recursing..."));
3688 rv = retrieve(cxt, 0);
3691 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
3696 if (flags & SHF_IDX_CLASSNAME) {
3701 * Fetch index from `aclass'
3704 if (flags & SHF_LARGE_CLASSLEN)
3709 sva = av_fetch(cxt->aclass, idx, FALSE);
3711 CROAK(("Class name #%"IVdf" should have been seen already",
3714 class = SvPVX(*sva); /* We know it's a PV, by construction */
3715 TRACEME(("class ID %d => %s", idx, class));
3719 * Decode class name length and read that name.
3721 * NOTA BENE: even if the length is stored on one byte, we don't read
3722 * on the stack. Just like retrieve_blessed(), we limit the name to
3723 * LG_BLESS bytes. This is an arbitrary decision.
3726 if (flags & SHF_LARGE_CLASSLEN)
3731 if (len > LG_BLESS) {
3732 TRACEME(("** allocating %d bytes for class name", len+1));
3733 New(10003, class, len+1, char);
3737 class[len] = '\0'; /* Mark string end */
3740 * Record new classname.
3743 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
3747 TRACEME(("class name: %s", class));
3750 * Decode user-frozen string length and read it in an SV.
3752 * For efficiency reasons, we read data directly into the SV buffer.
3753 * To understand that code, read retrieve_scalar()
3756 if (flags & SHF_LARGE_STRLEN)
3761 frozen = NEWSV(10002, len2);
3763 SAFEREAD(SvPVX(frozen), len2, frozen);
3764 SvCUR_set(frozen, len2);
3765 *SvEND(frozen) = '\0';
3767 (void) SvPOK_only(frozen); /* Validates string pointer */
3768 if (cxt->s_tainted) /* Is input source tainted? */
3771 TRACEME(("frozen string: %d bytes", len2));
3774 * Decode object-ID list length, if present.
3777 if (flags & SHF_HAS_LIST) {
3778 if (flags & SHF_LARGE_LISTLEN)
3784 av_extend(av, len3 + 1); /* Leave room for [0] */
3785 AvFILLp(av) = len3; /* About to be filled anyway */
3789 TRACEME(("has %d object IDs to link", len3));
3792 * Read object-ID list into array.
3793 * Because we pre-extended it, we can cheat and fill it manually.
3795 * We read object tags and we can convert them into SV* on the fly
3796 * because we know all the references listed in there (as tags)
3797 * have been already serialized, hence we have a valid correspondance
3798 * between each of those tags and the recreated SV.
3802 SV **ary = AvARRAY(av);
3804 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
3811 svh = av_fetch(cxt->aseen, tag, FALSE);
3813 CROAK(("Object #%"IVdf" should have been retrieved already",
3816 ary[i] = SvREFCNT_inc(xsv);
3821 * Bless the object and look up the STORABLE_thaw hook.
3825 hook = pkg_can(cxt->hook, SvSTASH(sv), "STORABLE_thaw");
3828 * Hook not found. Maybe they did not require the module where this
3829 * hook is defined yet?
3831 * If the require below succeeds, we'll be able to find the hook.
3832 * Still, it only works reliably when each class is defined in a
3836 SV *psv = newSVpvn("require ", 8);
3837 sv_catpv(psv, class);
3839 TRACEME(("No STORABLE_thaw defined for objects of class %s", class));
3840 TRACEME(("Going to require module '%s' with '%s'", class, SvPVX(psv)));
3842 perl_eval_sv(psv, G_DISCARD);
3846 * We cache results of pkg_can, so we need to uncache before attempting
3850 pkg_uncache(cxt->hook, SvSTASH(sv), "STORABLE_thaw");
3851 hook = pkg_can(cxt->hook, SvSTASH(sv), "STORABLE_thaw");
3854 CROAK(("No STORABLE_thaw defined for objects of class %s "
3855 "(even after a \"require %s;\")", class, class));
3859 * If we don't have an `av' yet, prepare one.
3860 * Then insert the frozen string as item [0].
3868 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
3873 * $object->STORABLE_thaw($cloning, $frozen, @refs);
3875 * where $object is our blessed (empty) object, $cloning is a boolean
3876 * telling whether we're running a deep clone, $frozen is the frozen
3877 * string the user gave us in his serializing hook, and @refs, which may
3878 * be empty, is the list of extra references he returned along for us
3881 * In effect, the hook is an alternate creation routine for the class,
3882 * the object itself being already created by the runtime.
3885 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
3886 class, PTR2UV(sv), (IV) AvFILLp(av) + 1));
3889 (void) scalar_call(rv, hook, clone, av, G_SCALAR|G_DISCARD);
3896 SvREFCNT_dec(frozen);
3899 if (!(flags & SHF_IDX_CLASSNAME) && class != buf)
3903 * If we had an <extra> type, then the object was not as simple, and
3904 * we need to restore extra magic now.
3910 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
3912 rv = retrieve(cxt, 0); /* Retrieve <magic object> */
3914 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
3915 PTR2UV(rv), PTR2UV(sv)));
3917 switch (extra_type) {
3919 sv_upgrade(sv, SVt_PVMG);
3922 sv_upgrade(sv, SVt_PVAV);
3923 AvREAL_off((AV *)sv);
3926 sv_upgrade(sv, SVt_PVHV);
3929 CROAK(("Forgot to deal with extra type %d", extra_type));
3934 * Adding the magic only now, well after the STORABLE_thaw hook was called
3935 * means the hook cannot know it deals with an object whose variable is
3936 * tied. But this is happening when retrieving $o in the following case:
3940 * my $o = bless \%h, 'BAR';
3942 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
3943 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
3944 * hash but a tied one should not matter at all, and remain transparent.
3945 * This means the magic must be restored by Storable AFTER the hook is
3948 * That looks very reasonable to me, but then I've come up with this
3949 * after a bug report from David Nesting, who was trying to store such
3950 * an object and caused Storable to fail. And unfortunately, it was
3951 * also the easiest way to retrofit support for blessed ref to tied objects
3952 * into the existing design. -- RAM, 17/02/2001
3955 sv_magic(sv, rv, mtype, Nullch, 0);
3956 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
3964 * Retrieve reference to some other scalar.
3965 * Layout is SX_REF <object>, with SX_REF already read.
3967 static SV *retrieve_ref(stcxt_t *cxt, char *cname)
3972 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
3975 * We need to create the SV that holds the reference to the yet-to-retrieve
3976 * object now, so that we may record the address in the seen table.
3977 * Otherwise, if the object to retrieve references us, we won't be able
3978 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
3979 * do the retrieve first and use rv = newRV(sv) since it will be too late
3980 * for SEEN() recording.
3983 rv = NEWSV(10002, 0);
3984 SEEN(rv, cname); /* Will return if rv is null */
3985 sv = retrieve(cxt, 0); /* Retrieve <object> */
3987 return (SV *) 0; /* Failed */
3990 * WARNING: breaks RV encapsulation.
3992 * Now for the tricky part. We have to upgrade our existing SV, so that
3993 * it is now an RV on sv... Again, we cheat by duplicating the code
3994 * held in newSVrv(), since we already got our SV from retrieve().
3998 * SvRV(rv) = SvREFCNT_inc(sv);
4000 * here because the reference count we got from retrieve() above is
4001 * already correct: if the object was retrieved from the file, then
4002 * its reference count is one. Otherwise, if it was retrieved via
4003 * an SX_OBJECT indication, a ref count increment was done.
4006 sv_upgrade(rv, SVt_RV);
4007 SvRV(rv) = sv; /* $rv = \$sv */
4010 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4016 * retrieve_overloaded
4018 * Retrieve reference to some other scalar with overloading.
4019 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4021 static SV *retrieve_overloaded(stcxt_t *cxt, char *cname)
4027 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4030 * Same code as retrieve_ref(), duplicated to avoid extra call.
4033 rv = NEWSV(10002, 0);
4034 SEEN(rv, cname); /* Will return if rv is null */
4035 sv = retrieve(cxt, 0); /* Retrieve <object> */
4037 return (SV *) 0; /* Failed */
4040 * WARNING: breaks RV encapsulation.
4043 sv_upgrade(rv, SVt_RV);
4044 SvRV(rv) = sv; /* $rv = \$sv */
4048 * Restore overloading magic.
4051 stash = (HV *) SvSTASH (sv);
4052 if (!stash || !Gv_AMG(stash))
4053 CROAK(("Cannot restore overloading on %s(0x%"UVxf") (package %s)",
4054 sv_reftype(sv, FALSE),
4056 stash ? HvNAME(stash) : "<unknown>"));
4060 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4066 * retrieve_tied_array
4068 * Retrieve tied array
4069 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4071 static SV *retrieve_tied_array(stcxt_t *cxt, char *cname)
4076 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4078 tv = NEWSV(10002, 0);
4079 SEEN(tv, cname); /* Will return if tv is null */
4080 sv = retrieve(cxt, 0); /* Retrieve <object> */
4082 return (SV *) 0; /* Failed */
4084 sv_upgrade(tv, SVt_PVAV);
4085 AvREAL_off((AV *)tv);
4086 sv_magic(tv, sv, 'P', Nullch, 0);
4087 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4089 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4095 * retrieve_tied_hash
4097 * Retrieve tied hash
4098 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4100 static SV *retrieve_tied_hash(stcxt_t *cxt, char *cname)
4105 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4107 tv = NEWSV(10002, 0);
4108 SEEN(tv, cname); /* Will return if tv is null */
4109 sv = retrieve(cxt, 0); /* Retrieve <object> */
4111 return (SV *) 0; /* Failed */
4113 sv_upgrade(tv, SVt_PVHV);
4114 sv_magic(tv, sv, 'P', Nullch, 0);
4115 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4117 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4123 * retrieve_tied_scalar
4125 * Retrieve tied scalar
4126 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4128 static SV *retrieve_tied_scalar(stcxt_t *cxt, char *cname)
4133 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4135 tv = NEWSV(10002, 0);
4136 SEEN(tv, cname); /* Will return if rv is null */
4137 sv = retrieve(cxt, 0); /* Retrieve <object> */
4139 return (SV *) 0; /* Failed */
4141 sv_upgrade(tv, SVt_PVMG);
4142 sv_magic(tv, sv, 'q', Nullch, 0);
4143 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4145 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4153 * Retrieve reference to value in a tied hash.
4154 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4156 static SV *retrieve_tied_key(stcxt_t *cxt, char *cname)
4162 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4164 tv = NEWSV(10002, 0);
4165 SEEN(tv, cname); /* Will return if tv is null */
4166 sv = retrieve(cxt, 0); /* Retrieve <object> */
4168 return (SV *) 0; /* Failed */
4170 key = retrieve(cxt, 0); /* Retrieve <key> */
4172 return (SV *) 0; /* Failed */
4174 sv_upgrade(tv, SVt_PVMG);
4175 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4176 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4177 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4185 * Retrieve reference to value in a tied array.
4186 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4188 static SV *retrieve_tied_idx(stcxt_t *cxt, char *cname)
4194 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4196 tv = NEWSV(10002, 0);
4197 SEEN(tv, cname); /* Will return if tv is null */
4198 sv = retrieve(cxt, 0); /* Retrieve <object> */
4200 return (SV *) 0; /* Failed */
4202 RLEN(idx); /* Retrieve <idx> */
4204 sv_upgrade(tv, SVt_PVMG);
4205 sv_magic(tv, sv, 'p', Nullch, idx);
4206 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4215 * Retrieve defined long (string) scalar.
4217 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4218 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4219 * was not stored on a single byte.
4221 static SV *retrieve_lscalar(stcxt_t *cxt, char *cname)
4227 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4230 * Allocate an empty scalar of the suitable length.
4233 sv = NEWSV(10002, len);
4234 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4237 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4239 * Now, for efficiency reasons, read data directly inside the SV buffer,
4240 * and perform the SV final settings directly by duplicating the final
4241 * work done by sv_setpv. Since we're going to allocate lots of scalars
4242 * this way, it's worth the hassle and risk.
4245 SAFEREAD(SvPVX(sv), len, sv);
4246 SvCUR_set(sv, len); /* Record C string length */
4247 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4248 (void) SvPOK_only(sv); /* Validate string pointer */
4249 if (cxt->s_tainted) /* Is input source tainted? */
4250 SvTAINT(sv); /* External data cannot be trusted */
4252 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4253 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4261 * Retrieve defined short (string) scalar.
4263 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4264 * The scalar is "short" so <length> is single byte. If it is 0, there
4265 * is no <data> section.
4267 static SV *retrieve_scalar(stcxt_t *cxt, char *cname)
4273 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4276 * Allocate an empty scalar of the suitable length.
4279 sv = NEWSV(10002, len);
4280 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4283 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4288 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4289 * To make it defined with an empty length, upgrade it now...
4290 * Don't upgrade to a PV if the original type contains more
4291 * information than a scalar.
4293 if (SvTYPE(sv) <= SVt_PV) {
4294 sv_upgrade(sv, SVt_PV);
4297 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4298 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4301 * Now, for efficiency reasons, read data directly inside the SV buffer,
4302 * and perform the SV final settings directly by duplicating the final
4303 * work done by sv_setpv. Since we're going to allocate lots of scalars
4304 * this way, it's worth the hassle and risk.
4306 SAFEREAD(SvPVX(sv), len, sv);
4307 SvCUR_set(sv, len); /* Record C string length */
4308 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4309 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4312 (void) SvPOK_only(sv); /* Validate string pointer */
4313 if (cxt->s_tainted) /* Is input source tainted? */
4314 SvTAINT(sv); /* External data cannot be trusted */
4316 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4323 * Like retrieve_scalar(), but tag result as utf8.
4324 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4326 static SV *retrieve_utf8str(stcxt_t *cxt, char *cname)
4330 TRACEME(("retrieve_utf8str"));
4332 sv = retrieve_scalar(cxt, cname);
4334 #ifdef HAS_UTF8_SCALARS
4337 if (cxt->use_bytes < 0)
4339 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4341 if (cxt->use_bytes == 0)
4352 * Like retrieve_lscalar(), but tag result as utf8.
4353 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4355 static SV *retrieve_lutf8str(stcxt_t *cxt, char *cname)
4359 TRACEME(("retrieve_lutf8str"));
4361 sv = retrieve_lscalar(cxt, cname);
4363 #ifdef HAS_UTF8_SCALARS
4366 if (cxt->use_bytes < 0)
4368 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4370 if (cxt->use_bytes == 0)
4380 * Retrieve defined integer.
4381 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4383 static SV *retrieve_integer(stcxt_t *cxt, char *cname)
4388 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4390 READ(&iv, sizeof(iv));
4392 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4394 TRACEME(("integer %"IVdf, iv));
4395 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4403 * Retrieve defined integer in network order.
4404 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4406 static SV *retrieve_netint(stcxt_t *cxt, char *cname)
4411 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4415 sv = newSViv((int) ntohl(iv));
4416 TRACEME(("network integer %d", (int) ntohl(iv)));
4419 TRACEME(("network integer (as-is) %d", iv));
4421 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4423 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
4431 * Retrieve defined double.
4432 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
4434 static SV *retrieve_double(stcxt_t *cxt, char *cname)
4439 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
4441 READ(&nv, sizeof(nv));
4443 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4445 TRACEME(("double %"NVff, nv));
4446 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
4454 * Retrieve defined byte (small integer within the [-128, +127] range).
4455 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
4457 static SV *retrieve_byte(stcxt_t *cxt, char *cname)
4461 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
4463 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
4466 TRACEME(("small integer read as %d", (unsigned char) siv));
4467 tmp = (unsigned char) siv - 128;
4469 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4471 TRACEME(("byte %d", tmp));
4472 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
4480 * Return the undefined value.
4482 static SV *retrieve_undef(stcxt_t *cxt, char *cname)
4486 TRACEME(("retrieve_undef"));
4497 * Return the immortal undefined value.
4499 static SV *retrieve_sv_undef(stcxt_t *cxt, char *cname)
4501 SV *sv = &PL_sv_undef;
4503 TRACEME(("retrieve_sv_undef"));
4512 * Return the immortal yes value.
4514 static SV *retrieve_sv_yes(stcxt_t *cxt, char *cname)
4516 SV *sv = &PL_sv_yes;
4518 TRACEME(("retrieve_sv_yes"));
4527 * Return the immortal no value.
4529 static SV *retrieve_sv_no(stcxt_t *cxt, char *cname)
4533 TRACEME(("retrieve_sv_no"));
4542 * Retrieve a whole array.
4543 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
4544 * Each item is stored as <object>.
4546 * When we come here, SX_ARRAY has been read already.
4548 static SV *retrieve_array(stcxt_t *cxt, char *cname)
4555 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
4558 * Read length, and allocate array, then pre-extend it.
4562 TRACEME(("size = %d", len));
4564 SEEN(av, cname); /* Will return if array not allocated nicely */
4568 return (SV *) av; /* No data follow if array is empty */
4571 * Now get each item in turn...
4574 for (i = 0; i < len; i++) {
4575 TRACEME(("(#%d) item", i));
4576 sv = retrieve(cxt, 0); /* Retrieve item */
4579 if (av_store(av, i, sv) == 0)
4583 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
4591 * Retrieve a whole hash table.
4592 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4593 * Keys are stored as <length> <data>, the <data> section being omitted
4595 * Values are stored as <object>.
4597 * When we come here, SX_HASH has been read already.
4599 static SV *retrieve_hash(stcxt_t *cxt, char *cname)
4607 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
4610 * Read length, allocate table.
4614 TRACEME(("size = %d", len));
4616 SEEN(hv, cname); /* Will return if table not allocated properly */
4618 return (SV *) hv; /* No data follow if table empty */
4619 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
4622 * Now get each key/value pair in turn...
4625 for (i = 0; i < len; i++) {
4630 TRACEME(("(#%d) value", i));
4631 sv = retrieve(cxt, 0);
4637 * Since we're reading into kbuf, we must ensure we're not
4638 * recursing between the read and the hv_store() where it's used.
4639 * Hence the key comes after the value.
4642 RLEN(size); /* Get key size */
4643 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
4646 kbuf[size] = '\0'; /* Mark string end, just in case */
4647 TRACEME(("(#%d) key '%s'", i, kbuf));
4650 * Enter key/value pair into hash table.
4653 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
4657 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
4665 * Retrieve a whole hash table.
4666 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4667 * Keys are stored as <length> <data>, the <data> section being omitted
4669 * Values are stored as <object>.
4671 * When we come here, SX_HASH has been read already.
4673 static SV *retrieve_flag_hash(stcxt_t *cxt, char *cname)
4682 GETMARK(hash_flags);
4683 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
4685 * Read length, allocate table.
4688 #ifndef HAS_RESTRICTED_HASHES
4689 if (hash_flags & SHV_RESTRICTED) {
4690 if (cxt->derestrict < 0)
4692 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
4694 if (cxt->derestrict == 0)
4695 RESTRICTED_HASH_CROAK();
4700 TRACEME(("size = %d, flags = %d", len, hash_flags));
4702 SEEN(hv, cname); /* Will return if table not allocated properly */
4704 return (SV *) hv; /* No data follow if table empty */
4705 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
4708 * Now get each key/value pair in turn...
4711 for (i = 0; i < len; i++) {
4713 int store_flags = 0;
4718 TRACEME(("(#%d) value", i));
4719 sv = retrieve(cxt, 0);
4724 #ifdef HAS_RESTRICTED_HASHES
4725 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
4729 if (flags & SHV_K_ISSV) {
4730 /* XXX you can't set a placeholder with an SV key.
4731 Then again, you can't get an SV key.
4732 Without messing around beyond what the API is supposed to do.
4735 TRACEME(("(#%d) keysv, flags=%d", i, flags));
4736 keysv = retrieve(cxt, 0);
4740 if (!hv_store_ent(hv, keysv, sv, 0))
4745 * Since we're reading into kbuf, we must ensure we're not
4746 * recursing between the read and the hv_store() where it's used.
4747 * Hence the key comes after the value.
4750 if (flags & SHV_K_PLACEHOLDER) {
4753 store_flags |= HVhek_PLACEHOLD;
4755 if (flags & SHV_K_UTF8) {
4756 #ifdef HAS_UTF8_HASHES
4757 store_flags |= HVhek_UTF8;
4759 if (cxt->use_bytes < 0)
4761 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4763 if (cxt->use_bytes == 0)
4767 #ifdef HAS_UTF8_HASHES
4768 if (flags & SHV_K_WASUTF8)
4769 store_flags |= HVhek_WASUTF8;
4772 RLEN(size); /* Get key size */
4773 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
4776 kbuf[size] = '\0'; /* Mark string end, just in case */
4777 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
4778 flags, store_flags));
4781 * Enter key/value pair into hash table.
4784 #ifdef HAS_RESTRICTED_HASHES
4785 if (hv_store_flags(hv, kbuf, size, sv, 0, flags) == 0)
4788 if (!(store_flags & HVhek_PLACEHOLD))
4789 if (hv_store(hv, kbuf, size, sv, 0) == 0)
4794 #ifdef HAS_RESTRICTED_HASHES
4795 if (hash_flags & SHV_RESTRICTED)
4799 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
4805 * old_retrieve_array
4807 * Retrieve a whole array in pre-0.6 binary format.
4809 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
4810 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
4812 * When we come here, SX_ARRAY has been read already.
4814 static SV *old_retrieve_array(stcxt_t *cxt, char *cname)
4822 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
4825 * Read length, and allocate array, then pre-extend it.
4829 TRACEME(("size = %d", len));
4831 SEEN(av, 0); /* Will return if array not allocated nicely */
4835 return (SV *) av; /* No data follow if array is empty */
4838 * Now get each item in turn...
4841 for (i = 0; i < len; i++) {
4843 if (c == SX_IT_UNDEF) {
4844 TRACEME(("(#%d) undef item", i));
4845 continue; /* av_extend() already filled us with undef */
4848 (void) retrieve_other((stcxt_t *) 0, 0); /* Will croak out */
4849 TRACEME(("(#%d) item", i));
4850 sv = retrieve(cxt, 0); /* Retrieve item */
4853 if (av_store(av, i, sv) == 0)
4857 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
4865 * Retrieve a whole hash table in pre-0.6 binary format.
4867 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4868 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
4870 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
4872 * When we come here, SX_HASH has been read already.
4874 static SV *old_retrieve_hash(stcxt_t *cxt, char *cname)
4882 static SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
4884 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
4887 * Read length, allocate table.
4891 TRACEME(("size = %d", len));
4893 SEEN(hv, 0); /* Will return if table not allocated properly */
4895 return (SV *) hv; /* No data follow if table empty */
4896 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
4899 * Now get each key/value pair in turn...
4902 for (i = 0; i < len; i++) {
4908 if (c == SX_VL_UNDEF) {
4909 TRACEME(("(#%d) undef value", i));
4911 * Due to a bug in hv_store(), it's not possible to pass
4912 * &PL_sv_undef to hv_store() as a value, otherwise the
4913 * associated key will not be creatable any more. -- RAM, 14/01/97
4916 sv_h_undef = newSVsv(&PL_sv_undef);
4917 sv = SvREFCNT_inc(sv_h_undef);
4918 } else if (c == SX_VALUE) {
4919 TRACEME(("(#%d) value", i));
4920 sv = retrieve(cxt, 0);
4924 (void) retrieve_other((stcxt_t *) 0, 0); /* Will croak out */
4928 * Since we're reading into kbuf, we must ensure we're not
4929 * recursing between the read and the hv_store() where it's used.
4930 * Hence the key comes after the value.
4935 (void) retrieve_other((stcxt_t *) 0, 0); /* Will croak out */
4936 RLEN(size); /* Get key size */
4937 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
4940 kbuf[size] = '\0'; /* Mark string end, just in case */
4941 TRACEME(("(#%d) key '%s'", i, kbuf));
4944 * Enter key/value pair into hash table.
4947 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
4951 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
4957 *** Retrieval engine.
4963 * Make sure the stored data we're trying to retrieve has been produced
4964 * on an ILP compatible system with the same byteorder. It croaks out in
4965 * case an error is detected. [ILP = integer-long-pointer sizes]
4966 * Returns null if error is detected, &PL_sv_undef otherwise.
4968 * Note that there's no byte ordering info emitted when network order was
4969 * used at store time.
4971 static SV *magic_check(stcxt_t *cxt)
4973 /* The worst case for a malicious header would be old magic (which is
4974 longer), major, minor, byteorder length byte of 255, 255 bytes of
4975 garbage, sizeof int, long, pointer, NV.
4976 So the worse of that we can read is 255 bytes of garbage plus 4.
4977 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
4978 compiling perl on a system with chars that are larger than 8 bits.
4979 (Even Crays aren't *that* perverse).
4981 unsigned char buf[4 + 255];
4982 unsigned char *current;
4985 int use_network_order;
4988 int version_minor = 0;
4990 TRACEME(("magic_check"));
4993 * The "magic number" is only for files, not when freezing in memory.
4997 /* This includes the '\0' at the end. I want to read the extra byte,
4998 which is usually going to be the major version number. */
4999 STRLEN len = sizeof(magicstr);
5002 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5004 /* Point at the byte after the byte we read. */
5005 current = buf + --len; /* Do the -- outside of macros. */
5007 if (memNE(buf, magicstr, len)) {
5009 * Try to read more bytes to check for the old magic number, which
5013 TRACEME(("trying for old magic number"));
5015 old_len = sizeof(old_magicstr) - 1;
5016 READ(current + 1, (SSize_t)(old_len - len));
5018 if (memNE(buf, old_magicstr, old_len))
5019 CROAK(("File is not a perl storable"));
5020 current = buf + old_len;
5022 use_network_order = *current;
5024 GETMARK(use_network_order);
5027 * Starting with 0.6, the "use_network_order" byte flag is also used to
5028 * indicate the version number of the binary, and therefore governs the
5029 * setting of sv_retrieve_vtbl. See magic_write().
5032 version_major = use_network_order >> 1;
5033 cxt->retrieve_vtbl = version_major ? sv_retrieve : sv_old_retrieve;
5035 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5039 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5040 * minor version of the protocol. See magic_write().
5043 if (version_major > 1)
5044 GETMARK(version_minor);
5046 cxt->ver_major = version_major;
5047 cxt->ver_minor = version_minor;
5049 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5052 * Inter-operability sanity check: we can't retrieve something stored
5053 * using a format more recent than ours, because we have no way to
5054 * know what has changed, and letting retrieval go would mean a probable
5055 * failure reporting a "corrupted" storable file.
5059 version_major > STORABLE_BIN_MAJOR ||
5060 (version_major == STORABLE_BIN_MAJOR &&
5061 version_minor > STORABLE_BIN_MINOR)
5064 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5065 STORABLE_BIN_MINOR));
5067 if (version_major == STORABLE_BIN_MAJOR) {
5068 TRACEME(("cxt->accept_future_minor is %d",
5069 cxt->accept_future_minor));
5070 if (cxt->accept_future_minor < 0)
5071 cxt->accept_future_minor
5072 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5075 if (cxt->accept_future_minor == 1)
5076 croak_now = 0; /* Don't croak yet. */
5079 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5080 version_major, version_minor,
5081 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5086 * If they stored using network order, there's no byte ordering
5087 * information to check.
5090 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5091 return &PL_sv_undef; /* No byte ordering info */
5093 /* In C truth is 1, falsehood is 0. Very convienient. */
5094 use_NV_size = version_major >= 2 && version_minor >= 2;
5097 length = c + 3 + use_NV_size;
5098 READ(buf, length); /* Not null-terminated */
5100 TRACEME(("byte order '%.*s' %d", c, buf, c));
5102 #ifdef USE_56_INTERWORK_KLUDGE
5103 /* No point in caching this in the context as we only need it once per
5104 retrieve, and we need to recheck it each read. */
5105 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5106 if ((c != (sizeof (byteorderstr_56) - 1))
5107 || memNE(buf, byteorderstr_56, c))
5108 CROAK(("Byte order is not compatible"));
5112 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5113 CROAK(("Byte order is not compatible"));
5119 if ((int) *current++ != sizeof(int))
5120 CROAK(("Integer size is not compatible"));
5123 if ((int) *current++ != sizeof(long))
5124 CROAK(("Long integer size is not compatible"));
5126 /* sizeof(char *) */
5127 if ((int) *current != sizeof(char *))
5128 CROAK(("Pointer integer size is not compatible"));
5132 if ((int) *++current != sizeof(NV))
5133 CROAK(("Double size is not compatible"));
5136 return &PL_sv_undef; /* OK */
5142 * Recursively retrieve objects from the specified file and return their
5143 * root SV (which may be an AV or an HV for what we care).
5144 * Returns null if there is a problem.
5146 static SV *retrieve(stcxt_t *cxt, char *cname)
5152 TRACEME(("retrieve"));
5155 * Grab address tag which identifies the object if we are retrieving
5156 * an older format. Since the new binary format counts objects and no
5157 * longer explicitely tags them, we must keep track of the correspondance
5160 * The following section will disappear one day when the old format is
5161 * no longer supported, hence the final "goto" in the "if" block.
5164 if (cxt->hseen) { /* Retrieving old binary */
5166 if (cxt->netorder) {
5168 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5169 tag = (stag_t) nettag;
5171 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5174 if (type == SX_OBJECT) {
5176 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5178 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5180 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5183 * The following code is common with the SX_OBJECT case below.
5186 svh = av_fetch(cxt->aseen, tagn, FALSE);
5188 CROAK(("Object #%"IVdf" should have been retrieved already",
5191 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5192 SvREFCNT_inc(sv); /* One more reference to this same sv */
5193 return sv; /* The SV pointer where object was retrieved */
5197 * Map new object, but don't increase tagnum. This will be done
5198 * by each of the retrieve_* functions when they call SEEN().
5200 * The mapping associates the "tag" initially present with a unique
5201 * tag number. See test for SX_OBJECT above to see how this is perused.
5204 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5205 newSViv(cxt->tagnum), 0))
5212 * Regular post-0.6 binary format.
5217 TRACEME(("retrieve type = %d", type));
5220 * Are we dealing with an object we should have already retrieved?
5223 if (type == SX_OBJECT) {
5227 svh = av_fetch(cxt->aseen, tag, FALSE);
5229 CROAK(("Object #%"IVdf" should have been retrieved already",
5232 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5233 SvREFCNT_inc(sv); /* One more reference to this same sv */
5234 return sv; /* The SV pointer where object was retrieved */
5235 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5236 if (cxt->accept_future_minor < 0)
5237 cxt->accept_future_minor
5238 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5241 if (cxt->accept_future_minor == 1) {
5242 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5243 "This Storable is v%d.%d and can only handle data types up to %d",
5244 cxt->ver_major, cxt->ver_minor, type,
5245 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5249 first_time: /* Will disappear when support for old format is dropped */
5252 * Okay, first time through for this one.
5255 sv = RETRIEVE(cxt, type)(cxt, cname);
5257 return (SV *) 0; /* Failed */
5260 * Old binary formats (pre-0.7).
5262 * Final notifications, ended by SX_STORED may now follow.
5263 * Currently, the only pertinent notification to apply on the
5264 * freshly retrieved object is either:
5265 * SX_CLASS <char-len> <classname> for short classnames.
5266 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5267 * Class name is then read into the key buffer pool used by
5268 * hash table key retrieval.
5271 if (cxt->ver_major < 2) {
5272 while ((type = GETCHAR()) != SX_STORED) {
5276 GETMARK(len); /* Length coded on a single char */
5278 case SX_LG_CLASS: /* Length coded on a regular integer */
5283 return (SV *) 0; /* Failed */
5285 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5288 kbuf[len] = '\0'; /* Mark string end */
5293 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5294 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
5302 * Retrieve data held in file and return the root object.
5303 * Common routine for pretrieve and mretrieve.
5305 static SV *do_retrieve(
5312 int is_tainted; /* Is input source tainted? */
5313 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
5315 TRACEME(("do_retrieve (optype = 0x%x)", optype));
5317 optype |= ST_RETRIEVE;
5320 * Sanity assertions for retrieve dispatch tables.
5323 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
5324 ("old and new retrieve dispatch table have same size"));
5325 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
5326 ("SX_ERROR entry correctly initialized in old dispatch table"));
5327 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
5328 ("SX_ERROR entry correctly initialized in new dispatch table"));
5331 * Workaround for CROAK leak: if they enter with a "dirty" context,
5332 * free up memory for them now.
5339 * Now that STORABLE_xxx hooks exist, it is possible that they try to
5340 * re-enter retrieve() via the hooks.
5344 cxt = allocate_context(cxt);
5348 ASSERT(cxt->entry == 1, ("starting new recursion"));
5349 ASSERT(!cxt->s_dirty, ("clean context"));
5354 * Data is loaded into the memory buffer when f is NULL, unless `in' is
5355 * also NULL, in which case we're expecting the data to already lie
5356 * in the buffer (dclone case).
5359 KBUFINIT(); /* Allocate hash key reading pool once */
5362 MBUF_SAVE_AND_LOAD(in);
5365 * Magic number verifications.
5367 * This needs to be done before calling init_retrieve_context()
5368 * since the format indication in the file are necessary to conduct
5369 * some of the initializations.
5372 cxt->fio = f; /* Where I/O are performed */
5374 if (!magic_check(cxt))
5375 CROAK(("Magic number checking on storable %s failed",
5376 cxt->fio ? "file" : "string"));
5378 TRACEME(("data stored in %s format",
5379 cxt->netorder ? "net order" : "native"));
5382 * Check whether input source is tainted, so that we don't wrongly
5383 * taint perfectly good values...
5385 * We assume file input is always tainted. If both `f' and `in' are
5386 * NULL, then we come from dclone, and tainted is already filled in
5387 * the context. That's a kludge, but the whole dclone() thing is
5388 * already quite a kludge anyway! -- RAM, 15/09/2000.
5391 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
5392 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
5393 init_retrieve_context(cxt, optype, is_tainted);
5395 ASSERT(is_retrieving(), ("within retrieve operation"));
5397 sv = retrieve(cxt, 0); /* Recursively retrieve object, get root SV */
5406 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
5409 * The "root" context is never freed.
5412 clean_retrieve_context(cxt);
5413 if (cxt->prev) /* This context was stacked */
5414 free_context(cxt); /* It was not the "root" context */
5417 * Prepare returned value.
5421 TRACEME(("retrieve ERROR"));
5422 return &PL_sv_undef; /* Something went wrong, return undef */
5425 TRACEME(("retrieve got %s(0x%"UVxf")",
5426 sv_reftype(sv, FALSE), PTR2UV(sv)));
5429 * Backward compatibility with Storable-0.5@9 (which we know we
5430 * are retrieving if hseen is non-null): don't create an extra RV
5431 * for objects since we special-cased it at store time.
5433 * Build a reference to the SV returned by pretrieve even if it is
5434 * already one and not a scalar, for consistency reasons.
5437 if (pre_06_fmt) { /* Was not handling overloading by then */
5439 TRACEME(("fixing for old formats -- pre 0.6"));
5440 if (sv_type(sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
5441 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
5447 * If reference is overloaded, restore behaviour.
5449 * NB: minor glitch here: normally, overloaded refs are stored specially
5450 * so that we can croak when behaviour cannot be re-installed, and also
5451 * avoid testing for overloading magic at each reference retrieval.
5453 * Unfortunately, the root reference is implicitely stored, so we must
5454 * check for possible overloading now. Furthermore, if we don't restore
5455 * overloading, we cannot croak as if the original ref was, because we
5456 * have no way to determine whether it was an overloaded ref or not in
5459 * It's a pity that overloading magic is attached to the rv, and not to
5460 * the underlying sv as blessing is.
5464 HV *stash = (HV *) SvSTASH(sv);
5465 SV *rv = newRV_noinc(sv);
5466 if (stash && Gv_AMG(stash)) {
5468 TRACEME(("restored overloading on root reference"));
5470 TRACEME(("ended do_retrieve() with an object"));
5474 TRACEME(("regular do_retrieve() end"));
5476 return newRV_noinc(sv);
5482 * Retrieve data held in file and return the root object, undef on error.
5484 SV *pretrieve(PerlIO *f)
5486 TRACEME(("pretrieve"));
5487 return do_retrieve(f, Nullsv, 0);
5493 * Retrieve data held in scalar and return the root object, undef on error.
5495 SV *mretrieve(SV *sv)
5497 TRACEME(("mretrieve"));
5498 return do_retrieve((PerlIO*) 0, sv, 0);
5508 * Deep clone: returns a fresh copy of the original referenced SV tree.
5510 * This is achieved by storing the object in memory and restoring from
5511 * there. Not that efficient, but it should be faster than doing it from
5518 stcxt_t *real_context;
5521 TRACEME(("dclone"));
5524 * Workaround for CROAK leak: if they enter with a "dirty" context,
5525 * free up memory for them now.
5532 * do_store() optimizes for dclone by not freeing its context, should
5533 * we need to allocate one because we're deep cloning from a hook.
5536 if (!do_store((PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
5537 return &PL_sv_undef; /* Error during store */
5540 * Because of the above optimization, we have to refresh the context,
5541 * since a new one could have been allocated and stacked by do_store().
5544 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
5545 cxt = real_context; /* And we need this temporary... */
5548 * Now, `cxt' may refer to a new context.
5551 ASSERT(!cxt->s_dirty, ("clean context"));
5552 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
5555 TRACEME(("dclone stored %d bytes", size));
5559 * Since we're passing do_retrieve() both a NULL file and sv, we need
5560 * to pre-compute the taintedness of the input by setting cxt->tainted
5561 * to whatever state our own input string was. -- RAM, 15/09/2000
5563 * do_retrieve() will free non-root context.
5566 cxt->s_tainted = SvTAINTED(sv);
5567 out = do_retrieve((PerlIO*) 0, Nullsv, ST_CLONE);
5569 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
5579 * The Perl IO GV object distinguishes between input and output for sockets
5580 * but not for plain files. To allow Storable to transparently work on
5581 * plain files and sockets transparently, we have to ask xsubpp to fetch the
5582 * right object for us. Hence the OutputStream and InputStream declarations.
5584 * Before perl 5.004_05, those entries in the standard typemap are not
5585 * defined in perl include files, so we do that here.
5588 #ifndef OutputStream
5589 #define OutputStream PerlIO *
5590 #define InputStream PerlIO *
5591 #endif /* !OutputStream */
5593 MODULE = Storable PACKAGE = Storable::Cxt
5599 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
5603 if (!cxt->membuf_ro && mbase)
5605 if (cxt->membuf_ro && (cxt->msaved).arena)
5606 Safefree((cxt->msaved).arena);
5609 MODULE = Storable PACKAGE = Storable
5616 /* Only disable the used only once warning if we are in debugging mode. */
5617 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
5619 #ifdef USE_56_INTERWORK_KLUDGE
5620 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
5654 last_op_in_netorder()