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); \
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) */
787 * Useful store shortcuts...
794 else if (PerlIO_putc(cxt->fio, x) == EOF) \
798 #define WRITE_I32(x) \
800 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
803 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
810 if (cxt->netorder) { \
811 int y = (int) htonl(x); \
814 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
819 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
824 #define WLEN(x) WRITE_I32(x)
831 else if (PerlIO_write(cxt->fio, x, y) != y) \
835 #define STORE_PV_LEN(pv, len, small, large) \
837 if (len <= LG_SCALAR) { \
838 unsigned char clen = (unsigned char) len; \
850 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
853 * Store undef in arrays and hashes without recursing through store().
855 #define STORE_UNDEF() \
862 * Useful retrieve shortcuts...
866 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
872 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
876 #define READ_I32(x) \
878 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
882 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
892 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
895 x = (int) ntohl(x); \
898 #define RLEN(x) READ_I32(x)
905 else if (PerlIO_read(cxt->fio, x, y) != y) \
909 #define SAFEREAD(x,y,z) \
912 MBUF_SAFEREAD(x,y,z); \
913 else if (PerlIO_read(cxt->fio, x, y) != y) { \
920 * This macro is used at retrieve time, to remember where object 'y', bearing a
921 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
922 * we'll therefore know where it has been retrieved and will be able to
923 * share the same reference, as in the original stored memory image.
925 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
926 * on the objects given to STORABLE_thaw and expect that to be defined), and
927 * also for overloaded objects (for which we might not find the stash if the
928 * object is not blessed yet--this might occur for overloaded objects that
929 * refer to themselves indirectly: if we blessed upon return from a sub
930 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
931 * restored on it because the underlying object would not be blessed yet!).
933 * To achieve that, the class name of the last retrieved object is passed down
934 * recursively, and the first SEEN() call for which the class name is not NULL
935 * will bless the object.
941 if (av_store(cxt->aseen, cxt->tagnum++, SvREFCNT_inc(y)) == 0) \
943 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
944 PTR2UV(y), SvREFCNT(y)-1)); \
946 BLESS((SV *) (y), c); \
950 * Bless `s' in `p', via a temporary reference, required by sv_bless().
956 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
957 stash = gv_stashpv((p), TRUE); \
958 ref = newRV_noinc(s); \
959 (void) sv_bless(ref, stash); \
965 static SV *retrieve(stcxt_t *cxt, char *cname);
968 * Dynamic dispatching table for SV store.
971 static int store_ref(stcxt_t *cxt, SV *sv);
972 static int store_scalar(stcxt_t *cxt, SV *sv);
973 static int store_array(stcxt_t *cxt, AV *av);
974 static int store_hash(stcxt_t *cxt, HV *hv);
975 static int store_tied(stcxt_t *cxt, SV *sv);
976 static int store_tied_item(stcxt_t *cxt, SV *sv);
977 static int store_code(stcxt_t *cxt, CV *cv);
978 static int store_other(stcxt_t *cxt, SV *sv);
979 static int store_blessed(stcxt_t *cxt, SV *sv, int type, HV *pkg);
981 static int (*sv_store[])(stcxt_t *cxt, SV *sv) = {
982 store_ref, /* svis_REF */
983 store_scalar, /* svis_SCALAR */
984 (int (*)(stcxt_t *cxt, SV *sv)) store_array, /* svis_ARRAY */
985 (int (*)(stcxt_t *cxt, SV *sv)) store_hash, /* svis_HASH */
986 store_tied, /* svis_TIED */
987 store_tied_item, /* svis_TIED_ITEM */
988 (int (*)(stcxt_t *cxt, SV *sv)) store_code, /* svis_CODE */
989 store_other, /* svis_OTHER */
992 #define SV_STORE(x) (*sv_store[x])
995 * Dynamic dispatching tables for SV retrieval.
998 static SV *retrieve_lscalar(stcxt_t *cxt, char *cname);
999 static SV *retrieve_lutf8str(stcxt_t *cxt, char *cname);
1000 static SV *old_retrieve_array(stcxt_t *cxt, char *cname);
1001 static SV *old_retrieve_hash(stcxt_t *cxt, char *cname);
1002 static SV *retrieve_ref(stcxt_t *cxt, char *cname);
1003 static SV *retrieve_undef(stcxt_t *cxt, char *cname);
1004 static SV *retrieve_integer(stcxt_t *cxt, char *cname);
1005 static SV *retrieve_double(stcxt_t *cxt, char *cname);
1006 static SV *retrieve_byte(stcxt_t *cxt, char *cname);
1007 static SV *retrieve_netint(stcxt_t *cxt, char *cname);
1008 static SV *retrieve_scalar(stcxt_t *cxt, char *cname);
1009 static SV *retrieve_utf8str(stcxt_t *cxt, char *cname);
1010 static SV *retrieve_tied_array(stcxt_t *cxt, char *cname);
1011 static SV *retrieve_tied_hash(stcxt_t *cxt, char *cname);
1012 static SV *retrieve_tied_scalar(stcxt_t *cxt, char *cname);
1013 static SV *retrieve_other(stcxt_t *cxt, char *cname);
1015 static SV *(*sv_old_retrieve[])(stcxt_t *cxt, char *cname) = {
1016 0, /* SX_OBJECT -- entry unused dynamically */
1017 retrieve_lscalar, /* SX_LSCALAR */
1018 old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1019 old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1020 retrieve_ref, /* SX_REF */
1021 retrieve_undef, /* SX_UNDEF */
1022 retrieve_integer, /* SX_INTEGER */
1023 retrieve_double, /* SX_DOUBLE */
1024 retrieve_byte, /* SX_BYTE */
1025 retrieve_netint, /* SX_NETINT */
1026 retrieve_scalar, /* SX_SCALAR */
1027 retrieve_tied_array, /* SX_ARRAY */
1028 retrieve_tied_hash, /* SX_HASH */
1029 retrieve_tied_scalar, /* SX_SCALAR */
1030 retrieve_other, /* SX_SV_UNDEF not supported */
1031 retrieve_other, /* SX_SV_YES not supported */
1032 retrieve_other, /* SX_SV_NO not supported */
1033 retrieve_other, /* SX_BLESS not supported */
1034 retrieve_other, /* SX_IX_BLESS not supported */
1035 retrieve_other, /* SX_HOOK not supported */
1036 retrieve_other, /* SX_OVERLOADED not supported */
1037 retrieve_other, /* SX_TIED_KEY not supported */
1038 retrieve_other, /* SX_TIED_IDX not supported */
1039 retrieve_other, /* SX_UTF8STR not supported */
1040 retrieve_other, /* SX_LUTF8STR not supported */
1041 retrieve_other, /* SX_FLAG_HASH not supported */
1042 retrieve_other, /* SX_CODE not supported */
1043 retrieve_other, /* SX_ERROR */
1046 static SV *retrieve_array(stcxt_t *cxt, char *cname);
1047 static SV *retrieve_hash(stcxt_t *cxt, char *cname);
1048 static SV *retrieve_sv_undef(stcxt_t *cxt, char *cname);
1049 static SV *retrieve_sv_yes(stcxt_t *cxt, char *cname);
1050 static SV *retrieve_sv_no(stcxt_t *cxt, char *cname);
1051 static SV *retrieve_blessed(stcxt_t *cxt, char *cname);
1052 static SV *retrieve_idx_blessed(stcxt_t *cxt, char *cname);
1053 static SV *retrieve_hook(stcxt_t *cxt, char *cname);
1054 static SV *retrieve_overloaded(stcxt_t *cxt, char *cname);
1055 static SV *retrieve_tied_key(stcxt_t *cxt, char *cname);
1056 static SV *retrieve_tied_idx(stcxt_t *cxt, char *cname);
1057 static SV *retrieve_flag_hash(stcxt_t *cxt, char *cname);
1058 static SV *retrieve_code(stcxt_t *cxt, char *cname);
1060 static SV *(*sv_retrieve[])(stcxt_t *cxt, char *cname) = {
1061 0, /* SX_OBJECT -- entry unused dynamically */
1062 retrieve_lscalar, /* SX_LSCALAR */
1063 retrieve_array, /* SX_ARRAY */
1064 retrieve_hash, /* SX_HASH */
1065 retrieve_ref, /* SX_REF */
1066 retrieve_undef, /* SX_UNDEF */
1067 retrieve_integer, /* SX_INTEGER */
1068 retrieve_double, /* SX_DOUBLE */
1069 retrieve_byte, /* SX_BYTE */
1070 retrieve_netint, /* SX_NETINT */
1071 retrieve_scalar, /* SX_SCALAR */
1072 retrieve_tied_array, /* SX_ARRAY */
1073 retrieve_tied_hash, /* SX_HASH */
1074 retrieve_tied_scalar, /* SX_SCALAR */
1075 retrieve_sv_undef, /* SX_SV_UNDEF */
1076 retrieve_sv_yes, /* SX_SV_YES */
1077 retrieve_sv_no, /* SX_SV_NO */
1078 retrieve_blessed, /* SX_BLESS */
1079 retrieve_idx_blessed, /* SX_IX_BLESS */
1080 retrieve_hook, /* SX_HOOK */
1081 retrieve_overloaded, /* SX_OVERLOAD */
1082 retrieve_tied_key, /* SX_TIED_KEY */
1083 retrieve_tied_idx, /* SX_TIED_IDX */
1084 retrieve_utf8str, /* SX_UTF8STR */
1085 retrieve_lutf8str, /* SX_LUTF8STR */
1086 retrieve_flag_hash, /* SX_HASH */
1087 retrieve_code, /* SX_CODE */
1088 retrieve_other, /* SX_ERROR */
1091 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1093 static SV *mbuf2sv(void);
1096 *** Context management.
1102 * Called once per "thread" (interpreter) to initialize some global context.
1104 static void init_perinterp(void)
1108 cxt->netorder = 0; /* true if network order used */
1109 cxt->forgive_me = -1; /* whether to be forgiving... */
1115 * Called at the end of every context cleaning, to perform common reset
1118 static void reset_context(stcxt_t *cxt)
1122 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1126 * init_store_context
1128 * Initialize a new store context for real recursion.
1130 static void init_store_context(
1136 TRACEME(("init_store_context"));
1138 cxt->netorder = network_order;
1139 cxt->forgive_me = -1; /* Fetched from perl if needed */
1140 cxt->deparse = -1; /* Idem */
1141 cxt->eval = NULL; /* Idem */
1142 cxt->canonical = -1; /* Idem */
1143 cxt->tagnum = -1; /* Reset tag numbers */
1144 cxt->classnum = -1; /* Reset class numbers */
1145 cxt->fio = f; /* Where I/O are performed */
1146 cxt->optype = optype; /* A store, or a deep clone */
1147 cxt->entry = 1; /* No recursion yet */
1150 * The `hseen' table is used to keep track of each SV stored and their
1151 * associated tag numbers is special. It is "abused" because the
1152 * values stored are not real SV, just integers cast to (SV *),
1153 * which explains the freeing below.
1155 * It is also one possible bottlneck to achieve good storing speed,
1156 * so the "shared keys" optimization is turned off (unlikely to be
1157 * of any use here), and the hash table is "pre-extended". Together,
1158 * those optimizations increase the throughput by 12%.
1161 cxt->hseen = newHV(); /* Table where seen objects are stored */
1162 HvSHAREKEYS_off(cxt->hseen);
1165 * The following does not work well with perl5.004_04, and causes
1166 * a core dump later on, in a completely unrelated spot, which
1167 * makes me think there is a memory corruption going on.
1169 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1170 * it below does not make any difference. It seems to work fine
1171 * with perl5.004_68 but given the probable nature of the bug,
1172 * that does not prove anything.
1174 * It's a shame because increasing the amount of buckets raises
1175 * store() throughput by 5%, but until I figure this out, I can't
1176 * allow for this to go into production.
1178 * It is reported fixed in 5.005, hence the #if.
1180 #if PERL_VERSION >= 5
1181 #define HBUCKETS 4096 /* Buckets for %hseen */
1182 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1186 * The `hclass' hash uses the same settings as `hseen' above, but it is
1187 * used to assign sequential tags (numbers) to class names for blessed
1190 * We turn the shared key optimization on.
1193 cxt->hclass = newHV(); /* Where seen classnames are stored */
1195 #if PERL_VERSION >= 5
1196 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1200 * The `hook' hash table is used to keep track of the references on
1201 * the STORABLE_freeze hook routines, when found in some class name.
1203 * It is assumed that the inheritance tree will not be changed during
1204 * storing, and that no new method will be dynamically created by the
1208 cxt->hook = newHV(); /* Table where hooks are cached */
1211 * The `hook_seen' array keeps track of all the SVs returned by
1212 * STORABLE_freeze hooks for us to serialize, so that they are not
1213 * reclaimed until the end of the serialization process. Each SV is
1214 * only stored once, the first time it is seen.
1217 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1221 * clean_store_context
1223 * Clean store context by
1225 static void clean_store_context(stcxt_t *cxt)
1229 TRACEME(("clean_store_context"));
1231 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1234 * Insert real values into hashes where we stored faked pointers.
1238 hv_iterinit(cxt->hseen);
1239 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1240 HeVAL(he) = &PL_sv_undef;
1244 hv_iterinit(cxt->hclass);
1245 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1246 HeVAL(he) = &PL_sv_undef;
1250 * And now dispose of them...
1252 * The surrounding if() protection has been added because there might be
1253 * some cases where this routine is called more than once, during
1254 * exceptionnal events. This was reported by Marc Lehmann when Storable
1255 * is executed from mod_perl, and the fix was suggested by him.
1256 * -- RAM, 20/12/2000
1260 HV *hseen = cxt->hseen;
1263 sv_free((SV *) hseen);
1267 HV *hclass = cxt->hclass;
1270 sv_free((SV *) hclass);
1274 HV *hook = cxt->hook;
1277 sv_free((SV *) hook);
1280 if (cxt->hook_seen) {
1281 AV *hook_seen = cxt->hook_seen;
1283 av_undef(hook_seen);
1284 sv_free((SV *) hook_seen);
1287 cxt->forgive_me = -1; /* Fetched from perl if needed */
1288 cxt->deparse = -1; /* Idem */
1290 SvREFCNT_dec(cxt->eval);
1292 cxt->eval = NULL; /* Idem */
1293 cxt->canonical = -1; /* Idem */
1299 * init_retrieve_context
1301 * Initialize a new retrieve context for real recursion.
1303 static void init_retrieve_context(stcxt_t *cxt, int optype, int is_tainted)
1305 TRACEME(("init_retrieve_context"));
1308 * The hook hash table is used to keep track of the references on
1309 * the STORABLE_thaw hook routines, when found in some class name.
1311 * It is assumed that the inheritance tree will not be changed during
1312 * storing, and that no new method will be dynamically created by the
1316 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1319 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1320 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1321 * the correspondance between the tags and the tag number used by the
1322 * new retrieve routines.
1325 cxt->hseen = ((cxt->retrieve_vtbl == sv_old_retrieve) ? newHV() : 0);
1327 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1328 cxt->aclass = newAV(); /* Where seen classnames are kept */
1329 cxt->tagnum = 0; /* Have to count objects... */
1330 cxt->classnum = 0; /* ...and class names as well */
1331 cxt->optype = optype;
1332 cxt->s_tainted = is_tainted;
1333 cxt->entry = 1; /* No recursion yet */
1334 #ifndef HAS_RESTRICTED_HASHES
1335 cxt->derestrict = -1; /* Fetched from perl if needed */
1337 #ifndef HAS_UTF8_ALL
1338 cxt->use_bytes = -1; /* Fetched from perl if needed */
1340 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1344 * clean_retrieve_context
1346 * Clean retrieve context by
1348 static void clean_retrieve_context(stcxt_t *cxt)
1350 TRACEME(("clean_retrieve_context"));
1352 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1355 AV *aseen = cxt->aseen;
1358 sv_free((SV *) aseen);
1362 AV *aclass = cxt->aclass;
1365 sv_free((SV *) aclass);
1369 HV *hook = cxt->hook;
1372 sv_free((SV *) hook);
1376 HV *hseen = cxt->hseen;
1379 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1382 #ifndef HAS_RESTRICTED_HASHES
1383 cxt->derestrict = -1; /* Fetched from perl if needed */
1385 #ifndef HAS_UTF8_ALL
1386 cxt->use_bytes = -1; /* Fetched from perl if needed */
1388 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1396 * A workaround for the CROAK bug: cleanup the last context.
1398 static void clean_context(stcxt_t *cxt)
1400 TRACEME(("clean_context"));
1402 ASSERT(cxt->s_dirty, ("dirty context"));
1407 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1409 if (cxt->optype & ST_RETRIEVE)
1410 clean_retrieve_context(cxt);
1411 else if (cxt->optype & ST_STORE)
1412 clean_store_context(cxt);
1416 ASSERT(!cxt->s_dirty, ("context is clean"));
1417 ASSERT(cxt->entry == 0, ("context is reset"));
1423 * Allocate a new context and push it on top of the parent one.
1424 * This new context is made globally visible via SET_STCXT().
1426 static stcxt_t *allocate_context(parent_cxt)
1427 stcxt_t *parent_cxt;
1431 TRACEME(("allocate_context"));
1433 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1435 NEW_STORABLE_CXT_OBJ(cxt);
1436 cxt->prev = parent_cxt->my_sv;
1439 ASSERT(!cxt->s_dirty, ("clean context"));
1447 * Free current context, which cannot be the "root" one.
1448 * Make the context underneath globally visible via SET_STCXT().
1450 static void free_context(cxt)
1453 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1455 TRACEME(("free_context"));
1457 ASSERT(!cxt->s_dirty, ("clean context"));
1458 ASSERT(prev, ("not freeing root context"));
1460 SvREFCNT_dec(cxt->my_sv);
1463 ASSERT(cxt, ("context not void"));
1473 * Tells whether we're in the middle of a store operation.
1475 int is_storing(void)
1479 return cxt->entry && (cxt->optype & ST_STORE);
1485 * Tells whether we're in the middle of a retrieve operation.
1487 int is_retrieving(void)
1491 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1495 * last_op_in_netorder
1497 * Returns whether last operation was made using network order.
1499 * This is typically out-of-band information that might prove useful
1500 * to people wishing to convert native to network order data when used.
1502 int last_op_in_netorder(void)
1506 return cxt->netorder;
1510 *** Hook lookup and calling routines.
1516 * A wrapper on gv_fetchmethod_autoload() which caches results.
1518 * Returns the routine reference as an SV*, or null if neither the package
1519 * nor its ancestors know about the method.
1521 static SV *pkg_fetchmeth(
1530 * The following code is the same as the one performed by UNIVERSAL::can
1534 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1535 if (gv && isGV(gv)) {
1536 sv = newRV((SV*) GvCV(gv));
1537 TRACEME(("%s->%s: 0x%"UVxf, HvNAME(pkg), method, PTR2UV(sv)));
1539 sv = newSVsv(&PL_sv_undef);
1540 TRACEME(("%s->%s: not found", HvNAME(pkg), method));
1544 * Cache the result, ignoring failure: if we can't store the value,
1545 * it just won't be cached.
1548 (void) hv_store(cache, HvNAME(pkg), strlen(HvNAME(pkg)), sv, 0);
1550 return SvOK(sv) ? sv : (SV *) 0;
1556 * Force cached value to be undef: hook ignored even if present.
1558 static void pkg_hide(
1563 (void) hv_store(cache,
1564 HvNAME(pkg), strlen(HvNAME(pkg)), newSVsv(&PL_sv_undef), 0);
1570 * Discard cached value: a whole fetch loop will be retried at next lookup.
1572 static void pkg_uncache(
1577 (void) hv_delete(cache, HvNAME(pkg), strlen(HvNAME(pkg)), G_DISCARD);
1583 * Our own "UNIVERSAL::can", which caches results.
1585 * Returns the routine reference as an SV*, or null if the object does not
1586 * know about the method.
1596 TRACEME(("pkg_can for %s->%s", HvNAME(pkg), method));
1599 * Look into the cache to see whether we already have determined
1600 * where the routine was, if any.
1602 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1603 * that only one hook (i.e. always the same) is cached in a given cache.
1606 svh = hv_fetch(cache, HvNAME(pkg), strlen(HvNAME(pkg)), FALSE);
1610 TRACEME(("cached %s->%s: not found", HvNAME(pkg), method));
1613 TRACEME(("cached %s->%s: 0x%"UVxf,
1614 HvNAME(pkg), method, PTR2UV(sv)));
1619 TRACEME(("not cached yet"));
1620 return pkg_fetchmeth(cache, pkg, method); /* Fetch and cache */
1626 * Call routine as obj->hook(av) in scalar context.
1627 * Propagates the single returned value if not called in void context.
1629 static SV *scalar_call(
1640 TRACEME(("scalar_call (cloning=%d)", cloning));
1647 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1649 SV **ary = AvARRAY(av);
1650 int cnt = AvFILLp(av) + 1;
1652 XPUSHs(ary[0]); /* Frozen string */
1653 for (i = 1; i < cnt; i++) {
1654 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1655 i, PTR2UV(ary[i])));
1656 XPUSHs(sv_2mortal(newRV(ary[i])));
1661 TRACEME(("calling..."));
1662 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1663 TRACEME(("count = %d", count));
1669 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1682 * Call routine obj->hook(cloning) in list context.
1683 * Returns the list of returned values in an array.
1685 static AV *array_call(
1695 TRACEME(("array_call (cloning=%d)", cloning));
1701 XPUSHs(obj); /* Target object */
1702 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1705 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1710 for (i = count - 1; i >= 0; i--) {
1712 av_store(av, i, SvREFCNT_inc(sv));
1725 * Lookup the class name in the `hclass' table and either assign it a new ID
1726 * or return the existing one, by filling in `classnum'.
1728 * Return true if the class was known, false if the ID was just generated.
1730 static int known_class(
1732 char *name, /* Class name */
1733 int len, /* Name length */
1737 HV *hclass = cxt->hclass;
1739 TRACEME(("known_class (%s)", name));
1742 * Recall that we don't store pointers in this hash table, but tags.
1743 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1746 svh = hv_fetch(hclass, name, len, FALSE);
1748 *classnum = LOW_32BITS(*svh);
1753 * Unknown classname, we need to record it.
1757 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1758 CROAK(("Unable to record new classname"));
1760 *classnum = cxt->classnum;
1765 *** Sepcific store routines.
1771 * Store a reference.
1772 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1774 static int store_ref(stcxt_t *cxt, SV *sv)
1776 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1779 * Follow reference, and check if target is overloaded.
1785 HV *stash = (HV *) SvSTASH(sv);
1786 if (stash && Gv_AMG(stash)) {
1787 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1788 PUTMARK(SX_OVERLOAD);
1794 return store(cxt, sv);
1802 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1803 * The <data> section is omitted if <length> is 0.
1805 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1806 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1808 static int store_scalar(stcxt_t *cxt, SV *sv)
1813 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1815 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1818 * For efficiency, break the SV encapsulation by peaking at the flags
1819 * directly without using the Perl macros to avoid dereferencing
1820 * sv->sv_flags each time we wish to check the flags.
1823 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1824 if (sv == &PL_sv_undef) {
1825 TRACEME(("immortal undef"));
1826 PUTMARK(SX_SV_UNDEF);
1828 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
1835 * Always store the string representation of a scalar if it exists.
1836 * Gisle Aas provided me with this test case, better than a long speach:
1838 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1839 * SV = PVNV(0x80c8520)
1841 * FLAGS = (NOK,POK,pNOK,pPOK)
1844 * PV = 0x80c83d0 "abc"\0
1848 * Write SX_SCALAR, length, followed by the actual data.
1850 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
1851 * appropriate, followed by the actual (binary) data. A double
1852 * is written as a string if network order, for portability.
1854 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
1855 * The reason is that when the scalar value is tainted, the SvNOK(sv)
1858 * The test for a read-only scalar with both POK and NOK set is meant
1859 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
1860 * address comparison for each scalar we store.
1863 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
1865 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
1866 if (sv == &PL_sv_yes) {
1867 TRACEME(("immortal yes"));
1869 } else if (sv == &PL_sv_no) {
1870 TRACEME(("immortal no"));
1873 pv = SvPV(sv, len); /* We know it's SvPOK */
1874 goto string; /* Share code below */
1876 } else if (flags & SVf_POK) {
1877 /* public string - go direct to string read. */
1878 goto string_readlen;
1880 #if (PATCHLEVEL <= 6)
1881 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
1882 direct if NV flag is off. */
1883 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
1885 /* 5.7 rules are that if IV public flag is set, IV value is as
1886 good, if not better, than NV value. */
1892 * Will come here from below with iv set if double is an integer.
1896 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1898 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
1899 * (for example) and that ends up in the optimised small integer
1902 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
1903 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
1904 goto string_readlen;
1908 * Optimize small integers into a single byte, otherwise store as
1909 * a real integer (converted into network order if they asked).
1912 if (iv >= -128 && iv <= 127) {
1913 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
1916 TRACEME(("small integer stored as %d", siv));
1917 } else if (cxt->netorder) {
1919 TRACEME(("no htonl, fall back to string for integer"));
1920 goto string_readlen;
1928 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1929 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
1931 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
1932 /* Bigger than 32 bits. */
1933 TRACEME(("large network order integer as string, value = %"IVdf, iv));
1934 goto string_readlen;
1938 niv = (I32) htonl((I32) iv);
1939 TRACEME(("using network order"));
1944 PUTMARK(SX_INTEGER);
1945 WRITE(&iv, sizeof(iv));
1948 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
1949 } else if (flags & SVf_NOK) {
1951 #if (PATCHLEVEL <= 6)
1954 * Watch for number being an integer in disguise.
1956 if (nv == (NV) (iv = I_V(nv))) {
1957 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
1958 goto integer; /* Share code above */
1965 goto integer; /* Share code above */
1970 if (cxt->netorder) {
1971 TRACEME(("double %"NVff" stored as string", nv));
1972 goto string_readlen; /* Share code below */
1976 WRITE(&nv, sizeof(nv));
1978 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
1980 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
1981 I32 wlen; /* For 64-bit machines */
1987 * Will come here from above if it was readonly, POK and NOK but
1988 * neither &PL_sv_yes nor &PL_sv_no.
1992 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
1994 STORE_UTF8STR(pv, wlen);
1996 STORE_SCALAR(pv, wlen);
1997 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
1998 PTR2UV(sv), SvPVX(sv), (IV)len));
2000 CROAK(("Can't determine type of %s(0x%"UVxf")",
2001 sv_reftype(sv, FALSE),
2003 return 0; /* Ok, no recursion on scalars */
2011 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2012 * Each item is stored as <object>.
2014 static int store_array(stcxt_t *cxt, AV *av)
2017 I32 len = av_len(av) + 1;
2021 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2024 * Signal array by emitting SX_ARRAY, followed by the array length.
2029 TRACEME(("size = %d", len));
2032 * Now store each item recursively.
2035 for (i = 0; i < len; i++) {
2036 sav = av_fetch(av, i, 0);
2038 TRACEME(("(#%d) undef item", i));
2042 TRACEME(("(#%d) item", i));
2043 if ((ret = store(cxt, *sav))) /* Extra () for -Wall, grr... */
2047 TRACEME(("ok (array)"));
2056 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2059 sortcmp(const void *a, const void *b)
2061 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2068 * Store a hash table.
2070 * For a "normal" hash (not restricted, no utf8 keys):
2072 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2073 * Values are stored as <object>.
2074 * Keys are stored as <length> <data>, the <data> section being omitted
2077 * For a "fancy" hash (restricted or utf8 keys):
2079 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2081 * Values are stored as <object>.
2082 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2084 * Currently the only hash flag is "restriced"
2085 * Key flags are as for hv.h
2087 static int store_hash(stcxt_t *cxt, HV *hv)
2090 #ifdef HAS_RESTRICTED_HASHES
2099 int flagged_hash = ((SvREADONLY(hv)
2100 #ifdef HAS_HASH_KEY_FLAGS
2104 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2107 /* needs int cast for C++ compilers, doesn't it? */
2108 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2111 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2115 * Signal hash by emitting SX_HASH, followed by the table length.
2119 PUTMARK(SX_FLAG_HASH);
2120 PUTMARK(hash_flags);
2125 TRACEME(("size = %d", len));
2128 * Save possible iteration state via each() on that table.
2131 riter = HvRITER(hv);
2132 eiter = HvEITER(hv);
2136 * Now store each item recursively.
2138 * If canonical is defined to some true value then store each
2139 * key/value pair in sorted order otherwise the order is random.
2140 * Canonical order is irrelevant when a deep clone operation is performed.
2142 * Fetch the value from perl only once per store() operation, and only
2147 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2148 (cxt->canonical < 0 && (cxt->canonical =
2149 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2152 * Storing in order, sorted by key.
2153 * Run through the hash, building up an array of keys in a
2154 * mortal array, sort the array and then run through the
2160 /*av_extend (av, len);*/
2162 TRACEME(("using canonical order"));
2164 for (i = 0; i < len; i++) {
2165 #ifdef HAS_RESTRICTED_HASHES
2166 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2168 HE *he = hv_iternext(hv);
2170 SV *key = hv_iterkeysv(he);
2171 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2174 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
2176 for (i = 0; i < len; i++) {
2177 unsigned char flags;
2181 SV *key = av_shift(av);
2182 HE *he = hv_fetch_ent(hv, key, 0, 0);
2183 SV *val = HeVAL(he);
2185 return 1; /* Internal error, not I/O error */
2188 * Store value first.
2191 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2193 if ((ret = store(cxt, val))) /* Extra () for -Wall, grr... */
2198 * Keys are written after values to make sure retrieval
2199 * can be optimal in terms of memory usage, where keys are
2200 * read into a fixed unique buffer called kbuf.
2201 * See retrieve_hash() for details.
2204 /* Implementation of restricted hashes isn't nicely
2207 = (((hash_flags & SHV_RESTRICTED)
2209 ? SHV_K_LOCKED : 0);
2210 if (val == &PL_sv_undef)
2211 flags |= SHV_K_PLACEHOLDER;
2213 keyval = SvPV(key, keylen_tmp);
2214 keylen = keylen_tmp;
2215 #ifdef HAS_UTF8_HASHES
2216 /* If you build without optimisation on pre 5.6
2217 then nothing spots that SvUTF8(key) is always 0,
2218 so the block isn't optimised away, at which point
2219 the linker dislikes the reference to
2222 const char *keysave = keyval;
2223 bool is_utf8 = TRUE;
2225 /* Just casting the &klen to (STRLEN) won't work
2226 well if STRLEN and I32 are of different widths.
2228 keyval = (char*)bytes_from_utf8((U8*)keyval,
2232 /* If we were able to downgrade here, then than
2233 means that we have a key which only had chars
2234 0-255, but was utf8 encoded. */
2236 if (keyval != keysave) {
2237 keylen = keylen_tmp;
2238 flags |= SHV_K_WASUTF8;
2240 /* keylen_tmp can't have changed, so no need
2241 to assign back to keylen. */
2242 flags |= SHV_K_UTF8;
2249 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2251 assert (flags == 0);
2252 TRACEME(("(#%d) key '%s'", i, keyval));
2256 WRITE(keyval, keylen);
2257 if (flags & SHV_K_WASUTF8)
2262 * Free up the temporary array
2271 * Storing in "random" order (in the order the keys are stored
2272 * within the the hash). This is the default and will be faster!
2275 for (i = 0; i < len; i++) {
2278 unsigned char flags;
2279 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2280 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2282 HE *he = hv_iternext(hv);
2284 SV *val = (he ? hv_iterval(hv, he) : 0);
2289 return 1; /* Internal error, not I/O error */
2292 * Store value first.
2295 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2297 if ((ret = store(cxt, val))) /* Extra () for -Wall, grr... */
2300 /* Implementation of restricted hashes isn't nicely
2303 = (((hash_flags & SHV_RESTRICTED)
2305 ? SHV_K_LOCKED : 0);
2306 if (val == &PL_sv_undef)
2307 flags |= SHV_K_PLACEHOLDER;
2309 hek = HeKEY_hek(he);
2311 if (len == HEf_SVKEY) {
2312 /* This is somewhat sick, but the internal APIs are
2313 * such that XS code could put one of these in in
2315 * Maybe we should be capable of storing one if
2318 key_sv = HeKEY_sv(he);
2319 flags |= SHV_K_ISSV;
2321 /* Regular string key. */
2322 #ifdef HAS_HASH_KEY_FLAGS
2324 flags |= SHV_K_UTF8;
2325 if (HEK_WASUTF8(hek))
2326 flags |= SHV_K_WASUTF8;
2332 * Keys are written after values to make sure retrieval
2333 * can be optimal in terms of memory usage, where keys are
2334 * read into a fixed unique buffer called kbuf.
2335 * See retrieve_hash() for details.
2340 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2342 assert (flags == 0);
2343 TRACEME(("(#%d) key '%s'", i, key));
2345 if (flags & SHV_K_ISSV) {
2355 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2358 HvRITER(hv) = riter; /* Restore hash iterator state */
2359 HvEITER(hv) = eiter;
2367 * Store a code reference.
2369 * Layout is SX_CODE <length> followed by a scalar containing the perl
2370 * source code of the code reference.
2372 static int store_code(stcxt_t *cxt, CV *cv)
2374 #if PERL_VERSION < 6
2376 * retrieve_code does not work with perl 5.005 or less
2378 return store_other(cxt, (SV*)cv);
2382 int ret, count, reallen;
2383 SV *text, *bdeparse;
2385 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2388 cxt->deparse == 0 ||
2389 (cxt->deparse < 0 && !(cxt->deparse =
2390 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2392 return store_other(cxt, (SV*)cv);
2396 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2397 * blessed code references.
2399 /* XXX sv_2mortal seems to be evil here. why? */
2400 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2406 * create the B::Deparse object
2410 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2412 count = call_method("new", G_SCALAR);
2415 CROAK(("Unexpected return value from B::Deparse::new\n"));
2419 * call the coderef2text method
2423 XPUSHs(bdeparse); /* XXX is this already mortal? */
2424 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2426 count = call_method("coderef2text", G_SCALAR);
2429 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2433 reallen = strlen(SvPV_nolen(text));
2436 * Empty code references or XS functions are deparsed as
2437 * "(prototype) ;" or ";".
2440 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2441 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2445 * Signal code by emitting SX_CODE.
2449 TRACEME(("size = %d", len));
2450 TRACEME(("code = %s", SvPV_nolen(text)));
2453 * Now store the source code.
2456 STORE_SCALAR(SvPV_nolen(text), len);
2461 TRACEME(("ok (code)"));
2470 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2471 * a special mark, followed by the underlying tied object. For instance, when
2472 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2473 * <hash object> stands for the serialization of the tied hash.
2475 static int store_tied(stcxt_t *cxt, SV *sv)
2479 int svt = SvTYPE(sv);
2482 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2485 * We have a small run-time penalty here because we chose to factorise
2486 * all tieds objects into the same routine, and not have a store_tied_hash,
2487 * a store_tied_array, etc...
2489 * Don't use a switch() statement, as most compilers don't optimize that
2490 * well for 2/3 values. An if() else if() cascade is just fine. We put
2491 * tied hashes first, as they are the most likely beasts.
2494 if (svt == SVt_PVHV) {
2495 TRACEME(("tied hash"));
2496 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2497 } else if (svt == SVt_PVAV) {
2498 TRACEME(("tied array"));
2499 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2501 TRACEME(("tied scalar"));
2502 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2506 if (!(mg = mg_find(sv, mtype)))
2507 CROAK(("No magic '%c' found while storing tied %s", mtype,
2508 (svt == SVt_PVHV) ? "hash" :
2509 (svt == SVt_PVAV) ? "array" : "scalar"));
2512 * The mg->mg_obj found by mg_find() above actually points to the
2513 * underlying tied Perl object implementation. For instance, if the
2514 * original SV was that of a tied array, then mg->mg_obj is an AV.
2516 * Note that we store the Perl object as-is. We don't call its FETCH
2517 * method along the way. At retrieval time, we won't call its STORE
2518 * method either, but the tieing magic will be re-installed. In itself,
2519 * that ensures that the tieing semantics are preserved since futher
2520 * accesses on the retrieved object will indeed call the magic methods...
2523 if ((ret = store(cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2526 TRACEME(("ok (tied)"));
2534 * Stores a reference to an item within a tied structure:
2536 * . \$h{key}, stores both the (tied %h) object and 'key'.
2537 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2539 * Layout is therefore either:
2540 * SX_TIED_KEY <object> <key>
2541 * SX_TIED_IDX <object> <index>
2543 static int store_tied_item(stcxt_t *cxt, SV *sv)
2548 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2550 if (!(mg = mg_find(sv, 'p')))
2551 CROAK(("No magic 'p' found while storing reference to tied item"));
2554 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2558 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2559 PUTMARK(SX_TIED_KEY);
2560 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2562 if ((ret = store(cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2565 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2567 if ((ret = store(cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2570 I32 idx = mg->mg_len;
2572 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2573 PUTMARK(SX_TIED_IDX);
2574 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2576 if ((ret = store(cxt, mg->mg_obj))) /* Idem, for -Wall */
2579 TRACEME(("store_tied_item: storing IDX %d", idx));
2584 TRACEME(("ok (tied item)"));
2590 * store_hook -- dispatched manually, not via sv_store[]
2592 * The blessed SV is serialized by a hook.
2596 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2598 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2599 * the trailing part [] is present, the type of object (scalar, array or hash).
2600 * There is also a bit which says how the classname is stored between:
2605 * and when the <index> form is used (classname already seen), the "large
2606 * classname" bit in <flags> indicates how large the <index> is.
2608 * The serialized string returned by the hook is of length <len2> and comes
2609 * next. It is an opaque string for us.
2611 * Those <len3> object IDs which are listed last represent the extra references
2612 * not directly serialized by the hook, but which are linked to the object.
2614 * When recursion is mandated to resolve object-IDs not yet seen, we have
2615 * instead, with <header> being flags with bits set to indicate the object type
2616 * and that recursion was indeed needed:
2618 * SX_HOOK <header> <object> <header> <object> <flags>
2620 * that same header being repeated between serialized objects obtained through
2621 * recursion, until we reach flags indicating no recursion, at which point
2622 * we know we've resynchronized with a single layout, after <flags>.
2624 * When storing a blessed ref to a tied variable, the following format is
2627 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2629 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2630 * real object type is held in the <extra> flag. At the very end of the
2631 * serialization stream, the underlying magic object is serialized, just like
2632 * any other tied variable.
2634 static int store_hook(
2647 int count; /* really len3 + 1 */
2648 unsigned char flags;
2651 int recursed = 0; /* counts recursion */
2652 int obj_type; /* object type, on 2 bits */
2655 int clone = cxt->optype & ST_CLONE;
2656 char mtype = '\0'; /* for blessed ref to tied structures */
2657 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2659 TRACEME(("store_hook, class \"%s\", tagged #%d", HvNAME(pkg), cxt->tagnum));
2662 * Determine object type on 2 bits.
2667 obj_type = SHT_SCALAR;
2670 obj_type = SHT_ARRAY;
2673 obj_type = SHT_HASH;
2677 * Produced by a blessed ref to a tied data structure, $o in the
2678 * following Perl code.
2682 * my $o = bless \%h, 'BAR';
2684 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2685 * (since we have only 2 bits in <flags> to store the type), and an
2686 * <extra> byte flag will be emitted after the FIRST <flags> in the
2687 * stream, carrying what we put in `eflags'.
2689 obj_type = SHT_EXTRA;
2690 switch (SvTYPE(sv)) {
2692 eflags = (unsigned char) SHT_THASH;
2696 eflags = (unsigned char) SHT_TARRAY;
2700 eflags = (unsigned char) SHT_TSCALAR;
2706 CROAK(("Unexpected object type (%d) in store_hook()", type));
2708 flags = SHF_NEED_RECURSE | obj_type;
2710 class = HvNAME(pkg);
2711 len = strlen(class);
2714 * To call the hook, we need to fake a call like:
2716 * $object->STORABLE_freeze($cloning);
2718 * but we don't have the $object here. For instance, if $object is
2719 * a blessed array, what we have in `sv' is the array, and we can't
2720 * call a method on those.
2722 * Therefore, we need to create a temporary reference to the object and
2723 * make the call on that reference.
2726 TRACEME(("about to call STORABLE_freeze on class %s", class));
2728 ref = newRV_noinc(sv); /* Temporary reference */
2729 av = array_call(ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2731 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2733 count = AvFILLp(av) + 1;
2734 TRACEME(("store_hook, array holds %d items", count));
2737 * If they return an empty list, it means they wish to ignore the
2738 * hook for this class (and not just this instance -- that's for them
2739 * to handle if they so wish).
2741 * Simply disable the cached entry for the hook (it won't be recomputed
2742 * since it's present in the cache) and recurse to store_blessed().
2747 * They must not change their mind in the middle of a serialization.
2750 if (hv_fetch(cxt->hclass, class, len, FALSE))
2751 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2752 (cxt->optype & ST_CLONE) ? "cloning" : "storing", class));
2754 pkg_hide(cxt->hook, pkg, "STORABLE_freeze");
2756 ASSERT(!pkg_can(cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2757 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", class));
2759 return store_blessed(cxt, sv, type, pkg);
2763 * Get frozen string.
2767 pv = SvPV(ary[0], len2);
2770 * If they returned more than one item, we need to serialize some
2771 * extra references if not already done.
2773 * Loop over the array, starting at position #1, and for each item,
2774 * ensure it is a reference, serialize it if not already done, and
2775 * replace the entry with the tag ID of the corresponding serialized
2778 * We CHEAT by not calling av_fetch() and read directly within the
2782 for (i = 1; i < count; i++) {
2786 AV *av_hook = cxt->hook_seen;
2789 CROAK(("Item #%d returned by STORABLE_freeze "
2790 "for %s is not a reference", i, class));
2791 xsv = SvRV(rsv); /* Follow ref to know what to look for */
2794 * Look in hseen and see if we have a tag already.
2795 * Serialize entry if not done already, and get its tag.
2798 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
2799 goto sv_seen; /* Avoid moving code too far to the right */
2801 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
2804 * We need to recurse to store that object and get it to be known
2805 * so that we can resolve the list of object-IDs at retrieve time.
2807 * The first time we do this, we need to emit the proper header
2808 * indicating that we recursed, and what the type of object is (the
2809 * object we're storing via a user-hook). Indeed, during retrieval,
2810 * we'll have to create the object before recursing to retrieve the
2811 * others, in case those would point back at that object.
2814 /* [SX_HOOK] <flags> [<extra>] <object>*/
2818 if (obj_type == SHT_EXTRA)
2823 if ((ret = store(cxt, xsv))) /* Given by hook for us to store */
2826 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
2828 CROAK(("Could not serialize item #%d from hook in %s", i, class));
2831 * It was the first time we serialized `xsv'.
2833 * Keep this SV alive until the end of the serialization: if we
2834 * disposed of it right now by decrementing its refcount, and it was
2835 * a temporary value, some next temporary value allocated during
2836 * another STORABLE_freeze might take its place, and we'd wrongly
2837 * assume that new SV was already serialized, based on its presence
2840 * Therefore, push it away in cxt->hook_seen.
2843 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
2847 * Dispose of the REF they returned. If we saved the `xsv' away
2848 * in the array of returned SVs, that will not cause the underlying
2849 * referenced SV to be reclaimed.
2852 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
2853 SvREFCNT_dec(rsv); /* Dispose of reference */
2856 * Replace entry with its tag (not a real SV, so no refcnt increment)
2860 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
2861 i-1, PTR2UV(xsv), PTR2UV(*svh)));
2865 * Allocate a class ID if not already done.
2867 * This needs to be done after the recursion above, since at retrieval
2868 * time, we'll see the inner objects first. Many thanks to
2869 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
2870 * proposed the right fix. -- RAM, 15/09/2000
2873 if (!known_class(cxt, class, len, &classnum)) {
2874 TRACEME(("first time we see class %s, ID = %d", class, classnum));
2875 classnum = -1; /* Mark: we must store classname */
2877 TRACEME(("already seen class %s, ID = %d", class, classnum));
2881 * Compute leading flags.
2885 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
2886 flags |= SHF_LARGE_CLASSLEN;
2888 flags |= SHF_IDX_CLASSNAME;
2889 if (len2 > LG_SCALAR)
2890 flags |= SHF_LARGE_STRLEN;
2892 flags |= SHF_HAS_LIST;
2893 if (count > (LG_SCALAR + 1))
2894 flags |= SHF_LARGE_LISTLEN;
2897 * We're ready to emit either serialized form:
2899 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2900 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
2902 * If we recursed, the SX_HOOK has already been emitted.
2905 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
2906 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
2907 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
2909 /* SX_HOOK <flags> [<extra>] */
2913 if (obj_type == SHT_EXTRA)
2918 /* <len> <classname> or <index> */
2919 if (flags & SHF_IDX_CLASSNAME) {
2920 if (flags & SHF_LARGE_CLASSLEN)
2923 unsigned char cnum = (unsigned char) classnum;
2927 if (flags & SHF_LARGE_CLASSLEN)
2930 unsigned char clen = (unsigned char) len;
2933 WRITE(class, len); /* Final \0 is omitted */
2936 /* <len2> <frozen-str> */
2937 if (flags & SHF_LARGE_STRLEN) {
2938 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
2939 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
2941 unsigned char clen = (unsigned char) len2;
2945 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
2947 /* [<len3> <object-IDs>] */
2948 if (flags & SHF_HAS_LIST) {
2949 int len3 = count - 1;
2950 if (flags & SHF_LARGE_LISTLEN)
2953 unsigned char clen = (unsigned char) len3;
2958 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
2959 * real pointer, rather a tag number, well under the 32-bit limit.
2962 for (i = 1; i < count; i++) {
2963 I32 tagval = htonl(LOW_32BITS(ary[i]));
2965 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
2970 * Free the array. We need extra care for indices after 0, since they
2971 * don't hold real SVs but integers cast.
2975 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
2980 * If object was tied, need to insert serialization of the magic object.
2983 if (obj_type == SHT_EXTRA) {
2986 if (!(mg = mg_find(sv, mtype))) {
2987 int svt = SvTYPE(sv);
2988 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
2989 mtype, (svt == SVt_PVHV) ? "hash" :
2990 (svt == SVt_PVAV) ? "array" : "scalar"));
2993 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
2994 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3000 if ((ret = store(cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3008 * store_blessed -- dispatched manually, not via sv_store[]
3010 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3011 * of its ancestors. If there is, then redispatch to store_hook();
3013 * Otherwise, the blessed SV is stored using the following layout:
3015 * SX_BLESS <flag> <len> <classname> <object>
3017 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3018 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3019 * Otherwise, the low order bits give the length, thereby giving a compact
3020 * representation for class names less than 127 chars long.
3022 * Each <classname> seen is remembered and indexed, so that the next time
3023 * an object in the blessed in the same <classname> is stored, the following
3026 * SX_IX_BLESS <flag> <index> <object>
3028 * where <index> is the classname index, stored on 0 or 4 bytes depending
3029 * on the high-order bit in flag (same encoding as above for <len>).
3031 static int store_blessed(
3042 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME(pkg)));
3045 * Look for a hook for this blessed SV and redirect to store_hook()
3049 hook = pkg_can(cxt->hook, pkg, "STORABLE_freeze");
3051 return store_hook(cxt, sv, type, pkg, hook);
3054 * This is a blessed SV without any serialization hook.
3057 class = HvNAME(pkg);
3058 len = strlen(class);
3060 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3061 PTR2UV(sv), class, cxt->tagnum));
3064 * Determine whether it is the first time we see that class name (in which
3065 * case it will be stored in the SX_BLESS form), or whether we already
3066 * saw that class name before (in which case the SX_IX_BLESS form will be
3070 if (known_class(cxt, class, len, &classnum)) {
3071 TRACEME(("already seen class %s, ID = %d", class, classnum));
3072 PUTMARK(SX_IX_BLESS);
3073 if (classnum <= LG_BLESS) {
3074 unsigned char cnum = (unsigned char) classnum;
3077 unsigned char flag = (unsigned char) 0x80;
3082 TRACEME(("first time we see class %s, ID = %d", class, classnum));
3084 if (len <= LG_BLESS) {
3085 unsigned char clen = (unsigned char) len;
3088 unsigned char flag = (unsigned char) 0x80;
3090 WLEN(len); /* Don't BER-encode, this should be rare */
3092 WRITE(class, len); /* Final \0 is omitted */
3096 * Now emit the <object> part.
3099 return SV_STORE(type)(cxt, sv);
3105 * We don't know how to store the item we reached, so return an error condition.
3106 * (it's probably a GLOB, some CODE reference, etc...)
3108 * If they defined the `forgive_me' variable at the Perl level to some
3109 * true value, then don't croak, just warn, and store a placeholder string
3112 static int store_other(stcxt_t *cxt, SV *sv)
3115 static char buf[80];
3117 TRACEME(("store_other"));
3120 * Fetch the value from perl only once per store() operation.
3124 cxt->forgive_me == 0 ||
3125 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3126 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3128 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3130 warn("Can't store item %s(0x%"UVxf")",
3131 sv_reftype(sv, FALSE), PTR2UV(sv));
3134 * Store placeholder string as a scalar instead...
3137 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3138 PTR2UV(sv), (char) 0);
3141 STORE_SCALAR(buf, len);
3142 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3148 *** Store driving routines
3154 * WARNING: partially duplicates Perl's sv_reftype for speed.
3156 * Returns the type of the SV, identified by an integer. That integer
3157 * may then be used to index the dynamic routine dispatch table.
3159 static int sv_type(SV *sv)
3161 switch (SvTYPE(sv)) {
3166 * No need to check for ROK, that can't be set here since there
3167 * is no field capable of hodling the xrv_rv reference.
3175 * Starting from SVt_PV, it is possible to have the ROK flag
3176 * set, the pointer to the other SV being either stored in
3177 * the xrv_rv (in the case of a pure SVt_RV), or as the
3178 * xpv_pv field of an SVt_PV and its heirs.
3180 * However, those SV cannot be magical or they would be an
3181 * SVt_PVMG at least.
3183 return SvROK(sv) ? svis_REF : svis_SCALAR;
3185 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3186 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3187 return svis_TIED_ITEM;
3190 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3192 return SvROK(sv) ? svis_REF : svis_SCALAR;
3194 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3198 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3213 * Recursively store objects pointed to by the sv to the specified file.
3215 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3216 * object (one for which storage has started -- it may not be over if we have
3217 * a self-referenced structure). This data set forms a stored <object>.
3219 static int store(stcxt_t *cxt, SV *sv)
3224 HV *hseen = cxt->hseen;
3226 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3229 * If object has already been stored, do not duplicate data.
3230 * Simply emit the SX_OBJECT marker followed by its tag data.
3231 * The tag is always written in network order.
3233 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3234 * real pointer, rather a tag number (watch the insertion code below).
3235 * That means it probably safe to assume it is well under the 32-bit limit,
3236 * and makes the truncation safe.
3237 * -- RAM, 14/09/1999
3240 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3242 I32 tagval = htonl(LOW_32BITS(*svh));
3244 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3252 * Allocate a new tag and associate it with the address of the sv being
3253 * stored, before recursing...
3255 * In order to avoid creating new SvIVs to hold the tagnum we just
3256 * cast the tagnum to an SV pointer and store that in the hash. This
3257 * means that we must clean up the hash manually afterwards, but gives
3258 * us a 15% throughput increase.
3263 if (!hv_store(hseen,
3264 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3268 * Store `sv' and everything beneath it, using appropriate routine.
3269 * Abort immediately if we get a non-zero status back.
3274 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3275 PTR2UV(sv), cxt->tagnum, type));
3278 HV *pkg = SvSTASH(sv);
3279 ret = store_blessed(cxt, sv, type, pkg);
3281 ret = SV_STORE(type)(cxt, sv);
3283 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3284 ret ? "FAILED" : "ok", PTR2UV(sv),
3285 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3293 * Write magic number and system information into the file.
3294 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3295 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3296 * All size and lenghts are written as single characters here.
3298 * Note that no byte ordering info is emitted when <network> is true, since
3299 * integers will be emitted in network order in that case.
3301 static int magic_write(stcxt_t *cxt)
3304 * Starting with 0.6, the "use_network_order" byte flag is also used to
3305 * indicate the version number of the binary image, encoded in the upper
3306 * bits. The bit 0 is always used to indicate network order.
3309 * Starting with 0.7, a full byte is dedicated to the minor version of
3310 * the binary format, which is incremented only when new markers are
3311 * introduced, for instance, but when backward compatibility is preserved.
3314 /* Make these at compile time. The WRITE() macro is sufficiently complex
3315 that it saves about 200 bytes doing it this way and only using it
3317 static const unsigned char network_file_header[] = {
3319 (STORABLE_BIN_MAJOR << 1) | 1,
3320 STORABLE_BIN_WRITE_MINOR
3322 static const unsigned char file_header[] = {
3324 (STORABLE_BIN_MAJOR << 1) | 0,
3325 STORABLE_BIN_WRITE_MINOR,
3326 /* sizeof the array includes the 0 byte at the end: */
3327 (char) sizeof (byteorderstr) - 1,
3329 (unsigned char) sizeof(int),
3330 (unsigned char) sizeof(long),
3331 (unsigned char) sizeof(char *),
3332 (unsigned char) sizeof(NV)
3334 #ifdef USE_56_INTERWORK_KLUDGE
3335 static const unsigned char file_header_56[] = {
3337 (STORABLE_BIN_MAJOR << 1) | 0,
3338 STORABLE_BIN_WRITE_MINOR,
3339 /* sizeof the array includes the 0 byte at the end: */
3340 (char) sizeof (byteorderstr_56) - 1,
3342 (unsigned char) sizeof(int),
3343 (unsigned char) sizeof(long),
3344 (unsigned char) sizeof(char *),
3345 (unsigned char) sizeof(NV)
3348 const unsigned char *header;
3351 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3353 if (cxt->netorder) {
3354 header = network_file_header;
3355 length = sizeof (network_file_header);
3357 #ifdef USE_56_INTERWORK_KLUDGE
3358 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3359 header = file_header_56;
3360 length = sizeof (file_header_56);
3364 header = file_header;
3365 length = sizeof (file_header);
3370 /* sizeof the array includes the 0 byte at the end. */
3371 header += sizeof (magicstr) - 1;
3372 length -= sizeof (magicstr) - 1;
3375 WRITE( (unsigned char*) header, length);
3377 if (!cxt->netorder) {
3378 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3379 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3380 (int) sizeof(int), (int) sizeof(long),
3381 (int) sizeof(char *), (int) sizeof(NV)));
3389 * Common code for store operations.
3391 * When memory store is requested (f = NULL) and a non null SV* is given in
3392 * `res', it is filled with a new SV created out of the memory buffer.
3394 * It is required to provide a non-null `res' when the operation type is not
3395 * dclone() and store() is performed to memory.
3397 static int do_store(
3407 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3408 ("must supply result SV pointer for real recursion to memory"));
3410 TRACEME(("do_store (optype=%d, netorder=%d)",
3411 optype, network_order));
3416 * Workaround for CROAK leak: if they enter with a "dirty" context,
3417 * free up memory for them now.
3424 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3425 * re-enter store() via the hooks. We need to stack contexts.
3429 cxt = allocate_context(cxt);
3433 ASSERT(cxt->entry == 1, ("starting new recursion"));
3434 ASSERT(!cxt->s_dirty, ("clean context"));
3437 * Ensure sv is actually a reference. From perl, we called something
3439 * pstore(FILE, \@array);
3440 * so we must get the scalar value behing that reference.
3444 CROAK(("Not a reference"));
3445 sv = SvRV(sv); /* So follow it to know what to store */
3448 * If we're going to store to memory, reset the buffer.
3455 * Prepare context and emit headers.
3458 init_store_context(cxt, f, optype, network_order);
3460 if (-1 == magic_write(cxt)) /* Emit magic and ILP info */
3461 return 0; /* Error */
3464 * Recursively store object...
3467 ASSERT(is_storing(), ("within store operation"));
3469 status = store(cxt, sv); /* Just do it! */
3472 * If they asked for a memory store and they provided an SV pointer,
3473 * make an SV string out of the buffer and fill their pointer.
3475 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3476 * an SV, since context cleanup might free the buffer if we did recurse.
3477 * (unless caller is dclone(), which is aware of that).
3480 if (!cxt->fio && res)
3486 * The "root" context is never freed, since it is meant to be always
3487 * handy for the common case where no recursion occurs at all (i.e.
3488 * we enter store() outside of any Storable code and leave it, period).
3489 * We know it's the "root" context because there's nothing stacked
3494 * When deep cloning, we don't free the context: doing so would force
3495 * us to copy the data in the memory buffer. Sicne we know we're
3496 * about to enter do_retrieve...
3499 clean_store_context(cxt);
3500 if (cxt->prev && !(cxt->optype & ST_CLONE))
3503 TRACEME(("do_store returns %d", status));
3511 * Store the transitive data closure of given object to disk.
3512 * Returns 0 on error, a true value otherwise.
3514 int pstore(PerlIO *f, SV *sv)
3516 TRACEME(("pstore"));
3517 return do_store(f, sv, 0, FALSE, (SV**) 0);
3524 * Same as pstore(), but network order is used for integers and doubles are
3525 * emitted as strings.
3527 int net_pstore(PerlIO *f, SV *sv)
3529 TRACEME(("net_pstore"));
3530 return do_store(f, sv, 0, TRUE, (SV**) 0);
3540 * Build a new SV out of the content of the internal memory buffer.
3542 static SV *mbuf2sv(void)
3546 return newSVpv(mbase, MBUF_SIZE());
3552 * Store the transitive data closure of given object to memory.
3553 * Returns undef on error, a scalar value containing the data otherwise.
3559 TRACEME(("mstore"));
3561 if (!do_store((PerlIO*) 0, sv, 0, FALSE, &out))
3562 return &PL_sv_undef;
3570 * Same as mstore(), but network order is used for integers and doubles are
3571 * emitted as strings.
3573 SV *net_mstore(SV *sv)
3577 TRACEME(("net_mstore"));
3579 if (!do_store((PerlIO*) 0, sv, 0, TRUE, &out))
3580 return &PL_sv_undef;
3586 *** Specific retrieve callbacks.
3592 * Return an error via croak, since it is not possible that we get here
3593 * under normal conditions, when facing a file produced via pstore().
3595 static SV *retrieve_other(stcxt_t *cxt, char *cname)
3598 cxt->ver_major != STORABLE_BIN_MAJOR &&
3599 cxt->ver_minor != STORABLE_BIN_MINOR
3601 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3602 cxt->fio ? "file" : "string",
3603 cxt->ver_major, cxt->ver_minor,
3604 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3606 CROAK(("Corrupted storable %s (binary v%d.%d)",
3607 cxt->fio ? "file" : "string",
3608 cxt->ver_major, cxt->ver_minor));
3611 return (SV *) 0; /* Just in case */
3615 * retrieve_idx_blessed
3617 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3618 * <index> can be coded on either 1 or 5 bytes.
3620 static SV *retrieve_idx_blessed(stcxt_t *cxt, char *cname)
3627 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3628 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3630 GETMARK(idx); /* Index coded on a single char? */
3635 * Fetch classname in `aclass'
3638 sva = av_fetch(cxt->aclass, idx, FALSE);
3640 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3642 class = SvPVX(*sva); /* We know it's a PV, by construction */
3644 TRACEME(("class ID %d => %s", idx, class));
3647 * Retrieve object and bless it.
3650 sv = retrieve(cxt, class); /* First SV which is SEEN will be blessed */
3658 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3659 * <len> can be coded on either 1 or 5 bytes.
3661 static SV *retrieve_blessed(stcxt_t *cxt, char *cname)
3665 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3668 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3669 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3672 * Decode class name length and read that name.
3674 * Short classnames have two advantages: their length is stored on one
3675 * single byte, and the string can be read on the stack.
3678 GETMARK(len); /* Length coded on a single char? */
3681 TRACEME(("** allocating %d bytes for class name", len+1));
3682 New(10003, class, len+1, char);
3685 class[len] = '\0'; /* Mark string end */
3688 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3691 TRACEME(("new class name \"%s\" will bear ID = %d", class, cxt->classnum));
3693 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
3697 * Retrieve object and bless it.
3700 sv = retrieve(cxt, class); /* First SV which is SEEN will be blessed */
3710 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3711 * with leading mark already read, as usual.
3713 * When recursion was involved during serialization of the object, there
3714 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
3715 * we reach a <flags> marker with the recursion bit cleared.
3717 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
3718 * is held in the <extra> byte, and if the object is tied, the serialized
3719 * magic object comes at the very end:
3721 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
3723 * This means the STORABLE_thaw hook will NOT get a tied variable during its
3724 * processing (since we won't have seen the magic object by the time the hook
3725 * is called). See comments below for why it was done that way.
3727 static SV *retrieve_hook(stcxt_t *cxt, char *cname)
3730 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3741 int clone = cxt->optype & ST_CLONE;
3743 unsigned int extra_type = 0;
3745 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
3746 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3749 * Read flags, which tell us about the type, and whether we need to recurse.
3755 * Create the (empty) object, and mark it as seen.
3757 * This must be done now, because tags are incremented, and during
3758 * serialization, the object tag was affected before recursion could
3762 obj_type = flags & SHF_TYPE_MASK;
3768 sv = (SV *) newAV();
3771 sv = (SV *) newHV();
3775 * Read <extra> flag to know the type of the object.
3776 * Record associated magic type for later.
3778 GETMARK(extra_type);
3779 switch (extra_type) {
3785 sv = (SV *) newAV();
3789 sv = (SV *) newHV();
3793 return retrieve_other(cxt, 0); /* Let it croak */
3797 return retrieve_other(cxt, 0); /* Let it croak */
3799 SEEN(sv, 0); /* Don't bless yet */
3802 * Whilst flags tell us to recurse, do so.
3804 * We don't need to remember the addresses returned by retrieval, because
3805 * all the references will be obtained through indirection via the object
3806 * tags in the object-ID list.
3808 * We need to decrement the reference count for these objects
3809 * because, if the user doesn't save a reference to them in the hook,
3810 * they must be freed when this context is cleaned.
3813 while (flags & SHF_NEED_RECURSE) {
3814 TRACEME(("retrieve_hook recursing..."));
3815 rv = retrieve(cxt, 0);
3819 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
3824 if (flags & SHF_IDX_CLASSNAME) {
3829 * Fetch index from `aclass'
3832 if (flags & SHF_LARGE_CLASSLEN)
3837 sva = av_fetch(cxt->aclass, idx, FALSE);
3839 CROAK(("Class name #%"IVdf" should have been seen already",
3842 class = SvPVX(*sva); /* We know it's a PV, by construction */
3843 TRACEME(("class ID %d => %s", idx, class));
3847 * Decode class name length and read that name.
3849 * NOTA BENE: even if the length is stored on one byte, we don't read
3850 * on the stack. Just like retrieve_blessed(), we limit the name to
3851 * LG_BLESS bytes. This is an arbitrary decision.
3854 if (flags & SHF_LARGE_CLASSLEN)
3859 if (len > LG_BLESS) {
3860 TRACEME(("** allocating %d bytes for class name", len+1));
3861 New(10003, class, len+1, char);
3865 class[len] = '\0'; /* Mark string end */
3868 * Record new classname.
3871 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
3875 TRACEME(("class name: %s", class));
3878 * Decode user-frozen string length and read it in an SV.
3880 * For efficiency reasons, we read data directly into the SV buffer.
3881 * To understand that code, read retrieve_scalar()
3884 if (flags & SHF_LARGE_STRLEN)
3889 frozen = NEWSV(10002, len2);
3891 SAFEREAD(SvPVX(frozen), len2, frozen);
3892 SvCUR_set(frozen, len2);
3893 *SvEND(frozen) = '\0';
3895 (void) SvPOK_only(frozen); /* Validates string pointer */
3896 if (cxt->s_tainted) /* Is input source tainted? */
3899 TRACEME(("frozen string: %d bytes", len2));
3902 * Decode object-ID list length, if present.
3905 if (flags & SHF_HAS_LIST) {
3906 if (flags & SHF_LARGE_LISTLEN)
3912 av_extend(av, len3 + 1); /* Leave room for [0] */
3913 AvFILLp(av) = len3; /* About to be filled anyway */
3917 TRACEME(("has %d object IDs to link", len3));
3920 * Read object-ID list into array.
3921 * Because we pre-extended it, we can cheat and fill it manually.
3923 * We read object tags and we can convert them into SV* on the fly
3924 * because we know all the references listed in there (as tags)
3925 * have been already serialized, hence we have a valid correspondance
3926 * between each of those tags and the recreated SV.
3930 SV **ary = AvARRAY(av);
3932 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
3939 svh = av_fetch(cxt->aseen, tag, FALSE);
3941 CROAK(("Object #%"IVdf" should have been retrieved already",
3944 ary[i] = SvREFCNT_inc(xsv);
3949 * Bless the object and look up the STORABLE_thaw hook.
3953 hook = pkg_can(cxt->hook, SvSTASH(sv), "STORABLE_thaw");
3956 * Hook not found. Maybe they did not require the module where this
3957 * hook is defined yet?
3959 * If the require below succeeds, we'll be able to find the hook.
3960 * Still, it only works reliably when each class is defined in a
3964 SV *psv = newSVpvn("require ", 8);
3965 sv_catpv(psv, class);
3967 TRACEME(("No STORABLE_thaw defined for objects of class %s", class));
3968 TRACEME(("Going to require module '%s' with '%s'", class, SvPVX(psv)));
3970 perl_eval_sv(psv, G_DISCARD);
3974 * We cache results of pkg_can, so we need to uncache before attempting
3978 pkg_uncache(cxt->hook, SvSTASH(sv), "STORABLE_thaw");
3979 hook = pkg_can(cxt->hook, SvSTASH(sv), "STORABLE_thaw");
3982 CROAK(("No STORABLE_thaw defined for objects of class %s "
3983 "(even after a \"require %s;\")", class, class));
3987 * If we don't have an `av' yet, prepare one.
3988 * Then insert the frozen string as item [0].
3996 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4001 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4003 * where $object is our blessed (empty) object, $cloning is a boolean
4004 * telling whether we're running a deep clone, $frozen is the frozen
4005 * string the user gave us in his serializing hook, and @refs, which may
4006 * be empty, is the list of extra references he returned along for us
4009 * In effect, the hook is an alternate creation routine for the class,
4010 * the object itself being already created by the runtime.
4013 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4014 class, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4017 (void) scalar_call(rv, hook, clone, av, G_SCALAR|G_DISCARD);
4024 SvREFCNT_dec(frozen);
4027 if (!(flags & SHF_IDX_CLASSNAME) && class != buf)
4031 * If we had an <extra> type, then the object was not as simple, and
4032 * we need to restore extra magic now.
4038 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4040 rv = retrieve(cxt, 0); /* Retrieve <magic object> */
4042 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4043 PTR2UV(rv), PTR2UV(sv)));
4045 switch (extra_type) {
4047 sv_upgrade(sv, SVt_PVMG);
4050 sv_upgrade(sv, SVt_PVAV);
4051 AvREAL_off((AV *)sv);
4054 sv_upgrade(sv, SVt_PVHV);
4057 CROAK(("Forgot to deal with extra type %d", extra_type));
4062 * Adding the magic only now, well after the STORABLE_thaw hook was called
4063 * means the hook cannot know it deals with an object whose variable is
4064 * tied. But this is happening when retrieving $o in the following case:
4068 * my $o = bless \%h, 'BAR';
4070 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4071 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4072 * hash but a tied one should not matter at all, and remain transparent.
4073 * This means the magic must be restored by Storable AFTER the hook is
4076 * That looks very reasonable to me, but then I've come up with this
4077 * after a bug report from David Nesting, who was trying to store such
4078 * an object and caused Storable to fail. And unfortunately, it was
4079 * also the easiest way to retrofit support for blessed ref to tied objects
4080 * into the existing design. -- RAM, 17/02/2001
4083 sv_magic(sv, rv, mtype, Nullch, 0);
4084 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4092 * Retrieve reference to some other scalar.
4093 * Layout is SX_REF <object>, with SX_REF already read.
4095 static SV *retrieve_ref(stcxt_t *cxt, char *cname)
4100 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4103 * We need to create the SV that holds the reference to the yet-to-retrieve
4104 * object now, so that we may record the address in the seen table.
4105 * Otherwise, if the object to retrieve references us, we won't be able
4106 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4107 * do the retrieve first and use rv = newRV(sv) since it will be too late
4108 * for SEEN() recording.
4111 rv = NEWSV(10002, 0);
4112 SEEN(rv, cname); /* Will return if rv is null */
4113 sv = retrieve(cxt, 0); /* Retrieve <object> */
4115 return (SV *) 0; /* Failed */
4118 * WARNING: breaks RV encapsulation.
4120 * Now for the tricky part. We have to upgrade our existing SV, so that
4121 * it is now an RV on sv... Again, we cheat by duplicating the code
4122 * held in newSVrv(), since we already got our SV from retrieve().
4126 * SvRV(rv) = SvREFCNT_inc(sv);
4128 * here because the reference count we got from retrieve() above is
4129 * already correct: if the object was retrieved from the file, then
4130 * its reference count is one. Otherwise, if it was retrieved via
4131 * an SX_OBJECT indication, a ref count increment was done.
4135 /* Do not use sv_upgrade to preserve STASH */
4136 SvFLAGS(rv) &= ~SVTYPEMASK;
4137 SvFLAGS(rv) |= SVt_RV;
4139 sv_upgrade(rv, SVt_RV);
4142 SvRV(rv) = sv; /* $rv = \$sv */
4145 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4151 * retrieve_overloaded
4153 * Retrieve reference to some other scalar with overloading.
4154 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4156 static SV *retrieve_overloaded(stcxt_t *cxt, char *cname)
4162 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4165 * Same code as retrieve_ref(), duplicated to avoid extra call.
4168 rv = NEWSV(10002, 0);
4169 SEEN(rv, cname); /* Will return if rv is null */
4170 sv = retrieve(cxt, 0); /* Retrieve <object> */
4172 return (SV *) 0; /* Failed */
4175 * WARNING: breaks RV encapsulation.
4178 sv_upgrade(rv, SVt_RV);
4179 SvRV(rv) = sv; /* $rv = \$sv */
4183 * Restore overloading magic.
4186 stash = (HV *) SvSTASH (sv);
4187 if (!stash || !Gv_AMG(stash))
4188 CROAK(("Cannot restore overloading on %s(0x%"UVxf") (package %s)",
4189 sv_reftype(sv, FALSE),
4191 stash ? HvNAME(stash) : "<unknown>"));
4195 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4201 * retrieve_tied_array
4203 * Retrieve tied array
4204 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4206 static SV *retrieve_tied_array(stcxt_t *cxt, char *cname)
4211 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4213 tv = NEWSV(10002, 0);
4214 SEEN(tv, cname); /* Will return if tv is null */
4215 sv = retrieve(cxt, 0); /* Retrieve <object> */
4217 return (SV *) 0; /* Failed */
4219 sv_upgrade(tv, SVt_PVAV);
4220 AvREAL_off((AV *)tv);
4221 sv_magic(tv, sv, 'P', Nullch, 0);
4222 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4224 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4230 * retrieve_tied_hash
4232 * Retrieve tied hash
4233 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4235 static SV *retrieve_tied_hash(stcxt_t *cxt, char *cname)
4240 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4242 tv = NEWSV(10002, 0);
4243 SEEN(tv, cname); /* Will return if tv is null */
4244 sv = retrieve(cxt, 0); /* Retrieve <object> */
4246 return (SV *) 0; /* Failed */
4248 sv_upgrade(tv, SVt_PVHV);
4249 sv_magic(tv, sv, 'P', Nullch, 0);
4250 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4252 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4258 * retrieve_tied_scalar
4260 * Retrieve tied scalar
4261 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4263 static SV *retrieve_tied_scalar(stcxt_t *cxt, char *cname)
4268 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4270 tv = NEWSV(10002, 0);
4271 SEEN(tv, cname); /* Will return if rv is null */
4272 sv = retrieve(cxt, 0); /* Retrieve <object> */
4274 return (SV *) 0; /* Failed */
4276 sv_upgrade(tv, SVt_PVMG);
4277 sv_magic(tv, sv, 'q', Nullch, 0);
4278 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4280 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4288 * Retrieve reference to value in a tied hash.
4289 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4291 static SV *retrieve_tied_key(stcxt_t *cxt, char *cname)
4297 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4299 tv = NEWSV(10002, 0);
4300 SEEN(tv, cname); /* Will return if tv is null */
4301 sv = retrieve(cxt, 0); /* Retrieve <object> */
4303 return (SV *) 0; /* Failed */
4305 key = retrieve(cxt, 0); /* Retrieve <key> */
4307 return (SV *) 0; /* Failed */
4309 sv_upgrade(tv, SVt_PVMG);
4310 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4311 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4312 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4320 * Retrieve reference to value in a tied array.
4321 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4323 static SV *retrieve_tied_idx(stcxt_t *cxt, char *cname)
4329 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4331 tv = NEWSV(10002, 0);
4332 SEEN(tv, cname); /* Will return if tv is null */
4333 sv = retrieve(cxt, 0); /* Retrieve <object> */
4335 return (SV *) 0; /* Failed */
4337 RLEN(idx); /* Retrieve <idx> */
4339 sv_upgrade(tv, SVt_PVMG);
4340 sv_magic(tv, sv, 'p', Nullch, idx);
4341 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4350 * Retrieve defined long (string) scalar.
4352 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4353 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4354 * was not stored on a single byte.
4356 static SV *retrieve_lscalar(stcxt_t *cxt, char *cname)
4362 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4365 * Allocate an empty scalar of the suitable length.
4368 sv = NEWSV(10002, len);
4369 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4372 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4374 * Now, for efficiency reasons, read data directly inside the SV buffer,
4375 * and perform the SV final settings directly by duplicating the final
4376 * work done by sv_setpv. Since we're going to allocate lots of scalars
4377 * this way, it's worth the hassle and risk.
4380 SAFEREAD(SvPVX(sv), len, sv);
4381 SvCUR_set(sv, len); /* Record C string length */
4382 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4383 (void) SvPOK_only(sv); /* Validate string pointer */
4384 if (cxt->s_tainted) /* Is input source tainted? */
4385 SvTAINT(sv); /* External data cannot be trusted */
4387 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4388 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4396 * Retrieve defined short (string) scalar.
4398 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4399 * The scalar is "short" so <length> is single byte. If it is 0, there
4400 * is no <data> section.
4402 static SV *retrieve_scalar(stcxt_t *cxt, char *cname)
4408 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4411 * Allocate an empty scalar of the suitable length.
4414 sv = NEWSV(10002, len);
4415 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4418 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4423 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4424 * To make it defined with an empty length, upgrade it now...
4425 * Don't upgrade to a PV if the original type contains more
4426 * information than a scalar.
4428 if (SvTYPE(sv) <= SVt_PV) {
4429 sv_upgrade(sv, SVt_PV);
4432 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4433 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4436 * Now, for efficiency reasons, read data directly inside the SV buffer,
4437 * and perform the SV final settings directly by duplicating the final
4438 * work done by sv_setpv. Since we're going to allocate lots of scalars
4439 * this way, it's worth the hassle and risk.
4441 SAFEREAD(SvPVX(sv), len, sv);
4442 SvCUR_set(sv, len); /* Record C string length */
4443 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4444 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4447 (void) SvPOK_only(sv); /* Validate string pointer */
4448 if (cxt->s_tainted) /* Is input source tainted? */
4449 SvTAINT(sv); /* External data cannot be trusted */
4451 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4458 * Like retrieve_scalar(), but tag result as utf8.
4459 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4461 static SV *retrieve_utf8str(stcxt_t *cxt, char *cname)
4465 TRACEME(("retrieve_utf8str"));
4467 sv = retrieve_scalar(cxt, cname);
4469 #ifdef HAS_UTF8_SCALARS
4472 if (cxt->use_bytes < 0)
4474 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4476 if (cxt->use_bytes == 0)
4487 * Like retrieve_lscalar(), but tag result as utf8.
4488 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4490 static SV *retrieve_lutf8str(stcxt_t *cxt, char *cname)
4494 TRACEME(("retrieve_lutf8str"));
4496 sv = retrieve_lscalar(cxt, cname);
4498 #ifdef HAS_UTF8_SCALARS
4501 if (cxt->use_bytes < 0)
4503 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4505 if (cxt->use_bytes == 0)
4515 * Retrieve defined integer.
4516 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4518 static SV *retrieve_integer(stcxt_t *cxt, char *cname)
4523 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4525 READ(&iv, sizeof(iv));
4527 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4529 TRACEME(("integer %"IVdf, iv));
4530 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4538 * Retrieve defined integer in network order.
4539 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4541 static SV *retrieve_netint(stcxt_t *cxt, char *cname)
4546 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4550 sv = newSViv((int) ntohl(iv));
4551 TRACEME(("network integer %d", (int) ntohl(iv)));
4554 TRACEME(("network integer (as-is) %d", iv));
4556 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4558 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
4566 * Retrieve defined double.
4567 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
4569 static SV *retrieve_double(stcxt_t *cxt, char *cname)
4574 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
4576 READ(&nv, sizeof(nv));
4578 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4580 TRACEME(("double %"NVff, nv));
4581 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
4589 * Retrieve defined byte (small integer within the [-128, +127] range).
4590 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
4592 static SV *retrieve_byte(stcxt_t *cxt, char *cname)
4596 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
4598 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
4601 TRACEME(("small integer read as %d", (unsigned char) siv));
4602 tmp = (unsigned char) siv - 128;
4604 SEEN(sv, cname); /* Associate this new scalar with tag "tagnum" */
4606 TRACEME(("byte %d", tmp));
4607 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
4615 * Return the undefined value.
4617 static SV *retrieve_undef(stcxt_t *cxt, char *cname)
4621 TRACEME(("retrieve_undef"));
4632 * Return the immortal undefined value.
4634 static SV *retrieve_sv_undef(stcxt_t *cxt, char *cname)
4636 SV *sv = &PL_sv_undef;
4638 TRACEME(("retrieve_sv_undef"));
4647 * Return the immortal yes value.
4649 static SV *retrieve_sv_yes(stcxt_t *cxt, char *cname)
4651 SV *sv = &PL_sv_yes;
4653 TRACEME(("retrieve_sv_yes"));
4662 * Return the immortal no value.
4664 static SV *retrieve_sv_no(stcxt_t *cxt, char *cname)
4668 TRACEME(("retrieve_sv_no"));
4677 * Retrieve a whole array.
4678 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
4679 * Each item is stored as <object>.
4681 * When we come here, SX_ARRAY has been read already.
4683 static SV *retrieve_array(stcxt_t *cxt, char *cname)
4690 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
4693 * Read length, and allocate array, then pre-extend it.
4697 TRACEME(("size = %d", len));
4699 SEEN(av, cname); /* Will return if array not allocated nicely */
4703 return (SV *) av; /* No data follow if array is empty */
4706 * Now get each item in turn...
4709 for (i = 0; i < len; i++) {
4710 TRACEME(("(#%d) item", i));
4711 sv = retrieve(cxt, 0); /* Retrieve item */
4714 if (av_store(av, i, sv) == 0)
4718 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
4726 * Retrieve a whole hash table.
4727 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4728 * Keys are stored as <length> <data>, the <data> section being omitted
4730 * Values are stored as <object>.
4732 * When we come here, SX_HASH has been read already.
4734 static SV *retrieve_hash(stcxt_t *cxt, char *cname)
4742 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
4745 * Read length, allocate table.
4749 TRACEME(("size = %d", len));
4751 SEEN(hv, cname); /* Will return if table not allocated properly */
4753 return (SV *) hv; /* No data follow if table empty */
4754 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
4757 * Now get each key/value pair in turn...
4760 for (i = 0; i < len; i++) {
4765 TRACEME(("(#%d) value", i));
4766 sv = retrieve(cxt, 0);
4772 * Since we're reading into kbuf, we must ensure we're not
4773 * recursing between the read and the hv_store() where it's used.
4774 * Hence the key comes after the value.
4777 RLEN(size); /* Get key size */
4778 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
4781 kbuf[size] = '\0'; /* Mark string end, just in case */
4782 TRACEME(("(#%d) key '%s'", i, kbuf));
4785 * Enter key/value pair into hash table.
4788 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
4792 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
4800 * Retrieve a whole hash table.
4801 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4802 * Keys are stored as <length> <data>, the <data> section being omitted
4804 * Values are stored as <object>.
4806 * When we come here, SX_HASH has been read already.
4808 static SV *retrieve_flag_hash(stcxt_t *cxt, char *cname)
4817 GETMARK(hash_flags);
4818 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
4820 * Read length, allocate table.
4823 #ifndef HAS_RESTRICTED_HASHES
4824 if (hash_flags & SHV_RESTRICTED) {
4825 if (cxt->derestrict < 0)
4827 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
4829 if (cxt->derestrict == 0)
4830 RESTRICTED_HASH_CROAK();
4835 TRACEME(("size = %d, flags = %d", len, hash_flags));
4837 SEEN(hv, cname); /* Will return if table not allocated properly */
4839 return (SV *) hv; /* No data follow if table empty */
4840 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
4843 * Now get each key/value pair in turn...
4846 for (i = 0; i < len; i++) {
4848 int store_flags = 0;
4853 TRACEME(("(#%d) value", i));
4854 sv = retrieve(cxt, 0);
4859 #ifdef HAS_RESTRICTED_HASHES
4860 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
4864 if (flags & SHV_K_ISSV) {
4865 /* XXX you can't set a placeholder with an SV key.
4866 Then again, you can't get an SV key.
4867 Without messing around beyond what the API is supposed to do.
4870 TRACEME(("(#%d) keysv, flags=%d", i, flags));
4871 keysv = retrieve(cxt, 0);
4875 if (!hv_store_ent(hv, keysv, sv, 0))
4880 * Since we're reading into kbuf, we must ensure we're not
4881 * recursing between the read and the hv_store() where it's used.
4882 * Hence the key comes after the value.
4885 if (flags & SHV_K_PLACEHOLDER) {
4888 store_flags |= HVhek_PLACEHOLD;
4890 if (flags & SHV_K_UTF8) {
4891 #ifdef HAS_UTF8_HASHES
4892 store_flags |= HVhek_UTF8;
4894 if (cxt->use_bytes < 0)
4896 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4898 if (cxt->use_bytes == 0)
4902 #ifdef HAS_UTF8_HASHES
4903 if (flags & SHV_K_WASUTF8)
4904 store_flags |= HVhek_WASUTF8;
4907 RLEN(size); /* Get key size */
4908 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
4911 kbuf[size] = '\0'; /* Mark string end, just in case */
4912 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
4913 flags, store_flags));
4916 * Enter key/value pair into hash table.
4919 #ifdef HAS_RESTRICTED_HASHES
4920 if (hv_store_flags(hv, kbuf, size, sv, 0, flags) == 0)
4923 if (!(store_flags & HVhek_PLACEHOLD))
4924 if (hv_store(hv, kbuf, size, sv, 0) == 0)
4929 #ifdef HAS_RESTRICTED_HASHES
4930 if (hash_flags & SHV_RESTRICTED)
4934 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
4942 * Return a code reference.
4944 static SV *retrieve_code(stcxt_t *cxt, char *cname)
4946 #if PERL_VERSION < 6
4947 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
4952 SV *sv, *text, *sub, *errsv;
4954 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
4957 * Retrieve the source of the code reference
4958 * as a small or large scalar
4964 text = retrieve_scalar(cxt, cname);
4967 text = retrieve_lscalar(cxt, cname);
4970 CROAK(("Unexpected type %d in retrieve_code\n", type));
4974 * prepend "sub " to the source
4977 sub = newSVpvn("sub ", 4);
4978 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
4982 * evaluate the source to a code reference and use the CV value
4985 if (cxt->eval == NULL) {
4986 cxt->eval = perl_get_sv("Storable::Eval", TRUE);
4987 SvREFCNT_inc(cxt->eval);
4989 if (!SvTRUE(cxt->eval)) {
4991 cxt->forgive_me == 0 ||
4992 (cxt->forgive_me < 0 && !(cxt->forgive_me =
4993 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
4995 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5005 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5006 SV* errsv = get_sv("@", TRUE);
5007 sv_setpv(errsv, ""); /* clear $@ */
5009 XPUSHs(sv_2mortal(newSVsv(sub)));
5011 count = call_sv(cxt->eval, G_SCALAR);
5014 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5016 if (SvTRUE(errsv)) {
5017 CROAK(("code %s caused an error: %s",
5018 SvPV_nolen(sub), SvPV_nolen(errsv)));
5022 cv = eval_pv(SvPV_nolen(sub), TRUE);
5024 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5027 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5030 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5042 * old_retrieve_array
5044 * Retrieve a whole array in pre-0.6 binary format.
5046 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5047 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5049 * When we come here, SX_ARRAY has been read already.
5051 static SV *old_retrieve_array(stcxt_t *cxt, char *cname)
5059 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5062 * Read length, and allocate array, then pre-extend it.
5066 TRACEME(("size = %d", len));
5068 SEEN(av, 0); /* Will return if array not allocated nicely */
5072 return (SV *) av; /* No data follow if array is empty */
5075 * Now get each item in turn...
5078 for (i = 0; i < len; i++) {
5080 if (c == SX_IT_UNDEF) {
5081 TRACEME(("(#%d) undef item", i));
5082 continue; /* av_extend() already filled us with undef */
5085 (void) retrieve_other((stcxt_t *) 0, 0); /* Will croak out */
5086 TRACEME(("(#%d) item", i));
5087 sv = retrieve(cxt, 0); /* Retrieve item */
5090 if (av_store(av, i, sv) == 0)
5094 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5102 * Retrieve a whole hash table in pre-0.6 binary format.
5104 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5105 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5107 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5109 * When we come here, SX_HASH has been read already.
5111 static SV *old_retrieve_hash(stcxt_t *cxt, char *cname)
5119 static SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5121 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5124 * Read length, allocate table.
5128 TRACEME(("size = %d", len));
5130 SEEN(hv, 0); /* Will return if table not allocated properly */
5132 return (SV *) hv; /* No data follow if table empty */
5133 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5136 * Now get each key/value pair in turn...
5139 for (i = 0; i < len; i++) {
5145 if (c == SX_VL_UNDEF) {
5146 TRACEME(("(#%d) undef value", i));
5148 * Due to a bug in hv_store(), it's not possible to pass
5149 * &PL_sv_undef to hv_store() as a value, otherwise the
5150 * associated key will not be creatable any more. -- RAM, 14/01/97
5153 sv_h_undef = newSVsv(&PL_sv_undef);
5154 sv = SvREFCNT_inc(sv_h_undef);
5155 } else if (c == SX_VALUE) {
5156 TRACEME(("(#%d) value", i));
5157 sv = retrieve(cxt, 0);
5161 (void) retrieve_other((stcxt_t *) 0, 0); /* Will croak out */
5165 * Since we're reading into kbuf, we must ensure we're not
5166 * recursing between the read and the hv_store() where it's used.
5167 * Hence the key comes after the value.
5172 (void) retrieve_other((stcxt_t *) 0, 0); /* Will croak out */
5173 RLEN(size); /* Get key size */
5174 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5177 kbuf[size] = '\0'; /* Mark string end, just in case */
5178 TRACEME(("(#%d) key '%s'", i, kbuf));
5181 * Enter key/value pair into hash table.
5184 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5188 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5194 *** Retrieval engine.
5200 * Make sure the stored data we're trying to retrieve has been produced
5201 * on an ILP compatible system with the same byteorder. It croaks out in
5202 * case an error is detected. [ILP = integer-long-pointer sizes]
5203 * Returns null if error is detected, &PL_sv_undef otherwise.
5205 * Note that there's no byte ordering info emitted when network order was
5206 * used at store time.
5208 static SV *magic_check(stcxt_t *cxt)
5210 /* The worst case for a malicious header would be old magic (which is
5211 longer), major, minor, byteorder length byte of 255, 255 bytes of
5212 garbage, sizeof int, long, pointer, NV.
5213 So the worse of that we can read is 255 bytes of garbage plus 4.
5214 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5215 compiling perl on a system with chars that are larger than 8 bits.
5216 (Even Crays aren't *that* perverse).
5218 unsigned char buf[4 + 255];
5219 unsigned char *current;
5222 int use_network_order;
5225 int version_minor = 0;
5227 TRACEME(("magic_check"));
5230 * The "magic number" is only for files, not when freezing in memory.
5234 /* This includes the '\0' at the end. I want to read the extra byte,
5235 which is usually going to be the major version number. */
5236 STRLEN len = sizeof(magicstr);
5239 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5241 /* Point at the byte after the byte we read. */
5242 current = buf + --len; /* Do the -- outside of macros. */
5244 if (memNE(buf, magicstr, len)) {
5246 * Try to read more bytes to check for the old magic number, which
5250 TRACEME(("trying for old magic number"));
5252 old_len = sizeof(old_magicstr) - 1;
5253 READ(current + 1, (SSize_t)(old_len - len));
5255 if (memNE(buf, old_magicstr, old_len))
5256 CROAK(("File is not a perl storable"));
5257 current = buf + old_len;
5259 use_network_order = *current;
5261 GETMARK(use_network_order);
5264 * Starting with 0.6, the "use_network_order" byte flag is also used to
5265 * indicate the version number of the binary, and therefore governs the
5266 * setting of sv_retrieve_vtbl. See magic_write().
5269 version_major = use_network_order >> 1;
5270 cxt->retrieve_vtbl = version_major ? sv_retrieve : sv_old_retrieve;
5272 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5276 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5277 * minor version of the protocol. See magic_write().
5280 if (version_major > 1)
5281 GETMARK(version_minor);
5283 cxt->ver_major = version_major;
5284 cxt->ver_minor = version_minor;
5286 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5289 * Inter-operability sanity check: we can't retrieve something stored
5290 * using a format more recent than ours, because we have no way to
5291 * know what has changed, and letting retrieval go would mean a probable
5292 * failure reporting a "corrupted" storable file.
5296 version_major > STORABLE_BIN_MAJOR ||
5297 (version_major == STORABLE_BIN_MAJOR &&
5298 version_minor > STORABLE_BIN_MINOR)
5301 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5302 STORABLE_BIN_MINOR));
5304 if (version_major == STORABLE_BIN_MAJOR) {
5305 TRACEME(("cxt->accept_future_minor is %d",
5306 cxt->accept_future_minor));
5307 if (cxt->accept_future_minor < 0)
5308 cxt->accept_future_minor
5309 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5312 if (cxt->accept_future_minor == 1)
5313 croak_now = 0; /* Don't croak yet. */
5316 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5317 version_major, version_minor,
5318 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5323 * If they stored using network order, there's no byte ordering
5324 * information to check.
5327 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5328 return &PL_sv_undef; /* No byte ordering info */
5330 /* In C truth is 1, falsehood is 0. Very convienient. */
5331 use_NV_size = version_major >= 2 && version_minor >= 2;
5334 length = c + 3 + use_NV_size;
5335 READ(buf, length); /* Not null-terminated */
5337 TRACEME(("byte order '%.*s' %d", c, buf, c));
5339 #ifdef USE_56_INTERWORK_KLUDGE
5340 /* No point in caching this in the context as we only need it once per
5341 retrieve, and we need to recheck it each read. */
5342 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5343 if ((c != (sizeof (byteorderstr_56) - 1))
5344 || memNE(buf, byteorderstr_56, c))
5345 CROAK(("Byte order is not compatible"));
5349 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5350 CROAK(("Byte order is not compatible"));
5356 if ((int) *current++ != sizeof(int))
5357 CROAK(("Integer size is not compatible"));
5360 if ((int) *current++ != sizeof(long))
5361 CROAK(("Long integer size is not compatible"));
5363 /* sizeof(char *) */
5364 if ((int) *current != sizeof(char *))
5365 CROAK(("Pointer size is not compatible"));
5369 if ((int) *++current != sizeof(NV))
5370 CROAK(("Double size is not compatible"));
5373 return &PL_sv_undef; /* OK */
5379 * Recursively retrieve objects from the specified file and return their
5380 * root SV (which may be an AV or an HV for what we care).
5381 * Returns null if there is a problem.
5383 static SV *retrieve(stcxt_t *cxt, char *cname)
5389 TRACEME(("retrieve"));
5392 * Grab address tag which identifies the object if we are retrieving
5393 * an older format. Since the new binary format counts objects and no
5394 * longer explicitely tags them, we must keep track of the correspondance
5397 * The following section will disappear one day when the old format is
5398 * no longer supported, hence the final "goto" in the "if" block.
5401 if (cxt->hseen) { /* Retrieving old binary */
5403 if (cxt->netorder) {
5405 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5406 tag = (stag_t) nettag;
5408 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5411 if (type == SX_OBJECT) {
5413 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5415 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5417 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5420 * The following code is common with the SX_OBJECT case below.
5423 svh = av_fetch(cxt->aseen, tagn, FALSE);
5425 CROAK(("Object #%"IVdf" should have been retrieved already",
5428 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5429 SvREFCNT_inc(sv); /* One more reference to this same sv */
5430 return sv; /* The SV pointer where object was retrieved */
5434 * Map new object, but don't increase tagnum. This will be done
5435 * by each of the retrieve_* functions when they call SEEN().
5437 * The mapping associates the "tag" initially present with a unique
5438 * tag number. See test for SX_OBJECT above to see how this is perused.
5441 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5442 newSViv(cxt->tagnum), 0))
5449 * Regular post-0.6 binary format.
5454 TRACEME(("retrieve type = %d", type));
5457 * Are we dealing with an object we should have already retrieved?
5460 if (type == SX_OBJECT) {
5464 svh = av_fetch(cxt->aseen, tag, FALSE);
5466 CROAK(("Object #%"IVdf" should have been retrieved already",
5469 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5470 SvREFCNT_inc(sv); /* One more reference to this same sv */
5471 return sv; /* The SV pointer where object was retrieved */
5472 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5473 if (cxt->accept_future_minor < 0)
5474 cxt->accept_future_minor
5475 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5478 if (cxt->accept_future_minor == 1) {
5479 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5480 "This Storable is v%d.%d and can only handle data types up to %d",
5481 cxt->ver_major, cxt->ver_minor, type,
5482 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5486 first_time: /* Will disappear when support for old format is dropped */
5489 * Okay, first time through for this one.
5492 sv = RETRIEVE(cxt, type)(cxt, cname);
5494 return (SV *) 0; /* Failed */
5497 * Old binary formats (pre-0.7).
5499 * Final notifications, ended by SX_STORED may now follow.
5500 * Currently, the only pertinent notification to apply on the
5501 * freshly retrieved object is either:
5502 * SX_CLASS <char-len> <classname> for short classnames.
5503 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5504 * Class name is then read into the key buffer pool used by
5505 * hash table key retrieval.
5508 if (cxt->ver_major < 2) {
5509 while ((type = GETCHAR()) != SX_STORED) {
5513 GETMARK(len); /* Length coded on a single char */
5515 case SX_LG_CLASS: /* Length coded on a regular integer */
5520 return (SV *) 0; /* Failed */
5522 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5525 kbuf[len] = '\0'; /* Mark string end */
5530 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5531 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
5539 * Retrieve data held in file and return the root object.
5540 * Common routine for pretrieve and mretrieve.
5542 static SV *do_retrieve(
5549 int is_tainted; /* Is input source tainted? */
5550 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
5552 TRACEME(("do_retrieve (optype = 0x%x)", optype));
5554 optype |= ST_RETRIEVE;
5557 * Sanity assertions for retrieve dispatch tables.
5560 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
5561 ("old and new retrieve dispatch table have same size"));
5562 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
5563 ("SX_ERROR entry correctly initialized in old dispatch table"));
5564 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
5565 ("SX_ERROR entry correctly initialized in new dispatch table"));
5568 * Workaround for CROAK leak: if they enter with a "dirty" context,
5569 * free up memory for them now.
5576 * Now that STORABLE_xxx hooks exist, it is possible that they try to
5577 * re-enter retrieve() via the hooks.
5581 cxt = allocate_context(cxt);
5585 ASSERT(cxt->entry == 1, ("starting new recursion"));
5586 ASSERT(!cxt->s_dirty, ("clean context"));
5591 * Data is loaded into the memory buffer when f is NULL, unless `in' is
5592 * also NULL, in which case we're expecting the data to already lie
5593 * in the buffer (dclone case).
5596 KBUFINIT(); /* Allocate hash key reading pool once */
5599 MBUF_SAVE_AND_LOAD(in);
5602 * Magic number verifications.
5604 * This needs to be done before calling init_retrieve_context()
5605 * since the format indication in the file are necessary to conduct
5606 * some of the initializations.
5609 cxt->fio = f; /* Where I/O are performed */
5611 if (!magic_check(cxt))
5612 CROAK(("Magic number checking on storable %s failed",
5613 cxt->fio ? "file" : "string"));
5615 TRACEME(("data stored in %s format",
5616 cxt->netorder ? "net order" : "native"));
5619 * Check whether input source is tainted, so that we don't wrongly
5620 * taint perfectly good values...
5622 * We assume file input is always tainted. If both `f' and `in' are
5623 * NULL, then we come from dclone, and tainted is already filled in
5624 * the context. That's a kludge, but the whole dclone() thing is
5625 * already quite a kludge anyway! -- RAM, 15/09/2000.
5628 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
5629 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
5630 init_retrieve_context(cxt, optype, is_tainted);
5632 ASSERT(is_retrieving(), ("within retrieve operation"));
5634 sv = retrieve(cxt, 0); /* Recursively retrieve object, get root SV */
5643 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
5646 * The "root" context is never freed.
5649 clean_retrieve_context(cxt);
5650 if (cxt->prev) /* This context was stacked */
5651 free_context(cxt); /* It was not the "root" context */
5654 * Prepare returned value.
5658 TRACEME(("retrieve ERROR"));
5659 #if (PATCHLEVEL <= 4)
5660 /* perl 5.00405 seems to screw up at this point with an
5661 'attempt to modify a read only value' error reported in the
5662 eval { $self = pretrieve(*FILE) } in _retrieve.
5663 I can't see what the cause of this error is, but I suspect a
5664 bug in 5.004, as it seems to be capable of issuing spurious
5665 errors or core dumping with matches on $@. I'm not going to
5666 spend time on what could be a fruitless search for the cause,
5667 so here's a bodge. If you're running 5.004 and don't like
5668 this inefficiency, either upgrade to a newer perl, or you are
5669 welcome to find the problem and send in a patch.
5673 return &PL_sv_undef; /* Something went wrong, return undef */
5677 TRACEME(("retrieve got %s(0x%"UVxf")",
5678 sv_reftype(sv, FALSE), PTR2UV(sv)));
5681 * Backward compatibility with Storable-0.5@9 (which we know we
5682 * are retrieving if hseen is non-null): don't create an extra RV
5683 * for objects since we special-cased it at store time.
5685 * Build a reference to the SV returned by pretrieve even if it is
5686 * already one and not a scalar, for consistency reasons.
5689 if (pre_06_fmt) { /* Was not handling overloading by then */
5691 TRACEME(("fixing for old formats -- pre 0.6"));
5692 if (sv_type(sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
5693 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
5699 * If reference is overloaded, restore behaviour.
5701 * NB: minor glitch here: normally, overloaded refs are stored specially
5702 * so that we can croak when behaviour cannot be re-installed, and also
5703 * avoid testing for overloading magic at each reference retrieval.
5705 * Unfortunately, the root reference is implicitely stored, so we must
5706 * check for possible overloading now. Furthermore, if we don't restore
5707 * overloading, we cannot croak as if the original ref was, because we
5708 * have no way to determine whether it was an overloaded ref or not in
5711 * It's a pity that overloading magic is attached to the rv, and not to
5712 * the underlying sv as blessing is.
5716 HV *stash = (HV *) SvSTASH(sv);
5717 SV *rv = newRV_noinc(sv);
5718 if (stash && Gv_AMG(stash)) {
5720 TRACEME(("restored overloading on root reference"));
5722 TRACEME(("ended do_retrieve() with an object"));
5726 TRACEME(("regular do_retrieve() end"));
5728 return newRV_noinc(sv);
5734 * Retrieve data held in file and return the root object, undef on error.
5736 SV *pretrieve(PerlIO *f)
5738 TRACEME(("pretrieve"));
5739 return do_retrieve(f, Nullsv, 0);
5745 * Retrieve data held in scalar and return the root object, undef on error.
5747 SV *mretrieve(SV *sv)
5749 TRACEME(("mretrieve"));
5750 return do_retrieve((PerlIO*) 0, sv, 0);
5760 * Deep clone: returns a fresh copy of the original referenced SV tree.
5762 * This is achieved by storing the object in memory and restoring from
5763 * there. Not that efficient, but it should be faster than doing it from
5770 stcxt_t *real_context;
5773 TRACEME(("dclone"));
5776 * Workaround for CROAK leak: if they enter with a "dirty" context,
5777 * free up memory for them now.
5784 * do_store() optimizes for dclone by not freeing its context, should
5785 * we need to allocate one because we're deep cloning from a hook.
5788 if (!do_store((PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
5789 return &PL_sv_undef; /* Error during store */
5792 * Because of the above optimization, we have to refresh the context,
5793 * since a new one could have been allocated and stacked by do_store().
5796 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
5797 cxt = real_context; /* And we need this temporary... */
5800 * Now, `cxt' may refer to a new context.
5803 ASSERT(!cxt->s_dirty, ("clean context"));
5804 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
5807 TRACEME(("dclone stored %d bytes", size));
5811 * Since we're passing do_retrieve() both a NULL file and sv, we need
5812 * to pre-compute the taintedness of the input by setting cxt->tainted
5813 * to whatever state our own input string was. -- RAM, 15/09/2000
5815 * do_retrieve() will free non-root context.
5818 cxt->s_tainted = SvTAINTED(sv);
5819 out = do_retrieve((PerlIO*) 0, Nullsv, ST_CLONE);
5821 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
5831 * The Perl IO GV object distinguishes between input and output for sockets
5832 * but not for plain files. To allow Storable to transparently work on
5833 * plain files and sockets transparently, we have to ask xsubpp to fetch the
5834 * right object for us. Hence the OutputStream and InputStream declarations.
5836 * Before perl 5.004_05, those entries in the standard typemap are not
5837 * defined in perl include files, so we do that here.
5840 #ifndef OutputStream
5841 #define OutputStream PerlIO *
5842 #define InputStream PerlIO *
5843 #endif /* !OutputStream */
5845 MODULE = Storable PACKAGE = Storable::Cxt
5851 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
5855 if (!cxt->membuf_ro && mbase)
5857 if (cxt->membuf_ro && (cxt->msaved).arena)
5858 Safefree((cxt->msaved).arena);
5861 MODULE = Storable PACKAGE = Storable
5867 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
5869 /* Only disable the used only once warning if we are in debugging mode. */
5870 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
5872 #ifdef USE_56_INTERWORK_KLUDGE
5873 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
5907 last_op_in_netorder()
projects / p5sagit/p5-mst-13.2.git / blob