2 * Store and retrieve mechanism.
4 * Copyright (c) 1995-2000, Raphael Manfredi
6 * You may redistribute only under the same terms as Perl 5, as specified
7 * in the README file that comes with the distribution.
16 # include <patchlevel.h> /* Perl's one, needed since 5.6 */
17 # if !(defined(PERL_VERSION) || (SUBVERSION > 0 && defined(PATCHLEVEL)))
18 # include <could_not_find_Perl_patchlevel.h>
24 #define DEBUGME /* Debug mode, turns assertions on as well */
25 #define DASSERT /* Assertion mode */
28 #if 0 /* On NetWare USE_PERLIO is not used */
29 #define DEBUGME /* Debug mode, turns assertions on as well */
30 #define DASSERT /* Assertion mode */
35 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
36 * Provide them with the necessary defines so they can build with pre-5.004.
39 #ifndef PERLIO_IS_STDIO
41 #define PerlIO_getc(x) getc(x)
42 #define PerlIO_putc(f,x) putc(x,f)
43 #define PerlIO_read(x,y,z) fread(y,1,z,x)
44 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
45 #define PerlIO_stdoutf printf
46 #endif /* PERLIO_IS_STDIO */
47 #endif /* USE_PERLIO */
50 * Earlier versions of perl might be used, we can't assume they have the latest!
53 #ifndef PERL_VERSION /* For perls < 5.6 */
54 #define PERL_VERSION PATCHLEVEL
56 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
58 #if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
59 #define PL_sv_yes sv_yes
60 #define PL_sv_no sv_no
61 #define PL_sv_undef sv_undef
62 #if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
63 #define newSVpvn newSVpv
65 #endif /* PATCHLEVEL <= 4 */
66 #ifndef HvSHAREKEYS_off
67 #define HvSHAREKEYS_off(hv) /* Ignore */
69 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
70 #define AvFILLp AvFILL
72 typedef double NV; /* Older perls lack the NV type */
73 #define IVdf "ld" /* Various printf formats for Perl types */
77 #define INT2PTR(t,v) (t)(IV)(v)
78 #define PTR2UV(v) (unsigned long)(v)
79 #endif /* PERL_VERSION -- perls < 5.6 */
81 #ifndef NVef /* The following were not part of perl 5.6 */
82 #if defined(USE_LONG_DOUBLE) && \
83 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
84 #define NVef PERL_PRIeldbl
85 #define NVff PERL_PRIfldbl
86 #define NVgf PERL_PRIgldbl
101 * TRACEME() will only output things when the $Storable::DEBUGME is true.
106 if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
107 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
114 #define ASSERT(x,y) \
117 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
118 __FILE__, __LINE__); \
119 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
130 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
132 #define SX_OBJECT C(0) /* Already stored object */
133 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
134 #define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
135 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
136 #define SX_REF C(4) /* Reference to object forthcoming */
137 #define SX_UNDEF C(5) /* Undefined scalar */
138 #define SX_INTEGER C(6) /* Integer forthcoming */
139 #define SX_DOUBLE C(7) /* Double forthcoming */
140 #define SX_BYTE C(8) /* (signed) byte forthcoming */
141 #define SX_NETINT C(9) /* Integer in network order forthcoming */
142 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
143 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
144 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
145 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
146 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
147 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
148 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
149 #define SX_BLESS C(17) /* Object is blessed */
150 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
151 #define SX_HOOK C(19) /* Stored via hook, user-defined */
152 #define SX_OVERLOAD C(20) /* Overloaded reference */
153 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
154 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
155 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
156 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
157 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
158 #define SX_CODE C(26) /* Code references as perl source code */
159 #define SX_ERROR C(27) /* Error */
162 * Those are only used to retrieve "old" pre-0.6 binary images.
164 #define SX_ITEM 'i' /* An array item introducer */
165 #define SX_IT_UNDEF 'I' /* Undefined array item */
166 #define SX_KEY 'k' /* A hash key introducer */
167 #define SX_VALUE 'v' /* A hash value introducer */
168 #define SX_VL_UNDEF 'V' /* Undefined hash value */
171 * Those are only used to retrieve "old" pre-0.7 binary images
174 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
175 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
176 #define SX_STORED 'X' /* End of object */
179 * Limits between short/long length representation.
182 #define LG_SCALAR 255 /* Large scalar length limit */
183 #define LG_BLESS 127 /* Large classname bless limit */
189 #define ST_STORE 0x1 /* Store operation */
190 #define ST_RETRIEVE 0x2 /* Retrieval operation */
191 #define ST_CLONE 0x4 /* Deep cloning operation */
194 * The following structure is used for hash table key retrieval. Since, when
195 * retrieving objects, we'll be facing blessed hash references, it's best
196 * to pre-allocate that buffer once and resize it as the need arises, never
197 * freeing it (keys will be saved away someplace else anyway, so even large
198 * keys are not enough a motivation to reclaim that space).
200 * This structure is also used for memory store/retrieve operations which
201 * happen in a fixed place before being malloc'ed elsewhere if persistency
202 * is required. Hence the aptr pointer.
205 char *arena; /* Will hold hash key strings, resized as needed */
206 STRLEN asiz; /* Size of aforementionned buffer */
207 char *aptr; /* Arena pointer, for in-place read/write ops */
208 char *aend; /* First invalid address */
213 * A hash table records the objects which have already been stored.
214 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
215 * an arbitrary sequence number) is used to identify them.
218 * An array table records the objects which have already been retrieved,
219 * as seen by the tag determind by counting the objects themselves. The
220 * reference to that retrieved object is kept in the table, and is returned
221 * when an SX_OBJECT is found bearing that same tag.
223 * The same processing is used to record "classname" for blessed objects:
224 * indexing by a hash at store time, and via an array at retrieve time.
227 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
230 * The following "thread-safe" related defines were contributed by
231 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
232 * only renamed things a little bit to ensure consistency with surrounding
233 * code. -- RAM, 14/09/1999
235 * The original patch suffered from the fact that the stcxt_t structure
236 * was global. Murray tried to minimize the impact on the code as much as
239 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
240 * on objects. Therefore, the notion of context needs to be generalized,
244 #define MY_VERSION "Storable(" XS_VERSION ")"
248 * Conditional UTF8 support.
252 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
253 #define HAS_UTF8_SCALARS
255 #define HAS_UTF8_HASHES
258 /* 5.6 perl has utf8 scalars but not hashes */
262 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
265 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
268 #ifdef HvPLACEHOLDERS
269 #define HAS_RESTRICTED_HASHES
271 #define HVhek_PLACEHOLD 0x200
272 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
276 #define HAS_HASH_KEY_FLAGS
280 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
281 * files remap tainted and dirty when threading is enabled. That's bad for
282 * perl to remap such common words. -- RAM, 29/09/00
285 typedef struct stcxt {
286 int entry; /* flags recursion */
287 int optype; /* type of traversal operation */
288 HV *hseen; /* which objects have been seen, store time */
289 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
290 AV *aseen; /* which objects have been seen, retrieve time */
291 IV where_is_undef; /* index in aseen of PL_sv_undef */
292 HV *hclass; /* which classnames have been seen, store time */
293 AV *aclass; /* which classnames have been seen, retrieve time */
294 HV *hook; /* cache for hook methods per class name */
295 IV tagnum; /* incremented at store time for each seen object */
296 IV classnum; /* incremented at store time for each seen classname */
297 int netorder; /* true if network order used */
298 int s_tainted; /* true if input source is tainted, at retrieve time */
299 int forgive_me; /* whether to be forgiving... */
300 int deparse; /* whether to deparse code refs */
301 SV *eval; /* whether to eval source code */
302 int canonical; /* whether to store hashes sorted by key */
303 #ifndef HAS_RESTRICTED_HASHES
304 int derestrict; /* whether to downgrade restrcted hashes */
307 int use_bytes; /* whether to bytes-ify utf8 */
309 int accept_future_minor; /* croak immediately on future minor versions? */
310 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
311 int membuf_ro; /* true means membuf is read-only and msaved is rw */
312 struct extendable keybuf; /* for hash key retrieval */
313 struct extendable membuf; /* for memory store/retrieve operations */
314 struct extendable msaved; /* where potentially valid mbuf is saved */
315 PerlIO *fio; /* where I/O are performed, NULL for memory */
316 int ver_major; /* major of version for retrieved object */
317 int ver_minor; /* minor of version for retrieved object */
318 SV *(**retrieve_vtbl)(); /* retrieve dispatch table */
319 SV *prev; /* contexts chained backwards in real recursion */
320 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
323 #define NEW_STORABLE_CXT_OBJ(cxt) \
325 SV *self = newSV(sizeof(stcxt_t) - 1); \
326 SV *my_sv = newRV_noinc(self); \
327 sv_bless(my_sv, gv_stashpv("Storable::Cxt", TRUE)); \
328 cxt = (stcxt_t *)SvPVX(self); \
329 Zero(cxt, 1, stcxt_t); \
330 cxt->my_sv = my_sv; \
333 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
335 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
337 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
338 #else /* >= perl5.004_68 */
340 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
341 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
342 #endif /* < perl5.004_68 */
344 #define dSTCXT_PTR(T,name) \
345 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
346 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
349 dSTCXT_PTR(stcxt_t *, cxt)
353 NEW_STORABLE_CXT_OBJ(cxt); \
354 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
356 #define SET_STCXT(x) \
359 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
362 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
364 static stcxt_t *Context_ptr = NULL;
365 #define dSTCXT stcxt_t *cxt = Context_ptr
366 #define SET_STCXT(x) Context_ptr = x
369 NEW_STORABLE_CXT_OBJ(cxt); \
373 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
377 * Croaking implies a memory leak, since we don't use setjmp/longjmp
378 * to catch the exit and free memory used during store or retrieve
379 * operations. This is not too difficult to fix, but I need to understand
380 * how Perl does it, and croaking is exceptional anyway, so I lack the
381 * motivation to do it.
383 * The current workaround is to mark the context as dirty when croaking,
384 * so that data structures can be freed whenever we renter Storable code
385 * (but only *then*: it's a workaround, not a fix).
387 * This is also imperfect, because we don't really know how far they trapped
388 * the croak(), and when we were recursing, we won't be able to clean anything
389 * but the topmost context stacked.
392 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
395 * End of "thread-safe" related definitions.
401 * Keep only the low 32 bits of a pointer (used for tags, which are not
406 #define LOW_32BITS(x) ((I32) (x))
408 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
414 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
415 * Used in the WLEN and RLEN macros.
419 #define oI(x) ((I32 *) ((char *) (x) + 4))
420 #define oS(x) ((x) - 4)
421 #define oC(x) (x = 0)
430 * key buffer handling
432 #define kbuf (cxt->keybuf).arena
433 #define ksiz (cxt->keybuf).asiz
437 TRACEME(("** allocating kbuf of 128 bytes")); \
438 New(10003, kbuf, 128, char); \
445 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
446 Renew(kbuf, x+1, char); \
452 * memory buffer handling
454 #define mbase (cxt->membuf).arena
455 #define msiz (cxt->membuf).asiz
456 #define mptr (cxt->membuf).aptr
457 #define mend (cxt->membuf).aend
459 #define MGROW (1 << 13)
460 #define MMASK (MGROW - 1)
462 #define round_mgrow(x) \
463 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
464 #define trunc_int(x) \
465 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
466 #define int_aligned(x) \
467 ((unsigned long) (x) == trunc_int(x))
469 #define MBUF_INIT(x) \
472 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
473 New(10003, mbase, MGROW, char); \
474 msiz = (STRLEN)MGROW; \
480 mend = mbase + msiz; \
483 #define MBUF_TRUNC(x) mptr = mbase + x
484 #define MBUF_SIZE() (mptr - mbase)
490 * Those macros are used in do_retrieve() to save the current memory
491 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
492 * data from a string.
494 #define MBUF_SAVE_AND_LOAD(in) \
496 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
497 cxt->membuf_ro = 1; \
498 TRACEME(("saving mbuf")); \
499 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
503 #define MBUF_RESTORE() \
505 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
506 cxt->membuf_ro = 0; \
507 TRACEME(("restoring mbuf")); \
508 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
512 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
513 * See store_scalar() for other usage of this workaround.
515 #define MBUF_LOAD(v) \
517 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
519 CROAK(("Not a scalar string")); \
520 mptr = mbase = SvPV(v, msiz); \
521 mend = mbase + msiz; \
524 #define MBUF_XTEND(x) \
526 int nsz = (int) round_mgrow((x)+msiz); \
527 int offset = mptr - mbase; \
528 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
529 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
531 Renew(mbase, nsz, char); \
533 mptr = mbase + offset; \
534 mend = mbase + nsz; \
537 #define MBUF_CHK(x) \
539 if ((mptr + (x)) > mend) \
543 #define MBUF_GETC(x) \
546 x = (int) (unsigned char) *mptr++; \
552 #define MBUF_GETINT(x) \
555 if ((mptr + 4) <= mend) { \
556 memcpy(oI(&x), mptr, 4); \
562 #define MBUF_GETINT(x) \
564 if ((mptr + sizeof(int)) <= mend) { \
565 if (int_aligned(mptr)) \
568 memcpy(&x, mptr, sizeof(int)); \
569 mptr += sizeof(int); \
575 #define MBUF_READ(x,s) \
577 if ((mptr + (s)) <= mend) { \
578 memcpy(x, mptr, s); \
584 #define MBUF_SAFEREAD(x,s,z) \
586 if ((mptr + (s)) <= mend) { \
587 memcpy(x, mptr, s); \
595 #define MBUF_PUTC(c) \
598 *mptr++ = (char) c; \
601 *mptr++ = (char) c; \
606 #define MBUF_PUTINT(i) \
609 memcpy(mptr, oI(&i), 4); \
613 #define MBUF_PUTINT(i) \
615 MBUF_CHK(sizeof(int)); \
616 if (int_aligned(mptr)) \
619 memcpy(mptr, &i, sizeof(int)); \
620 mptr += sizeof(int); \
624 #define MBUF_WRITE(x,s) \
627 memcpy(mptr, x, s); \
632 * Possible return values for sv_type().
636 #define svis_SCALAR 1
640 #define svis_TIED_ITEM 5
648 #define SHF_TYPE_MASK 0x03
649 #define SHF_LARGE_CLASSLEN 0x04
650 #define SHF_LARGE_STRLEN 0x08
651 #define SHF_LARGE_LISTLEN 0x10
652 #define SHF_IDX_CLASSNAME 0x20
653 #define SHF_NEED_RECURSE 0x40
654 #define SHF_HAS_LIST 0x80
657 * Types for SX_HOOK (last 2 bits in flags).
663 #define SHT_EXTRA 3 /* Read extra byte for type */
666 * The following are held in the "extra byte"...
669 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
670 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
671 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
674 * per hash flags for flagged hashes
677 #define SHV_RESTRICTED 0x01
680 * per key flags for flagged hashes
683 #define SHV_K_UTF8 0x01
684 #define SHV_K_WASUTF8 0x02
685 #define SHV_K_LOCKED 0x04
686 #define SHV_K_ISSV 0x08
687 #define SHV_K_PLACEHOLDER 0x10
690 * Before 0.6, the magic string was "perl-store" (binary version number 0).
692 * Since 0.6 introduced many binary incompatibilities, the magic string has
693 * been changed to "pst0" to allow an old image to be properly retrieved by
694 * a newer Storable, but ensure a newer image cannot be retrieved with an
697 * At 0.7, objects are given the ability to serialize themselves, and the
698 * set of markers is extended, backward compatibility is not jeopardized,
699 * so the binary version number could have remained unchanged. To correctly
700 * spot errors if a file making use of 0.7-specific extensions is given to
701 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
702 * a "minor" version, to better track this kind of evolution from now on.
705 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
706 static const char magicstr[] = "pst0"; /* Used as a magic number */
708 #define MAGICSTR_BYTES 'p','s','t','0'
709 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
711 /* 5.6.x introduced the ability to have IVs as long long.
712 However, Configure still defined BYTEORDER based on the size of a long.
713 Storable uses the BYTEORDER value as part of the header, but doesn't
714 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
715 with IV as long long on a platform that uses Configure (ie most things
716 except VMS and Windows) headers are identical for the different IV sizes,
717 despite the files containing some fields based on sizeof(IV)
719 5.8 is consistent - the following redifinition kludge is only needed on
720 5.6.x, but the interwork is needed on 5.8 while data survives in files
725 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
726 #ifndef NO_56_INTERWORK_KLUDGE
727 #define USE_56_INTERWORK_KLUDGE
729 #if BYTEORDER == 0x1234
731 #define BYTEORDER 0x12345678
733 #if BYTEORDER == 0x4321
735 #define BYTEORDER 0x87654321
740 #if BYTEORDER == 0x1234
741 #define BYTEORDER_BYTES '1','2','3','4'
743 #if BYTEORDER == 0x12345678
744 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
745 #ifdef USE_56_INTERWORK_KLUDGE
746 #define BYTEORDER_BYTES_56 '1','2','3','4'
749 #if BYTEORDER == 0x87654321
750 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
751 #ifdef USE_56_INTERWORK_KLUDGE
752 #define BYTEORDER_BYTES_56 '4','3','2','1'
755 #if BYTEORDER == 0x4321
756 #define BYTEORDER_BYTES '4','3','2','1'
758 #error Unknown byteoder. Please append your byteorder to Storable.xs
764 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
765 #ifdef USE_56_INTERWORK_KLUDGE
766 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
769 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
770 #define STORABLE_BIN_MINOR 6 /* Binary minor "version" */
772 /* If we aren't 5.7.3 or later, we won't be writing out files that use the
773 * new flagged hash introdued in 2.5, so put 2.4 in the binary header to
774 * maximise ease of interoperation with older Storables.
775 * Could we write 2.3s if we're on 5.005_03? NWC
777 #if (PATCHLEVEL <= 6)
778 #define STORABLE_BIN_WRITE_MINOR 4
781 * As of perl 5.7.3, utf8 hash key is introduced.
782 * So this must change -- dankogai
784 #define STORABLE_BIN_WRITE_MINOR 6
785 #endif /* (PATCHLEVEL <= 6) */
787 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
788 #define PL_sv_placeholder PL_sv_undef
792 * Useful store shortcuts...
796 * Note that if you put more than one mark for storing a particular
797 * type of thing, *and* in the retrieve_foo() function you mark both
798 * the thingy's you get off with SEEN(), you *must* increase the
799 * tagnum with cxt->tagnum++ along with this macro!
806 else if (PerlIO_putc(cxt->fio, x) == EOF) \
810 #define WRITE_I32(x) \
812 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
815 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
822 if (cxt->netorder) { \
823 int y = (int) htonl(x); \
826 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
831 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
836 #define WLEN(x) WRITE_I32(x)
843 else if (PerlIO_write(cxt->fio, x, y) != y) \
847 #define STORE_PV_LEN(pv, len, small, large) \
849 if (len <= LG_SCALAR) { \
850 unsigned char clen = (unsigned char) len; \
862 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
865 * Store &PL_sv_undef in arrays without recursing through store().
867 #define STORE_SV_UNDEF() \
870 PUTMARK(SX_SV_UNDEF); \
874 * Useful retrieve shortcuts...
878 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
884 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
888 #define READ_I32(x) \
890 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
894 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
904 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
907 x = (int) ntohl(x); \
910 #define RLEN(x) READ_I32(x)
917 else if (PerlIO_read(cxt->fio, x, y) != y) \
921 #define SAFEREAD(x,y,z) \
924 MBUF_SAFEREAD(x,y,z); \
925 else if (PerlIO_read(cxt->fio, x, y) != y) { \
932 * This macro is used at retrieve time, to remember where object 'y', bearing a
933 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
934 * we'll therefore know where it has been retrieved and will be able to
935 * share the same reference, as in the original stored memory image.
937 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
938 * on the objects given to STORABLE_thaw and expect that to be defined), and
939 * also for overloaded objects (for which we might not find the stash if the
940 * object is not blessed yet--this might occur for overloaded objects that
941 * refer to themselves indirectly: if we blessed upon return from a sub
942 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
943 * restored on it because the underlying object would not be blessed yet!).
945 * To achieve that, the class name of the last retrieved object is passed down
946 * recursively, and the first SEEN() call for which the class name is not NULL
947 * will bless the object.
949 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
951 #define SEEN(y,c,i) \
955 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
957 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
958 PTR2UV(y), SvREFCNT(y)-1)); \
960 BLESS((SV *) (y), c); \
964 * Bless `s' in `p', via a temporary reference, required by sv_bless().
970 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
971 stash = gv_stashpv((p), TRUE); \
972 ref = newRV_noinc(s); \
973 (void) sv_bless(ref, stash); \
979 static SV *retrieve(stcxt_t *cxt, char *cname);
982 * Dynamic dispatching table for SV store.
985 static int store_ref(stcxt_t *cxt, SV *sv);
986 static int store_scalar(stcxt_t *cxt, SV *sv);
987 static int store_array(stcxt_t *cxt, AV *av);
988 static int store_hash(stcxt_t *cxt, HV *hv);
989 static int store_tied(stcxt_t *cxt, SV *sv);
990 static int store_tied_item(stcxt_t *cxt, SV *sv);
991 static int store_code(stcxt_t *cxt, CV *cv);
992 static int store_other(stcxt_t *cxt, SV *sv);
993 static int store_blessed(stcxt_t *cxt, SV *sv, int type, HV *pkg);
995 static int (*sv_store[])(stcxt_t *cxt, SV *sv) = {
996 store_ref, /* svis_REF */
997 store_scalar, /* svis_SCALAR */
998 (int (*)(stcxt_t *cxt, SV *sv)) store_array, /* svis_ARRAY */
999 (int (*)(stcxt_t *cxt, SV *sv)) store_hash, /* svis_HASH */
1000 store_tied, /* svis_TIED */
1001 store_tied_item, /* svis_TIED_ITEM */
1002 (int (*)(stcxt_t *cxt, SV *sv)) store_code, /* svis_CODE */
1003 store_other, /* svis_OTHER */
1006 #define SV_STORE(x) (*sv_store[x])
1009 * Dynamic dispatching tables for SV retrieval.
1012 static SV *retrieve_lscalar(stcxt_t *cxt, char *cname);
1013 static SV *retrieve_lutf8str(stcxt_t *cxt, char *cname);
1014 static SV *old_retrieve_array(stcxt_t *cxt, char *cname);
1015 static SV *old_retrieve_hash(stcxt_t *cxt, char *cname);
1016 static SV *retrieve_ref(stcxt_t *cxt, char *cname);
1017 static SV *retrieve_undef(stcxt_t *cxt, char *cname);
1018 static SV *retrieve_integer(stcxt_t *cxt, char *cname);
1019 static SV *retrieve_double(stcxt_t *cxt, char *cname);
1020 static SV *retrieve_byte(stcxt_t *cxt, char *cname);
1021 static SV *retrieve_netint(stcxt_t *cxt, char *cname);
1022 static SV *retrieve_scalar(stcxt_t *cxt, char *cname);
1023 static SV *retrieve_utf8str(stcxt_t *cxt, char *cname);
1024 static SV *retrieve_tied_array(stcxt_t *cxt, char *cname);
1025 static SV *retrieve_tied_hash(stcxt_t *cxt, char *cname);
1026 static SV *retrieve_tied_scalar(stcxt_t *cxt, char *cname);
1027 static SV *retrieve_other(stcxt_t *cxt, char *cname);
1029 static SV *(*sv_old_retrieve[])(stcxt_t *cxt, char *cname) = {
1030 0, /* SX_OBJECT -- entry unused dynamically */
1031 retrieve_lscalar, /* SX_LSCALAR */
1032 old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1033 old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1034 retrieve_ref, /* SX_REF */
1035 retrieve_undef, /* SX_UNDEF */
1036 retrieve_integer, /* SX_INTEGER */
1037 retrieve_double, /* SX_DOUBLE */
1038 retrieve_byte, /* SX_BYTE */
1039 retrieve_netint, /* SX_NETINT */
1040 retrieve_scalar, /* SX_SCALAR */
1041 retrieve_tied_array, /* SX_ARRAY */
1042 retrieve_tied_hash, /* SX_HASH */
1043 retrieve_tied_scalar, /* SX_SCALAR */
1044 retrieve_other, /* SX_SV_UNDEF not supported */
1045 retrieve_other, /* SX_SV_YES not supported */
1046 retrieve_other, /* SX_SV_NO not supported */
1047 retrieve_other, /* SX_BLESS not supported */
1048 retrieve_other, /* SX_IX_BLESS not supported */
1049 retrieve_other, /* SX_HOOK not supported */
1050 retrieve_other, /* SX_OVERLOADED not supported */
1051 retrieve_other, /* SX_TIED_KEY not supported */
1052 retrieve_other, /* SX_TIED_IDX not supported */
1053 retrieve_other, /* SX_UTF8STR not supported */
1054 retrieve_other, /* SX_LUTF8STR not supported */
1055 retrieve_other, /* SX_FLAG_HASH not supported */
1056 retrieve_other, /* SX_CODE not supported */
1057 retrieve_other, /* SX_ERROR */
1060 static SV *retrieve_array(stcxt_t *cxt, char *cname);
1061 static SV *retrieve_hash(stcxt_t *cxt, char *cname);
1062 static SV *retrieve_sv_undef(stcxt_t *cxt, char *cname);
1063 static SV *retrieve_sv_yes(stcxt_t *cxt, char *cname);
1064 static SV *retrieve_sv_no(stcxt_t *cxt, char *cname);
1065 static SV *retrieve_blessed(stcxt_t *cxt, char *cname);
1066 static SV *retrieve_idx_blessed(stcxt_t *cxt, char *cname);
1067 static SV *retrieve_hook(stcxt_t *cxt, char *cname);
1068 static SV *retrieve_overloaded(stcxt_t *cxt, char *cname);
1069 static SV *retrieve_tied_key(stcxt_t *cxt, char *cname);
1070 static SV *retrieve_tied_idx(stcxt_t *cxt, char *cname);
1071 static SV *retrieve_flag_hash(stcxt_t *cxt, char *cname);
1072 static SV *retrieve_code(stcxt_t *cxt, char *cname);
1074 static SV *(*sv_retrieve[])(stcxt_t *cxt, char *cname) = {
1075 0, /* SX_OBJECT -- entry unused dynamically */
1076 retrieve_lscalar, /* SX_LSCALAR */
1077 retrieve_array, /* SX_ARRAY */
1078 retrieve_hash, /* SX_HASH */
1079 retrieve_ref, /* SX_REF */
1080 retrieve_undef, /* SX_UNDEF */
1081 retrieve_integer, /* SX_INTEGER */
1082 retrieve_double, /* SX_DOUBLE */
1083 retrieve_byte, /* SX_BYTE */
1084 retrieve_netint, /* SX_NETINT */
1085 retrieve_scalar, /* SX_SCALAR */
1086 retrieve_tied_array, /* SX_ARRAY */
1087 retrieve_tied_hash, /* SX_HASH */
1088 retrieve_tied_scalar, /* SX_SCALAR */
1089 retrieve_sv_undef, /* SX_SV_UNDEF */
1090 retrieve_sv_yes, /* SX_SV_YES */
1091 retrieve_sv_no, /* SX_SV_NO */
1092 retrieve_blessed, /* SX_BLESS */
1093 retrieve_idx_blessed, /* SX_IX_BLESS */
1094 retrieve_hook, /* SX_HOOK */
1095 retrieve_overloaded, /* SX_OVERLOAD */
1096 retrieve_tied_key, /* SX_TIED_KEY */
1097 retrieve_tied_idx, /* SX_TIED_IDX */
1098 retrieve_utf8str, /* SX_UTF8STR */
1099 retrieve_lutf8str, /* SX_LUTF8STR */
1100 retrieve_flag_hash, /* SX_HASH */
1101 retrieve_code, /* SX_CODE */
1102 retrieve_other, /* SX_ERROR */
1105 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1107 static SV *mbuf2sv(void);
1110 *** Context management.
1116 * Called once per "thread" (interpreter) to initialize some global context.
1118 static void init_perinterp(void)
1122 cxt->netorder = 0; /* true if network order used */
1123 cxt->forgive_me = -1; /* whether to be forgiving... */
1129 * Called at the end of every context cleaning, to perform common reset
1132 static void reset_context(stcxt_t *cxt)
1136 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1140 * init_store_context
1142 * Initialize a new store context for real recursion.
1144 static void init_store_context(
1150 TRACEME(("init_store_context"));
1152 cxt->netorder = network_order;
1153 cxt->forgive_me = -1; /* Fetched from perl if needed */
1154 cxt->deparse = -1; /* Idem */
1155 cxt->eval = NULL; /* Idem */
1156 cxt->canonical = -1; /* Idem */
1157 cxt->tagnum = -1; /* Reset tag numbers */
1158 cxt->classnum = -1; /* Reset class numbers */
1159 cxt->fio = f; /* Where I/O are performed */
1160 cxt->optype = optype; /* A store, or a deep clone */
1161 cxt->entry = 1; /* No recursion yet */
1164 * The `hseen' table is used to keep track of each SV stored and their
1165 * associated tag numbers is special. It is "abused" because the
1166 * values stored are not real SV, just integers cast to (SV *),
1167 * which explains the freeing below.
1169 * It is also one possible bottlneck to achieve good storing speed,
1170 * so the "shared keys" optimization is turned off (unlikely to be
1171 * of any use here), and the hash table is "pre-extended". Together,
1172 * those optimizations increase the throughput by 12%.
1175 cxt->hseen = newHV(); /* Table where seen objects are stored */
1176 HvSHAREKEYS_off(cxt->hseen);
1179 * The following does not work well with perl5.004_04, and causes
1180 * a core dump later on, in a completely unrelated spot, which
1181 * makes me think there is a memory corruption going on.
1183 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1184 * it below does not make any difference. It seems to work fine
1185 * with perl5.004_68 but given the probable nature of the bug,
1186 * that does not prove anything.
1188 * It's a shame because increasing the amount of buckets raises
1189 * store() throughput by 5%, but until I figure this out, I can't
1190 * allow for this to go into production.
1192 * It is reported fixed in 5.005, hence the #if.
1194 #if PERL_VERSION >= 5
1195 #define HBUCKETS 4096 /* Buckets for %hseen */
1196 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1200 * The `hclass' hash uses the same settings as `hseen' above, but it is
1201 * used to assign sequential tags (numbers) to class names for blessed
1204 * We turn the shared key optimization on.
1207 cxt->hclass = newHV(); /* Where seen classnames are stored */
1209 #if PERL_VERSION >= 5
1210 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1214 * The `hook' hash table is used to keep track of the references on
1215 * the STORABLE_freeze hook routines, when found in some class name.
1217 * It is assumed that the inheritance tree will not be changed during
1218 * storing, and that no new method will be dynamically created by the
1222 cxt->hook = newHV(); /* Table where hooks are cached */
1225 * The `hook_seen' array keeps track of all the SVs returned by
1226 * STORABLE_freeze hooks for us to serialize, so that they are not
1227 * reclaimed until the end of the serialization process. Each SV is
1228 * only stored once, the first time it is seen.
1231 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1235 * clean_store_context
1237 * Clean store context by
1239 static void clean_store_context(stcxt_t *cxt)
1243 TRACEME(("clean_store_context"));
1245 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1248 * Insert real values into hashes where we stored faked pointers.
1252 hv_iterinit(cxt->hseen);
1253 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1254 HeVAL(he) = &PL_sv_undef;
1258 hv_iterinit(cxt->hclass);
1259 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1260 HeVAL(he) = &PL_sv_undef;
1264 * And now dispose of them...
1266 * The surrounding if() protection has been added because there might be
1267 * some cases where this routine is called more than once, during
1268 * exceptionnal events. This was reported by Marc Lehmann when Storable
1269 * is executed from mod_perl, and the fix was suggested by him.
1270 * -- RAM, 20/12/2000
1274 HV *hseen = cxt->hseen;
1277 sv_free((SV *) hseen);
1281 HV *hclass = cxt->hclass;
1284 sv_free((SV *) hclass);
1288 HV *hook = cxt->hook;
1291 sv_free((SV *) hook);
1294 if (cxt->hook_seen) {
1295 AV *hook_seen = cxt->hook_seen;
1297 av_undef(hook_seen);
1298 sv_free((SV *) hook_seen);
1301 cxt->forgive_me = -1; /* Fetched from perl if needed */
1302 cxt->deparse = -1; /* Idem */
1304 SvREFCNT_dec(cxt->eval);
1306 cxt->eval = NULL; /* Idem */
1307 cxt->canonical = -1; /* Idem */
1313 * init_retrieve_context
1315 * Initialize a new retrieve context for real recursion.
1317 static void init_retrieve_context(stcxt_t *cxt, int optype, int is_tainted)
1319 TRACEME(("init_retrieve_context"));
1322 * The hook hash table is used to keep track of the references on
1323 * the STORABLE_thaw hook routines, when found in some class name.
1325 * It is assumed that the inheritance tree will not be changed during
1326 * storing, and that no new method will be dynamically created by the
1330 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1333 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1334 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1335 * the correspondance between the tags and the tag number used by the
1336 * new retrieve routines.
1339 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1342 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1343 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1344 cxt->aclass = newAV(); /* Where seen classnames are kept */
1345 cxt->tagnum = 0; /* Have to count objects... */
1346 cxt->classnum = 0; /* ...and class names as well */
1347 cxt->optype = optype;
1348 cxt->s_tainted = is_tainted;
1349 cxt->entry = 1; /* No recursion yet */
1350 #ifndef HAS_RESTRICTED_HASHES
1351 cxt->derestrict = -1; /* Fetched from perl if needed */
1353 #ifndef HAS_UTF8_ALL
1354 cxt->use_bytes = -1; /* Fetched from perl if needed */
1356 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1360 * clean_retrieve_context
1362 * Clean retrieve context by
1364 static void clean_retrieve_context(stcxt_t *cxt)
1366 TRACEME(("clean_retrieve_context"));
1368 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1371 AV *aseen = cxt->aseen;
1374 sv_free((SV *) aseen);
1376 cxt->where_is_undef = -1;
1379 AV *aclass = cxt->aclass;
1382 sv_free((SV *) aclass);
1386 HV *hook = cxt->hook;
1389 sv_free((SV *) hook);
1393 HV *hseen = cxt->hseen;
1396 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1399 #ifndef HAS_RESTRICTED_HASHES
1400 cxt->derestrict = -1; /* Fetched from perl if needed */
1402 #ifndef HAS_UTF8_ALL
1403 cxt->use_bytes = -1; /* Fetched from perl if needed */
1405 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1413 * A workaround for the CROAK bug: cleanup the last context.
1415 static void clean_context(stcxt_t *cxt)
1417 TRACEME(("clean_context"));
1419 ASSERT(cxt->s_dirty, ("dirty context"));
1424 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1426 if (cxt->optype & ST_RETRIEVE)
1427 clean_retrieve_context(cxt);
1428 else if (cxt->optype & ST_STORE)
1429 clean_store_context(cxt);
1433 ASSERT(!cxt->s_dirty, ("context is clean"));
1434 ASSERT(cxt->entry == 0, ("context is reset"));
1440 * Allocate a new context and push it on top of the parent one.
1441 * This new context is made globally visible via SET_STCXT().
1443 static stcxt_t *allocate_context(parent_cxt)
1444 stcxt_t *parent_cxt;
1448 TRACEME(("allocate_context"));
1450 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1452 NEW_STORABLE_CXT_OBJ(cxt);
1453 cxt->prev = parent_cxt->my_sv;
1456 ASSERT(!cxt->s_dirty, ("clean context"));
1464 * Free current context, which cannot be the "root" one.
1465 * Make the context underneath globally visible via SET_STCXT().
1467 static void free_context(cxt)
1470 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1472 TRACEME(("free_context"));
1474 ASSERT(!cxt->s_dirty, ("clean context"));
1475 ASSERT(prev, ("not freeing root context"));
1477 SvREFCNT_dec(cxt->my_sv);
1480 ASSERT(cxt, ("context not void"));
1490 * Tells whether we're in the middle of a store operation.
1492 int is_storing(void)
1496 return cxt->entry && (cxt->optype & ST_STORE);
1502 * Tells whether we're in the middle of a retrieve operation.
1504 int is_retrieving(void)
1508 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1512 * last_op_in_netorder
1514 * Returns whether last operation was made using network order.
1516 * This is typically out-of-band information that might prove useful
1517 * to people wishing to convert native to network order data when used.
1519 int last_op_in_netorder(void)
1523 return cxt->netorder;
1527 *** Hook lookup and calling routines.
1533 * A wrapper on gv_fetchmethod_autoload() which caches results.
1535 * Returns the routine reference as an SV*, or null if neither the package
1536 * nor its ancestors know about the method.
1538 static SV *pkg_fetchmeth(
1547 * The following code is the same as the one performed by UNIVERSAL::can
1551 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1552 if (gv && isGV(gv)) {
1553 sv = newRV((SV*) GvCV(gv));
1554 TRACEME(("%s->%s: 0x%"UVxf, HvNAME(pkg), method, PTR2UV(sv)));
1556 sv = newSVsv(&PL_sv_undef);
1557 TRACEME(("%s->%s: not found", HvNAME(pkg), method));
1561 * Cache the result, ignoring failure: if we can't store the value,
1562 * it just won't be cached.
1565 (void) hv_store(cache, HvNAME(pkg), strlen(HvNAME(pkg)), sv, 0);
1567 return SvOK(sv) ? sv : (SV *) 0;
1573 * Force cached value to be undef: hook ignored even if present.
1575 static void pkg_hide(
1580 (void) hv_store(cache,
1581 HvNAME(pkg), strlen(HvNAME(pkg)), newSVsv(&PL_sv_undef), 0);
1587 * Discard cached value: a whole fetch loop will be retried at next lookup.
1589 static void pkg_uncache(
1594 (void) hv_delete(cache, HvNAME(pkg), strlen(HvNAME(pkg)), G_DISCARD);
1600 * Our own "UNIVERSAL::can", which caches results.
1602 * Returns the routine reference as an SV*, or null if the object does not
1603 * know about the method.
1613 TRACEME(("pkg_can for %s->%s", HvNAME(pkg), method));
1616 * Look into the cache to see whether we already have determined
1617 * where the routine was, if any.
1619 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1620 * that only one hook (i.e. always the same) is cached in a given cache.
1623 svh = hv_fetch(cache, HvNAME(pkg), strlen(HvNAME(pkg)), FALSE);
1627 TRACEME(("cached %s->%s: not found", HvNAME(pkg), method));
1630 TRACEME(("cached %s->%s: 0x%"UVxf,
1631 HvNAME(pkg), method, PTR2UV(sv)));
1636 TRACEME(("not cached yet"));
1637 return pkg_fetchmeth(cache, pkg, method); /* Fetch and cache */
1643 * Call routine as obj->hook(av) in scalar context.
1644 * Propagates the single returned value if not called in void context.
1646 static SV *scalar_call(
1657 TRACEME(("scalar_call (cloning=%d)", cloning));
1664 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1666 SV **ary = AvARRAY(av);
1667 int cnt = AvFILLp(av) + 1;
1669 XPUSHs(ary[0]); /* Frozen string */
1670 for (i = 1; i < cnt; i++) {
1671 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1672 i, PTR2UV(ary[i])));
1673 XPUSHs(sv_2mortal(newRV(ary[i])));
1678 TRACEME(("calling..."));
1679 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1680 TRACEME(("count = %d", count));
1686 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1699 * Call routine obj->hook(cloning) in list context.
1700 * Returns the list of returned values in an array.
1702 static AV *array_call(
1712 TRACEME(("array_call (cloning=%d)", cloning));
1718 XPUSHs(obj); /* Target object */
1719 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1722 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1727 for (i = count - 1; i >= 0; i--) {
1729 av_store(av, i, SvREFCNT_inc(sv));
1742 * Lookup the class name in the `hclass' table and either assign it a new ID
1743 * or return the existing one, by filling in `classnum'.
1745 * Return true if the class was known, false if the ID was just generated.
1747 static int known_class(
1749 char *name, /* Class name */
1750 int len, /* Name length */
1754 HV *hclass = cxt->hclass;
1756 TRACEME(("known_class (%s)", name));
1759 * Recall that we don't store pointers in this hash table, but tags.
1760 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1763 svh = hv_fetch(hclass, name, len, FALSE);
1765 *classnum = LOW_32BITS(*svh);
1770 * Unknown classname, we need to record it.
1774 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1775 CROAK(("Unable to record new classname"));
1777 *classnum = cxt->classnum;
1782 *** Sepcific store routines.
1788 * Store a reference.
1789 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1791 static int store_ref(stcxt_t *cxt, SV *sv)
1793 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1796 * Follow reference, and check if target is overloaded.
1802 HV *stash = (HV *) SvSTASH(sv);
1803 if (stash && Gv_AMG(stash)) {
1804 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1805 PUTMARK(SX_OVERLOAD);
1811 return store(cxt, sv);
1819 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1820 * The <data> section is omitted if <length> is 0.
1822 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1823 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1825 static int store_scalar(stcxt_t *cxt, SV *sv)
1830 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1832 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1835 * For efficiency, break the SV encapsulation by peaking at the flags
1836 * directly without using the Perl macros to avoid dereferencing
1837 * sv->sv_flags each time we wish to check the flags.
1840 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1841 if (sv == &PL_sv_undef) {
1842 TRACEME(("immortal undef"));
1843 PUTMARK(SX_SV_UNDEF);
1845 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
1852 * Always store the string representation of a scalar if it exists.
1853 * Gisle Aas provided me with this test case, better than a long speach:
1855 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1856 * SV = PVNV(0x80c8520)
1858 * FLAGS = (NOK,POK,pNOK,pPOK)
1861 * PV = 0x80c83d0 "abc"\0
1865 * Write SX_SCALAR, length, followed by the actual data.
1867 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
1868 * appropriate, followed by the actual (binary) data. A double
1869 * is written as a string if network order, for portability.
1871 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
1872 * The reason is that when the scalar value is tainted, the SvNOK(sv)
1875 * The test for a read-only scalar with both POK and NOK set is meant
1876 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
1877 * address comparison for each scalar we store.
1880 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
1882 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
1883 if (sv == &PL_sv_yes) {
1884 TRACEME(("immortal yes"));
1886 } else if (sv == &PL_sv_no) {
1887 TRACEME(("immortal no"));
1890 pv = SvPV(sv, len); /* We know it's SvPOK */
1891 goto string; /* Share code below */
1893 } else if (flags & SVf_POK) {
1894 /* public string - go direct to string read. */
1895 goto string_readlen;
1897 #if (PATCHLEVEL <= 6)
1898 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
1899 direct if NV flag is off. */
1900 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
1902 /* 5.7 rules are that if IV public flag is set, IV value is as
1903 good, if not better, than NV value. */
1909 * Will come here from below with iv set if double is an integer.
1913 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1915 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
1916 * (for example) and that ends up in the optimised small integer
1919 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
1920 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
1921 goto string_readlen;
1925 * Optimize small integers into a single byte, otherwise store as
1926 * a real integer (converted into network order if they asked).
1929 if (iv >= -128 && iv <= 127) {
1930 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
1933 TRACEME(("small integer stored as %d", siv));
1934 } else if (cxt->netorder) {
1936 TRACEME(("no htonl, fall back to string for integer"));
1937 goto string_readlen;
1945 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1946 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
1948 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
1949 /* Bigger than 32 bits. */
1950 TRACEME(("large network order integer as string, value = %"IVdf, iv));
1951 goto string_readlen;
1955 niv = (I32) htonl((I32) iv);
1956 TRACEME(("using network order"));
1961 PUTMARK(SX_INTEGER);
1962 WRITE(&iv, sizeof(iv));
1965 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
1966 } else if (flags & SVf_NOK) {
1968 #if (PATCHLEVEL <= 6)
1971 * Watch for number being an integer in disguise.
1973 if (nv == (NV) (iv = I_V(nv))) {
1974 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
1975 goto integer; /* Share code above */
1980 if (SvIOK_notUV(sv)) {
1982 goto integer; /* Share code above */
1987 if (cxt->netorder) {
1988 TRACEME(("double %"NVff" stored as string", nv));
1989 goto string_readlen; /* Share code below */
1993 WRITE(&nv, sizeof(nv));
1995 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
1997 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
1998 I32 wlen; /* For 64-bit machines */
2004 * Will come here from above if it was readonly, POK and NOK but
2005 * neither &PL_sv_yes nor &PL_sv_no.
2009 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2011 STORE_UTF8STR(pv, wlen);
2013 STORE_SCALAR(pv, wlen);
2014 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2015 PTR2UV(sv), SvPVX(sv), (IV)len));
2017 CROAK(("Can't determine type of %s(0x%"UVxf")",
2018 sv_reftype(sv, FALSE),
2020 return 0; /* Ok, no recursion on scalars */
2028 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2029 * Each item is stored as <object>.
2031 static int store_array(stcxt_t *cxt, AV *av)
2034 I32 len = av_len(av) + 1;
2038 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2041 * Signal array by emitting SX_ARRAY, followed by the array length.
2046 TRACEME(("size = %d", len));
2049 * Now store each item recursively.
2052 for (i = 0; i < len; i++) {
2053 sav = av_fetch(av, i, 0);
2055 TRACEME(("(#%d) undef item", i));
2059 TRACEME(("(#%d) item", i));
2060 if ((ret = store(cxt, *sav))) /* Extra () for -Wall, grr... */
2064 TRACEME(("ok (array)"));
2073 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2076 sortcmp(const void *a, const void *b)
2078 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2085 * Store a hash table.
2087 * For a "normal" hash (not restricted, no utf8 keys):
2089 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2090 * Values are stored as <object>.
2091 * Keys are stored as <length> <data>, the <data> section being omitted
2094 * For a "fancy" hash (restricted or utf8 keys):
2096 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2098 * Values are stored as <object>.
2099 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2101 * Currently the only hash flag is "restriced"
2102 * Key flags are as for hv.h
2104 static int store_hash(stcxt_t *cxt, HV *hv)
2107 #ifdef HAS_RESTRICTED_HASHES
2116 int flagged_hash = ((SvREADONLY(hv)
2117 #ifdef HAS_HASH_KEY_FLAGS
2121 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2124 /* needs int cast for C++ compilers, doesn't it? */
2125 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2128 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2132 * Signal hash by emitting SX_HASH, followed by the table length.
2136 PUTMARK(SX_FLAG_HASH);
2137 PUTMARK(hash_flags);
2142 TRACEME(("size = %d", len));
2145 * Save possible iteration state via each() on that table.
2148 riter = HvRITER(hv);
2149 eiter = HvEITER(hv);
2153 * Now store each item recursively.
2155 * If canonical is defined to some true value then store each
2156 * key/value pair in sorted order otherwise the order is random.
2157 * Canonical order is irrelevant when a deep clone operation is performed.
2159 * Fetch the value from perl only once per store() operation, and only
2164 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2165 (cxt->canonical < 0 && (cxt->canonical =
2166 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2169 * Storing in order, sorted by key.
2170 * Run through the hash, building up an array of keys in a
2171 * mortal array, sort the array and then run through the
2177 /*av_extend (av, len);*/
2179 TRACEME(("using canonical order"));
2181 for (i = 0; i < len; i++) {
2182 #ifdef HAS_RESTRICTED_HASHES
2183 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2185 HE *he = hv_iternext(hv);
2187 SV *key = hv_iterkeysv(he);
2188 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2191 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
2193 for (i = 0; i < len; i++) {
2194 #ifdef HAS_RESTRICTED_HASHES
2195 int placeholders = HvPLACEHOLDERS(hv);
2197 unsigned char flags = 0;
2201 SV *key = av_shift(av);
2202 /* This will fail if key is a placeholder.
2203 Track how many placeholders we have, and error if we
2205 HE *he = hv_fetch_ent(hv, key, 0, 0);
2209 if (!(val = HeVAL(he))) {
2210 /* Internal error, not I/O error */
2214 #ifdef HAS_RESTRICTED_HASHES
2215 /* Should be a placeholder. */
2216 if (placeholders-- < 0) {
2217 /* This should not happen - number of
2218 retrieves should be identical to
2219 number of placeholders. */
2222 /* Value is never needed, and PL_sv_undef is
2223 more space efficient to store. */
2226 ("Flags not 0 but %d", flags));
2227 flags = SHV_K_PLACEHOLDER;
2234 * Store value first.
2237 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2239 if ((ret = store(cxt, val))) /* Extra () for -Wall, grr... */
2244 * Keys are written after values to make sure retrieval
2245 * can be optimal in terms of memory usage, where keys are
2246 * read into a fixed unique buffer called kbuf.
2247 * See retrieve_hash() for details.
2250 /* Implementation of restricted hashes isn't nicely
2252 if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
2253 flags |= SHV_K_LOCKED;
2256 keyval = SvPV(key, keylen_tmp);
2257 keylen = keylen_tmp;
2258 #ifdef HAS_UTF8_HASHES
2259 /* If you build without optimisation on pre 5.6
2260 then nothing spots that SvUTF8(key) is always 0,
2261 so the block isn't optimised away, at which point
2262 the linker dislikes the reference to
2265 const char *keysave = keyval;
2266 bool is_utf8 = TRUE;
2268 /* Just casting the &klen to (STRLEN) won't work
2269 well if STRLEN and I32 are of different widths.
2271 keyval = (char*)bytes_from_utf8((U8*)keyval,
2275 /* If we were able to downgrade here, then than
2276 means that we have a key which only had chars
2277 0-255, but was utf8 encoded. */
2279 if (keyval != keysave) {
2280 keylen = keylen_tmp;
2281 flags |= SHV_K_WASUTF8;
2283 /* keylen_tmp can't have changed, so no need
2284 to assign back to keylen. */
2285 flags |= SHV_K_UTF8;
2292 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2294 /* This is a workaround for a bug in 5.8.0
2295 that causes the HEK_WASUTF8 flag to be
2296 set on an HEK without the hash being
2297 marked as having key flags. We just
2298 cross our fingers and drop the flag.
2300 assert (flags == 0 || flags == SHV_K_WASUTF8);
2301 TRACEME(("(#%d) key '%s'", i, keyval));
2305 WRITE(keyval, keylen);
2306 if (flags & SHV_K_WASUTF8)
2311 * Free up the temporary array
2320 * Storing in "random" order (in the order the keys are stored
2321 * within the hash). This is the default and will be faster!
2324 for (i = 0; i < len; i++) {
2327 unsigned char flags;
2328 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2329 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2331 HE *he = hv_iternext(hv);
2333 SV *val = (he ? hv_iterval(hv, he) : 0);
2338 return 1; /* Internal error, not I/O error */
2340 /* Implementation of restricted hashes isn't nicely
2343 = (((hash_flags & SHV_RESTRICTED)
2345 ? SHV_K_LOCKED : 0);
2347 if (val == &PL_sv_placeholder) {
2348 flags |= SHV_K_PLACEHOLDER;
2353 * Store value first.
2356 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2358 if ((ret = store(cxt, val))) /* Extra () for -Wall, grr... */
2362 hek = HeKEY_hek(he);
2364 if (len == HEf_SVKEY) {
2365 /* This is somewhat sick, but the internal APIs are
2366 * such that XS code could put one of these in in
2368 * Maybe we should be capable of storing one if
2371 key_sv = HeKEY_sv(he);
2372 flags |= SHV_K_ISSV;
2374 /* Regular string key. */
2375 #ifdef HAS_HASH_KEY_FLAGS
2377 flags |= SHV_K_UTF8;
2378 if (HEK_WASUTF8(hek))
2379 flags |= SHV_K_WASUTF8;
2385 * Keys are written after values to make sure retrieval
2386 * can be optimal in terms of memory usage, where keys are
2387 * read into a fixed unique buffer called kbuf.
2388 * See retrieve_hash() for details.
2393 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2395 /* This is a workaround for a bug in 5.8.0
2396 that causes the HEK_WASUTF8 flag to be
2397 set on an HEK without the hash being
2398 marked as having key flags. We just
2399 cross our fingers and drop the flag.
2401 assert (flags == 0 || flags == SHV_K_WASUTF8);
2402 TRACEME(("(#%d) key '%s'", i, key));
2404 if (flags & SHV_K_ISSV) {
2414 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2417 HvRITER(hv) = riter; /* Restore hash iterator state */
2418 HvEITER(hv) = eiter;
2426 * Store a code reference.
2428 * Layout is SX_CODE <length> followed by a scalar containing the perl
2429 * source code of the code reference.
2431 static int store_code(stcxt_t *cxt, CV *cv)
2433 #if PERL_VERSION < 6
2435 * retrieve_code does not work with perl 5.005 or less
2437 return store_other(cxt, (SV*)cv);
2442 SV *text, *bdeparse;
2444 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2447 cxt->deparse == 0 ||
2448 (cxt->deparse < 0 && !(cxt->deparse =
2449 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2451 return store_other(cxt, (SV*)cv);
2455 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2456 * blessed code references.
2458 /* XXX sv_2mortal seems to be evil here. why? */
2459 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2465 * create the B::Deparse object
2469 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2471 count = call_method("new", G_SCALAR);
2474 CROAK(("Unexpected return value from B::Deparse::new\n"));
2478 * call the coderef2text method
2482 XPUSHs(bdeparse); /* XXX is this already mortal? */
2483 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2485 count = call_method("coderef2text", G_SCALAR);
2488 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2492 reallen = strlen(SvPV_nolen(text));
2495 * Empty code references or XS functions are deparsed as
2496 * "(prototype) ;" or ";".
2499 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2500 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2504 * Signal code by emitting SX_CODE.
2508 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2509 TRACEME(("size = %d", len));
2510 TRACEME(("code = %s", SvPV_nolen(text)));
2513 * Now store the source code.
2516 STORE_SCALAR(SvPV_nolen(text), len);
2521 TRACEME(("ok (code)"));
2530 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2531 * a special mark, followed by the underlying tied object. For instance, when
2532 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2533 * <hash object> stands for the serialization of the tied hash.
2535 static int store_tied(stcxt_t *cxt, SV *sv)
2540 int svt = SvTYPE(sv);
2543 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2546 * We have a small run-time penalty here because we chose to factorise
2547 * all tieds objects into the same routine, and not have a store_tied_hash,
2548 * a store_tied_array, etc...
2550 * Don't use a switch() statement, as most compilers don't optimize that
2551 * well for 2/3 values. An if() else if() cascade is just fine. We put
2552 * tied hashes first, as they are the most likely beasts.
2555 if (svt == SVt_PVHV) {
2556 TRACEME(("tied hash"));
2557 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2558 } else if (svt == SVt_PVAV) {
2559 TRACEME(("tied array"));
2560 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2562 TRACEME(("tied scalar"));
2563 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2567 if (!(mg = mg_find(sv, mtype)))
2568 CROAK(("No magic '%c' found while storing tied %s", mtype,
2569 (svt == SVt_PVHV) ? "hash" :
2570 (svt == SVt_PVAV) ? "array" : "scalar"));
2573 * The mg->mg_obj found by mg_find() above actually points to the
2574 * underlying tied Perl object implementation. For instance, if the
2575 * original SV was that of a tied array, then mg->mg_obj is an AV.
2577 * Note that we store the Perl object as-is. We don't call its FETCH
2578 * method along the way. At retrieval time, we won't call its STORE
2579 * method either, but the tieing magic will be re-installed. In itself,
2580 * that ensures that the tieing semantics are preserved since futher
2581 * accesses on the retrieved object will indeed call the magic methods...
2584 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2585 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2586 if ((ret = store(cxt, obj)))
2589 TRACEME(("ok (tied)"));
2597 * Stores a reference to an item within a tied structure:
2599 * . \$h{key}, stores both the (tied %h) object and 'key'.
2600 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2602 * Layout is therefore either:
2603 * SX_TIED_KEY <object> <key>
2604 * SX_TIED_IDX <object> <index>
2606 static int store_tied_item(stcxt_t *cxt, SV *sv)
2611 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2613 if (!(mg = mg_find(sv, 'p')))
2614 CROAK(("No magic 'p' found while storing reference to tied item"));
2617 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2621 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2622 PUTMARK(SX_TIED_KEY);
2623 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2625 if ((ret = store(cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2628 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2630 if ((ret = store(cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2633 I32 idx = mg->mg_len;
2635 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2636 PUTMARK(SX_TIED_IDX);
2637 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2639 if ((ret = store(cxt, mg->mg_obj))) /* Idem, for -Wall */
2642 TRACEME(("store_tied_item: storing IDX %d", idx));
2647 TRACEME(("ok (tied item)"));
2653 * store_hook -- dispatched manually, not via sv_store[]
2655 * The blessed SV is serialized by a hook.
2659 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2661 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2662 * the trailing part [] is present, the type of object (scalar, array or hash).
2663 * There is also a bit which says how the classname is stored between:
2668 * and when the <index> form is used (classname already seen), the "large
2669 * classname" bit in <flags> indicates how large the <index> is.
2671 * The serialized string returned by the hook is of length <len2> and comes
2672 * next. It is an opaque string for us.
2674 * Those <len3> object IDs which are listed last represent the extra references
2675 * not directly serialized by the hook, but which are linked to the object.
2677 * When recursion is mandated to resolve object-IDs not yet seen, we have
2678 * instead, with <header> being flags with bits set to indicate the object type
2679 * and that recursion was indeed needed:
2681 * SX_HOOK <header> <object> <header> <object> <flags>
2683 * that same header being repeated between serialized objects obtained through
2684 * recursion, until we reach flags indicating no recursion, at which point
2685 * we know we've resynchronized with a single layout, after <flags>.
2687 * When storing a blessed ref to a tied variable, the following format is
2690 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2692 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2693 * real object type is held in the <extra> flag. At the very end of the
2694 * serialization stream, the underlying magic object is serialized, just like
2695 * any other tied variable.
2697 static int store_hook(
2710 int count; /* really len3 + 1 */
2711 unsigned char flags;
2714 int recursed = 0; /* counts recursion */
2715 int obj_type; /* object type, on 2 bits */
2718 int clone = cxt->optype & ST_CLONE;
2719 char mtype = '\0'; /* for blessed ref to tied structures */
2720 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2722 TRACEME(("store_hook, class \"%s\", tagged #%d", HvNAME(pkg), cxt->tagnum));
2725 * Determine object type on 2 bits.
2730 obj_type = SHT_SCALAR;
2733 obj_type = SHT_ARRAY;
2736 obj_type = SHT_HASH;
2740 * Produced by a blessed ref to a tied data structure, $o in the
2741 * following Perl code.
2745 * my $o = bless \%h, 'BAR';
2747 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2748 * (since we have only 2 bits in <flags> to store the type), and an
2749 * <extra> byte flag will be emitted after the FIRST <flags> in the
2750 * stream, carrying what we put in `eflags'.
2752 obj_type = SHT_EXTRA;
2753 switch (SvTYPE(sv)) {
2755 eflags = (unsigned char) SHT_THASH;
2759 eflags = (unsigned char) SHT_TARRAY;
2763 eflags = (unsigned char) SHT_TSCALAR;
2769 CROAK(("Unexpected object type (%d) in store_hook()", type));
2771 flags = SHF_NEED_RECURSE | obj_type;
2773 class = HvNAME(pkg);
2774 len = strlen(class);
2777 * To call the hook, we need to fake a call like:
2779 * $object->STORABLE_freeze($cloning);
2781 * but we don't have the $object here. For instance, if $object is
2782 * a blessed array, what we have in `sv' is the array, and we can't
2783 * call a method on those.
2785 * Therefore, we need to create a temporary reference to the object and
2786 * make the call on that reference.
2789 TRACEME(("about to call STORABLE_freeze on class %s", class));
2791 ref = newRV_noinc(sv); /* Temporary reference */
2792 av = array_call(ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2794 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2796 count = AvFILLp(av) + 1;
2797 TRACEME(("store_hook, array holds %d items", count));
2800 * If they return an empty list, it means they wish to ignore the
2801 * hook for this class (and not just this instance -- that's for them
2802 * to handle if they so wish).
2804 * Simply disable the cached entry for the hook (it won't be recomputed
2805 * since it's present in the cache) and recurse to store_blessed().
2810 * They must not change their mind in the middle of a serialization.
2813 if (hv_fetch(cxt->hclass, class, len, FALSE))
2814 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2815 (cxt->optype & ST_CLONE) ? "cloning" : "storing", class));
2817 pkg_hide(cxt->hook, pkg, "STORABLE_freeze");
2819 ASSERT(!pkg_can(cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2820 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", class));
2822 return store_blessed(cxt, sv, type, pkg);
2826 * Get frozen string.
2830 pv = SvPV(ary[0], len2);
2833 * If they returned more than one item, we need to serialize some
2834 * extra references if not already done.
2836 * Loop over the array, starting at position #1, and for each item,
2837 * ensure it is a reference, serialize it if not already done, and
2838 * replace the entry with the tag ID of the corresponding serialized
2841 * We CHEAT by not calling av_fetch() and read directly within the
2845 for (i = 1; i < count; i++) {
2849 AV *av_hook = cxt->hook_seen;
2852 CROAK(("Item #%d returned by STORABLE_freeze "
2853 "for %s is not a reference", i, class));
2854 xsv = SvRV(rsv); /* Follow ref to know what to look for */
2857 * Look in hseen and see if we have a tag already.
2858 * Serialize entry if not done already, and get its tag.
2861 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
2862 goto sv_seen; /* Avoid moving code too far to the right */
2864 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
2867 * We need to recurse to store that object and get it to be known
2868 * so that we can resolve the list of object-IDs at retrieve time.
2870 * The first time we do this, we need to emit the proper header
2871 * indicating that we recursed, and what the type of object is (the
2872 * object we're storing via a user-hook). Indeed, during retrieval,
2873 * we'll have to create the object before recursing to retrieve the
2874 * others, in case those would point back at that object.
2877 /* [SX_HOOK] <flags> [<extra>] <object>*/
2881 if (obj_type == SHT_EXTRA)
2886 if ((ret = store(cxt, xsv))) /* Given by hook for us to store */
2889 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
2891 CROAK(("Could not serialize item #%d from hook in %s", i, class));
2894 * It was the first time we serialized `xsv'.
2896 * Keep this SV alive until the end of the serialization: if we
2897 * disposed of it right now by decrementing its refcount, and it was
2898 * a temporary value, some next temporary value allocated during
2899 * another STORABLE_freeze might take its place, and we'd wrongly
2900 * assume that new SV was already serialized, based on its presence
2903 * Therefore, push it away in cxt->hook_seen.
2906 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
2910 * Dispose of the REF they returned. If we saved the `xsv' away
2911 * in the array of returned SVs, that will not cause the underlying
2912 * referenced SV to be reclaimed.
2915 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
2916 SvREFCNT_dec(rsv); /* Dispose of reference */
2919 * Replace entry with its tag (not a real SV, so no refcnt increment)
2923 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
2924 i-1, PTR2UV(xsv), PTR2UV(*svh)));
2928 * Allocate a class ID if not already done.
2930 * This needs to be done after the recursion above, since at retrieval
2931 * time, we'll see the inner objects first. Many thanks to
2932 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
2933 * proposed the right fix. -- RAM, 15/09/2000
2936 if (!known_class(cxt, class, len, &classnum)) {
2937 TRACEME(("first time we see class %s, ID = %d", class, classnum));
2938 classnum = -1; /* Mark: we must store classname */
2940 TRACEME(("already seen class %s, ID = %d", class, classnum));
2944 * Compute leading flags.
2948 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
2949 flags |= SHF_LARGE_CLASSLEN;
2951 flags |= SHF_IDX_CLASSNAME;
2952 if (len2 > LG_SCALAR)
2953 flags |= SHF_LARGE_STRLEN;
2955 flags |= SHF_HAS_LIST;
2956 if (count > (LG_SCALAR + 1))
2957 flags |= SHF_LARGE_LISTLEN;
2960 * We're ready to emit either serialized form:
2962 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2963 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
2965 * If we recursed, the SX_HOOK has already been emitted.
2968 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
2969 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
2970 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
2972 /* SX_HOOK <flags> [<extra>] */
2976 if (obj_type == SHT_EXTRA)
2981 /* <len> <classname> or <index> */
2982 if (flags & SHF_IDX_CLASSNAME) {
2983 if (flags & SHF_LARGE_CLASSLEN)
2986 unsigned char cnum = (unsigned char) classnum;
2990 if (flags & SHF_LARGE_CLASSLEN)
2993 unsigned char clen = (unsigned char) len;
2996 WRITE(class, len); /* Final \0 is omitted */
2999 /* <len2> <frozen-str> */
3000 if (flags & SHF_LARGE_STRLEN) {
3001 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3002 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3004 unsigned char clen = (unsigned char) len2;
3008 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3010 /* [<len3> <object-IDs>] */
3011 if (flags & SHF_HAS_LIST) {
3012 int len3 = count - 1;
3013 if (flags & SHF_LARGE_LISTLEN)
3016 unsigned char clen = (unsigned char) len3;
3021 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3022 * real pointer, rather a tag number, well under the 32-bit limit.
3025 for (i = 1; i < count; i++) {
3026 I32 tagval = htonl(LOW_32BITS(ary[i]));
3028 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3033 * Free the array. We need extra care for indices after 0, since they
3034 * don't hold real SVs but integers cast.
3038 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3043 * If object was tied, need to insert serialization of the magic object.
3046 if (obj_type == SHT_EXTRA) {
3049 if (!(mg = mg_find(sv, mtype))) {
3050 int svt = SvTYPE(sv);
3051 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3052 mtype, (svt == SVt_PVHV) ? "hash" :
3053 (svt == SVt_PVAV) ? "array" : "scalar"));
3056 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3057 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3063 if ((ret = store(cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3071 * store_blessed -- dispatched manually, not via sv_store[]
3073 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3074 * of its ancestors. If there is, then redispatch to store_hook();
3076 * Otherwise, the blessed SV is stored using the following layout:
3078 * SX_BLESS <flag> <len> <classname> <object>
3080 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3081 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3082 * Otherwise, the low order bits give the length, thereby giving a compact
3083 * representation for class names less than 127 chars long.
3085 * Each <classname> seen is remembered and indexed, so that the next time
3086 * an object in the blessed in the same <classname> is stored, the following
3089 * SX_IX_BLESS <flag> <index> <object>
3091 * where <index> is the classname index, stored on 0 or 4 bytes depending
3092 * on the high-order bit in flag (same encoding as above for <len>).
3094 static int store_blessed(
3105 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME(pkg)));
3108 * Look for a hook for this blessed SV and redirect to store_hook()
3112 hook = pkg_can(cxt->hook, pkg, "STORABLE_freeze");
3114 return store_hook(cxt, sv, type, pkg, hook);
3117 * This is a blessed SV without any serialization hook.
3120 class = HvNAME(pkg);
3121 len = strlen(class);
3123 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3124 PTR2UV(sv), class, cxt->tagnum));
3127 * Determine whether it is the first time we see that class name (in which
3128 * case it will be stored in the SX_BLESS form), or whether we already
3129 * saw that class name before (in which case the SX_IX_BLESS form will be
3133 if (known_class(cxt, class, len, &classnum)) {
3134 TRACEME(("already seen class %s, ID = %d", class, classnum));
3135 PUTMARK(SX_IX_BLESS);
3136 if (classnum <= LG_BLESS) {
3137 unsigned char cnum = (unsigned char) classnum;
3140 unsigned char flag = (unsigned char) 0x80;
3145 TRACEME(("first time we see class %s, ID = %d", class, classnum));
3147 if (len <= LG_BLESS) {
3148 unsigned char clen = (unsigned char) len;
3151 unsigned char flag = (unsigned char) 0x80;
3153 WLEN(len); /* Don't BER-encode, this should be rare */
3155 WRITE(class, len); /* Final \0 is omitted */
3159 * Now emit the <object> part.
3162 return SV_STORE(type)(cxt, sv);
3168 * We don't know how to store the item we reached, so return an error condition.
3169 * (it's probably a GLOB, some CODE reference, etc...)
3171 * If they defined the `forgive_me' variable at the Perl level to some
3172 * true value, then don't croak, just warn, and store a placeholder string
3175 static int store_other(stcxt_t *cxt, SV *sv)
3178 static char buf[80];
3180 TRACEME(("store_other"));
3183 * Fetch the value from perl only once per store() operation.
3187 cxt->forgive_me == 0 ||
3188 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3189 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3191 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3193 warn("Can't store item %s(0x%"UVxf")",
3194 sv_reftype(sv, FALSE), PTR2UV(sv));
3197 * Store placeholder string as a scalar instead...
3200 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3201 PTR2UV(sv), (char) 0);
3204 STORE_SCALAR(buf, len);
3205 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3211 *** Store driving routines
3217 * WARNING: partially duplicates Perl's sv_reftype for speed.
3219 * Returns the type of the SV, identified by an integer. That integer
3220 * may then be used to index the dynamic routine dispatch table.
3222 static int sv_type(SV *sv)
3224 switch (SvTYPE(sv)) {
3229 * No need to check for ROK, that can't be set here since there
3230 * is no field capable of hodling the xrv_rv reference.
3238 * Starting from SVt_PV, it is possible to have the ROK flag
3239 * set, the pointer to the other SV being either stored in
3240 * the xrv_rv (in the case of a pure SVt_RV), or as the
3241 * xpv_pv field of an SVt_PV and its heirs.
3243 * However, those SV cannot be magical or they would be an
3244 * SVt_PVMG at least.
3246 return SvROK(sv) ? svis_REF : svis_SCALAR;
3248 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3249 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3250 return svis_TIED_ITEM;
3253 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3255 return SvROK(sv) ? svis_REF : svis_SCALAR;
3257 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3261 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3276 * Recursively store objects pointed to by the sv to the specified file.
3278 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3279 * object (one for which storage has started -- it may not be over if we have
3280 * a self-referenced structure). This data set forms a stored <object>.
3282 static int store(stcxt_t *cxt, SV *sv)
3287 HV *hseen = cxt->hseen;
3289 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3292 * If object has already been stored, do not duplicate data.
3293 * Simply emit the SX_OBJECT marker followed by its tag data.
3294 * The tag is always written in network order.
3296 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3297 * real pointer, rather a tag number (watch the insertion code below).
3298 * That means it probably safe to assume it is well under the 32-bit limit,
3299 * and makes the truncation safe.
3300 * -- RAM, 14/09/1999
3303 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3307 if (sv == &PL_sv_undef) {
3308 /* We have seen PL_sv_undef before, but fake it as
3311 Not the simplest solution to making restricted
3312 hashes work on 5.8.0, but it does mean that
3313 repeated references to the one true undef will
3314 take up less space in the output file.
3316 /* Need to jump past the next hv_store, because on the
3317 second store of undef the old hash value will be
3318 SV_REFCNT_DEC()ed, and as Storable cheats horribly
3319 by storing non-SVs in the hash a SEGV will ensure.
3320 Need to increase the tag number so that the
3321 receiver has no idea what games we're up to. This
3322 special casing doesn't affect hooks that store
3323 undef, as the hook routine does its own lookup into
3324 hseen. Also this means that any references back
3325 to PL_sv_undef (from the pathological case of hooks
3326 storing references to it) will find the seen hash
3327 entry for the first time, as if we didn't have this
3328 hackery here. (That hseen lookup works even on 5.8.0
3329 because it's a key of &PL_sv_undef and a value
3330 which is a tag number, not a value which is
3334 goto undef_special_case;
3337 tagval = htonl(LOW_32BITS(*svh));
3339 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3347 * Allocate a new tag and associate it with the address of the sv being
3348 * stored, before recursing...
3350 * In order to avoid creating new SvIVs to hold the tagnum we just
3351 * cast the tagnum to an SV pointer and store that in the hash. This
3352 * means that we must clean up the hash manually afterwards, but gives
3353 * us a 15% throughput increase.
3358 if (!hv_store(hseen,
3359 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3363 * Store `sv' and everything beneath it, using appropriate routine.
3364 * Abort immediately if we get a non-zero status back.
3370 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3371 PTR2UV(sv), cxt->tagnum, type));
3374 HV *pkg = SvSTASH(sv);
3375 ret = store_blessed(cxt, sv, type, pkg);
3377 ret = SV_STORE(type)(cxt, sv);
3379 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3380 ret ? "FAILED" : "ok", PTR2UV(sv),
3381 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3389 * Write magic number and system information into the file.
3390 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3391 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3392 * All size and lenghts are written as single characters here.
3394 * Note that no byte ordering info is emitted when <network> is true, since
3395 * integers will be emitted in network order in that case.
3397 static int magic_write(stcxt_t *cxt)
3400 * Starting with 0.6, the "use_network_order" byte flag is also used to
3401 * indicate the version number of the binary image, encoded in the upper
3402 * bits. The bit 0 is always used to indicate network order.
3405 * Starting with 0.7, a full byte is dedicated to the minor version of
3406 * the binary format, which is incremented only when new markers are
3407 * introduced, for instance, but when backward compatibility is preserved.
3410 /* Make these at compile time. The WRITE() macro is sufficiently complex
3411 that it saves about 200 bytes doing it this way and only using it
3413 static const unsigned char network_file_header[] = {
3415 (STORABLE_BIN_MAJOR << 1) | 1,
3416 STORABLE_BIN_WRITE_MINOR
3418 static const unsigned char file_header[] = {
3420 (STORABLE_BIN_MAJOR << 1) | 0,
3421 STORABLE_BIN_WRITE_MINOR,
3422 /* sizeof the array includes the 0 byte at the end: */
3423 (char) sizeof (byteorderstr) - 1,
3425 (unsigned char) sizeof(int),
3426 (unsigned char) sizeof(long),
3427 (unsigned char) sizeof(char *),
3428 (unsigned char) sizeof(NV)
3430 #ifdef USE_56_INTERWORK_KLUDGE
3431 static const unsigned char file_header_56[] = {
3433 (STORABLE_BIN_MAJOR << 1) | 0,
3434 STORABLE_BIN_WRITE_MINOR,
3435 /* sizeof the array includes the 0 byte at the end: */
3436 (char) sizeof (byteorderstr_56) - 1,
3438 (unsigned char) sizeof(int),
3439 (unsigned char) sizeof(long),
3440 (unsigned char) sizeof(char *),
3441 (unsigned char) sizeof(NV)
3444 const unsigned char *header;
3447 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3449 if (cxt->netorder) {
3450 header = network_file_header;
3451 length = sizeof (network_file_header);
3453 #ifdef USE_56_INTERWORK_KLUDGE
3454 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3455 header = file_header_56;
3456 length = sizeof (file_header_56);
3460 header = file_header;
3461 length = sizeof (file_header);
3466 /* sizeof the array includes the 0 byte at the end. */
3467 header += sizeof (magicstr) - 1;
3468 length -= sizeof (magicstr) - 1;
3471 WRITE( (unsigned char*) header, length);
3473 if (!cxt->netorder) {
3474 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3475 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3476 (int) sizeof(int), (int) sizeof(long),
3477 (int) sizeof(char *), (int) sizeof(NV)));
3485 * Common code for store operations.
3487 * When memory store is requested (f = NULL) and a non null SV* is given in
3488 * `res', it is filled with a new SV created out of the memory buffer.
3490 * It is required to provide a non-null `res' when the operation type is not
3491 * dclone() and store() is performed to memory.
3493 static int do_store(
3503 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3504 ("must supply result SV pointer for real recursion to memory"));
3506 TRACEME(("do_store (optype=%d, netorder=%d)",
3507 optype, network_order));
3512 * Workaround for CROAK leak: if they enter with a "dirty" context,
3513 * free up memory for them now.
3520 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3521 * re-enter store() via the hooks. We need to stack contexts.
3525 cxt = allocate_context(cxt);
3529 ASSERT(cxt->entry == 1, ("starting new recursion"));
3530 ASSERT(!cxt->s_dirty, ("clean context"));
3533 * Ensure sv is actually a reference. From perl, we called something
3535 * pstore(FILE, \@array);
3536 * so we must get the scalar value behing that reference.
3540 CROAK(("Not a reference"));
3541 sv = SvRV(sv); /* So follow it to know what to store */
3544 * If we're going to store to memory, reset the buffer.
3551 * Prepare context and emit headers.
3554 init_store_context(cxt, f, optype, network_order);
3556 if (-1 == magic_write(cxt)) /* Emit magic and ILP info */
3557 return 0; /* Error */
3560 * Recursively store object...
3563 ASSERT(is_storing(), ("within store operation"));
3565 status = store(cxt, sv); /* Just do it! */
3568 * If they asked for a memory store and they provided an SV pointer,
3569 * make an SV string out of the buffer and fill their pointer.
3571 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3572 * an SV, since context cleanup might free the buffer if we did recurse.
3573 * (unless caller is dclone(), which is aware of that).
3576 if (!cxt->fio && res)
3582 * The "root" context is never freed, since it is meant to be always
3583 * handy for the common case where no recursion occurs at all (i.e.
3584 * we enter store() outside of any Storable code and leave it, period).
3585 * We know it's the "root" context because there's nothing stacked
3590 * When deep cloning, we don't free the context: doing so would force
3591 * us to copy the data in the memory buffer. Sicne we know we're
3592 * about to enter do_retrieve...
3595 clean_store_context(cxt);
3596 if (cxt->prev && !(cxt->optype & ST_CLONE))
3599 TRACEME(("do_store returns %d", status));
3607 * Store the transitive data closure of given object to disk.
3608 * Returns 0 on error, a true value otherwise.
3610 int pstore(PerlIO *f, SV *sv)
3612 TRACEME(("pstore"));
3613 return do_store(f, sv, 0, FALSE, (SV**) 0);
3620 * Same as pstore(), but network order is used for integers and doubles are
3621 * emitted as strings.
3623 int net_pstore(PerlIO *f, SV *sv)
3625 TRACEME(("net_pstore"));
3626 return do_store(f, sv, 0, TRUE, (SV**) 0);
3636 * Build a new SV out of the content of the internal memory buffer.
3638 static SV *mbuf2sv(void)
3642 return newSVpv(mbase, MBUF_SIZE());
3648 * Store the transitive data closure of given object to memory.
3649 * Returns undef on error, a scalar value containing the data otherwise.
3655 TRACEME(("mstore"));
3657 if (!do_store((PerlIO*) 0, sv, 0, FALSE, &out))
3658 return &PL_sv_undef;
3666 * Same as mstore(), but network order is used for integers and doubles are
3667 * emitted as strings.
3669 SV *net_mstore(SV *sv)
3673 TRACEME(("net_mstore"));
3675 if (!do_store((PerlIO*) 0, sv, 0, TRUE, &out))
3676 return &PL_sv_undef;
3682 *** Specific retrieve callbacks.
3688 * Return an error via croak, since it is not possible that we get here
3689 * under normal conditions, when facing a file produced via pstore().
3691 static SV *retrieve_other(stcxt_t *cxt, char *cname)
3694 cxt->ver_major != STORABLE_BIN_MAJOR &&
3695 cxt->ver_minor != STORABLE_BIN_MINOR
3697 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3698 cxt->fio ? "file" : "string",
3699 cxt->ver_major, cxt->ver_minor,
3700 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3702 CROAK(("Corrupted storable %s (binary v%d.%d)",
3703 cxt->fio ? "file" : "string",
3704 cxt->ver_major, cxt->ver_minor));
3707 return (SV *) 0; /* Just in case */
3711 * retrieve_idx_blessed
3713 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3714 * <index> can be coded on either 1 or 5 bytes.
3716 static SV *retrieve_idx_blessed(stcxt_t *cxt, char *cname)
3723 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3724 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3726 GETMARK(idx); /* Index coded on a single char? */
3731 * Fetch classname in `aclass'
3734 sva = av_fetch(cxt->aclass, idx, FALSE);
3736 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3738 class = SvPVX(*sva); /* We know it's a PV, by construction */
3740 TRACEME(("class ID %d => %s", idx, class));
3743 * Retrieve object and bless it.
3746 sv = retrieve(cxt, class); /* First SV which is SEEN will be blessed */
3754 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3755 * <len> can be coded on either 1 or 5 bytes.
3757 static SV *retrieve_blessed(stcxt_t *cxt, char *cname)
3761 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3764 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3765 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3768 * Decode class name length and read that name.
3770 * Short classnames have two advantages: their length is stored on one
3771 * single byte, and the string can be read on the stack.
3774 GETMARK(len); /* Length coded on a single char? */
3777 TRACEME(("** allocating %d bytes for class name", len+1));
3778 New(10003, class, len+1, char);
3781 class[len] = '\0'; /* Mark string end */
3784 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3787 TRACEME(("new class name \"%s\" will bear ID = %d", class, cxt->classnum));
3789 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
3793 * Retrieve object and bless it.
3796 sv = retrieve(cxt, class); /* First SV which is SEEN will be blessed */
3806 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3807 * with leading mark already read, as usual.
3809 * When recursion was involved during serialization of the object, there
3810 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
3811 * we reach a <flags> marker with the recursion bit cleared.
3813 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
3814 * is held in the <extra> byte, and if the object is tied, the serialized
3815 * magic object comes at the very end:
3817 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
3819 * This means the STORABLE_thaw hook will NOT get a tied variable during its
3820 * processing (since we won't have seen the magic object by the time the hook
3821 * is called). See comments below for why it was done that way.
3823 static SV *retrieve_hook(stcxt_t *cxt, char *cname)
3826 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3837 int clone = cxt->optype & ST_CLONE;
3839 unsigned int extra_type = 0;
3841 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
3842 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3845 * Read flags, which tell us about the type, and whether we need to recurse.
3851 * Create the (empty) object, and mark it as seen.
3853 * This must be done now, because tags are incremented, and during
3854 * serialization, the object tag was affected before recursion could
3858 obj_type = flags & SHF_TYPE_MASK;
3864 sv = (SV *) newAV();
3867 sv = (SV *) newHV();
3871 * Read <extra> flag to know the type of the object.
3872 * Record associated magic type for later.
3874 GETMARK(extra_type);
3875 switch (extra_type) {
3881 sv = (SV *) newAV();
3885 sv = (SV *) newHV();
3889 return retrieve_other(cxt, 0); /* Let it croak */
3893 return retrieve_other(cxt, 0); /* Let it croak */
3895 SEEN(sv, 0, 0); /* Don't bless yet */
3898 * Whilst flags tell us to recurse, do so.
3900 * We don't need to remember the addresses returned by retrieval, because
3901 * all the references will be obtained through indirection via the object
3902 * tags in the object-ID list.
3904 * We need to decrement the reference count for these objects
3905 * because, if the user doesn't save a reference to them in the hook,
3906 * they must be freed when this context is cleaned.
3909 while (flags & SHF_NEED_RECURSE) {
3910 TRACEME(("retrieve_hook recursing..."));
3911 rv = retrieve(cxt, 0);
3915 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
3920 if (flags & SHF_IDX_CLASSNAME) {
3925 * Fetch index from `aclass'
3928 if (flags & SHF_LARGE_CLASSLEN)
3933 sva = av_fetch(cxt->aclass, idx, FALSE);
3935 CROAK(("Class name #%"IVdf" should have been seen already",
3938 class = SvPVX(*sva); /* We know it's a PV, by construction */
3939 TRACEME(("class ID %d => %s", idx, class));
3943 * Decode class name length and read that name.
3945 * NOTA BENE: even if the length is stored on one byte, we don't read
3946 * on the stack. Just like retrieve_blessed(), we limit the name to
3947 * LG_BLESS bytes. This is an arbitrary decision.
3950 if (flags & SHF_LARGE_CLASSLEN)
3955 if (len > LG_BLESS) {
3956 TRACEME(("** allocating %d bytes for class name", len+1));
3957 New(10003, class, len+1, char);
3961 class[len] = '\0'; /* Mark string end */
3964 * Record new classname.
3967 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
3971 TRACEME(("class name: %s", class));
3974 * Decode user-frozen string length and read it in an SV.
3976 * For efficiency reasons, we read data directly into the SV buffer.
3977 * To understand that code, read retrieve_scalar()
3980 if (flags & SHF_LARGE_STRLEN)
3985 frozen = NEWSV(10002, len2);
3987 SAFEREAD(SvPVX(frozen), len2, frozen);
3988 SvCUR_set(frozen, len2);
3989 *SvEND(frozen) = '\0';
3991 (void) SvPOK_only(frozen); /* Validates string pointer */
3992 if (cxt->s_tainted) /* Is input source tainted? */
3995 TRACEME(("frozen string: %d bytes", len2));
3998 * Decode object-ID list length, if present.
4001 if (flags & SHF_HAS_LIST) {
4002 if (flags & SHF_LARGE_LISTLEN)
4008 av_extend(av, len3 + 1); /* Leave room for [0] */
4009 AvFILLp(av) = len3; /* About to be filled anyway */
4013 TRACEME(("has %d object IDs to link", len3));
4016 * Read object-ID list into array.
4017 * Because we pre-extended it, we can cheat and fill it manually.
4019 * We read object tags and we can convert them into SV* on the fly
4020 * because we know all the references listed in there (as tags)
4021 * have been already serialized, hence we have a valid correspondance
4022 * between each of those tags and the recreated SV.
4026 SV **ary = AvARRAY(av);
4028 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
4035 svh = av_fetch(cxt->aseen, tag, FALSE);
4037 if (tag == cxt->where_is_undef) {
4038 /* av_fetch uses PL_sv_undef internally, hence this
4039 somewhat gruesome hack. */
4043 CROAK(("Object #%"IVdf" should have been retrieved already",
4048 ary[i] = SvREFCNT_inc(xsv);
4053 * Bless the object and look up the STORABLE_thaw hook.
4057 hook = pkg_can(cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4060 * Hook not found. Maybe they did not require the module where this
4061 * hook is defined yet?
4063 * If the require below succeeds, we'll be able to find the hook.
4064 * Still, it only works reliably when each class is defined in a
4068 SV *psv = newSVpvn("require ", 8);
4069 sv_catpv(psv, class);
4071 TRACEME(("No STORABLE_thaw defined for objects of class %s", class));
4072 TRACEME(("Going to require module '%s' with '%s'", class, SvPVX(psv)));
4074 perl_eval_sv(psv, G_DISCARD);
4078 * We cache results of pkg_can, so we need to uncache before attempting
4082 pkg_uncache(cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4083 hook = pkg_can(cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4086 CROAK(("No STORABLE_thaw defined for objects of class %s "
4087 "(even after a \"require %s;\")", class, class));
4091 * If we don't have an `av' yet, prepare one.
4092 * Then insert the frozen string as item [0].
4100 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4105 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4107 * where $object is our blessed (empty) object, $cloning is a boolean
4108 * telling whether we're running a deep clone, $frozen is the frozen
4109 * string the user gave us in his serializing hook, and @refs, which may
4110 * be empty, is the list of extra references he returned along for us
4113 * In effect, the hook is an alternate creation routine for the class,
4114 * the object itself being already created by the runtime.
4117 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4118 class, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4121 (void) scalar_call(rv, hook, clone, av, G_SCALAR|G_DISCARD);
4128 SvREFCNT_dec(frozen);
4131 if (!(flags & SHF_IDX_CLASSNAME) && class != buf)
4135 * If we had an <extra> type, then the object was not as simple, and
4136 * we need to restore extra magic now.
4142 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4144 rv = retrieve(cxt, 0); /* Retrieve <magic object> */
4146 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4147 PTR2UV(rv), PTR2UV(sv)));
4149 switch (extra_type) {
4151 sv_upgrade(sv, SVt_PVMG);
4154 sv_upgrade(sv, SVt_PVAV);
4155 AvREAL_off((AV *)sv);
4158 sv_upgrade(sv, SVt_PVHV);
4161 CROAK(("Forgot to deal with extra type %d", extra_type));
4166 * Adding the magic only now, well after the STORABLE_thaw hook was called
4167 * means the hook cannot know it deals with an object whose variable is
4168 * tied. But this is happening when retrieving $o in the following case:
4172 * my $o = bless \%h, 'BAR';
4174 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4175 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4176 * hash but a tied one should not matter at all, and remain transparent.
4177 * This means the magic must be restored by Storable AFTER the hook is
4180 * That looks very reasonable to me, but then I've come up with this
4181 * after a bug report from David Nesting, who was trying to store such
4182 * an object and caused Storable to fail. And unfortunately, it was
4183 * also the easiest way to retrofit support for blessed ref to tied objects
4184 * into the existing design. -- RAM, 17/02/2001
4187 sv_magic(sv, rv, mtype, Nullch, 0);
4188 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4196 * Retrieve reference to some other scalar.
4197 * Layout is SX_REF <object>, with SX_REF already read.
4199 static SV *retrieve_ref(stcxt_t *cxt, char *cname)
4204 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4207 * We need to create the SV that holds the reference to the yet-to-retrieve
4208 * object now, so that we may record the address in the seen table.
4209 * Otherwise, if the object to retrieve references us, we won't be able
4210 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4211 * do the retrieve first and use rv = newRV(sv) since it will be too late
4212 * for SEEN() recording.
4215 rv = NEWSV(10002, 0);
4216 SEEN(rv, cname, 0); /* Will return if rv is null */
4217 sv = retrieve(cxt, 0); /* Retrieve <object> */
4219 return (SV *) 0; /* Failed */
4222 * WARNING: breaks RV encapsulation.
4224 * Now for the tricky part. We have to upgrade our existing SV, so that
4225 * it is now an RV on sv... Again, we cheat by duplicating the code
4226 * held in newSVrv(), since we already got our SV from retrieve().
4230 * SvRV(rv) = SvREFCNT_inc(sv);
4232 * here because the reference count we got from retrieve() above is
4233 * already correct: if the object was retrieved from the file, then
4234 * its reference count is one. Otherwise, if it was retrieved via
4235 * an SX_OBJECT indication, a ref count increment was done.
4239 /* Do not use sv_upgrade to preserve STASH */
4240 SvFLAGS(rv) &= ~SVTYPEMASK;
4241 SvFLAGS(rv) |= SVt_RV;
4243 sv_upgrade(rv, SVt_RV);
4246 SvRV(rv) = sv; /* $rv = \$sv */
4249 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4255 * retrieve_overloaded
4257 * Retrieve reference to some other scalar with overloading.
4258 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4260 static SV *retrieve_overloaded(stcxt_t *cxt, char *cname)
4266 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4269 * Same code as retrieve_ref(), duplicated to avoid extra call.
4272 rv = NEWSV(10002, 0);
4273 SEEN(rv, cname, 0); /* Will return if rv is null */
4274 sv = retrieve(cxt, 0); /* Retrieve <object> */
4276 return (SV *) 0; /* Failed */
4279 * WARNING: breaks RV encapsulation.
4282 sv_upgrade(rv, SVt_RV);
4283 SvRV(rv) = sv; /* $rv = \$sv */
4287 * Restore overloading magic.
4290 || !(stash = (HV *) SvSTASH (sv))
4292 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4294 sv_reftype(sv, FALSE),
4296 stash ? HvNAME(stash) : "<unknown>"));
4300 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4306 * retrieve_tied_array
4308 * Retrieve tied array
4309 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4311 static SV *retrieve_tied_array(stcxt_t *cxt, char *cname)
4316 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4318 tv = NEWSV(10002, 0);
4319 SEEN(tv, cname, 0); /* Will return if tv is null */
4320 sv = retrieve(cxt, 0); /* Retrieve <object> */
4322 return (SV *) 0; /* Failed */
4324 sv_upgrade(tv, SVt_PVAV);
4325 AvREAL_off((AV *)tv);
4326 sv_magic(tv, sv, 'P', Nullch, 0);
4327 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4329 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4335 * retrieve_tied_hash
4337 * Retrieve tied hash
4338 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4340 static SV *retrieve_tied_hash(stcxt_t *cxt, char *cname)
4345 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4347 tv = NEWSV(10002, 0);
4348 SEEN(tv, cname, 0); /* Will return if tv is null */
4349 sv = retrieve(cxt, 0); /* Retrieve <object> */
4351 return (SV *) 0; /* Failed */
4353 sv_upgrade(tv, SVt_PVHV);
4354 sv_magic(tv, sv, 'P', Nullch, 0);
4355 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4357 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4363 * retrieve_tied_scalar
4365 * Retrieve tied scalar
4366 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4368 static SV *retrieve_tied_scalar(stcxt_t *cxt, char *cname)
4371 SV *sv, *obj = NULL;
4373 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4375 tv = NEWSV(10002, 0);
4376 SEEN(tv, cname, 0); /* Will return if rv is null */
4377 sv = retrieve(cxt, 0); /* Retrieve <object> */
4379 return (SV *) 0; /* Failed */
4381 else if (SvTYPE(sv) != SVt_NULL) {
4385 sv_upgrade(tv, SVt_PVMG);
4386 sv_magic(tv, obj, 'q', Nullch, 0);
4389 /* Undo refcnt inc from sv_magic() */
4393 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4401 * Retrieve reference to value in a tied hash.
4402 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4404 static SV *retrieve_tied_key(stcxt_t *cxt, char *cname)
4410 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4412 tv = NEWSV(10002, 0);
4413 SEEN(tv, cname, 0); /* Will return if tv is null */
4414 sv = retrieve(cxt, 0); /* Retrieve <object> */
4416 return (SV *) 0; /* Failed */
4418 key = retrieve(cxt, 0); /* Retrieve <key> */
4420 return (SV *) 0; /* Failed */
4422 sv_upgrade(tv, SVt_PVMG);
4423 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4424 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4425 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4433 * Retrieve reference to value in a tied array.
4434 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4436 static SV *retrieve_tied_idx(stcxt_t *cxt, char *cname)
4442 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4444 tv = NEWSV(10002, 0);
4445 SEEN(tv, cname, 0); /* Will return if tv is null */
4446 sv = retrieve(cxt, 0); /* Retrieve <object> */
4448 return (SV *) 0; /* Failed */
4450 RLEN(idx); /* Retrieve <idx> */
4452 sv_upgrade(tv, SVt_PVMG);
4453 sv_magic(tv, sv, 'p', Nullch, idx);
4454 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4463 * Retrieve defined long (string) scalar.
4465 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4466 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4467 * was not stored on a single byte.
4469 static SV *retrieve_lscalar(stcxt_t *cxt, char *cname)
4475 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4478 * Allocate an empty scalar of the suitable length.
4481 sv = NEWSV(10002, len);
4482 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4485 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4487 * Now, for efficiency reasons, read data directly inside the SV buffer,
4488 * and perform the SV final settings directly by duplicating the final
4489 * work done by sv_setpv. Since we're going to allocate lots of scalars
4490 * this way, it's worth the hassle and risk.
4493 SAFEREAD(SvPVX(sv), len, sv);
4494 SvCUR_set(sv, len); /* Record C string length */
4495 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4496 (void) SvPOK_only(sv); /* Validate string pointer */
4497 if (cxt->s_tainted) /* Is input source tainted? */
4498 SvTAINT(sv); /* External data cannot be trusted */
4500 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4501 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4509 * Retrieve defined short (string) scalar.
4511 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4512 * The scalar is "short" so <length> is single byte. If it is 0, there
4513 * is no <data> section.
4515 static SV *retrieve_scalar(stcxt_t *cxt, char *cname)
4521 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4524 * Allocate an empty scalar of the suitable length.
4527 sv = NEWSV(10002, len);
4528 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4531 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4536 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4537 * To make it defined with an empty length, upgrade it now...
4538 * Don't upgrade to a PV if the original type contains more
4539 * information than a scalar.
4541 if (SvTYPE(sv) <= SVt_PV) {
4542 sv_upgrade(sv, SVt_PV);
4545 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4546 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4549 * Now, for efficiency reasons, read data directly inside the SV buffer,
4550 * and perform the SV final settings directly by duplicating the final
4551 * work done by sv_setpv. Since we're going to allocate lots of scalars
4552 * this way, it's worth the hassle and risk.
4554 SAFEREAD(SvPVX(sv), len, sv);
4555 SvCUR_set(sv, len); /* Record C string length */
4556 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4557 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4560 (void) SvPOK_only(sv); /* Validate string pointer */
4561 if (cxt->s_tainted) /* Is input source tainted? */
4562 SvTAINT(sv); /* External data cannot be trusted */
4564 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4571 * Like retrieve_scalar(), but tag result as utf8.
4572 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4574 static SV *retrieve_utf8str(stcxt_t *cxt, char *cname)
4578 TRACEME(("retrieve_utf8str"));
4580 sv = retrieve_scalar(cxt, cname);
4582 #ifdef HAS_UTF8_SCALARS
4585 if (cxt->use_bytes < 0)
4587 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4589 if (cxt->use_bytes == 0)
4600 * Like retrieve_lscalar(), but tag result as utf8.
4601 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4603 static SV *retrieve_lutf8str(stcxt_t *cxt, char *cname)
4607 TRACEME(("retrieve_lutf8str"));
4609 sv = retrieve_lscalar(cxt, cname);
4611 #ifdef HAS_UTF8_SCALARS
4614 if (cxt->use_bytes < 0)
4616 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4618 if (cxt->use_bytes == 0)
4628 * Retrieve defined integer.
4629 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4631 static SV *retrieve_integer(stcxt_t *cxt, char *cname)
4636 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4638 READ(&iv, sizeof(iv));
4640 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4642 TRACEME(("integer %"IVdf, iv));
4643 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4651 * Retrieve defined integer in network order.
4652 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4654 static SV *retrieve_netint(stcxt_t *cxt, char *cname)
4659 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4663 sv = newSViv((int) ntohl(iv));
4664 TRACEME(("network integer %d", (int) ntohl(iv)));
4667 TRACEME(("network integer (as-is) %d", iv));
4669 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4671 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
4679 * Retrieve defined double.
4680 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
4682 static SV *retrieve_double(stcxt_t *cxt, char *cname)
4687 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
4689 READ(&nv, sizeof(nv));
4691 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4693 TRACEME(("double %"NVff, nv));
4694 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
4702 * Retrieve defined byte (small integer within the [-128, +127] range).
4703 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
4705 static SV *retrieve_byte(stcxt_t *cxt, char *cname)
4709 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
4711 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
4714 TRACEME(("small integer read as %d", (unsigned char) siv));
4715 tmp = (unsigned char) siv - 128;
4717 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4719 TRACEME(("byte %d", tmp));
4720 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
4728 * Return the undefined value.
4730 static SV *retrieve_undef(stcxt_t *cxt, char *cname)
4734 TRACEME(("retrieve_undef"));
4745 * Return the immortal undefined value.
4747 static SV *retrieve_sv_undef(stcxt_t *cxt, char *cname)
4749 SV *sv = &PL_sv_undef;
4751 TRACEME(("retrieve_sv_undef"));
4753 /* Special case PL_sv_undef, as av_fetch uses it internally to mark
4754 deleted elements, and will return NULL (fetch failed) whenever it
4756 if (cxt->where_is_undef == -1) {
4757 cxt->where_is_undef = cxt->tagnum;
4766 * Return the immortal yes value.
4768 static SV *retrieve_sv_yes(stcxt_t *cxt, char *cname)
4770 SV *sv = &PL_sv_yes;
4772 TRACEME(("retrieve_sv_yes"));
4781 * Return the immortal no value.
4783 static SV *retrieve_sv_no(stcxt_t *cxt, char *cname)
4787 TRACEME(("retrieve_sv_no"));
4796 * Retrieve a whole array.
4797 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
4798 * Each item is stored as <object>.
4800 * When we come here, SX_ARRAY has been read already.
4802 static SV *retrieve_array(stcxt_t *cxt, char *cname)
4809 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
4812 * Read length, and allocate array, then pre-extend it.
4816 TRACEME(("size = %d", len));
4818 SEEN(av, cname, 0); /* Will return if array not allocated nicely */
4822 return (SV *) av; /* No data follow if array is empty */
4825 * Now get each item in turn...
4828 for (i = 0; i < len; i++) {
4829 TRACEME(("(#%d) item", i));
4830 sv = retrieve(cxt, 0); /* Retrieve item */
4833 if (av_store(av, i, sv) == 0)
4837 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
4845 * Retrieve a whole hash table.
4846 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4847 * Keys are stored as <length> <data>, the <data> section being omitted
4849 * Values are stored as <object>.
4851 * When we come here, SX_HASH has been read already.
4853 static SV *retrieve_hash(stcxt_t *cxt, char *cname)
4861 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
4864 * Read length, allocate table.
4868 TRACEME(("size = %d", len));
4870 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
4872 return (SV *) hv; /* No data follow if table empty */
4873 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
4876 * Now get each key/value pair in turn...
4879 for (i = 0; i < len; i++) {
4884 TRACEME(("(#%d) value", i));
4885 sv = retrieve(cxt, 0);
4891 * Since we're reading into kbuf, we must ensure we're not
4892 * recursing between the read and the hv_store() where it's used.
4893 * Hence the key comes after the value.
4896 RLEN(size); /* Get key size */
4897 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
4900 kbuf[size] = '\0'; /* Mark string end, just in case */
4901 TRACEME(("(#%d) key '%s'", i, kbuf));
4904 * Enter key/value pair into hash table.
4907 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
4911 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
4919 * Retrieve a whole hash table.
4920 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4921 * Keys are stored as <length> <data>, the <data> section being omitted
4923 * Values are stored as <object>.
4925 * When we come here, SX_HASH has been read already.
4927 static SV *retrieve_flag_hash(stcxt_t *cxt, char *cname)
4936 GETMARK(hash_flags);
4937 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
4939 * Read length, allocate table.
4942 #ifndef HAS_RESTRICTED_HASHES
4943 if (hash_flags & SHV_RESTRICTED) {
4944 if (cxt->derestrict < 0)
4946 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
4948 if (cxt->derestrict == 0)
4949 RESTRICTED_HASH_CROAK();
4954 TRACEME(("size = %d, flags = %d", len, hash_flags));
4956 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
4958 return (SV *) hv; /* No data follow if table empty */
4959 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
4962 * Now get each key/value pair in turn...
4965 for (i = 0; i < len; i++) {
4967 int store_flags = 0;
4972 TRACEME(("(#%d) value", i));
4973 sv = retrieve(cxt, 0);
4978 #ifdef HAS_RESTRICTED_HASHES
4979 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
4983 if (flags & SHV_K_ISSV) {
4984 /* XXX you can't set a placeholder with an SV key.
4985 Then again, you can't get an SV key.
4986 Without messing around beyond what the API is supposed to do.
4989 TRACEME(("(#%d) keysv, flags=%d", i, flags));
4990 keysv = retrieve(cxt, 0);
4994 if (!hv_store_ent(hv, keysv, sv, 0))
4999 * Since we're reading into kbuf, we must ensure we're not
5000 * recursing between the read and the hv_store() where it's used.
5001 * Hence the key comes after the value.
5004 if (flags & SHV_K_PLACEHOLDER) {
5006 sv = &PL_sv_placeholder;
5007 store_flags |= HVhek_PLACEHOLD;
5009 if (flags & SHV_K_UTF8) {
5010 #ifdef HAS_UTF8_HASHES
5011 store_flags |= HVhek_UTF8;
5013 if (cxt->use_bytes < 0)
5015 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
5017 if (cxt->use_bytes == 0)
5021 #ifdef HAS_UTF8_HASHES
5022 if (flags & SHV_K_WASUTF8)
5023 store_flags |= HVhek_WASUTF8;
5026 RLEN(size); /* Get key size */
5027 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5030 kbuf[size] = '\0'; /* Mark string end, just in case */
5031 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5032 flags, store_flags));
5035 * Enter key/value pair into hash table.
5038 #ifdef HAS_RESTRICTED_HASHES
5039 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5042 if (!(store_flags & HVhek_PLACEHOLD))
5043 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5048 #ifdef HAS_RESTRICTED_HASHES
5049 if (hash_flags & SHV_RESTRICTED)
5053 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5061 * Return a code reference.
5063 static SV *retrieve_code(stcxt_t *cxt, char *cname)
5065 #if PERL_VERSION < 6
5066 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5069 int type, count, tagnum;
5071 SV *sv, *text, *sub;
5073 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5076 * Insert dummy SV in the aseen array so that we don't screw
5077 * up the tag numbers. We would just make the internal
5078 * scalar an untagged item in the stream, but
5079 * retrieve_scalar() calls SEEN(). So we just increase the
5082 tagnum = cxt->tagnum;
5087 * Retrieve the source of the code reference
5088 * as a small or large scalar
5094 text = retrieve_scalar(cxt, cname);
5097 text = retrieve_lscalar(cxt, cname);
5100 CROAK(("Unexpected type %d in retrieve_code\n", type));
5104 * prepend "sub " to the source
5107 sub = newSVpvn("sub ", 4);
5108 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5112 * evaluate the source to a code reference and use the CV value
5115 if (cxt->eval == NULL) {
5116 cxt->eval = perl_get_sv("Storable::Eval", TRUE);
5117 SvREFCNT_inc(cxt->eval);
5119 if (!SvTRUE(cxt->eval)) {
5121 cxt->forgive_me == 0 ||
5122 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5123 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
5125 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5128 /* fix up the dummy entry... */
5129 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5137 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5138 SV* errsv = get_sv("@", TRUE);
5139 sv_setpv(errsv, ""); /* clear $@ */
5141 XPUSHs(sv_2mortal(newSVsv(sub)));
5143 count = call_sv(cxt->eval, G_SCALAR);
5146 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5148 if (SvTRUE(errsv)) {
5149 CROAK(("code %s caused an error: %s",
5150 SvPV_nolen(sub), SvPV_nolen(errsv)));
5154 cv = eval_pv(SvPV_nolen(sub), TRUE);
5156 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5159 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5162 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5167 /* fix up the dummy entry... */
5168 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5175 * old_retrieve_array
5177 * Retrieve a whole array in pre-0.6 binary format.
5179 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5180 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5182 * When we come here, SX_ARRAY has been read already.
5184 static SV *old_retrieve_array(stcxt_t *cxt, char *cname)
5192 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5195 * Read length, and allocate array, then pre-extend it.
5199 TRACEME(("size = %d", len));
5201 SEEN(av, 0, 0); /* Will return if array not allocated nicely */
5205 return (SV *) av; /* No data follow if array is empty */
5208 * Now get each item in turn...
5211 for (i = 0; i < len; i++) {
5213 if (c == SX_IT_UNDEF) {
5214 TRACEME(("(#%d) undef item", i));
5215 continue; /* av_extend() already filled us with undef */
5218 (void) retrieve_other((stcxt_t *) 0, 0); /* Will croak out */
5219 TRACEME(("(#%d) item", i));
5220 sv = retrieve(cxt, 0); /* Retrieve item */
5223 if (av_store(av, i, sv) == 0)
5227 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5235 * Retrieve a whole hash table in pre-0.6 binary format.
5237 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5238 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5240 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5242 * When we come here, SX_HASH has been read already.
5244 static SV *old_retrieve_hash(stcxt_t *cxt, char *cname)
5252 static SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5254 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5257 * Read length, allocate table.
5261 TRACEME(("size = %d", len));
5263 SEEN(hv, 0, 0); /* Will return if table not allocated properly */
5265 return (SV *) hv; /* No data follow if table empty */
5266 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5269 * Now get each key/value pair in turn...
5272 for (i = 0; i < len; i++) {
5278 if (c == SX_VL_UNDEF) {
5279 TRACEME(("(#%d) undef value", i));
5281 * Due to a bug in hv_store(), it's not possible to pass
5282 * &PL_sv_undef to hv_store() as a value, otherwise the
5283 * associated key will not be creatable any more. -- RAM, 14/01/97
5286 sv_h_undef = newSVsv(&PL_sv_undef);
5287 sv = SvREFCNT_inc(sv_h_undef);
5288 } else if (c == SX_VALUE) {
5289 TRACEME(("(#%d) value", i));
5290 sv = retrieve(cxt, 0);
5294 (void) retrieve_other((stcxt_t *) 0, 0); /* Will croak out */
5298 * Since we're reading into kbuf, we must ensure we're not
5299 * recursing between the read and the hv_store() where it's used.
5300 * Hence the key comes after the value.
5305 (void) retrieve_other((stcxt_t *) 0, 0); /* Will croak out */
5306 RLEN(size); /* Get key size */
5307 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5310 kbuf[size] = '\0'; /* Mark string end, just in case */
5311 TRACEME(("(#%d) key '%s'", i, kbuf));
5314 * Enter key/value pair into hash table.
5317 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5321 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5327 *** Retrieval engine.
5333 * Make sure the stored data we're trying to retrieve has been produced
5334 * on an ILP compatible system with the same byteorder. It croaks out in
5335 * case an error is detected. [ILP = integer-long-pointer sizes]
5336 * Returns null if error is detected, &PL_sv_undef otherwise.
5338 * Note that there's no byte ordering info emitted when network order was
5339 * used at store time.
5341 static SV *magic_check(stcxt_t *cxt)
5343 /* The worst case for a malicious header would be old magic (which is
5344 longer), major, minor, byteorder length byte of 255, 255 bytes of
5345 garbage, sizeof int, long, pointer, NV.
5346 So the worse of that we can read is 255 bytes of garbage plus 4.
5347 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5348 compiling perl on a system with chars that are larger than 8 bits.
5349 (Even Crays aren't *that* perverse).
5351 unsigned char buf[4 + 255];
5352 unsigned char *current;
5355 int use_network_order;
5358 int version_minor = 0;
5360 TRACEME(("magic_check"));
5363 * The "magic number" is only for files, not when freezing in memory.
5367 /* This includes the '\0' at the end. I want to read the extra byte,
5368 which is usually going to be the major version number. */
5369 STRLEN len = sizeof(magicstr);
5372 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5374 /* Point at the byte after the byte we read. */
5375 current = buf + --len; /* Do the -- outside of macros. */
5377 if (memNE(buf, magicstr, len)) {
5379 * Try to read more bytes to check for the old magic number, which
5383 TRACEME(("trying for old magic number"));
5385 old_len = sizeof(old_magicstr) - 1;
5386 READ(current + 1, (SSize_t)(old_len - len));
5388 if (memNE(buf, old_magicstr, old_len))
5389 CROAK(("File is not a perl storable"));
5390 current = buf + old_len;
5392 use_network_order = *current;
5394 GETMARK(use_network_order);
5397 * Starting with 0.6, the "use_network_order" byte flag is also used to
5398 * indicate the version number of the binary, and therefore governs the
5399 * setting of sv_retrieve_vtbl. See magic_write().
5402 version_major = use_network_order >> 1;
5403 cxt->retrieve_vtbl = version_major ? sv_retrieve : sv_old_retrieve;
5405 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5409 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5410 * minor version of the protocol. See magic_write().
5413 if (version_major > 1)
5414 GETMARK(version_minor);
5416 cxt->ver_major = version_major;
5417 cxt->ver_minor = version_minor;
5419 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5422 * Inter-operability sanity check: we can't retrieve something stored
5423 * using a format more recent than ours, because we have no way to
5424 * know what has changed, and letting retrieval go would mean a probable
5425 * failure reporting a "corrupted" storable file.
5429 version_major > STORABLE_BIN_MAJOR ||
5430 (version_major == STORABLE_BIN_MAJOR &&
5431 version_minor > STORABLE_BIN_MINOR)
5434 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5435 STORABLE_BIN_MINOR));
5437 if (version_major == STORABLE_BIN_MAJOR) {
5438 TRACEME(("cxt->accept_future_minor is %d",
5439 cxt->accept_future_minor));
5440 if (cxt->accept_future_minor < 0)
5441 cxt->accept_future_minor
5442 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5445 if (cxt->accept_future_minor == 1)
5446 croak_now = 0; /* Don't croak yet. */
5449 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5450 version_major, version_minor,
5451 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5456 * If they stored using network order, there's no byte ordering
5457 * information to check.
5460 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5461 return &PL_sv_undef; /* No byte ordering info */
5463 /* In C truth is 1, falsehood is 0. Very convienient. */
5464 use_NV_size = version_major >= 2 && version_minor >= 2;
5467 length = c + 3 + use_NV_size;
5468 READ(buf, length); /* Not null-terminated */
5470 TRACEME(("byte order '%.*s' %d", c, buf, c));
5472 #ifdef USE_56_INTERWORK_KLUDGE
5473 /* No point in caching this in the context as we only need it once per
5474 retrieve, and we need to recheck it each read. */
5475 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5476 if ((c != (sizeof (byteorderstr_56) - 1))
5477 || memNE(buf, byteorderstr_56, c))
5478 CROAK(("Byte order is not compatible"));
5482 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5483 CROAK(("Byte order is not compatible"));
5489 if ((int) *current++ != sizeof(int))
5490 CROAK(("Integer size is not compatible"));
5493 if ((int) *current++ != sizeof(long))
5494 CROAK(("Long integer size is not compatible"));
5496 /* sizeof(char *) */
5497 if ((int) *current != sizeof(char *))
5498 CROAK(("Pointer size is not compatible"));
5502 if ((int) *++current != sizeof(NV))
5503 CROAK(("Double size is not compatible"));
5506 return &PL_sv_undef; /* OK */
5512 * Recursively retrieve objects from the specified file and return their
5513 * root SV (which may be an AV or an HV for what we care).
5514 * Returns null if there is a problem.
5516 static SV *retrieve(stcxt_t *cxt, char *cname)
5522 TRACEME(("retrieve"));
5525 * Grab address tag which identifies the object if we are retrieving
5526 * an older format. Since the new binary format counts objects and no
5527 * longer explicitely tags them, we must keep track of the correspondance
5530 * The following section will disappear one day when the old format is
5531 * no longer supported, hence the final "goto" in the "if" block.
5534 if (cxt->hseen) { /* Retrieving old binary */
5536 if (cxt->netorder) {
5538 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5539 tag = (stag_t) nettag;
5541 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5544 if (type == SX_OBJECT) {
5546 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5548 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5550 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5553 * The following code is common with the SX_OBJECT case below.
5556 svh = av_fetch(cxt->aseen, tagn, FALSE);
5558 CROAK(("Object #%"IVdf" should have been retrieved already",
5561 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5562 SvREFCNT_inc(sv); /* One more reference to this same sv */
5563 return sv; /* The SV pointer where object was retrieved */
5567 * Map new object, but don't increase tagnum. This will be done
5568 * by each of the retrieve_* functions when they call SEEN().
5570 * The mapping associates the "tag" initially present with a unique
5571 * tag number. See test for SX_OBJECT above to see how this is perused.
5574 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5575 newSViv(cxt->tagnum), 0))
5582 * Regular post-0.6 binary format.
5587 TRACEME(("retrieve type = %d", type));
5590 * Are we dealing with an object we should have already retrieved?
5593 if (type == SX_OBJECT) {
5597 svh = av_fetch(cxt->aseen, tag, FALSE);
5599 CROAK(("Object #%"IVdf" should have been retrieved already",
5602 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5603 SvREFCNT_inc(sv); /* One more reference to this same sv */
5604 return sv; /* The SV pointer where object was retrieved */
5605 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5606 if (cxt->accept_future_minor < 0)
5607 cxt->accept_future_minor
5608 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5611 if (cxt->accept_future_minor == 1) {
5612 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5613 "This Storable is v%d.%d and can only handle data types up to %d",
5614 cxt->ver_major, cxt->ver_minor, type,
5615 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5619 first_time: /* Will disappear when support for old format is dropped */
5622 * Okay, first time through for this one.
5625 sv = RETRIEVE(cxt, type)(cxt, cname);
5627 return (SV *) 0; /* Failed */
5630 * Old binary formats (pre-0.7).
5632 * Final notifications, ended by SX_STORED may now follow.
5633 * Currently, the only pertinent notification to apply on the
5634 * freshly retrieved object is either:
5635 * SX_CLASS <char-len> <classname> for short classnames.
5636 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5637 * Class name is then read into the key buffer pool used by
5638 * hash table key retrieval.
5641 if (cxt->ver_major < 2) {
5642 while ((type = GETCHAR()) != SX_STORED) {
5646 GETMARK(len); /* Length coded on a single char */
5648 case SX_LG_CLASS: /* Length coded on a regular integer */
5653 return (SV *) 0; /* Failed */
5655 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5658 kbuf[len] = '\0'; /* Mark string end */
5663 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5664 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
5672 * Retrieve data held in file and return the root object.
5673 * Common routine for pretrieve and mretrieve.
5675 static SV *do_retrieve(
5682 int is_tainted; /* Is input source tainted? */
5683 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
5685 TRACEME(("do_retrieve (optype = 0x%x)", optype));
5687 optype |= ST_RETRIEVE;
5690 * Sanity assertions for retrieve dispatch tables.
5693 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
5694 ("old and new retrieve dispatch table have same size"));
5695 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
5696 ("SX_ERROR entry correctly initialized in old dispatch table"));
5697 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
5698 ("SX_ERROR entry correctly initialized in new dispatch table"));
5701 * Workaround for CROAK leak: if they enter with a "dirty" context,
5702 * free up memory for them now.
5709 * Now that STORABLE_xxx hooks exist, it is possible that they try to
5710 * re-enter retrieve() via the hooks.
5714 cxt = allocate_context(cxt);
5718 ASSERT(cxt->entry == 1, ("starting new recursion"));
5719 ASSERT(!cxt->s_dirty, ("clean context"));
5724 * Data is loaded into the memory buffer when f is NULL, unless `in' is
5725 * also NULL, in which case we're expecting the data to already lie
5726 * in the buffer (dclone case).
5729 KBUFINIT(); /* Allocate hash key reading pool once */
5732 MBUF_SAVE_AND_LOAD(in);
5735 * Magic number verifications.
5737 * This needs to be done before calling init_retrieve_context()
5738 * since the format indication in the file are necessary to conduct
5739 * some of the initializations.
5742 cxt->fio = f; /* Where I/O are performed */
5744 if (!magic_check(cxt))
5745 CROAK(("Magic number checking on storable %s failed",
5746 cxt->fio ? "file" : "string"));
5748 TRACEME(("data stored in %s format",
5749 cxt->netorder ? "net order" : "native"));
5752 * Check whether input source is tainted, so that we don't wrongly
5753 * taint perfectly good values...
5755 * We assume file input is always tainted. If both `f' and `in' are
5756 * NULL, then we come from dclone, and tainted is already filled in
5757 * the context. That's a kludge, but the whole dclone() thing is
5758 * already quite a kludge anyway! -- RAM, 15/09/2000.
5761 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
5762 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
5763 init_retrieve_context(cxt, optype, is_tainted);
5765 ASSERT(is_retrieving(), ("within retrieve operation"));
5767 sv = retrieve(cxt, 0); /* Recursively retrieve object, get root SV */
5776 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
5779 * The "root" context is never freed.
5782 clean_retrieve_context(cxt);
5783 if (cxt->prev) /* This context was stacked */
5784 free_context(cxt); /* It was not the "root" context */
5787 * Prepare returned value.
5791 TRACEME(("retrieve ERROR"));
5792 #if (PATCHLEVEL <= 4)
5793 /* perl 5.00405 seems to screw up at this point with an
5794 'attempt to modify a read only value' error reported in the
5795 eval { $self = pretrieve(*FILE) } in _retrieve.
5796 I can't see what the cause of this error is, but I suspect a
5797 bug in 5.004, as it seems to be capable of issuing spurious
5798 errors or core dumping with matches on $@. I'm not going to
5799 spend time on what could be a fruitless search for the cause,
5800 so here's a bodge. If you're running 5.004 and don't like
5801 this inefficiency, either upgrade to a newer perl, or you are
5802 welcome to find the problem and send in a patch.
5806 return &PL_sv_undef; /* Something went wrong, return undef */
5810 TRACEME(("retrieve got %s(0x%"UVxf")",
5811 sv_reftype(sv, FALSE), PTR2UV(sv)));
5814 * Backward compatibility with Storable-0.5@9 (which we know we
5815 * are retrieving if hseen is non-null): don't create an extra RV
5816 * for objects since we special-cased it at store time.
5818 * Build a reference to the SV returned by pretrieve even if it is
5819 * already one and not a scalar, for consistency reasons.
5822 if (pre_06_fmt) { /* Was not handling overloading by then */
5824 TRACEME(("fixing for old formats -- pre 0.6"));
5825 if (sv_type(sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
5826 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
5832 * If reference is overloaded, restore behaviour.
5834 * NB: minor glitch here: normally, overloaded refs are stored specially
5835 * so that we can croak when behaviour cannot be re-installed, and also
5836 * avoid testing for overloading magic at each reference retrieval.
5838 * Unfortunately, the root reference is implicitely stored, so we must
5839 * check for possible overloading now. Furthermore, if we don't restore
5840 * overloading, we cannot croak as if the original ref was, because we
5841 * have no way to determine whether it was an overloaded ref or not in
5844 * It's a pity that overloading magic is attached to the rv, and not to
5845 * the underlying sv as blessing is.
5849 HV *stash = (HV *) SvSTASH(sv);
5850 SV *rv = newRV_noinc(sv);
5851 if (stash && Gv_AMG(stash)) {
5853 TRACEME(("restored overloading on root reference"));
5855 TRACEME(("ended do_retrieve() with an object"));
5859 TRACEME(("regular do_retrieve() end"));
5861 return newRV_noinc(sv);
5867 * Retrieve data held in file and return the root object, undef on error.
5869 SV *pretrieve(PerlIO *f)
5871 TRACEME(("pretrieve"));
5872 return do_retrieve(f, Nullsv, 0);
5878 * Retrieve data held in scalar and return the root object, undef on error.
5880 SV *mretrieve(SV *sv)
5882 TRACEME(("mretrieve"));
5883 return do_retrieve((PerlIO*) 0, sv, 0);
5893 * Deep clone: returns a fresh copy of the original referenced SV tree.
5895 * This is achieved by storing the object in memory and restoring from
5896 * there. Not that efficient, but it should be faster than doing it from
5903 stcxt_t *real_context;
5906 TRACEME(("dclone"));
5909 * Workaround for CROAK leak: if they enter with a "dirty" context,
5910 * free up memory for them now.
5917 * do_store() optimizes for dclone by not freeing its context, should
5918 * we need to allocate one because we're deep cloning from a hook.
5921 if (!do_store((PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
5922 return &PL_sv_undef; /* Error during store */
5925 * Because of the above optimization, we have to refresh the context,
5926 * since a new one could have been allocated and stacked by do_store().
5929 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
5930 cxt = real_context; /* And we need this temporary... */
5933 * Now, `cxt' may refer to a new context.
5936 ASSERT(!cxt->s_dirty, ("clean context"));
5937 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
5940 TRACEME(("dclone stored %d bytes", size));
5944 * Since we're passing do_retrieve() both a NULL file and sv, we need
5945 * to pre-compute the taintedness of the input by setting cxt->tainted
5946 * to whatever state our own input string was. -- RAM, 15/09/2000
5948 * do_retrieve() will free non-root context.
5951 cxt->s_tainted = SvTAINTED(sv);
5952 out = do_retrieve((PerlIO*) 0, Nullsv, ST_CLONE);
5954 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
5964 * The Perl IO GV object distinguishes between input and output for sockets
5965 * but not for plain files. To allow Storable to transparently work on
5966 * plain files and sockets transparently, we have to ask xsubpp to fetch the
5967 * right object for us. Hence the OutputStream and InputStream declarations.
5969 * Before perl 5.004_05, those entries in the standard typemap are not
5970 * defined in perl include files, so we do that here.
5973 #ifndef OutputStream
5974 #define OutputStream PerlIO *
5975 #define InputStream PerlIO *
5976 #endif /* !OutputStream */
5978 MODULE = Storable PACKAGE = Storable::Cxt
5984 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
5988 if (!cxt->membuf_ro && mbase)
5990 if (cxt->membuf_ro && (cxt->msaved).arena)
5991 Safefree((cxt->msaved).arena);
5994 MODULE = Storable PACKAGE = Storable
6000 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
6002 /* Only disable the used only once warning if we are in debugging mode. */
6003 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
6005 #ifdef USE_56_INTERWORK_KLUDGE
6006 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
6043 last_op_in_netorder()
projects / p5sagit/p5-mst-13.2.git / blob