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 HV *hclass; /* which classnames have been seen, store time */
292 AV *aclass; /* which classnames have been seen, retrieve time */
293 HV *hook; /* cache for hook methods per class name */
294 IV tagnum; /* incremented at store time for each seen object */
295 IV classnum; /* incremented at store time for each seen classname */
296 int netorder; /* true if network order used */
297 int s_tainted; /* true if input source is tainted, at retrieve time */
298 int forgive_me; /* whether to be forgiving... */
299 int deparse; /* whether to deparse code refs */
300 SV *eval; /* whether to eval source code */
301 int canonical; /* whether to store hashes sorted by key */
302 #ifndef HAS_RESTRICTED_HASHES
303 int derestrict; /* whether to downgrade restrcted hashes */
306 int use_bytes; /* whether to bytes-ify utf8 */
308 int accept_future_minor; /* croak immediately on future minor versions? */
309 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
310 int membuf_ro; /* true means membuf is read-only and msaved is rw */
311 struct extendable keybuf; /* for hash key retrieval */
312 struct extendable membuf; /* for memory store/retrieve operations */
313 struct extendable msaved; /* where potentially valid mbuf is saved */
314 PerlIO *fio; /* where I/O are performed, NULL for memory */
315 int ver_major; /* major of version for retrieved object */
316 int ver_minor; /* minor of version for retrieved object */
317 SV *(**retrieve_vtbl)(); /* retrieve dispatch table */
318 SV *prev; /* contexts chained backwards in real recursion */
319 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
322 #define NEW_STORABLE_CXT_OBJ(cxt) \
324 SV *self = newSV(sizeof(stcxt_t) - 1); \
325 SV *my_sv = newRV_noinc(self); \
326 sv_bless(my_sv, gv_stashpv("Storable::Cxt", TRUE)); \
327 cxt = (stcxt_t *)SvPVX(self); \
328 Zero(cxt, 1, stcxt_t); \
329 cxt->my_sv = my_sv; \
332 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
334 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
336 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
337 #else /* >= perl5.004_68 */
339 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
340 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
341 #endif /* < perl5.004_68 */
343 #define dSTCXT_PTR(T,name) \
344 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
345 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
348 dSTCXT_PTR(stcxt_t *, cxt)
352 NEW_STORABLE_CXT_OBJ(cxt); \
353 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
355 #define SET_STCXT(x) \
358 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
361 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
363 static stcxt_t *Context_ptr = NULL;
364 #define dSTCXT stcxt_t *cxt = Context_ptr
365 #define SET_STCXT(x) Context_ptr = x
368 NEW_STORABLE_CXT_OBJ(cxt); \
372 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
376 * Croaking implies a memory leak, since we don't use setjmp/longjmp
377 * to catch the exit and free memory used during store or retrieve
378 * operations. This is not too difficult to fix, but I need to understand
379 * how Perl does it, and croaking is exceptional anyway, so I lack the
380 * motivation to do it.
382 * The current workaround is to mark the context as dirty when croaking,
383 * so that data structures can be freed whenever we renter Storable code
384 * (but only *then*: it's a workaround, not a fix).
386 * This is also imperfect, because we don't really know how far they trapped
387 * the croak(), and when we were recursing, we won't be able to clean anything
388 * but the topmost context stacked.
391 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
394 * End of "thread-safe" related definitions.
400 * Keep only the low 32 bits of a pointer (used for tags, which are not
405 #define LOW_32BITS(x) ((I32) (x))
407 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
413 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
414 * Used in the WLEN and RLEN macros.
418 #define oI(x) ((I32 *) ((char *) (x) + 4))
419 #define oS(x) ((x) - 4)
420 #define oC(x) (x = 0)
429 * key buffer handling
431 #define kbuf (cxt->keybuf).arena
432 #define ksiz (cxt->keybuf).asiz
436 TRACEME(("** allocating kbuf of 128 bytes")); \
437 New(10003, kbuf, 128, char); \
444 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
445 Renew(kbuf, x+1, char); \
451 * memory buffer handling
453 #define mbase (cxt->membuf).arena
454 #define msiz (cxt->membuf).asiz
455 #define mptr (cxt->membuf).aptr
456 #define mend (cxt->membuf).aend
458 #define MGROW (1 << 13)
459 #define MMASK (MGROW - 1)
461 #define round_mgrow(x) \
462 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
463 #define trunc_int(x) \
464 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
465 #define int_aligned(x) \
466 ((unsigned long) (x) == trunc_int(x))
468 #define MBUF_INIT(x) \
471 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
472 New(10003, mbase, MGROW, char); \
473 msiz = (STRLEN)MGROW; \
479 mend = mbase + msiz; \
482 #define MBUF_TRUNC(x) mptr = mbase + x
483 #define MBUF_SIZE() (mptr - mbase)
489 * Those macros are used in do_retrieve() to save the current memory
490 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
491 * data from a string.
493 #define MBUF_SAVE_AND_LOAD(in) \
495 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
496 cxt->membuf_ro = 1; \
497 TRACEME(("saving mbuf")); \
498 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
502 #define MBUF_RESTORE() \
504 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
505 cxt->membuf_ro = 0; \
506 TRACEME(("restoring mbuf")); \
507 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
511 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
512 * See store_scalar() for other usage of this workaround.
514 #define MBUF_LOAD(v) \
516 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
518 CROAK(("Not a scalar string")); \
519 mptr = mbase = SvPV(v, msiz); \
520 mend = mbase + msiz; \
523 #define MBUF_XTEND(x) \
525 int nsz = (int) round_mgrow((x)+msiz); \
526 int offset = mptr - mbase; \
527 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
528 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
530 Renew(mbase, nsz, char); \
532 mptr = mbase + offset; \
533 mend = mbase + nsz; \
536 #define MBUF_CHK(x) \
538 if ((mptr + (x)) > mend) \
542 #define MBUF_GETC(x) \
545 x = (int) (unsigned char) *mptr++; \
551 #define MBUF_GETINT(x) \
554 if ((mptr + 4) <= mend) { \
555 memcpy(oI(&x), mptr, 4); \
561 #define MBUF_GETINT(x) \
563 if ((mptr + sizeof(int)) <= mend) { \
564 if (int_aligned(mptr)) \
567 memcpy(&x, mptr, sizeof(int)); \
568 mptr += sizeof(int); \
574 #define MBUF_READ(x,s) \
576 if ((mptr + (s)) <= mend) { \
577 memcpy(x, mptr, s); \
583 #define MBUF_SAFEREAD(x,s,z) \
585 if ((mptr + (s)) <= mend) { \
586 memcpy(x, mptr, s); \
594 #define MBUF_PUTC(c) \
597 *mptr++ = (char) c; \
600 *mptr++ = (char) c; \
605 #define MBUF_PUTINT(i) \
608 memcpy(mptr, oI(&i), 4); \
612 #define MBUF_PUTINT(i) \
614 MBUF_CHK(sizeof(int)); \
615 if (int_aligned(mptr)) \
618 memcpy(mptr, &i, sizeof(int)); \
619 mptr += sizeof(int); \
623 #define MBUF_WRITE(x,s) \
626 memcpy(mptr, x, s); \
631 * Possible return values for sv_type().
635 #define svis_SCALAR 1
639 #define svis_TIED_ITEM 5
647 #define SHF_TYPE_MASK 0x03
648 #define SHF_LARGE_CLASSLEN 0x04
649 #define SHF_LARGE_STRLEN 0x08
650 #define SHF_LARGE_LISTLEN 0x10
651 #define SHF_IDX_CLASSNAME 0x20
652 #define SHF_NEED_RECURSE 0x40
653 #define SHF_HAS_LIST 0x80
656 * Types for SX_HOOK (last 2 bits in flags).
662 #define SHT_EXTRA 3 /* Read extra byte for type */
665 * The following are held in the "extra byte"...
668 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
669 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
670 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
673 * per hash flags for flagged hashes
676 #define SHV_RESTRICTED 0x01
679 * per key flags for flagged hashes
682 #define SHV_K_UTF8 0x01
683 #define SHV_K_WASUTF8 0x02
684 #define SHV_K_LOCKED 0x04
685 #define SHV_K_ISSV 0x08
686 #define SHV_K_PLACEHOLDER 0x10
689 * Before 0.6, the magic string was "perl-store" (binary version number 0).
691 * Since 0.6 introduced many binary incompatibilities, the magic string has
692 * been changed to "pst0" to allow an old image to be properly retrieved by
693 * a newer Storable, but ensure a newer image cannot be retrieved with an
696 * At 0.7, objects are given the ability to serialize themselves, and the
697 * set of markers is extended, backward compatibility is not jeopardized,
698 * so the binary version number could have remained unchanged. To correctly
699 * spot errors if a file making use of 0.7-specific extensions is given to
700 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
701 * a "minor" version, to better track this kind of evolution from now on.
704 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
705 static const char magicstr[] = "pst0"; /* Used as a magic number */
707 #define MAGICSTR_BYTES 'p','s','t','0'
708 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
710 /* 5.6.x introduced the ability to have IVs as long long.
711 However, Configure still defined BYTEORDER based on the size of a long.
712 Storable uses the BYTEORDER value as part of the header, but doesn't
713 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
714 with IV as long long on a platform that uses Configure (ie most things
715 except VMS and Windows) headers are identical for the different IV sizes,
716 despite the files containing some fields based on sizeof(IV)
718 5.8 is consistent - the following redifinition kludge is only needed on
719 5.6.x, but the interwork is needed on 5.8 while data survives in files
724 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
725 #ifndef NO_56_INTERWORK_KLUDGE
726 #define USE_56_INTERWORK_KLUDGE
728 #if BYTEORDER == 0x1234
730 #define BYTEORDER 0x12345678
732 #if BYTEORDER == 0x4321
734 #define BYTEORDER 0x87654321
739 #if BYTEORDER == 0x1234
740 #define BYTEORDER_BYTES '1','2','3','4'
742 #if BYTEORDER == 0x12345678
743 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
744 #ifdef USE_56_INTERWORK_KLUDGE
745 #define BYTEORDER_BYTES_56 '1','2','3','4'
748 #if BYTEORDER == 0x87654321
749 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
750 #ifdef USE_56_INTERWORK_KLUDGE
751 #define BYTEORDER_BYTES_56 '4','3','2','1'
754 #if BYTEORDER == 0x4321
755 #define BYTEORDER_BYTES '4','3','2','1'
757 #error Unknown byteoder. Please append your byteorder to Storable.xs
763 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
764 #ifdef USE_56_INTERWORK_KLUDGE
765 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
768 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
769 #define STORABLE_BIN_MINOR 6 /* Binary minor "version" */
771 /* If we aren't 5.7.3 or later, we won't be writing out files that use the
772 * new flagged hash introdued in 2.5, so put 2.4 in the binary header to
773 * maximise ease of interoperation with older Storables.
774 * Could we write 2.3s if we're on 5.005_03? NWC
776 #if (PATCHLEVEL <= 6)
777 #define STORABLE_BIN_WRITE_MINOR 4
780 * As of perl 5.7.3, utf8 hash key is introduced.
781 * So this must change -- dankogai
783 #define STORABLE_BIN_WRITE_MINOR 6
784 #endif /* (PATCHLEVEL <= 6) */
786 #if (PATCHLEVEL <= 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
787 #define PL_sv_placeholder PL_sv_undef
791 * Useful store shortcuts...
798 else if (PerlIO_putc(cxt->fio, x) == EOF) \
802 #define WRITE_I32(x) \
804 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
807 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
814 if (cxt->netorder) { \
815 int y = (int) htonl(x); \
818 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
823 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
828 #define WLEN(x) WRITE_I32(x)
835 else if (PerlIO_write(cxt->fio, x, y) != y) \
839 #define STORE_PV_LEN(pv, len, small, large) \
841 if (len <= LG_SCALAR) { \
842 unsigned char clen = (unsigned char) len; \
854 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
857 * Store &PL_sv_undef in arrays without recursing through store().
859 #define STORE_SV_UNDEF() \
862 PUTMARK(SX_SV_UNDEF); \
866 * Useful retrieve shortcuts...
870 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
876 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
880 #define READ_I32(x) \
882 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
886 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
896 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
899 x = (int) ntohl(x); \
902 #define RLEN(x) READ_I32(x)
909 else if (PerlIO_read(cxt->fio, x, y) != y) \
913 #define SAFEREAD(x,y,z) \
916 MBUF_SAFEREAD(x,y,z); \
917 else if (PerlIO_read(cxt->fio, x, y) != y) { \
924 * This macro is used at retrieve time, to remember where object 'y', bearing a
925 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
926 * we'll therefore know where it has been retrieved and will be able to
927 * share the same reference, as in the original stored memory image.
929 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
930 * on the objects given to STORABLE_thaw and expect that to be defined), and
931 * also for overloaded objects (for which we might not find the stash if the
932 * object is not blessed yet--this might occur for overloaded objects that
933 * refer to themselves indirectly: if we blessed upon return from a sub
934 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
935 * restored on it because the underlying object would not be blessed yet!).
937 * To achieve that, the class name of the last retrieved object is passed down
938 * recursively, and the first SEEN() call for which the class name is not NULL
939 * will bless the object.
945 if (av_store(cxt->aseen, cxt->tagnum++, SvREFCNT_inc(y)) == 0) \
947 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
948 PTR2UV(y), SvREFCNT(y)-1)); \
950 BLESS((SV *) (y), c); \
954 * Bless `s' in `p', via a temporary reference, required by sv_bless().
960 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
961 stash = gv_stashpv((p), TRUE); \
962 ref = newRV_noinc(s); \
963 (void) sv_bless(ref, stash); \
969 static SV *retrieve(stcxt_t *cxt, char *cname);
972 * Dynamic dispatching table for SV store.
975 static int store_ref(stcxt_t *cxt, SV *sv);
976 static int store_scalar(stcxt_t *cxt, SV *sv);
977 static int store_array(stcxt_t *cxt, AV *av);
978 static int store_hash(stcxt_t *cxt, HV *hv);
979 static int store_tied(stcxt_t *cxt, SV *sv);
980 static int store_tied_item(stcxt_t *cxt, SV *sv);
981 static int store_code(stcxt_t *cxt, CV *cv);
982 static int store_other(stcxt_t *cxt, SV *sv);
983 static int store_blessed(stcxt_t *cxt, SV *sv, int type, HV *pkg);
985 static int (*sv_store[])(stcxt_t *cxt, SV *sv) = {
986 store_ref, /* svis_REF */
987 store_scalar, /* svis_SCALAR */
988 (int (*)(stcxt_t *cxt, SV *sv)) store_array, /* svis_ARRAY */
989 (int (*)(stcxt_t *cxt, SV *sv)) store_hash, /* svis_HASH */
990 store_tied, /* svis_TIED */
991 store_tied_item, /* svis_TIED_ITEM */
992 (int (*)(stcxt_t *cxt, SV *sv)) store_code, /* svis_CODE */
993 store_other, /* svis_OTHER */
996 #define SV_STORE(x) (*sv_store[x])
999 * Dynamic dispatching tables for SV retrieval.
1002 static SV *retrieve_lscalar(stcxt_t *cxt, char *cname);
1003 static SV *retrieve_lutf8str(stcxt_t *cxt, char *cname);
1004 static SV *old_retrieve_array(stcxt_t *cxt, char *cname);
1005 static SV *old_retrieve_hash(stcxt_t *cxt, char *cname);
1006 static SV *retrieve_ref(stcxt_t *cxt, char *cname);
1007 static SV *retrieve_undef(stcxt_t *cxt, char *cname);
1008 static SV *retrieve_integer(stcxt_t *cxt, char *cname);
1009 static SV *retrieve_double(stcxt_t *cxt, char *cname);
1010 static SV *retrieve_byte(stcxt_t *cxt, char *cname);
1011 static SV *retrieve_netint(stcxt_t *cxt, char *cname);
1012 static SV *retrieve_scalar(stcxt_t *cxt, char *cname);
1013 static SV *retrieve_utf8str(stcxt_t *cxt, char *cname);
1014 static SV *retrieve_tied_array(stcxt_t *cxt, char *cname);
1015 static SV *retrieve_tied_hash(stcxt_t *cxt, char *cname);
1016 static SV *retrieve_tied_scalar(stcxt_t *cxt, char *cname);
1017 static SV *retrieve_other(stcxt_t *cxt, char *cname);
1019 static SV *(*sv_old_retrieve[])(stcxt_t *cxt, char *cname) = {
1020 0, /* SX_OBJECT -- entry unused dynamically */
1021 retrieve_lscalar, /* SX_LSCALAR */
1022 old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1023 old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1024 retrieve_ref, /* SX_REF */
1025 retrieve_undef, /* SX_UNDEF */
1026 retrieve_integer, /* SX_INTEGER */
1027 retrieve_double, /* SX_DOUBLE */
1028 retrieve_byte, /* SX_BYTE */
1029 retrieve_netint, /* SX_NETINT */
1030 retrieve_scalar, /* SX_SCALAR */
1031 retrieve_tied_array, /* SX_ARRAY */
1032 retrieve_tied_hash, /* SX_HASH */
1033 retrieve_tied_scalar, /* SX_SCALAR */
1034 retrieve_other, /* SX_SV_UNDEF not supported */
1035 retrieve_other, /* SX_SV_YES not supported */
1036 retrieve_other, /* SX_SV_NO not supported */
1037 retrieve_other, /* SX_BLESS not supported */
1038 retrieve_other, /* SX_IX_BLESS not supported */
1039 retrieve_other, /* SX_HOOK not supported */
1040 retrieve_other, /* SX_OVERLOADED not supported */
1041 retrieve_other, /* SX_TIED_KEY not supported */
1042 retrieve_other, /* SX_TIED_IDX not supported */
1043 retrieve_other, /* SX_UTF8STR not supported */
1044 retrieve_other, /* SX_LUTF8STR not supported */
1045 retrieve_other, /* SX_FLAG_HASH not supported */
1046 retrieve_other, /* SX_CODE not supported */
1047 retrieve_other, /* SX_ERROR */
1050 static SV *retrieve_array(stcxt_t *cxt, char *cname);
1051 static SV *retrieve_hash(stcxt_t *cxt, char *cname);
1052 static SV *retrieve_sv_undef(stcxt_t *cxt, char *cname);
1053 static SV *retrieve_sv_yes(stcxt_t *cxt, char *cname);
1054 static SV *retrieve_sv_no(stcxt_t *cxt, char *cname);
1055 static SV *retrieve_blessed(stcxt_t *cxt, char *cname);
1056 static SV *retrieve_idx_blessed(stcxt_t *cxt, char *cname);
1057 static SV *retrieve_hook(stcxt_t *cxt, char *cname);
1058 static SV *retrieve_overloaded(stcxt_t *cxt, char *cname);
1059 static SV *retrieve_tied_key(stcxt_t *cxt, char *cname);
1060 static SV *retrieve_tied_idx(stcxt_t *cxt, char *cname);
1061 static SV *retrieve_flag_hash(stcxt_t *cxt, char *cname);
1062 static SV *retrieve_code(stcxt_t *cxt, char *cname);
1064 static SV *(*sv_retrieve[])(stcxt_t *cxt, char *cname) = {
1065 0, /* SX_OBJECT -- entry unused dynamically */
1066 retrieve_lscalar, /* SX_LSCALAR */
1067 retrieve_array, /* SX_ARRAY */
1068 retrieve_hash, /* SX_HASH */
1069 retrieve_ref, /* SX_REF */
1070 retrieve_undef, /* SX_UNDEF */
1071 retrieve_integer, /* SX_INTEGER */
1072 retrieve_double, /* SX_DOUBLE */
1073 retrieve_byte, /* SX_BYTE */
1074 retrieve_netint, /* SX_NETINT */
1075 retrieve_scalar, /* SX_SCALAR */
1076 retrieve_tied_array, /* SX_ARRAY */
1077 retrieve_tied_hash, /* SX_HASH */
1078 retrieve_tied_scalar, /* SX_SCALAR */
1079 retrieve_sv_undef, /* SX_SV_UNDEF */
1080 retrieve_sv_yes, /* SX_SV_YES */
1081 retrieve_sv_no, /* SX_SV_NO */
1082 retrieve_blessed, /* SX_BLESS */
1083 retrieve_idx_blessed, /* SX_IX_BLESS */
1084 retrieve_hook, /* SX_HOOK */
1085 retrieve_overloaded, /* SX_OVERLOAD */
1086 retrieve_tied_key, /* SX_TIED_KEY */
1087 retrieve_tied_idx, /* SX_TIED_IDX */
1088 retrieve_utf8str, /* SX_UTF8STR */
1089 retrieve_lutf8str, /* SX_LUTF8STR */
1090 retrieve_flag_hash, /* SX_HASH */
1091 retrieve_code, /* SX_CODE */
1092 retrieve_other, /* SX_ERROR */
1095 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1097 static SV *mbuf2sv(void);
1100 *** Context management.
1106 * Called once per "thread" (interpreter) to initialize some global context.
1108 static void init_perinterp(void)
1112 cxt->netorder = 0; /* true if network order used */
1113 cxt->forgive_me = -1; /* whether to be forgiving... */
1119 * Called at the end of every context cleaning, to perform common reset
1122 static void reset_context(stcxt_t *cxt)
1126 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1130 * init_store_context
1132 * Initialize a new store context for real recursion.
1134 static void init_store_context(
1140 TRACEME(("init_store_context"));
1142 cxt->netorder = network_order;
1143 cxt->forgive_me = -1; /* Fetched from perl if needed */
1144 cxt->deparse = -1; /* Idem */
1145 cxt->eval = NULL; /* Idem */
1146 cxt->canonical = -1; /* Idem */
1147 cxt->tagnum = -1; /* Reset tag numbers */
1148 cxt->classnum = -1; /* Reset class numbers */
1149 cxt->fio = f; /* Where I/O are performed */
1150 cxt->optype = optype; /* A store, or a deep clone */
1151 cxt->entry = 1; /* No recursion yet */
1154 * The `hseen' table is used to keep track of each SV stored and their
1155 * associated tag numbers is special. It is "abused" because the
1156 * values stored are not real SV, just integers cast to (SV *),
1157 * which explains the freeing below.
1159 * It is also one possible bottlneck to achieve good storing speed,
1160 * so the "shared keys" optimization is turned off (unlikely to be
1161 * of any use here), and the hash table is "pre-extended". Together,
1162 * those optimizations increase the throughput by 12%.
1165 cxt->hseen = newHV(); /* Table where seen objects are stored */
1166 HvSHAREKEYS_off(cxt->hseen);
1169 * The following does not work well with perl5.004_04, and causes
1170 * a core dump later on, in a completely unrelated spot, which
1171 * makes me think there is a memory corruption going on.
1173 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1174 * it below does not make any difference. It seems to work fine
1175 * with perl5.004_68 but given the probable nature of the bug,
1176 * that does not prove anything.
1178 * It's a shame because increasing the amount of buckets raises
1179 * store() throughput by 5%, but until I figure this out, I can't
1180 * allow for this to go into production.
1182 * It is reported fixed in 5.005, hence the #if.
1184 #if PERL_VERSION >= 5
1185 #define HBUCKETS 4096 /* Buckets for %hseen */
1186 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1190 * The `hclass' hash uses the same settings as `hseen' above, but it is
1191 * used to assign sequential tags (numbers) to class names for blessed
1194 * We turn the shared key optimization on.
1197 cxt->hclass = newHV(); /* Where seen classnames are stored */
1199 #if PERL_VERSION >= 5
1200 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1204 * The `hook' hash table is used to keep track of the references on
1205 * the STORABLE_freeze hook routines, when found in some class name.
1207 * It is assumed that the inheritance tree will not be changed during
1208 * storing, and that no new method will be dynamically created by the
1212 cxt->hook = newHV(); /* Table where hooks are cached */
1215 * The `hook_seen' array keeps track of all the SVs returned by
1216 * STORABLE_freeze hooks for us to serialize, so that they are not
1217 * reclaimed until the end of the serialization process. Each SV is
1218 * only stored once, the first time it is seen.
1221 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1225 * clean_store_context
1227 * Clean store context by
1229 static void clean_store_context(stcxt_t *cxt)
1233 TRACEME(("clean_store_context"));
1235 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1238 * Insert real values into hashes where we stored faked pointers.
1242 hv_iterinit(cxt->hseen);
1243 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1244 HeVAL(he) = &PL_sv_undef;
1248 hv_iterinit(cxt->hclass);
1249 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1250 HeVAL(he) = &PL_sv_undef;
1254 * And now dispose of them...
1256 * The surrounding if() protection has been added because there might be
1257 * some cases where this routine is called more than once, during
1258 * exceptionnal events. This was reported by Marc Lehmann when Storable
1259 * is executed from mod_perl, and the fix was suggested by him.
1260 * -- RAM, 20/12/2000
1264 HV *hseen = cxt->hseen;
1267 sv_free((SV *) hseen);
1271 HV *hclass = cxt->hclass;
1274 sv_free((SV *) hclass);
1278 HV *hook = cxt->hook;
1281 sv_free((SV *) hook);
1284 if (cxt->hook_seen) {
1285 AV *hook_seen = cxt->hook_seen;
1287 av_undef(hook_seen);
1288 sv_free((SV *) hook_seen);
1291 cxt->forgive_me = -1; /* Fetched from perl if needed */
1292 cxt->deparse = -1; /* Idem */
1294 SvREFCNT_dec(cxt->eval);
1296 cxt->eval = NULL; /* Idem */
1297 cxt->canonical = -1; /* Idem */
1303 * init_retrieve_context
1305 * Initialize a new retrieve context for real recursion.
1307 static void init_retrieve_context(stcxt_t *cxt, int optype, int is_tainted)
1309 TRACEME(("init_retrieve_context"));
1312 * The hook hash table is used to keep track of the references on
1313 * the STORABLE_thaw hook routines, when found in some class name.
1315 * It is assumed that the inheritance tree will not be changed during
1316 * storing, and that no new method will be dynamically created by the
1320 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1323 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1324 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1325 * the correspondance between the tags and the tag number used by the
1326 * new retrieve routines.
1329 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1332 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1333 cxt->aclass = newAV(); /* Where seen classnames are kept */
1334 cxt->tagnum = 0; /* Have to count objects... */
1335 cxt->classnum = 0; /* ...and class names as well */
1336 cxt->optype = optype;
1337 cxt->s_tainted = is_tainted;
1338 cxt->entry = 1; /* No recursion yet */
1339 #ifndef HAS_RESTRICTED_HASHES
1340 cxt->derestrict = -1; /* Fetched from perl if needed */
1342 #ifndef HAS_UTF8_ALL
1343 cxt->use_bytes = -1; /* Fetched from perl if needed */
1345 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1349 * clean_retrieve_context
1351 * Clean retrieve context by
1353 static void clean_retrieve_context(stcxt_t *cxt)
1355 TRACEME(("clean_retrieve_context"));
1357 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1360 AV *aseen = cxt->aseen;
1363 sv_free((SV *) aseen);
1367 AV *aclass = cxt->aclass;
1370 sv_free((SV *) aclass);
1374 HV *hook = cxt->hook;
1377 sv_free((SV *) hook);
1381 HV *hseen = cxt->hseen;
1384 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1387 #ifndef HAS_RESTRICTED_HASHES
1388 cxt->derestrict = -1; /* Fetched from perl if needed */
1390 #ifndef HAS_UTF8_ALL
1391 cxt->use_bytes = -1; /* Fetched from perl if needed */
1393 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1401 * A workaround for the CROAK bug: cleanup the last context.
1403 static void clean_context(stcxt_t *cxt)
1405 TRACEME(("clean_context"));
1407 ASSERT(cxt->s_dirty, ("dirty context"));
1412 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1414 if (cxt->optype & ST_RETRIEVE)
1415 clean_retrieve_context(cxt);
1416 else if (cxt->optype & ST_STORE)
1417 clean_store_context(cxt);
1421 ASSERT(!cxt->s_dirty, ("context is clean"));
1422 ASSERT(cxt->entry == 0, ("context is reset"));
1428 * Allocate a new context and push it on top of the parent one.
1429 * This new context is made globally visible via SET_STCXT().
1431 static stcxt_t *allocate_context(parent_cxt)
1432 stcxt_t *parent_cxt;
1436 TRACEME(("allocate_context"));
1438 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1440 NEW_STORABLE_CXT_OBJ(cxt);
1441 cxt->prev = parent_cxt->my_sv;
1444 ASSERT(!cxt->s_dirty, ("clean context"));
1452 * Free current context, which cannot be the "root" one.
1453 * Make the context underneath globally visible via SET_STCXT().
1455 static void free_context(cxt)
1458 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1460 TRACEME(("free_context"));
1462 ASSERT(!cxt->s_dirty, ("clean context"));
1463 ASSERT(prev, ("not freeing root context"));
1465 SvREFCNT_dec(cxt->my_sv);
1468 ASSERT(cxt, ("context not void"));
1478 * Tells whether we're in the middle of a store operation.
1480 int is_storing(void)
1484 return cxt->entry && (cxt->optype & ST_STORE);
1490 * Tells whether we're in the middle of a retrieve operation.
1492 int is_retrieving(void)
1496 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1500 * last_op_in_netorder
1502 * Returns whether last operation was made using network order.
1504 * This is typically out-of-band information that might prove useful
1505 * to people wishing to convert native to network order data when used.
1507 int last_op_in_netorder(void)
1511 return cxt->netorder;
1515 *** Hook lookup and calling routines.
1521 * A wrapper on gv_fetchmethod_autoload() which caches results.
1523 * Returns the routine reference as an SV*, or null if neither the package
1524 * nor its ancestors know about the method.
1526 static SV *pkg_fetchmeth(
1535 * The following code is the same as the one performed by UNIVERSAL::can
1539 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1540 if (gv && isGV(gv)) {
1541 sv = newRV((SV*) GvCV(gv));
1542 TRACEME(("%s->%s: 0x%"UVxf, HvNAME(pkg), method, PTR2UV(sv)));
1544 sv = newSVsv(&PL_sv_undef);
1545 TRACEME(("%s->%s: not found", HvNAME(pkg), method));
1549 * Cache the result, ignoring failure: if we can't store the value,
1550 * it just won't be cached.
1553 (void) hv_store(cache, HvNAME(pkg), strlen(HvNAME(pkg)), sv, 0);
1555 return SvOK(sv) ? sv : (SV *) 0;
1561 * Force cached value to be undef: hook ignored even if present.
1563 static void pkg_hide(
1568 (void) hv_store(cache,
1569 HvNAME(pkg), strlen(HvNAME(pkg)), newSVsv(&PL_sv_undef), 0);
1575 * Discard cached value: a whole fetch loop will be retried at next lookup.
1577 static void pkg_uncache(
1582 (void) hv_delete(cache, HvNAME(pkg), strlen(HvNAME(pkg)), G_DISCARD);
1588 * Our own "UNIVERSAL::can", which caches results.
1590 * Returns the routine reference as an SV*, or null if the object does not
1591 * know about the method.
1601 TRACEME(("pkg_can for %s->%s", HvNAME(pkg), method));
1604 * Look into the cache to see whether we already have determined
1605 * where the routine was, if any.
1607 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1608 * that only one hook (i.e. always the same) is cached in a given cache.
1611 svh = hv_fetch(cache, HvNAME(pkg), strlen(HvNAME(pkg)), FALSE);
1615 TRACEME(("cached %s->%s: not found", HvNAME(pkg), method));
1618 TRACEME(("cached %s->%s: 0x%"UVxf,
1619 HvNAME(pkg), method, PTR2UV(sv)));
1624 TRACEME(("not cached yet"));
1625 return pkg_fetchmeth(cache, pkg, method); /* Fetch and cache */
1631 * Call routine as obj->hook(av) in scalar context.
1632 * Propagates the single returned value if not called in void context.
1634 static SV *scalar_call(
1645 TRACEME(("scalar_call (cloning=%d)", cloning));
1652 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1654 SV **ary = AvARRAY(av);
1655 int cnt = AvFILLp(av) + 1;
1657 XPUSHs(ary[0]); /* Frozen string */
1658 for (i = 1; i < cnt; i++) {
1659 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1660 i, PTR2UV(ary[i])));
1661 XPUSHs(sv_2mortal(newRV(ary[i])));
1666 TRACEME(("calling..."));
1667 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1668 TRACEME(("count = %d", count));
1674 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1687 * Call routine obj->hook(cloning) in list context.
1688 * Returns the list of returned values in an array.
1690 static AV *array_call(
1700 TRACEME(("array_call (cloning=%d)", cloning));
1706 XPUSHs(obj); /* Target object */
1707 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1710 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1715 for (i = count - 1; i >= 0; i--) {
1717 av_store(av, i, SvREFCNT_inc(sv));
1730 * Lookup the class name in the `hclass' table and either assign it a new ID
1731 * or return the existing one, by filling in `classnum'.
1733 * Return true if the class was known, false if the ID was just generated.
1735 static int known_class(
1737 char *name, /* Class name */
1738 int len, /* Name length */
1742 HV *hclass = cxt->hclass;
1744 TRACEME(("known_class (%s)", name));
1747 * Recall that we don't store pointers in this hash table, but tags.
1748 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1751 svh = hv_fetch(hclass, name, len, FALSE);
1753 *classnum = LOW_32BITS(*svh);
1758 * Unknown classname, we need to record it.
1762 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1763 CROAK(("Unable to record new classname"));
1765 *classnum = cxt->classnum;
1770 *** Sepcific store routines.
1776 * Store a reference.
1777 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1779 static int store_ref(stcxt_t *cxt, SV *sv)
1781 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1784 * Follow reference, and check if target is overloaded.
1790 HV *stash = (HV *) SvSTASH(sv);
1791 if (stash && Gv_AMG(stash)) {
1792 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1793 PUTMARK(SX_OVERLOAD);
1799 return store(cxt, sv);
1807 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1808 * The <data> section is omitted if <length> is 0.
1810 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1811 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1813 static int store_scalar(stcxt_t *cxt, SV *sv)
1818 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1820 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1823 * For efficiency, break the SV encapsulation by peaking at the flags
1824 * directly without using the Perl macros to avoid dereferencing
1825 * sv->sv_flags each time we wish to check the flags.
1828 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1829 if (sv == &PL_sv_undef) {
1830 TRACEME(("immortal undef"));
1831 PUTMARK(SX_SV_UNDEF);
1833 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
1840 * Always store the string representation of a scalar if it exists.
1841 * Gisle Aas provided me with this test case, better than a long speach:
1843 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1844 * SV = PVNV(0x80c8520)
1846 * FLAGS = (NOK,POK,pNOK,pPOK)
1849 * PV = 0x80c83d0 "abc"\0
1853 * Write SX_SCALAR, length, followed by the actual data.
1855 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
1856 * appropriate, followed by the actual (binary) data. A double
1857 * is written as a string if network order, for portability.
1859 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
1860 * The reason is that when the scalar value is tainted, the SvNOK(sv)
1863 * The test for a read-only scalar with both POK and NOK set is meant
1864 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
1865 * address comparison for each scalar we store.
1868 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
1870 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
1871 if (sv == &PL_sv_yes) {
1872 TRACEME(("immortal yes"));
1874 } else if (sv == &PL_sv_no) {
1875 TRACEME(("immortal no"));
1878 pv = SvPV(sv, len); /* We know it's SvPOK */
1879 goto string; /* Share code below */
1881 } else if (flags & SVf_POK) {
1882 /* public string - go direct to string read. */
1883 goto string_readlen;
1885 #if (PATCHLEVEL <= 6)
1886 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
1887 direct if NV flag is off. */
1888 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
1890 /* 5.7 rules are that if IV public flag is set, IV value is as
1891 good, if not better, than NV value. */
1897 * Will come here from below with iv set if double is an integer.
1901 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1903 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
1904 * (for example) and that ends up in the optimised small integer
1907 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
1908 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
1909 goto string_readlen;
1913 * Optimize small integers into a single byte, otherwise store as
1914 * a real integer (converted into network order if they asked).
1917 if (iv >= -128 && iv <= 127) {
1918 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
1921 TRACEME(("small integer stored as %d", siv));
1922 } else if (cxt->netorder) {
1924 TRACEME(("no htonl, fall back to string for integer"));
1925 goto string_readlen;
1933 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1934 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
1936 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
1937 /* Bigger than 32 bits. */
1938 TRACEME(("large network order integer as string, value = %"IVdf, iv));
1939 goto string_readlen;
1943 niv = (I32) htonl((I32) iv);
1944 TRACEME(("using network order"));
1949 PUTMARK(SX_INTEGER);
1950 WRITE(&iv, sizeof(iv));
1953 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
1954 } else if (flags & SVf_NOK) {
1956 #if (PATCHLEVEL <= 6)
1959 * Watch for number being an integer in disguise.
1961 if (nv == (NV) (iv = I_V(nv))) {
1962 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
1963 goto integer; /* Share code above */
1968 if (SvIOK_notUV(sv)) {
1970 goto integer; /* Share code above */
1975 if (cxt->netorder) {
1976 TRACEME(("double %"NVff" stored as string", nv));
1977 goto string_readlen; /* Share code below */
1981 WRITE(&nv, sizeof(nv));
1983 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
1985 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
1986 I32 wlen; /* For 64-bit machines */
1992 * Will come here from above if it was readonly, POK and NOK but
1993 * neither &PL_sv_yes nor &PL_sv_no.
1997 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
1999 STORE_UTF8STR(pv, wlen);
2001 STORE_SCALAR(pv, wlen);
2002 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2003 PTR2UV(sv), SvPVX(sv), (IV)len));
2005 CROAK(("Can't determine type of %s(0x%"UVxf")",
2006 sv_reftype(sv, FALSE),
2008 return 0; /* Ok, no recursion on scalars */
2016 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2017 * Each item is stored as <object>.
2019 static int store_array(stcxt_t *cxt, AV *av)
2022 I32 len = av_len(av) + 1;
2026 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2029 * Signal array by emitting SX_ARRAY, followed by the array length.
2034 TRACEME(("size = %d", len));
2037 * Now store each item recursively.
2040 for (i = 0; i < len; i++) {
2041 sav = av_fetch(av, i, 0);
2043 TRACEME(("(#%d) undef item", i));
2047 TRACEME(("(#%d) item", i));
2048 if ((ret = store(cxt, *sav))) /* Extra () for -Wall, grr... */
2052 TRACEME(("ok (array)"));
2061 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2064 sortcmp(const void *a, const void *b)
2066 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2073 * Store a hash table.
2075 * For a "normal" hash (not restricted, no utf8 keys):
2077 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2078 * Values are stored as <object>.
2079 * Keys are stored as <length> <data>, the <data> section being omitted
2082 * For a "fancy" hash (restricted or utf8 keys):
2084 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2086 * Values are stored as <object>.
2087 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2089 * Currently the only hash flag is "restriced"
2090 * Key flags are as for hv.h
2092 static int store_hash(stcxt_t *cxt, HV *hv)
2095 #ifdef HAS_RESTRICTED_HASHES
2104 int flagged_hash = ((SvREADONLY(hv)
2105 #ifdef HAS_HASH_KEY_FLAGS
2109 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2112 /* needs int cast for C++ compilers, doesn't it? */
2113 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2116 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2120 * Signal hash by emitting SX_HASH, followed by the table length.
2124 PUTMARK(SX_FLAG_HASH);
2125 PUTMARK(hash_flags);
2130 TRACEME(("size = %d", len));
2133 * Save possible iteration state via each() on that table.
2136 riter = HvRITER(hv);
2137 eiter = HvEITER(hv);
2141 * Now store each item recursively.
2143 * If canonical is defined to some true value then store each
2144 * key/value pair in sorted order otherwise the order is random.
2145 * Canonical order is irrelevant when a deep clone operation is performed.
2147 * Fetch the value from perl only once per store() operation, and only
2152 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2153 (cxt->canonical < 0 && (cxt->canonical =
2154 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2157 * Storing in order, sorted by key.
2158 * Run through the hash, building up an array of keys in a
2159 * mortal array, sort the array and then run through the
2165 /*av_extend (av, len);*/
2167 TRACEME(("using canonical order"));
2169 for (i = 0; i < len; i++) {
2170 #ifdef HAS_RESTRICTED_HASHES
2171 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2173 HE *he = hv_iternext(hv);
2175 SV *key = hv_iterkeysv(he);
2176 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2179 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
2181 for (i = 0; i < len; i++) {
2182 unsigned char flags;
2186 SV *key = av_shift(av);
2187 HE *he = hv_fetch_ent(hv, key, 0, 0);
2188 SV *val = HeVAL(he);
2190 return 1; /* Internal error, not I/O error */
2193 * Store value first.
2196 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2198 if ((ret = store(cxt, val))) /* Extra () for -Wall, grr... */
2203 * Keys are written after values to make sure retrieval
2204 * can be optimal in terms of memory usage, where keys are
2205 * read into a fixed unique buffer called kbuf.
2206 * See retrieve_hash() for details.
2209 /* Implementation of restricted hashes isn't nicely
2212 = (((hash_flags & SHV_RESTRICTED)
2214 ? SHV_K_LOCKED : 0);
2215 if (val == &PL_sv_placeholder)
2216 flags |= SHV_K_PLACEHOLDER;
2218 keyval = SvPV(key, keylen_tmp);
2219 keylen = keylen_tmp;
2220 #ifdef HAS_UTF8_HASHES
2221 /* If you build without optimisation on pre 5.6
2222 then nothing spots that SvUTF8(key) is always 0,
2223 so the block isn't optimised away, at which point
2224 the linker dislikes the reference to
2227 const char *keysave = keyval;
2228 bool is_utf8 = TRUE;
2230 /* Just casting the &klen to (STRLEN) won't work
2231 well if STRLEN and I32 are of different widths.
2233 keyval = (char*)bytes_from_utf8((U8*)keyval,
2237 /* If we were able to downgrade here, then than
2238 means that we have a key which only had chars
2239 0-255, but was utf8 encoded. */
2241 if (keyval != keysave) {
2242 keylen = keylen_tmp;
2243 flags |= SHV_K_WASUTF8;
2245 /* keylen_tmp can't have changed, so no need
2246 to assign back to keylen. */
2247 flags |= SHV_K_UTF8;
2254 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2256 /* This is a workaround for a bug in 5.8.0
2257 that causes the HEK_WASUTF8 flag to be
2258 set on an HEK without the hash being
2259 marked as having key flags. We just
2260 cross our fingers and drop the flag.
2262 assert (flags == 0 || flags == SHV_K_WASUTF8);
2263 TRACEME(("(#%d) key '%s'", i, keyval));
2267 WRITE(keyval, keylen);
2268 if (flags & SHV_K_WASUTF8)
2273 * Free up the temporary array
2282 * Storing in "random" order (in the order the keys are stored
2283 * within the hash). This is the default and will be faster!
2286 for (i = 0; i < len; i++) {
2289 unsigned char flags;
2290 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2291 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2293 HE *he = hv_iternext(hv);
2295 SV *val = (he ? hv_iterval(hv, he) : 0);
2300 return 1; /* Internal error, not I/O error */
2303 * Store value first.
2306 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2308 if ((ret = store(cxt, val))) /* Extra () for -Wall, grr... */
2311 /* Implementation of restricted hashes isn't nicely
2314 = (((hash_flags & SHV_RESTRICTED)
2316 ? SHV_K_LOCKED : 0);
2317 if (val == &PL_sv_placeholder)
2318 flags |= SHV_K_PLACEHOLDER;
2320 hek = HeKEY_hek(he);
2322 if (len == HEf_SVKEY) {
2323 /* This is somewhat sick, but the internal APIs are
2324 * such that XS code could put one of these in in
2326 * Maybe we should be capable of storing one if
2329 key_sv = HeKEY_sv(he);
2330 flags |= SHV_K_ISSV;
2332 /* Regular string key. */
2333 #ifdef HAS_HASH_KEY_FLAGS
2335 flags |= SHV_K_UTF8;
2336 if (HEK_WASUTF8(hek))
2337 flags |= SHV_K_WASUTF8;
2343 * Keys are written after values to make sure retrieval
2344 * can be optimal in terms of memory usage, where keys are
2345 * read into a fixed unique buffer called kbuf.
2346 * See retrieve_hash() for details.
2351 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2353 /* This is a workaround for a bug in 5.8.0
2354 that causes the HEK_WASUTF8 flag to be
2355 set on an HEK without the hash being
2356 marked as having key flags. We just
2357 cross our fingers and drop the flag.
2359 assert (flags == 0 || flags == SHV_K_WASUTF8);
2360 TRACEME(("(#%d) key '%s'", i, key));
2362 if (flags & SHV_K_ISSV) {
2372 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2375 HvRITER(hv) = riter; /* Restore hash iterator state */
2376 HvEITER(hv) = eiter;
2384 * Store a code reference.
2386 * Layout is SX_CODE <length> followed by a scalar containing the perl
2387 * source code of the code reference.
2389 static int store_code(stcxt_t *cxt, CV *cv)
2391 #if PERL_VERSION < 6
2393 * retrieve_code does not work with perl 5.005 or less
2395 return store_other(cxt, (SV*)cv);
2400 SV *text, *bdeparse;
2402 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2405 cxt->deparse == 0 ||
2406 (cxt->deparse < 0 && !(cxt->deparse =
2407 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2409 return store_other(cxt, (SV*)cv);
2413 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2414 * blessed code references.
2416 /* XXX sv_2mortal seems to be evil here. why? */
2417 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2423 * create the B::Deparse object
2427 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2429 count = call_method("new", G_SCALAR);
2432 CROAK(("Unexpected return value from B::Deparse::new\n"));
2436 * call the coderef2text method
2440 XPUSHs(bdeparse); /* XXX is this already mortal? */
2441 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2443 count = call_method("coderef2text", G_SCALAR);
2446 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2450 reallen = strlen(SvPV_nolen(text));
2453 * Empty code references or XS functions are deparsed as
2454 * "(prototype) ;" or ";".
2457 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2458 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2462 * Signal code by emitting SX_CODE.
2466 TRACEME(("size = %d", len));
2467 TRACEME(("code = %s", SvPV_nolen(text)));
2470 * Now store the source code.
2473 STORE_SCALAR(SvPV_nolen(text), len);
2478 TRACEME(("ok (code)"));
2487 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2488 * a special mark, followed by the underlying tied object. For instance, when
2489 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2490 * <hash object> stands for the serialization of the tied hash.
2492 static int store_tied(stcxt_t *cxt, SV *sv)
2497 int svt = SvTYPE(sv);
2500 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2503 * We have a small run-time penalty here because we chose to factorise
2504 * all tieds objects into the same routine, and not have a store_tied_hash,
2505 * a store_tied_array, etc...
2507 * Don't use a switch() statement, as most compilers don't optimize that
2508 * well for 2/3 values. An if() else if() cascade is just fine. We put
2509 * tied hashes first, as they are the most likely beasts.
2512 if (svt == SVt_PVHV) {
2513 TRACEME(("tied hash"));
2514 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2515 } else if (svt == SVt_PVAV) {
2516 TRACEME(("tied array"));
2517 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2519 TRACEME(("tied scalar"));
2520 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2524 if (!(mg = mg_find(sv, mtype)))
2525 CROAK(("No magic '%c' found while storing tied %s", mtype,
2526 (svt == SVt_PVHV) ? "hash" :
2527 (svt == SVt_PVAV) ? "array" : "scalar"));
2530 * The mg->mg_obj found by mg_find() above actually points to the
2531 * underlying tied Perl object implementation. For instance, if the
2532 * original SV was that of a tied array, then mg->mg_obj is an AV.
2534 * Note that we store the Perl object as-is. We don't call its FETCH
2535 * method along the way. At retrieval time, we won't call its STORE
2536 * method either, but the tieing magic will be re-installed. In itself,
2537 * that ensures that the tieing semantics are preserved since futher
2538 * accesses on the retrieved object will indeed call the magic methods...
2541 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2542 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2543 if ((ret = store(cxt, obj)))
2546 TRACEME(("ok (tied)"));
2554 * Stores a reference to an item within a tied structure:
2556 * . \$h{key}, stores both the (tied %h) object and 'key'.
2557 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2559 * Layout is therefore either:
2560 * SX_TIED_KEY <object> <key>
2561 * SX_TIED_IDX <object> <index>
2563 static int store_tied_item(stcxt_t *cxt, SV *sv)
2568 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2570 if (!(mg = mg_find(sv, 'p')))
2571 CROAK(("No magic 'p' found while storing reference to tied item"));
2574 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2578 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2579 PUTMARK(SX_TIED_KEY);
2580 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2582 if ((ret = store(cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2585 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2587 if ((ret = store(cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2590 I32 idx = mg->mg_len;
2592 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2593 PUTMARK(SX_TIED_IDX);
2594 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2596 if ((ret = store(cxt, mg->mg_obj))) /* Idem, for -Wall */
2599 TRACEME(("store_tied_item: storing IDX %d", idx));
2604 TRACEME(("ok (tied item)"));
2610 * store_hook -- dispatched manually, not via sv_store[]
2612 * The blessed SV is serialized by a hook.
2616 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2618 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2619 * the trailing part [] is present, the type of object (scalar, array or hash).
2620 * There is also a bit which says how the classname is stored between:
2625 * and when the <index> form is used (classname already seen), the "large
2626 * classname" bit in <flags> indicates how large the <index> is.
2628 * The serialized string returned by the hook is of length <len2> and comes
2629 * next. It is an opaque string for us.
2631 * Those <len3> object IDs which are listed last represent the extra references
2632 * not directly serialized by the hook, but which are linked to the object.
2634 * When recursion is mandated to resolve object-IDs not yet seen, we have
2635 * instead, with <header> being flags with bits set to indicate the object type
2636 * and that recursion was indeed needed:
2638 * SX_HOOK <header> <object> <header> <object> <flags>
2640 * that same header being repeated between serialized objects obtained through
2641 * recursion, until we reach flags indicating no recursion, at which point
2642 * we know we've resynchronized with a single layout, after <flags>.
2644 * When storing a blessed ref to a tied variable, the following format is
2647 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2649 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2650 * real object type is held in the <extra> flag. At the very end of the
2651 * serialization stream, the underlying magic object is serialized, just like
2652 * any other tied variable.
2654 static int store_hook(
2667 int count; /* really len3 + 1 */
2668 unsigned char flags;
2671 int recursed = 0; /* counts recursion */
2672 int obj_type; /* object type, on 2 bits */
2675 int clone = cxt->optype & ST_CLONE;
2676 char mtype = '\0'; /* for blessed ref to tied structures */
2677 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2679 TRACEME(("store_hook, class \"%s\", tagged #%d", HvNAME(pkg), cxt->tagnum));
2682 * Determine object type on 2 bits.
2687 obj_type = SHT_SCALAR;
2690 obj_type = SHT_ARRAY;
2693 obj_type = SHT_HASH;
2697 * Produced by a blessed ref to a tied data structure, $o in the
2698 * following Perl code.
2702 * my $o = bless \%h, 'BAR';
2704 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2705 * (since we have only 2 bits in <flags> to store the type), and an
2706 * <extra> byte flag will be emitted after the FIRST <flags> in the
2707 * stream, carrying what we put in `eflags'.
2709 obj_type = SHT_EXTRA;
2710 switch (SvTYPE(sv)) {
2712 eflags = (unsigned char) SHT_THASH;
2716 eflags = (unsigned char) SHT_TARRAY;
2720 eflags = (unsigned char) SHT_TSCALAR;
2726 CROAK(("Unexpected object type (%d) in store_hook()", type));
2728 flags = SHF_NEED_RECURSE | obj_type;
2730 class = HvNAME(pkg);
2731 len = strlen(class);
2734 * To call the hook, we need to fake a call like:
2736 * $object->STORABLE_freeze($cloning);
2738 * but we don't have the $object here. For instance, if $object is
2739 * a blessed array, what we have in `sv' is the array, and we can't
2740 * call a method on those.
2742 * Therefore, we need to create a temporary reference to the object and
2743 * make the call on that reference.
2746 TRACEME(("about to call STORABLE_freeze on class %s", class));
2748 ref = newRV_noinc(sv); /* Temporary reference */
2749 av = array_call(ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2751 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2753 count = AvFILLp(av) + 1;
2754 TRACEME(("store_hook, array holds %d items", count));
2757 * If they return an empty list, it means they wish to ignore the
2758 * hook for this class (and not just this instance -- that's for them
2759 * to handle if they so wish).
2761 * Simply disable the cached entry for the hook (it won't be recomputed
2762 * since it's present in the cache) and recurse to store_blessed().
2767 * They must not change their mind in the middle of a serialization.
2770 if (hv_fetch(cxt->hclass, class, len, FALSE))
2771 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2772 (cxt->optype & ST_CLONE) ? "cloning" : "storing", class));
2774 pkg_hide(cxt->hook, pkg, "STORABLE_freeze");
2776 ASSERT(!pkg_can(cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2777 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", class));
2779 return store_blessed(cxt, sv, type, pkg);
2783 * Get frozen string.
2787 pv = SvPV(ary[0], len2);
2790 * If they returned more than one item, we need to serialize some
2791 * extra references if not already done.
2793 * Loop over the array, starting at position #1, and for each item,
2794 * ensure it is a reference, serialize it if not already done, and
2795 * replace the entry with the tag ID of the corresponding serialized
2798 * We CHEAT by not calling av_fetch() and read directly within the
2802 for (i = 1; i < count; i++) {
2806 AV *av_hook = cxt->hook_seen;
2809 CROAK(("Item #%d returned by STORABLE_freeze "
2810 "for %s is not a reference", i, class));
2811 xsv = SvRV(rsv); /* Follow ref to know what to look for */
2814 * Look in hseen and see if we have a tag already.
2815 * Serialize entry if not done already, and get its tag.
2818 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
2819 goto sv_seen; /* Avoid moving code too far to the right */
2821 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
2824 * We need to recurse to store that object and get it to be known
2825 * so that we can resolve the list of object-IDs at retrieve time.
2827 * The first time we do this, we need to emit the proper header
2828 * indicating that we recursed, and what the type of object is (the
2829 * object we're storing via a user-hook). Indeed, during retrieval,
2830 * we'll have to create the object before recursing to retrieve the
2831 * others, in case those would point back at that object.
2834 /* [SX_HOOK] <flags> [<extra>] <object>*/
2838 if (obj_type == SHT_EXTRA)
2843 if ((ret = store(cxt, xsv))) /* Given by hook for us to store */
2846 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
2848 CROAK(("Could not serialize item #%d from hook in %s", i, class));
2851 * It was the first time we serialized `xsv'.
2853 * Keep this SV alive until the end of the serialization: if we
2854 * disposed of it right now by decrementing its refcount, and it was
2855 * a temporary value, some next temporary value allocated during
2856 * another STORABLE_freeze might take its place, and we'd wrongly
2857 * assume that new SV was already serialized, based on its presence
2860 * Therefore, push it away in cxt->hook_seen.
2863 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
2867 * Dispose of the REF they returned. If we saved the `xsv' away
2868 * in the array of returned SVs, that will not cause the underlying
2869 * referenced SV to be reclaimed.
2872 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
2873 SvREFCNT_dec(rsv); /* Dispose of reference */
2876 * Replace entry with its tag (not a real SV, so no refcnt increment)
2880 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
2881 i-1, PTR2UV(xsv), PTR2UV(*svh)));
2885 * Allocate a class ID if not already done.
2887 * This needs to be done after the recursion above, since at retrieval
2888 * time, we'll see the inner objects first. Many thanks to
2889 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
2890 * proposed the right fix. -- RAM, 15/09/2000
2893 if (!known_class(cxt, class, len, &classnum)) {
2894 TRACEME(("first time we see class %s, ID = %d", class, classnum));
2895 classnum = -1; /* Mark: we must store classname */
2897 TRACEME(("already seen class %s, ID = %d", class, classnum));
2901 * Compute leading flags.
2905 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
2906 flags |= SHF_LARGE_CLASSLEN;
2908 flags |= SHF_IDX_CLASSNAME;
2909 if (len2 > LG_SCALAR)
2910 flags |= SHF_LARGE_STRLEN;
2912 flags |= SHF_HAS_LIST;
2913 if (count > (LG_SCALAR + 1))
2914 flags |= SHF_LARGE_LISTLEN;
2917 * We're ready to emit either serialized form:
2919 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2920 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
2922 * If we recursed, the SX_HOOK has already been emitted.
2925 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
2926 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
2927 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
2929 /* SX_HOOK <flags> [<extra>] */
2933 if (obj_type == SHT_EXTRA)
2938 /* <len> <classname> or <index> */
2939 if (flags & SHF_IDX_CLASSNAME) {
2940 if (flags & SHF_LARGE_CLASSLEN)
2943 unsigned char cnum = (unsigned char) classnum;
2947 if (flags & SHF_LARGE_CLASSLEN)
2950 unsigned char clen = (unsigned char) len;
2953 WRITE(class, len); /* Final \0 is omitted */
2956 /* <len2> <frozen-str> */
2957 if (flags & SHF_LARGE_STRLEN) {
2958 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
2959 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
2961 unsigned char clen = (unsigned char) len2;
2965 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
2967 /* [<len3> <object-IDs>] */
2968 if (flags & SHF_HAS_LIST) {
2969 int len3 = count - 1;
2970 if (flags & SHF_LARGE_LISTLEN)
2973 unsigned char clen = (unsigned char) len3;
2978 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
2979 * real pointer, rather a tag number, well under the 32-bit limit.
2982 for (i = 1; i < count; i++) {
2983 I32 tagval = htonl(LOW_32BITS(ary[i]));
2985 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
2990 * Free the array. We need extra care for indices after 0, since they
2991 * don't hold real SVs but integers cast.
2995 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3000 * If object was tied, need to insert serialization of the magic object.
3003 if (obj_type == SHT_EXTRA) {
3006 if (!(mg = mg_find(sv, mtype))) {
3007 int svt = SvTYPE(sv);
3008 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3009 mtype, (svt == SVt_PVHV) ? "hash" :
3010 (svt == SVt_PVAV) ? "array" : "scalar"));
3013 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3014 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3020 if ((ret = store(cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3028 * store_blessed -- dispatched manually, not via sv_store[]
3030 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3031 * of its ancestors. If there is, then redispatch to store_hook();
3033 * Otherwise, the blessed SV is stored using the following layout:
3035 * SX_BLESS <flag> <len> <classname> <object>
3037 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3038 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3039 * Otherwise, the low order bits give the length, thereby giving a compact
3040 * representation for class names less than 127 chars long.
3042 * Each <classname> seen is remembered and indexed, so that the next time
3043 * an object in the blessed in the same <classname> is stored, the following
3046 * SX_IX_BLESS <flag> <index> <object>
3048 * where <index> is the classname index, stored on 0 or 4 bytes depending
3049 * on the high-order bit in flag (same encoding as above for <len>).
3051 static int store_blessed(
3062 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME(pkg)));
3065 * Look for a hook for this blessed SV and redirect to store_hook()
3069 hook = pkg_can(cxt->hook, pkg, "STORABLE_freeze");
3071 return store_hook(cxt, sv, type, pkg, hook);
3074 * This is a blessed SV without any serialization hook.
3077 class = HvNAME(pkg);
3078 len = strlen(class);
3080 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3081 PTR2UV(sv), class, cxt->tagnum));
3084 * Determine whether it is the first time we see that class name (in which
3085 * case it will be stored in the SX_BLESS form), or whether we already
3086 * saw that class name before (in which case the SX_IX_BLESS form will be
3090 if (known_class(cxt, class, len, &classnum)) {
3091 TRACEME(("already seen class %s, ID = %d", class, classnum));
3092 PUTMARK(SX_IX_BLESS);
3093 if (classnum <= LG_BLESS) {
3094 unsigned char cnum = (unsigned char) classnum;
3097 unsigned char flag = (unsigned char) 0x80;
3102 TRACEME(("first time we see class %s, ID = %d", class, classnum));
3104 if (len <= LG_BLESS) {
3105 unsigned char clen = (unsigned char) len;
3108 unsigned char flag = (unsigned char) 0x80;
3110 WLEN(len); /* Don't BER-encode, this should be rare */
3112 WRITE(class, len); /* Final \0 is omitted */
3116 * Now emit the <object> part.
3119 return SV_STORE(type)(cxt, sv);
3125 * We don't know how to store the item we reached, so return an error condition.
3126 * (it's probably a GLOB, some CODE reference, etc...)
3128 * If they defined the `forgive_me' variable at the Perl level to some
3129 * true value, then don't croak, just warn, and store a placeholder string
3132 static int store_other(stcxt_t *cxt, SV *sv)
3135 static char buf[80];
3137 TRACEME(("store_other"));
3140 * Fetch the value from perl only once per store() operation.
3144 cxt->forgive_me == 0 ||
3145 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3146 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3148 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3150 warn("Can't store item %s(0x%"UVxf")",
3151 sv_reftype(sv, FALSE), PTR2UV(sv));
3154 * Store placeholder string as a scalar instead...
3157 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3158 PTR2UV(sv), (char) 0);
3161 STORE_SCALAR(buf, len);
3162 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3168 *** Store driving routines
3174 * WARNING: partially duplicates Perl's sv_reftype for speed.
3176 * Returns the type of the SV, identified by an integer. That integer
3177 * may then be used to index the dynamic routine dispatch table.
3179 static int sv_type(SV *sv)
3181 switch (SvTYPE(sv)) {
3186 * No need to check for ROK, that can't be set here since there
3187 * is no field capable of hodling the xrv_rv reference.
3195 * Starting from SVt_PV, it is possible to have the ROK flag
3196 * set, the pointer to the other SV being either stored in
3197 * the xrv_rv (in the case of a pure SVt_RV), or as the
3198 * xpv_pv field of an SVt_PV and its heirs.
3200 * However, those SV cannot be magical or they would be an
3201 * SVt_PVMG at least.
3203 return SvROK(sv) ? svis_REF : svis_SCALAR;
3205 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3206 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3207 return svis_TIED_ITEM;
3210 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3212 return SvROK(sv) ? svis_REF : svis_SCALAR;
3214 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3218 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3233 * Recursively store objects pointed to by the sv to the specified file.
3235 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3236 * object (one for which storage has started -- it may not be over if we have
3237 * a self-referenced structure). This data set forms a stored <object>.
3239 static int store(stcxt_t *cxt, SV *sv)
3244 HV *hseen = cxt->hseen;
3246 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3249 * If object has already been stored, do not duplicate data.
3250 * Simply emit the SX_OBJECT marker followed by its tag data.
3251 * The tag is always written in network order.
3253 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3254 * real pointer, rather a tag number (watch the insertion code below).
3255 * That means it probably safe to assume it is well under the 32-bit limit,
3256 * and makes the truncation safe.
3257 * -- RAM, 14/09/1999
3260 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3262 I32 tagval = htonl(LOW_32BITS(*svh));
3264 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3272 * Allocate a new tag and associate it with the address of the sv being
3273 * stored, before recursing...
3275 * In order to avoid creating new SvIVs to hold the tagnum we just
3276 * cast the tagnum to an SV pointer and store that in the hash. This
3277 * means that we must clean up the hash manually afterwards, but gives
3278 * us a 15% throughput increase.
3283 if (!hv_store(hseen,
3284 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3288 * Store `sv' and everything beneath it, using appropriate routine.
3289 * Abort immediately if we get a non-zero status back.
3294 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3295 PTR2UV(sv), cxt->tagnum, type));
3298 HV *pkg = SvSTASH(sv);
3299 ret = store_blessed(cxt, sv, type, pkg);
3301 ret = SV_STORE(type)(cxt, sv);
3303 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3304 ret ? "FAILED" : "ok", PTR2UV(sv),
3305 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3313 * Write magic number and system information into the file.
3314 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3315 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3316 * All size and lenghts are written as single characters here.
3318 * Note that no byte ordering info is emitted when <network> is true, since
3319 * integers will be emitted in network order in that case.
3321 static int magic_write(stcxt_t *cxt)
3324 * Starting with 0.6, the "use_network_order" byte flag is also used to
3325 * indicate the version number of the binary image, encoded in the upper
3326 * bits. The bit 0 is always used to indicate network order.
3329 * Starting with 0.7, a full byte is dedicated to the minor version of
3330 * the binary format, which is incremented only when new markers are
3331 * introduced, for instance, but when backward compatibility is preserved.
3334 /* Make these at compile time. The WRITE() macro is sufficiently complex
3335 that it saves about 200 bytes doing it this way and only using it
3337 static const unsigned char network_file_header[] = {
3339 (STORABLE_BIN_MAJOR << 1) | 1,
3340 STORABLE_BIN_WRITE_MINOR
3342 static const unsigned char file_header[] = {
3344 (STORABLE_BIN_MAJOR << 1) | 0,
3345 STORABLE_BIN_WRITE_MINOR,
3346 /* sizeof the array includes the 0 byte at the end: */
3347 (char) sizeof (byteorderstr) - 1,
3349 (unsigned char) sizeof(int),
3350 (unsigned char) sizeof(long),
3351 (unsigned char) sizeof(char *),
3352 (unsigned char) sizeof(NV)
3354 #ifdef USE_56_INTERWORK_KLUDGE
3355 static const unsigned char file_header_56[] = {
3357 (STORABLE_BIN_MAJOR << 1) | 0,
3358 STORABLE_BIN_WRITE_MINOR,
3359 /* sizeof the array includes the 0 byte at the end: */
3360 (char) sizeof (byteorderstr_56) - 1,
3362 (unsigned char) sizeof(int),
3363 (unsigned char) sizeof(long),
3364 (unsigned char) sizeof(char *),
3365 (unsigned char) sizeof(NV)
3368 const unsigned char *header;
3371 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3373 if (cxt->netorder) {
3374 header = network_file_header;
3375 length = sizeof (network_file_header);
3377 #ifdef USE_56_INTERWORK_KLUDGE
3378 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3379 header = file_header_56;
3380 length = sizeof (file_header_56);
3384 header = file_header;
3385 length = sizeof (file_header);
3390 /* sizeof the array includes the 0 byte at the end. */
3391 header += sizeof (magicstr) - 1;
3392 length -= sizeof (magicstr) - 1;
3395 WRITE( (unsigned char*) header, length);
3397 if (!cxt->netorder) {
3398 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3399 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3400 (int) sizeof(int), (int) sizeof(long),
3401 (int) sizeof(char *), (int) sizeof(NV)));
3409 * Common code for store operations.
3411 * When memory store is requested (f = NULL) and a non null SV* is given in
3412 * `res', it is filled with a new SV created out of the memory buffer.
3414 * It is required to provide a non-null `res' when the operation type is not
3415 * dclone() and store() is performed to memory.
3417 static int do_store(
3427 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3428 ("must supply result SV pointer for real recursion to memory"));
3430 TRACEME(("do_store (optype=%d, netorder=%d)",
3431 optype, network_order));
3436 * Workaround for CROAK leak: if they enter with a "dirty" context,
3437 * free up memory for them now.
3444 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3445 * re-enter store() via the hooks. We need to stack contexts.
3449 cxt = allocate_context(cxt);
3453 ASSERT(cxt->entry == 1, ("starting new recursion"));
3454 ASSERT(!cxt->s_dirty, ("clean context"));
3457 * Ensure sv is actually a reference. From perl, we called something
3459 * pstore(FILE, \@array);
3460 * so we must get the scalar value behing that reference.
3464 CROAK(("Not a reference"));
3465 sv = SvRV(sv); /* So follow it to know what to store */
3468 * If we're going to store to memory, reset the buffer.
3475 * Prepare context and emit headers.
3478 init_store_context(cxt, f, optype, network_order);
3480 if (-1 == magic_write(cxt)) /* Emit magic and ILP info */
3481 return 0; /* Error */
3484 * Recursively store object...
3487 ASSERT(is_storing(), ("within store operation"));
3489 status = store(cxt, sv); /* Just do it! */
3492 * If they asked for a memory store and they provided an SV pointer,
3493 * make an SV string out of the buffer and fill their pointer.
3495 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3496 * an SV, since context cleanup might free the buffer if we did recurse.
3497 * (unless caller is dclone(), which is aware of that).
3500 if (!cxt->fio && res)
3506 * The "root" context is never freed, since it is meant to be always
3507 * handy for the common case where no recursion occurs at all (i.e.
3508 * we enter store() outside of any Storable code and leave it, period).
3509 * We know it's the "root" context because there's nothing stacked
3514 * When deep cloning, we don't free the context: doing so would force
3515 * us to copy the data in the memory buffer. Sicne we know we're
3516 * about to enter do_retrieve...
3519 clean_store_context(cxt);
3520 if (cxt->prev && !(cxt->optype & ST_CLONE))
3523 TRACEME(("do_store returns %d", status));
3531 * Store the transitive data closure of given object to disk.
3532 * Returns 0 on error, a true value otherwise.
3534 int pstore(PerlIO *f, SV *sv)
3536 TRACEME(("pstore"));
3537 return do_store(f, sv, 0, FALSE, (SV**) 0);
3544 * Same as pstore(), but network order is used for integers and doubles are
3545 * emitted as strings.
3547 int net_pstore(PerlIO *f, SV *sv)
3549 TRACEME(("net_pstore"));
3550 return do_store(f, sv, 0, TRUE, (SV**) 0);
3560 * Build a new SV out of the content of the internal memory buffer.
3562 static SV *mbuf2sv(void)
3566 return newSVpv(mbase, MBUF_SIZE());
3572 * Store the transitive data closure of given object to memory.
3573 * Returns undef on error, a scalar value containing the data otherwise.
3579 TRACEME(("mstore"));
3581 if (!do_store((PerlIO*) 0, sv, 0, FALSE, &out))
3582 return &PL_sv_undef;
3590 * Same as mstore(), but network order is used for integers and doubles are
3591 * emitted as strings.
3593 SV *net_mstore(SV *sv)
3597 TRACEME(("net_mstore"));
3599 if (!do_store((PerlIO*) 0, sv, 0, TRUE, &out))
3600 return &PL_sv_undef;
3606 *** Specific retrieve callbacks.
3612 * Return an error via croak, since it is not possible that we get here
3613 * under normal conditions, when facing a file produced via pstore().
3615 static SV *retrieve_other(stcxt_t *cxt, char *cname)
3618 cxt->ver_major != STORABLE_BIN_MAJOR &&
3619 cxt->ver_minor != STORABLE_BIN_MINOR
3621 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3622 cxt->fio ? "file" : "string",
3623 cxt->ver_major, cxt->ver_minor,
3624 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3626 CROAK(("Corrupted storable %s (binary v%d.%d)",
3627 cxt->fio ? "file" : "string",
3628 cxt->ver_major, cxt->ver_minor));
3631 return (SV *) 0; /* Just in case */
3635 * retrieve_idx_blessed
3637 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3638 * <index> can be coded on either 1 or 5 bytes.
3640 static SV *retrieve_idx_blessed(stcxt_t *cxt, char *cname)
3647 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3648 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3650 GETMARK(idx); /* Index coded on a single char? */
3655 * Fetch classname in `aclass'
3658 sva = av_fetch(cxt->aclass, idx, FALSE);
3660 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3662 class = SvPVX(*sva); /* We know it's a PV, by construction */
3664 TRACEME(("class ID %d => %s", idx, class));
3667 * Retrieve object and bless it.
3670 sv = retrieve(cxt, class); /* First SV which is SEEN will be blessed */
3678 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3679 * <len> can be coded on either 1 or 5 bytes.
3681 static SV *retrieve_blessed(stcxt_t *cxt, char *cname)
3685 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3688 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3689 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3692 * Decode class name length and read that name.
3694 * Short classnames have two advantages: their length is stored on one
3695 * single byte, and the string can be read on the stack.
3698 GETMARK(len); /* Length coded on a single char? */
3701 TRACEME(("** allocating %d bytes for class name", len+1));
3702 New(10003, class, len+1, char);
3705 class[len] = '\0'; /* Mark string end */
3708 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3711 TRACEME(("new class name \"%s\" will bear ID = %d", class, cxt->classnum));
3713 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
3717 * Retrieve object and bless it.
3720 sv = retrieve(cxt, class); /* First SV which is SEEN will be blessed */
3730 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3731 * with leading mark already read, as usual.
3733 * When recursion was involved during serialization of the object, there
3734 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
3735 * we reach a <flags> marker with the recursion bit cleared.
3737 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
3738 * is held in the <extra> byte, and if the object is tied, the serialized
3739 * magic object comes at the very end:
3741 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
3743 * This means the STORABLE_thaw hook will NOT get a tied variable during its
3744 * processing (since we won't have seen the magic object by the time the hook
3745 * is called). See comments below for why it was done that way.
3747 static SV *retrieve_hook(stcxt_t *cxt, char *cname)
3750 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3761 int clone = cxt->optype & ST_CLONE;
3763 unsigned int extra_type = 0;
3765 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
3766 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3769 * Read flags, which tell us about the type, and whether we need to recurse.
3775 * Create the (empty) object, and mark it as seen.
3777 * This must be done now, because tags are incremented, and during
3778 * serialization, the object tag was affected before recursion could
3782 obj_type = flags & SHF_TYPE_MASK;
3788 sv = (SV *) newAV();
3791 sv = (SV *) newHV();
3795 * Read <extra> flag to know the type of the object.
3796 * Record associated magic type for later.
3798 GETMARK(extra_type);
3799 switch (extra_type) {
3805 sv = (SV *) newAV();
3809 sv = (SV *) newHV();
3813 return retrieve_other(cxt, 0); /* Let it croak */
3817 return retrieve_other(cxt, 0); /* Let it croak */
3819 SEEN(sv, 0); /* Don't bless yet */
3822 * Whilst flags tell us to recurse, do so.
3824 * We don't need to remember the addresses returned by retrieval, because
3825 * all the references will be obtained through indirection via the object
3826 * tags in the object-ID list.
3828 * We need to decrement the reference count for these objects
3829 * because, if the user doesn't save a reference to them in the hook,
3830 * they must be freed when this context is cleaned.
3833 while (flags & SHF_NEED_RECURSE) {
3834 TRACEME(("retrieve_hook recursing..."));
3835 rv = retrieve(cxt, 0);
3839 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
3844 if (flags & SHF_IDX_CLASSNAME) {
3849 * Fetch index from `aclass'
3852 if (flags & SHF_LARGE_CLASSLEN)
3857 sva = av_fetch(cxt->aclass, idx, FALSE);
3859 CROAK(("Class name #%"IVdf" should have been seen already",
3862 class = SvPVX(*sva); /* We know it's a PV, by construction */
3863 TRACEME(("class ID %d => %s", idx, class));
3867 * Decode class name length and read that name.
3869 * NOTA BENE: even if the length is stored on one byte, we don't read
3870 * on the stack. Just like retrieve_blessed(), we limit the name to
3871 * LG_BLESS bytes. This is an arbitrary decision.
3874 if (flags & SHF_LARGE_CLASSLEN)
3879 if (len > LG_BLESS) {
3880 TRACEME(("** allocating %d bytes for class name", len+1));
3881 New(10003, class, len+1, char);
3885 class[len] = '\0'; /* Mark string end */
3888 * Record new classname.
3891 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
3895 TRACEME(("class name: %s", class));
3898 * Decode user-frozen string length and read it in an SV.
3900 * For efficiency reasons, we read data directly into the SV buffer.
3901 * To understand that code, read retrieve_scalar()
3904 if (flags & SHF_LARGE_STRLEN)
3909 frozen = NEWSV(10002, len2);
3911 SAFEREAD(SvPVX(frozen), len2, frozen);
3912 SvCUR_set(frozen, len2);
3913 *SvEND(frozen) = '\0';
3915 (void) SvPOK_only(frozen); /* Validates string pointer */
3916 if (cxt->s_tainted) /* Is input source tainted? */
3919 TRACEME(("frozen string: %d bytes", len2));
3922 * Decode object-ID list length, if present.
3925 if (flags & SHF_HAS_LIST) {
3926 if (flags & SHF_LARGE_LISTLEN)
3932 av_extend(av, len3 + 1); /* Leave room for [0] */
3933 AvFILLp(av) = len3; /* About to be filled anyway */
3937 TRACEME(("has %d object IDs to link", len3));
3940 * Read object-ID list into array.
3941 * Because we pre-extended it, we can cheat and fill it manually.
3943 * We read object tags and we can convert them into SV* on the fly
3944 * because we know all the references listed in there (as tags)
3945 * have been already serialized, hence we have a valid correspondance
3946 * between each of those tags and the recreated SV.
3950 SV **ary = AvARRAY(av);
3952 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
3959 svh = av_fetch(cxt->aseen, tag, FALSE);
3961 CROAK(("Object #%"IVdf" should have been retrieved already",
3964 ary[i] = SvREFCNT_inc(xsv);
3969 * Bless the object and look up the STORABLE_thaw hook.
3973 hook = pkg_can(cxt->hook, SvSTASH(sv), "STORABLE_thaw");
3976 * Hook not found. Maybe they did not require the module where this
3977 * hook is defined yet?
3979 * If the require below succeeds, we'll be able to find the hook.
3980 * Still, it only works reliably when each class is defined in a
3984 SV *psv = newSVpvn("require ", 8);
3985 sv_catpv(psv, class);
3987 TRACEME(("No STORABLE_thaw defined for objects of class %s", class));
3988 TRACEME(("Going to require module '%s' with '%s'", class, SvPVX(psv)));
3990 perl_eval_sv(psv, G_DISCARD);
3994 * We cache results of pkg_can, so we need to uncache before attempting
3998 pkg_uncache(cxt->hook, SvSTASH(sv), "STORABLE_thaw");
3999 hook = pkg_can(cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4002 CROAK(("No STORABLE_thaw defined for objects of class %s "
4003 "(even after a \"require %s;\")", class, class));
4007 * If we don't have an `av' yet, prepare one.
4008 * Then insert the frozen string as item [0].
4016 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4021 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4023 * where $object is our blessed (empty) object, $cloning is a boolean
4024 * telling whether we're running a deep clone, $frozen is the frozen
4025 * string the user gave us in his serializing hook, and @refs, which may
4026 * be empty, is the list of extra references he returned along for us
4029 * In effect, the hook is an alternate creation routine for the class,
4030 * the object itself being already created by the runtime.
4033 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4034 class, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4037 (void) scalar_call(rv, hook, clone, av, G_SCALAR|G_DISCARD);
4044 SvREFCNT_dec(frozen);
4047 if (!(flags & SHF_IDX_CLASSNAME) && class != buf)
4051 * If we had an <extra> type, then the object was not as simple, and
4052 * we need to restore extra magic now.
4058 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4060 rv = retrieve(cxt, 0); /* Retrieve <magic object> */
4062 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4063 PTR2UV(rv), PTR2UV(sv)));
4065 switch (extra_type) {
4067 sv_upgrade(sv, SVt_PVMG);
4070 sv_upgrade(sv, SVt_PVAV);
4071 AvREAL_off((AV *)sv);
4074 sv_upgrade(sv, SVt_PVHV);
4077 CROAK(("Forgot to deal with extra type %d", extra_type));
4082 * Adding the magic only now, well after the STORABLE_thaw hook was called
4083 * means the hook cannot know it deals with an object whose variable is
4084 * tied. But this is happening when retrieving $o in the following case:
4088 * my $o = bless \%h, 'BAR';
4090 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4091 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4092 * hash but a tied one should not matter at all, and remain transparent.
4093 * This means the magic must be restored by Storable AFTER the hook is
4096 * That looks very reasonable to me, but then I've come up with this
4097 * after a bug report from David Nesting, who was trying to store such
4098 * an object and caused Storable to fail. And unfortunately, it was
4099 * also the easiest way to retrofit support for blessed ref to tied objects
4100 * into the existing design. -- RAM, 17/02/2001
4103 sv_magic(sv, rv, mtype, Nullch, 0);
4104 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4112 * Retrieve reference to some other scalar.
4113 * Layout is SX_REF <object>, with SX_REF already read.
4115 static SV *retrieve_ref(stcxt_t *cxt, char *cname)
4120 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4123 * We need to create the SV that holds the reference to the yet-to-retrieve
4124 * object now, so that we may record the address in the seen table.
4125 * Otherwise, if the object to retrieve references us, we won't be able
4126 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4127 * do the retrieve first and use rv = newRV(sv) since it will be too late
4128 * for SEEN() recording.
4131 rv = NEWSV(10002, 0);
4132 SEEN(rv, cname); /* Will return if rv is null */
4133 sv = retrieve(cxt, 0); /* Retrieve <object> */
4135 return (SV *) 0; /* Failed */
4138 * WARNING: breaks RV encapsulation.
4140 * Now for the tricky part. We have to upgrade our existing SV, so that
4141 * it is now an RV on sv... Again, we cheat by duplicating the code
4142 * held in newSVrv(), since we already got our SV from retrieve().
4146 * SvRV(rv) = SvREFCNT_inc(sv);
4148 * here because the reference count we got from retrieve() above is
4149 * already correct: if the object was retrieved from the file, then
4150 * its reference count is one. Otherwise, if it was retrieved via
4151 * an SX_OBJECT indication, a ref count increment was done.
4155 /* Do not use sv_upgrade to preserve STASH */
4156 SvFLAGS(rv) &= ~SVTYPEMASK;
4157 SvFLAGS(rv) |= SVt_RV;
4159 sv_upgrade(rv, SVt_RV);
4162 SvRV(rv) = sv; /* $rv = \$sv */
4165 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4171 * retrieve_overloaded
4173 * Retrieve reference to some other scalar with overloading.
4174 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4176 static SV *retrieve_overloaded(stcxt_t *cxt, char *cname)
4182 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4185 * Same code as retrieve_ref(), duplicated to avoid extra call.
4188 rv = NEWSV(10002, 0);
4189 SEEN(rv, cname); /* Will return if rv is null */
4190 sv = retrieve(cxt, 0); /* Retrieve <object> */
4192 return (SV *) 0; /* Failed */
4195 * WARNING: breaks RV encapsulation.
4198 sv_upgrade(rv, SVt_RV);
4199 SvRV(rv) = sv; /* $rv = \$sv */
4203 * Restore overloading magic.
4206 stash = (HV *) SvSTASH (sv);
4207 if (!stash || !Gv_AMG(stash))
4208 CROAK(("Cannot restore overloading on %s(0x%"UVxf") (package %s)",
4209 sv_reftype(sv, FALSE),
4211 stash ? HvNAME(stash) : "<unknown>"));
4215 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4221 * retrieve_tied_array
4223 * Retrieve tied array
4224 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4226 static SV *retrieve_tied_array(stcxt_t *cxt, char *cname)
4231 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4233 tv = NEWSV(10002, 0);
4234 SEEN(tv, cname); /* Will return if tv is null */
4235 sv = retrieve(cxt, 0); /* Retrieve <object> */
4237 return (SV *) 0; /* Failed */
4239 sv_upgrade(tv, SVt_PVAV);
4240 AvREAL_off((AV *)tv);
4241 sv_magic(tv, sv, 'P', Nullch, 0);
4242 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4244 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4250 * retrieve_tied_hash
4252 * Retrieve tied hash
4253 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4255 static SV *retrieve_tied_hash(stcxt_t *cxt, char *cname)
4260 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4262 tv = NEWSV(10002, 0);
4263 SEEN(tv, cname); /* Will return if tv is null */
4264 sv = retrieve(cxt, 0); /* Retrieve <object> */
4266 return (SV *) 0; /* Failed */
4268 sv_upgrade(tv, SVt_PVHV);
4269 sv_magic(tv, sv, 'P', Nullch, 0);
4270 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4272 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4278 * retrieve_tied_scalar
4280 * Retrieve tied scalar
4281 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4283 static SV *retrieve_tied_scalar(stcxt_t *cxt, char *cname)
4286 SV *sv, *obj = NULL;
4288 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4290 tv = NEWSV(10002, 0);
4291 SEEN(tv, cname); /* Will return if rv is null */
4292 sv = retrieve(cxt, 0); /* Retrieve <object> */
4294 return (SV *) 0; /* Failed */
4296 else if (SvTYPE(sv) != SVt_NULL) {
4300 sv_upgrade(tv, SVt_PVMG);
4301 sv_magic(tv, obj, 'q', Nullch, 0);
4304 /* Undo refcnt inc from sv_magic() */
4308 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4316 * Retrieve reference to value in a tied hash.
4317 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4319 static SV *retrieve_tied_key(stcxt_t *cxt, char *cname)
4325 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4327 tv = NEWSV(10002, 0);
4328 SEEN(tv, cname); /* Will return if tv is null */
4329 sv = retrieve(cxt, 0); /* Retrieve <object> */
4331 return (SV *) 0; /* Failed */
4333 key = retrieve(cxt, 0); /* Retrieve <key> */
4335 return (SV *) 0; /* Failed */
4337 sv_upgrade(tv, SVt_PVMG);
4338 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4339 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4340 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4348 * Retrieve reference to value in a tied array.
4349 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4351 static SV *retrieve_tied_idx(stcxt_t *cxt, char *cname)
4357 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4359 tv = NEWSV(10002, 0);
4360 SEEN(tv, cname); /* Will return if tv is null */
4361 sv = retrieve(cxt, 0); /* Retrieve <object> */
4363 return (SV *) 0; /* Failed */
4365 RLEN(idx); /* Retrieve <idx> */
4367 sv_upgrade(tv, SVt_PVMG);
4368 sv_magic(tv, sv, 'p', Nullch, idx);
4369 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4378 * Retrieve defined long (string) scalar.
4380 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4381 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4382 * was not stored on a single byte.
4384 static SV *retrieve_lscalar(stcxt_t *cxt, char *cname)
4390 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4393 * Allocate an empty scalar of the suitable length.
4396 sv = NEWSV(10002, len);
4397 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4400 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4402 * Now, for efficiency reasons, read data directly inside the SV buffer,
4403 * and perform the SV final settings directly by duplicating the final
4404 * work done by sv_setpv. Since we're going to allocate lots of scalars
4405 * this way, it's worth the hassle and risk.
4408 SAFEREAD(SvPVX(sv), len, sv);
4409 SvCUR_set(sv, len); /* Record C string length */
4410 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4411 (void) SvPOK_only(sv); /* Validate string pointer */
4412 if (cxt->s_tainted) /* Is input source tainted? */
4413 SvTAINT(sv); /* External data cannot be trusted */
4415 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4416 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4424 * Retrieve defined short (string) scalar.
4426 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4427 * The scalar is "short" so <length> is single byte. If it is 0, there
4428 * is no <data> section.
4430 static SV *retrieve_scalar(stcxt_t *cxt, char *cname)
4436 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4439 * Allocate an empty scalar of the suitable length.
4442 sv = NEWSV(10002, len);
4443 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4446 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4451 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4452 * To make it defined with an empty length, upgrade it now...
4453 * Don't upgrade to a PV if the original type contains more
4454 * information than a scalar.
4456 if (SvTYPE(sv) <= SVt_PV) {
4457 sv_upgrade(sv, SVt_PV);
4460 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4461 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4464 * Now, for efficiency reasons, read data directly inside the SV buffer,
4465 * and perform the SV final settings directly by duplicating the final
4466 * work done by sv_setpv. Since we're going to allocate lots of scalars
4467 * this way, it's worth the hassle and risk.
4469 SAFEREAD(SvPVX(sv), len, sv);
4470 SvCUR_set(sv, len); /* Record C string length */
4471 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4472 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4475 (void) SvPOK_only(sv); /* Validate string pointer */
4476 if (cxt->s_tainted) /* Is input source tainted? */
4477 SvTAINT(sv); /* External data cannot be trusted */
4479 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4486 * Like retrieve_scalar(), but tag result as utf8.
4487 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4489 static SV *retrieve_utf8str(stcxt_t *cxt, char *cname)
4493 TRACEME(("retrieve_utf8str"));
4495 sv = retrieve_scalar(cxt, cname);
4497 #ifdef HAS_UTF8_SCALARS
4500 if (cxt->use_bytes < 0)
4502 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4504 if (cxt->use_bytes == 0)
4515 * Like retrieve_lscalar(), but tag result as utf8.
4516 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4518 static SV *retrieve_lutf8str(stcxt_t *cxt, char *cname)
4522 TRACEME(("retrieve_lutf8str"));
4524 sv = retrieve_lscalar(cxt, cname);
4526 #ifdef HAS_UTF8_SCALARS
4529 if (cxt->use_bytes < 0)
4531 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4533 if (cxt->use_bytes == 0)
4543 * Retrieve defined integer.
4544 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4546 static SV *retrieve_integer(stcxt_t *cxt, char *cname)
4551 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4553 READ(&iv, sizeof(iv));
4555 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4557 TRACEME(("integer %"IVdf, iv));
4558 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4566 * Retrieve defined integer in network order.
4567 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4569 static SV *retrieve_netint(stcxt_t *cxt, char *cname)
4574 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4578 sv = newSViv((int) ntohl(iv));
4579 TRACEME(("network integer %d", (int) ntohl(iv)));
4582 TRACEME(("network integer (as-is) %d", iv));
4584 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4586 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
4594 * Retrieve defined double.
4595 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
4597 static SV *retrieve_double(stcxt_t *cxt, char *cname)
4602 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
4604 READ(&nv, sizeof(nv));
4606 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4608 TRACEME(("double %"NVff, nv));
4609 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
4617 * Retrieve defined byte (small integer within the [-128, +127] range).
4618 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
4620 static SV *retrieve_byte(stcxt_t *cxt, char *cname)
4624 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
4626 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
4629 TRACEME(("small integer read as %d", (unsigned char) siv));
4630 tmp = (unsigned char) siv - 128;
4632 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4634 TRACEME(("byte %d", tmp));
4635 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
4643 * Return the undefined value.
4645 static SV *retrieve_undef(stcxt_t *cxt, char *cname)
4649 TRACEME(("retrieve_undef"));
4660 * Return the immortal undefined value.
4662 static SV *retrieve_sv_undef(stcxt_t *cxt, char *cname)
4664 SV *sv = &PL_sv_undef;
4666 TRACEME(("retrieve_sv_undef"));
4675 * Return the immortal yes value.
4677 static SV *retrieve_sv_yes(stcxt_t *cxt, char *cname)
4679 SV *sv = &PL_sv_yes;
4681 TRACEME(("retrieve_sv_yes"));
4690 * Return the immortal no value.
4692 static SV *retrieve_sv_no(stcxt_t *cxt, char *cname)
4696 TRACEME(("retrieve_sv_no"));
4705 * Retrieve a whole array.
4706 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
4707 * Each item is stored as <object>.
4709 * When we come here, SX_ARRAY has been read already.
4711 static SV *retrieve_array(stcxt_t *cxt, char *cname)
4718 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
4721 * Read length, and allocate array, then pre-extend it.
4725 TRACEME(("size = %d", len));
4727 SEEN(av, cname); /* Will return if array not allocated nicely */
4731 return (SV *) av; /* No data follow if array is empty */
4734 * Now get each item in turn...
4737 for (i = 0; i < len; i++) {
4738 TRACEME(("(#%d) item", i));
4739 sv = retrieve(cxt, 0); /* Retrieve item */
4742 if (av_store(av, i, sv) == 0)
4746 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
4754 * Retrieve a whole hash table.
4755 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4756 * Keys are stored as <length> <data>, the <data> section being omitted
4758 * Values are stored as <object>.
4760 * When we come here, SX_HASH has been read already.
4762 static SV *retrieve_hash(stcxt_t *cxt, char *cname)
4770 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
4773 * Read length, allocate table.
4777 TRACEME(("size = %d", len));
4779 SEEN(hv, cname); /* Will return if table not allocated properly */
4781 return (SV *) hv; /* No data follow if table empty */
4782 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
4785 * Now get each key/value pair in turn...
4788 for (i = 0; i < len; i++) {
4793 TRACEME(("(#%d) value", i));
4794 sv = retrieve(cxt, 0);
4800 * Since we're reading into kbuf, we must ensure we're not
4801 * recursing between the read and the hv_store() where it's used.
4802 * Hence the key comes after the value.
4805 RLEN(size); /* Get key size */
4806 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
4809 kbuf[size] = '\0'; /* Mark string end, just in case */
4810 TRACEME(("(#%d) key '%s'", i, kbuf));
4813 * Enter key/value pair into hash table.
4816 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
4820 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
4828 * Retrieve a whole hash table.
4829 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4830 * Keys are stored as <length> <data>, the <data> section being omitted
4832 * Values are stored as <object>.
4834 * When we come here, SX_HASH has been read already.
4836 static SV *retrieve_flag_hash(stcxt_t *cxt, char *cname)
4845 GETMARK(hash_flags);
4846 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
4848 * Read length, allocate table.
4851 #ifndef HAS_RESTRICTED_HASHES
4852 if (hash_flags & SHV_RESTRICTED) {
4853 if (cxt->derestrict < 0)
4855 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
4857 if (cxt->derestrict == 0)
4858 RESTRICTED_HASH_CROAK();
4863 TRACEME(("size = %d, flags = %d", len, hash_flags));
4865 SEEN(hv, cname); /* Will return if table not allocated properly */
4867 return (SV *) hv; /* No data follow if table empty */
4868 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
4871 * Now get each key/value pair in turn...
4874 for (i = 0; i < len; i++) {
4876 int store_flags = 0;
4881 TRACEME(("(#%d) value", i));
4882 sv = retrieve(cxt, 0);
4887 #ifdef HAS_RESTRICTED_HASHES
4888 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
4892 if (flags & SHV_K_ISSV) {
4893 /* XXX you can't set a placeholder with an SV key.
4894 Then again, you can't get an SV key.
4895 Without messing around beyond what the API is supposed to do.
4898 TRACEME(("(#%d) keysv, flags=%d", i, flags));
4899 keysv = retrieve(cxt, 0);
4903 if (!hv_store_ent(hv, keysv, sv, 0))
4908 * Since we're reading into kbuf, we must ensure we're not
4909 * recursing between the read and the hv_store() where it's used.
4910 * Hence the key comes after the value.
4913 if (flags & SHV_K_PLACEHOLDER) {
4915 sv = &PL_sv_placeholder;
4916 store_flags |= HVhek_PLACEHOLD;
4918 if (flags & SHV_K_UTF8) {
4919 #ifdef HAS_UTF8_HASHES
4920 store_flags |= HVhek_UTF8;
4922 if (cxt->use_bytes < 0)
4924 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4926 if (cxt->use_bytes == 0)
4930 #ifdef HAS_UTF8_HASHES
4931 if (flags & SHV_K_WASUTF8)
4932 store_flags |= HVhek_WASUTF8;
4935 RLEN(size); /* Get key size */
4936 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
4939 kbuf[size] = '\0'; /* Mark string end, just in case */
4940 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
4941 flags, store_flags));
4944 * Enter key/value pair into hash table.
4947 #ifdef HAS_RESTRICTED_HASHES
4948 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
4951 if (!(store_flags & HVhek_PLACEHOLD))
4952 if (hv_store(hv, kbuf, size, sv, 0) == 0)
4957 #ifdef HAS_RESTRICTED_HASHES
4958 if (hash_flags & SHV_RESTRICTED)
4962 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
4970 * Return a code reference.
4972 static SV *retrieve_code(stcxt_t *cxt, char *cname)
4974 #if PERL_VERSION < 6
4975 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
4980 SV *sv, *text, *sub;
4982 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
4985 * Retrieve the source of the code reference
4986 * as a small or large scalar
4992 text = retrieve_scalar(cxt, cname);
4995 text = retrieve_lscalar(cxt, cname);
4998 CROAK(("Unexpected type %d in retrieve_code\n", type));
5002 * prepend "sub " to the source
5005 sub = newSVpvn("sub ", 4);
5006 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5010 * evaluate the source to a code reference and use the CV value
5013 if (cxt->eval == NULL) {
5014 cxt->eval = perl_get_sv("Storable::Eval", TRUE);
5015 SvREFCNT_inc(cxt->eval);
5017 if (!SvTRUE(cxt->eval)) {
5019 cxt->forgive_me == 0 ||
5020 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5021 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
5023 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5033 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5034 SV* errsv = get_sv("@", TRUE);
5035 sv_setpv(errsv, ""); /* clear $@ */
5037 XPUSHs(sv_2mortal(newSVsv(sub)));
5039 count = call_sv(cxt->eval, G_SCALAR);
5042 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5044 if (SvTRUE(errsv)) {
5045 CROAK(("code %s caused an error: %s",
5046 SvPV_nolen(sub), SvPV_nolen(errsv)));
5050 cv = eval_pv(SvPV_nolen(sub), TRUE);
5052 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5055 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5058 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5070 * old_retrieve_array
5072 * Retrieve a whole array in pre-0.6 binary format.
5074 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5075 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5077 * When we come here, SX_ARRAY has been read already.
5079 static SV *old_retrieve_array(stcxt_t *cxt, char *cname)
5087 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5090 * Read length, and allocate array, then pre-extend it.
5094 TRACEME(("size = %d", len));
5096 SEEN(av, 0); /* Will return if array not allocated nicely */
5100 return (SV *) av; /* No data follow if array is empty */
5103 * Now get each item in turn...
5106 for (i = 0; i < len; i++) {
5108 if (c == SX_IT_UNDEF) {
5109 TRACEME(("(#%d) undef item", i));
5110 continue; /* av_extend() already filled us with undef */
5113 (void) retrieve_other((stcxt_t *) 0, 0); /* Will croak out */
5114 TRACEME(("(#%d) item", i));
5115 sv = retrieve(cxt, 0); /* Retrieve item */
5118 if (av_store(av, i, sv) == 0)
5122 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5130 * Retrieve a whole hash table in pre-0.6 binary format.
5132 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5133 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5135 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5137 * When we come here, SX_HASH has been read already.
5139 static SV *old_retrieve_hash(stcxt_t *cxt, char *cname)
5147 static SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5149 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5152 * Read length, allocate table.
5156 TRACEME(("size = %d", len));
5158 SEEN(hv, 0); /* Will return if table not allocated properly */
5160 return (SV *) hv; /* No data follow if table empty */
5161 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5164 * Now get each key/value pair in turn...
5167 for (i = 0; i < len; i++) {
5173 if (c == SX_VL_UNDEF) {
5174 TRACEME(("(#%d) undef value", i));
5176 * Due to a bug in hv_store(), it's not possible to pass
5177 * &PL_sv_undef to hv_store() as a value, otherwise the
5178 * associated key will not be creatable any more. -- RAM, 14/01/97
5181 sv_h_undef = newSVsv(&PL_sv_undef);
5182 sv = SvREFCNT_inc(sv_h_undef);
5183 } else if (c == SX_VALUE) {
5184 TRACEME(("(#%d) value", i));
5185 sv = retrieve(cxt, 0);
5189 (void) retrieve_other((stcxt_t *) 0, 0); /* Will croak out */
5193 * Since we're reading into kbuf, we must ensure we're not
5194 * recursing between the read and the hv_store() where it's used.
5195 * Hence the key comes after the value.
5200 (void) retrieve_other((stcxt_t *) 0, 0); /* Will croak out */
5201 RLEN(size); /* Get key size */
5202 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5205 kbuf[size] = '\0'; /* Mark string end, just in case */
5206 TRACEME(("(#%d) key '%s'", i, kbuf));
5209 * Enter key/value pair into hash table.
5212 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5216 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5222 *** Retrieval engine.
5228 * Make sure the stored data we're trying to retrieve has been produced
5229 * on an ILP compatible system with the same byteorder. It croaks out in
5230 * case an error is detected. [ILP = integer-long-pointer sizes]
5231 * Returns null if error is detected, &PL_sv_undef otherwise.
5233 * Note that there's no byte ordering info emitted when network order was
5234 * used at store time.
5236 static SV *magic_check(stcxt_t *cxt)
5238 /* The worst case for a malicious header would be old magic (which is
5239 longer), major, minor, byteorder length byte of 255, 255 bytes of
5240 garbage, sizeof int, long, pointer, NV.
5241 So the worse of that we can read is 255 bytes of garbage plus 4.
5242 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5243 compiling perl on a system with chars that are larger than 8 bits.
5244 (Even Crays aren't *that* perverse).
5246 unsigned char buf[4 + 255];
5247 unsigned char *current;
5250 int use_network_order;
5253 int version_minor = 0;
5255 TRACEME(("magic_check"));
5258 * The "magic number" is only for files, not when freezing in memory.
5262 /* This includes the '\0' at the end. I want to read the extra byte,
5263 which is usually going to be the major version number. */
5264 STRLEN len = sizeof(magicstr);
5267 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5269 /* Point at the byte after the byte we read. */
5270 current = buf + --len; /* Do the -- outside of macros. */
5272 if (memNE(buf, magicstr, len)) {
5274 * Try to read more bytes to check for the old magic number, which
5278 TRACEME(("trying for old magic number"));
5280 old_len = sizeof(old_magicstr) - 1;
5281 READ(current + 1, (SSize_t)(old_len - len));
5283 if (memNE(buf, old_magicstr, old_len))
5284 CROAK(("File is not a perl storable"));
5285 current = buf + old_len;
5287 use_network_order = *current;
5289 GETMARK(use_network_order);
5292 * Starting with 0.6, the "use_network_order" byte flag is also used to
5293 * indicate the version number of the binary, and therefore governs the
5294 * setting of sv_retrieve_vtbl. See magic_write().
5297 version_major = use_network_order >> 1;
5298 cxt->retrieve_vtbl = version_major ? sv_retrieve : sv_old_retrieve;
5300 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5304 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5305 * minor version of the protocol. See magic_write().
5308 if (version_major > 1)
5309 GETMARK(version_minor);
5311 cxt->ver_major = version_major;
5312 cxt->ver_minor = version_minor;
5314 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5317 * Inter-operability sanity check: we can't retrieve something stored
5318 * using a format more recent than ours, because we have no way to
5319 * know what has changed, and letting retrieval go would mean a probable
5320 * failure reporting a "corrupted" storable file.
5324 version_major > STORABLE_BIN_MAJOR ||
5325 (version_major == STORABLE_BIN_MAJOR &&
5326 version_minor > STORABLE_BIN_MINOR)
5329 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5330 STORABLE_BIN_MINOR));
5332 if (version_major == STORABLE_BIN_MAJOR) {
5333 TRACEME(("cxt->accept_future_minor is %d",
5334 cxt->accept_future_minor));
5335 if (cxt->accept_future_minor < 0)
5336 cxt->accept_future_minor
5337 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5340 if (cxt->accept_future_minor == 1)
5341 croak_now = 0; /* Don't croak yet. */
5344 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5345 version_major, version_minor,
5346 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5351 * If they stored using network order, there's no byte ordering
5352 * information to check.
5355 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5356 return &PL_sv_undef; /* No byte ordering info */
5358 /* In C truth is 1, falsehood is 0. Very convienient. */
5359 use_NV_size = version_major >= 2 && version_minor >= 2;
5362 length = c + 3 + use_NV_size;
5363 READ(buf, length); /* Not null-terminated */
5365 TRACEME(("byte order '%.*s' %d", c, buf, c));
5367 #ifdef USE_56_INTERWORK_KLUDGE
5368 /* No point in caching this in the context as we only need it once per
5369 retrieve, and we need to recheck it each read. */
5370 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5371 if ((c != (sizeof (byteorderstr_56) - 1))
5372 || memNE(buf, byteorderstr_56, c))
5373 CROAK(("Byte order is not compatible"));
5377 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5378 CROAK(("Byte order is not compatible"));
5384 if ((int) *current++ != sizeof(int))
5385 CROAK(("Integer size is not compatible"));
5388 if ((int) *current++ != sizeof(long))
5389 CROAK(("Long integer size is not compatible"));
5391 /* sizeof(char *) */
5392 if ((int) *current != sizeof(char *))
5393 CROAK(("Pointer size is not compatible"));
5397 if ((int) *++current != sizeof(NV))
5398 CROAK(("Double size is not compatible"));
5401 return &PL_sv_undef; /* OK */
5407 * Recursively retrieve objects from the specified file and return their
5408 * root SV (which may be an AV or an HV for what we care).
5409 * Returns null if there is a problem.
5411 static SV *retrieve(stcxt_t *cxt, char *cname)
5417 TRACEME(("retrieve"));
5420 * Grab address tag which identifies the object if we are retrieving
5421 * an older format. Since the new binary format counts objects and no
5422 * longer explicitely tags them, we must keep track of the correspondance
5425 * The following section will disappear one day when the old format is
5426 * no longer supported, hence the final "goto" in the "if" block.
5429 if (cxt->hseen) { /* Retrieving old binary */
5431 if (cxt->netorder) {
5433 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5434 tag = (stag_t) nettag;
5436 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5439 if (type == SX_OBJECT) {
5441 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5443 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5445 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5448 * The following code is common with the SX_OBJECT case below.
5451 svh = av_fetch(cxt->aseen, tagn, FALSE);
5453 CROAK(("Object #%"IVdf" should have been retrieved already",
5456 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5457 SvREFCNT_inc(sv); /* One more reference to this same sv */
5458 return sv; /* The SV pointer where object was retrieved */
5462 * Map new object, but don't increase tagnum. This will be done
5463 * by each of the retrieve_* functions when they call SEEN().
5465 * The mapping associates the "tag" initially present with a unique
5466 * tag number. See test for SX_OBJECT above to see how this is perused.
5469 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5470 newSViv(cxt->tagnum), 0))
5477 * Regular post-0.6 binary format.
5482 TRACEME(("retrieve type = %d", type));
5485 * Are we dealing with an object we should have already retrieved?
5488 if (type == SX_OBJECT) {
5492 svh = av_fetch(cxt->aseen, tag, FALSE);
5494 CROAK(("Object #%"IVdf" should have been retrieved already",
5497 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5498 SvREFCNT_inc(sv); /* One more reference to this same sv */
5499 return sv; /* The SV pointer where object was retrieved */
5500 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5501 if (cxt->accept_future_minor < 0)
5502 cxt->accept_future_minor
5503 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5506 if (cxt->accept_future_minor == 1) {
5507 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5508 "This Storable is v%d.%d and can only handle data types up to %d",
5509 cxt->ver_major, cxt->ver_minor, type,
5510 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5514 first_time: /* Will disappear when support for old format is dropped */
5517 * Okay, first time through for this one.
5520 sv = RETRIEVE(cxt, type)(cxt, cname);
5522 return (SV *) 0; /* Failed */
5525 * Old binary formats (pre-0.7).
5527 * Final notifications, ended by SX_STORED may now follow.
5528 * Currently, the only pertinent notification to apply on the
5529 * freshly retrieved object is either:
5530 * SX_CLASS <char-len> <classname> for short classnames.
5531 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5532 * Class name is then read into the key buffer pool used by
5533 * hash table key retrieval.
5536 if (cxt->ver_major < 2) {
5537 while ((type = GETCHAR()) != SX_STORED) {
5541 GETMARK(len); /* Length coded on a single char */
5543 case SX_LG_CLASS: /* Length coded on a regular integer */
5548 return (SV *) 0; /* Failed */
5550 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5553 kbuf[len] = '\0'; /* Mark string end */
5558 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5559 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
5567 * Retrieve data held in file and return the root object.
5568 * Common routine for pretrieve and mretrieve.
5570 static SV *do_retrieve(
5577 int is_tainted; /* Is input source tainted? */
5578 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
5580 TRACEME(("do_retrieve (optype = 0x%x)", optype));
5582 optype |= ST_RETRIEVE;
5585 * Sanity assertions for retrieve dispatch tables.
5588 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
5589 ("old and new retrieve dispatch table have same size"));
5590 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
5591 ("SX_ERROR entry correctly initialized in old dispatch table"));
5592 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
5593 ("SX_ERROR entry correctly initialized in new dispatch table"));
5596 * Workaround for CROAK leak: if they enter with a "dirty" context,
5597 * free up memory for them now.
5604 * Now that STORABLE_xxx hooks exist, it is possible that they try to
5605 * re-enter retrieve() via the hooks.
5609 cxt = allocate_context(cxt);
5613 ASSERT(cxt->entry == 1, ("starting new recursion"));
5614 ASSERT(!cxt->s_dirty, ("clean context"));
5619 * Data is loaded into the memory buffer when f is NULL, unless `in' is
5620 * also NULL, in which case we're expecting the data to already lie
5621 * in the buffer (dclone case).
5624 KBUFINIT(); /* Allocate hash key reading pool once */
5627 MBUF_SAVE_AND_LOAD(in);
5630 * Magic number verifications.
5632 * This needs to be done before calling init_retrieve_context()
5633 * since the format indication in the file are necessary to conduct
5634 * some of the initializations.
5637 cxt->fio = f; /* Where I/O are performed */
5639 if (!magic_check(cxt))
5640 CROAK(("Magic number checking on storable %s failed",
5641 cxt->fio ? "file" : "string"));
5643 TRACEME(("data stored in %s format",
5644 cxt->netorder ? "net order" : "native"));
5647 * Check whether input source is tainted, so that we don't wrongly
5648 * taint perfectly good values...
5650 * We assume file input is always tainted. If both `f' and `in' are
5651 * NULL, then we come from dclone, and tainted is already filled in
5652 * the context. That's a kludge, but the whole dclone() thing is
5653 * already quite a kludge anyway! -- RAM, 15/09/2000.
5656 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
5657 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
5658 init_retrieve_context(cxt, optype, is_tainted);
5660 ASSERT(is_retrieving(), ("within retrieve operation"));
5662 sv = retrieve(cxt, 0); /* Recursively retrieve object, get root SV */
5671 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
5674 * The "root" context is never freed.
5677 clean_retrieve_context(cxt);
5678 if (cxt->prev) /* This context was stacked */
5679 free_context(cxt); /* It was not the "root" context */
5682 * Prepare returned value.
5686 TRACEME(("retrieve ERROR"));
5687 #if (PATCHLEVEL <= 4)
5688 /* perl 5.00405 seems to screw up at this point with an
5689 'attempt to modify a read only value' error reported in the
5690 eval { $self = pretrieve(*FILE) } in _retrieve.
5691 I can't see what the cause of this error is, but I suspect a
5692 bug in 5.004, as it seems to be capable of issuing spurious
5693 errors or core dumping with matches on $@. I'm not going to
5694 spend time on what could be a fruitless search for the cause,
5695 so here's a bodge. If you're running 5.004 and don't like
5696 this inefficiency, either upgrade to a newer perl, or you are
5697 welcome to find the problem and send in a patch.
5701 return &PL_sv_undef; /* Something went wrong, return undef */
5705 TRACEME(("retrieve got %s(0x%"UVxf")",
5706 sv_reftype(sv, FALSE), PTR2UV(sv)));
5709 * Backward compatibility with Storable-0.5@9 (which we know we
5710 * are retrieving if hseen is non-null): don't create an extra RV
5711 * for objects since we special-cased it at store time.
5713 * Build a reference to the SV returned by pretrieve even if it is
5714 * already one and not a scalar, for consistency reasons.
5717 if (pre_06_fmt) { /* Was not handling overloading by then */
5719 TRACEME(("fixing for old formats -- pre 0.6"));
5720 if (sv_type(sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
5721 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
5727 * If reference is overloaded, restore behaviour.
5729 * NB: minor glitch here: normally, overloaded refs are stored specially
5730 * so that we can croak when behaviour cannot be re-installed, and also
5731 * avoid testing for overloading magic at each reference retrieval.
5733 * Unfortunately, the root reference is implicitely stored, so we must
5734 * check for possible overloading now. Furthermore, if we don't restore
5735 * overloading, we cannot croak as if the original ref was, because we
5736 * have no way to determine whether it was an overloaded ref or not in
5739 * It's a pity that overloading magic is attached to the rv, and not to
5740 * the underlying sv as blessing is.
5744 HV *stash = (HV *) SvSTASH(sv);
5745 SV *rv = newRV_noinc(sv);
5746 if (stash && Gv_AMG(stash)) {
5748 TRACEME(("restored overloading on root reference"));
5750 TRACEME(("ended do_retrieve() with an object"));
5754 TRACEME(("regular do_retrieve() end"));
5756 return newRV_noinc(sv);
5762 * Retrieve data held in file and return the root object, undef on error.
5764 SV *pretrieve(PerlIO *f)
5766 TRACEME(("pretrieve"));
5767 return do_retrieve(f, Nullsv, 0);
5773 * Retrieve data held in scalar and return the root object, undef on error.
5775 SV *mretrieve(SV *sv)
5777 TRACEME(("mretrieve"));
5778 return do_retrieve((PerlIO*) 0, sv, 0);
5788 * Deep clone: returns a fresh copy of the original referenced SV tree.
5790 * This is achieved by storing the object in memory and restoring from
5791 * there. Not that efficient, but it should be faster than doing it from
5798 stcxt_t *real_context;
5801 TRACEME(("dclone"));
5804 * Workaround for CROAK leak: if they enter with a "dirty" context,
5805 * free up memory for them now.
5812 * do_store() optimizes for dclone by not freeing its context, should
5813 * we need to allocate one because we're deep cloning from a hook.
5816 if (!do_store((PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
5817 return &PL_sv_undef; /* Error during store */
5820 * Because of the above optimization, we have to refresh the context,
5821 * since a new one could have been allocated and stacked by do_store().
5824 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
5825 cxt = real_context; /* And we need this temporary... */
5828 * Now, `cxt' may refer to a new context.
5831 ASSERT(!cxt->s_dirty, ("clean context"));
5832 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
5835 TRACEME(("dclone stored %d bytes", size));
5839 * Since we're passing do_retrieve() both a NULL file and sv, we need
5840 * to pre-compute the taintedness of the input by setting cxt->tainted
5841 * to whatever state our own input string was. -- RAM, 15/09/2000
5843 * do_retrieve() will free non-root context.
5846 cxt->s_tainted = SvTAINTED(sv);
5847 out = do_retrieve((PerlIO*) 0, Nullsv, ST_CLONE);
5849 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
5859 * The Perl IO GV object distinguishes between input and output for sockets
5860 * but not for plain files. To allow Storable to transparently work on
5861 * plain files and sockets transparently, we have to ask xsubpp to fetch the
5862 * right object for us. Hence the OutputStream and InputStream declarations.
5864 * Before perl 5.004_05, those entries in the standard typemap are not
5865 * defined in perl include files, so we do that here.
5868 #ifndef OutputStream
5869 #define OutputStream PerlIO *
5870 #define InputStream PerlIO *
5871 #endif /* !OutputStream */
5873 MODULE = Storable PACKAGE = Storable::Cxt
5879 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
5883 if (!cxt->membuf_ro && mbase)
5885 if (cxt->membuf_ro && (cxt->msaved).arena)
5886 Safefree((cxt->msaved).arena);
5889 MODULE = Storable PACKAGE = Storable
5895 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
5897 /* Only disable the used only once warning if we are in debugging mode. */
5898 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
5900 #ifdef USE_56_INTERWORK_KLUDGE
5901 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
5935 last_op_in_netorder()