2 * Store and retrieve mechanism.
4 * Copyright (c) 1995-2000, Raphael Manfredi
6 * You may redistribute only under the same terms as Perl 5, as specified
7 * in the README file that comes with the distribution.
11 #define PERL_NO_GET_CONTEXT /* we want efficiency */
17 #include <patchlevel.h> /* Perl's one, needed since 5.6 */
20 #if !defined(PERL_VERSION) || PERL_VERSION < 8
21 #include "ppport.h" /* handle old perls */
26 #define DEBUGME /* Debug mode, turns assertions on as well */
27 #define DASSERT /* Assertion mode */
30 #if 0 /* On NetWare USE_PERLIO is not used */
31 #define DEBUGME /* Debug mode, turns assertions on as well */
32 #define DASSERT /* Assertion mode */
37 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
38 * Provide them with the necessary defines so they can build with pre-5.004.
41 #ifndef PERLIO_IS_STDIO
43 #define PerlIO_getc(x) getc(x)
44 #define PerlIO_putc(f,x) putc(x,f)
45 #define PerlIO_read(x,y,z) fread(y,1,z,x)
46 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
47 #define PerlIO_stdoutf printf
48 #endif /* PERLIO_IS_STDIO */
49 #endif /* USE_PERLIO */
52 * Earlier versions of perl might be used, we can't assume they have the latest!
55 #ifndef PERL_VERSION /* For perls < 5.6 */
56 #define PERL_VERSION PATCHLEVEL
58 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
60 #if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
61 #define PL_sv_yes sv_yes
62 #define PL_sv_no sv_no
63 #define PL_sv_undef sv_undef
64 #if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
65 #define newSVpvn newSVpv
67 #endif /* PATCHLEVEL <= 4 */
68 #ifndef HvSHAREKEYS_off
69 #define HvSHAREKEYS_off(hv) /* Ignore */
71 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
72 #define AvFILLp AvFILL
74 typedef double NV; /* Older perls lack the NV type */
75 #define IVdf "ld" /* Various printf formats for Perl types */
79 #define INT2PTR(t,v) (t)(IV)(v)
80 #define PTR2UV(v) (unsigned long)(v)
81 #endif /* PERL_VERSION -- perls < 5.6 */
83 #ifndef NVef /* The following were not part of perl 5.6 */
84 #if defined(USE_LONG_DOUBLE) && \
85 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
86 #define NVef PERL_PRIeldbl
87 #define NVff PERL_PRIfldbl
88 #define NVgf PERL_PRIgldbl
103 * TRACEME() will only output things when the $Storable::DEBUGME is true.
108 if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
109 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
116 #define ASSERT(x,y) \
119 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
120 __FILE__, __LINE__); \
121 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
132 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
134 #define SX_OBJECT C(0) /* Already stored object */
135 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
136 #define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
137 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
138 #define SX_REF C(4) /* Reference to object forthcoming */
139 #define SX_UNDEF C(5) /* Undefined scalar */
140 #define SX_INTEGER C(6) /* Integer forthcoming */
141 #define SX_DOUBLE C(7) /* Double forthcoming */
142 #define SX_BYTE C(8) /* (signed) byte forthcoming */
143 #define SX_NETINT C(9) /* Integer in network order forthcoming */
144 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
145 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
146 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
147 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
148 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
149 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
150 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
151 #define SX_BLESS C(17) /* Object is blessed */
152 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
153 #define SX_HOOK C(19) /* Stored via hook, user-defined */
154 #define SX_OVERLOAD C(20) /* Overloaded reference */
155 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
156 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
157 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
158 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
159 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
160 #define SX_CODE C(26) /* Code references as perl source code */
161 #define SX_WEAKREF C(27) /* Weak reference to object forthcoming */
162 #define SX_WEAKOVERLOAD C(28) /* Overloaded weak reference */
163 #define SX_ERROR C(29) /* Error */
166 * Those are only used to retrieve "old" pre-0.6 binary images.
168 #define SX_ITEM 'i' /* An array item introducer */
169 #define SX_IT_UNDEF 'I' /* Undefined array item */
170 #define SX_KEY 'k' /* A hash key introducer */
171 #define SX_VALUE 'v' /* A hash value introducer */
172 #define SX_VL_UNDEF 'V' /* Undefined hash value */
175 * Those are only used to retrieve "old" pre-0.7 binary images
178 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
179 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
180 #define SX_STORED 'X' /* End of object */
183 * Limits between short/long length representation.
186 #define LG_SCALAR 255 /* Large scalar length limit */
187 #define LG_BLESS 127 /* Large classname bless limit */
193 #define ST_STORE 0x1 /* Store operation */
194 #define ST_RETRIEVE 0x2 /* Retrieval operation */
195 #define ST_CLONE 0x4 /* Deep cloning operation */
198 * The following structure is used for hash table key retrieval. Since, when
199 * retrieving objects, we'll be facing blessed hash references, it's best
200 * to pre-allocate that buffer once and resize it as the need arises, never
201 * freeing it (keys will be saved away someplace else anyway, so even large
202 * keys are not enough a motivation to reclaim that space).
204 * This structure is also used for memory store/retrieve operations which
205 * happen in a fixed place before being malloc'ed elsewhere if persistency
206 * is required. Hence the aptr pointer.
209 char *arena; /* Will hold hash key strings, resized as needed */
210 STRLEN asiz; /* Size of aforementionned buffer */
211 char *aptr; /* Arena pointer, for in-place read/write ops */
212 char *aend; /* First invalid address */
217 * A hash table records the objects which have already been stored.
218 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
219 * an arbitrary sequence number) is used to identify them.
222 * An array table records the objects which have already been retrieved,
223 * as seen by the tag determind by counting the objects themselves. The
224 * reference to that retrieved object is kept in the table, and is returned
225 * when an SX_OBJECT is found bearing that same tag.
227 * The same processing is used to record "classname" for blessed objects:
228 * indexing by a hash at store time, and via an array at retrieve time.
231 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
234 * The following "thread-safe" related defines were contributed by
235 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
236 * only renamed things a little bit to ensure consistency with surrounding
237 * code. -- RAM, 14/09/1999
239 * The original patch suffered from the fact that the stcxt_t structure
240 * was global. Murray tried to minimize the impact on the code as much as
243 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
244 * on objects. Therefore, the notion of context needs to be generalized,
248 #define MY_VERSION "Storable(" XS_VERSION ")"
252 * Conditional UTF8 support.
256 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
257 #define HAS_UTF8_SCALARS
259 #define HAS_UTF8_HASHES
262 /* 5.6 perl has utf8 scalars but not hashes */
266 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
269 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
272 #define WEAKREF_CROAK() CROAK(("Cannot retrieve weak references in this perl"))
275 #ifdef HvPLACEHOLDERS
276 #define HAS_RESTRICTED_HASHES
278 #define HVhek_PLACEHOLD 0x200
279 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
283 #define HAS_HASH_KEY_FLAGS
287 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
288 * files remap tainted and dirty when threading is enabled. That's bad for
289 * perl to remap such common words. -- RAM, 29/09/00
292 typedef struct stcxt {
293 int entry; /* flags recursion */
294 int optype; /* type of traversal operation */
295 HV *hseen; /* which objects have been seen, store time */
296 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
297 AV *aseen; /* which objects have been seen, retrieve time */
298 IV where_is_undef; /* index in aseen of PL_sv_undef */
299 HV *hclass; /* which classnames have been seen, store time */
300 AV *aclass; /* which classnames have been seen, retrieve time */
301 HV *hook; /* cache for hook methods per class name */
302 IV tagnum; /* incremented at store time for each seen object */
303 IV classnum; /* incremented at store time for each seen classname */
304 int netorder; /* true if network order used */
305 int s_tainted; /* true if input source is tainted, at retrieve time */
306 int forgive_me; /* whether to be forgiving... */
307 int deparse; /* whether to deparse code refs */
308 SV *eval; /* whether to eval source code */
309 int canonical; /* whether to store hashes sorted by key */
310 #ifndef HAS_RESTRICTED_HASHES
311 int derestrict; /* whether to downgrade restrcted hashes */
314 int use_bytes; /* whether to bytes-ify utf8 */
316 int accept_future_minor; /* croak immediately on future minor versions? */
317 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
318 int membuf_ro; /* true means membuf is read-only and msaved is rw */
319 struct extendable keybuf; /* for hash key retrieval */
320 struct extendable membuf; /* for memory store/retrieve operations */
321 struct extendable msaved; /* where potentially valid mbuf is saved */
322 PerlIO *fio; /* where I/O are performed, NULL for memory */
323 int ver_major; /* major of version for retrieved object */
324 int ver_minor; /* minor of version for retrieved object */
325 SV *(**retrieve_vtbl)(); /* retrieve dispatch table */
326 SV *prev; /* contexts chained backwards in real recursion */
327 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
330 #define NEW_STORABLE_CXT_OBJ(cxt) \
332 SV *self = newSV(sizeof(stcxt_t) - 1); \
333 SV *my_sv = newRV_noinc(self); \
334 sv_bless(my_sv, gv_stashpv("Storable::Cxt", TRUE)); \
335 cxt = (stcxt_t *)SvPVX(self); \
336 Zero(cxt, 1, stcxt_t); \
337 cxt->my_sv = my_sv; \
340 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
342 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
344 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
345 #else /* >= perl5.004_68 */
347 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
348 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
349 #endif /* < perl5.004_68 */
351 #define dSTCXT_PTR(T,name) \
352 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
353 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
356 dSTCXT_PTR(stcxt_t *, cxt)
360 NEW_STORABLE_CXT_OBJ(cxt); \
361 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
363 #define SET_STCXT(x) \
366 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
369 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
371 static stcxt_t *Context_ptr = NULL;
372 #define dSTCXT stcxt_t *cxt = Context_ptr
373 #define SET_STCXT(x) Context_ptr = x
376 NEW_STORABLE_CXT_OBJ(cxt); \
380 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
384 * Croaking implies a memory leak, since we don't use setjmp/longjmp
385 * to catch the exit and free memory used during store or retrieve
386 * operations. This is not too difficult to fix, but I need to understand
387 * how Perl does it, and croaking is exceptional anyway, so I lack the
388 * motivation to do it.
390 * The current workaround is to mark the context as dirty when croaking,
391 * so that data structures can be freed whenever we renter Storable code
392 * (but only *then*: it's a workaround, not a fix).
394 * This is also imperfect, because we don't really know how far they trapped
395 * the croak(), and when we were recursing, we won't be able to clean anything
396 * but the topmost context stacked.
399 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
402 * End of "thread-safe" related definitions.
408 * Keep only the low 32 bits of a pointer (used for tags, which are not
413 #define LOW_32BITS(x) ((I32) (x))
415 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
421 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
422 * Used in the WLEN and RLEN macros.
426 #define oI(x) ((I32 *) ((char *) (x) + 4))
427 #define oS(x) ((x) - 4)
428 #define oC(x) (x = 0)
437 * key buffer handling
439 #define kbuf (cxt->keybuf).arena
440 #define ksiz (cxt->keybuf).asiz
444 TRACEME(("** allocating kbuf of 128 bytes")); \
445 New(10003, kbuf, 128, char); \
452 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
453 Renew(kbuf, x+1, char); \
459 * memory buffer handling
461 #define mbase (cxt->membuf).arena
462 #define msiz (cxt->membuf).asiz
463 #define mptr (cxt->membuf).aptr
464 #define mend (cxt->membuf).aend
466 #define MGROW (1 << 13)
467 #define MMASK (MGROW - 1)
469 #define round_mgrow(x) \
470 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
471 #define trunc_int(x) \
472 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
473 #define int_aligned(x) \
474 ((unsigned long) (x) == trunc_int(x))
476 #define MBUF_INIT(x) \
479 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
480 New(10003, mbase, MGROW, char); \
481 msiz = (STRLEN)MGROW; \
487 mend = mbase + msiz; \
490 #define MBUF_TRUNC(x) mptr = mbase + x
491 #define MBUF_SIZE() (mptr - mbase)
497 * Those macros are used in do_retrieve() to save the current memory
498 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
499 * data from a string.
501 #define MBUF_SAVE_AND_LOAD(in) \
503 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
504 cxt->membuf_ro = 1; \
505 TRACEME(("saving mbuf")); \
506 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
510 #define MBUF_RESTORE() \
512 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
513 cxt->membuf_ro = 0; \
514 TRACEME(("restoring mbuf")); \
515 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
519 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
520 * See store_scalar() for other usage of this workaround.
522 #define MBUF_LOAD(v) \
524 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
526 CROAK(("Not a scalar string")); \
527 mptr = mbase = SvPV(v, msiz); \
528 mend = mbase + msiz; \
531 #define MBUF_XTEND(x) \
533 int nsz = (int) round_mgrow((x)+msiz); \
534 int offset = mptr - mbase; \
535 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
536 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
538 Renew(mbase, nsz, char); \
540 mptr = mbase + offset; \
541 mend = mbase + nsz; \
544 #define MBUF_CHK(x) \
546 if ((mptr + (x)) > mend) \
550 #define MBUF_GETC(x) \
553 x = (int) (unsigned char) *mptr++; \
559 #define MBUF_GETINT(x) \
562 if ((mptr + 4) <= mend) { \
563 memcpy(oI(&x), mptr, 4); \
569 #define MBUF_GETINT(x) \
571 if ((mptr + sizeof(int)) <= mend) { \
572 if (int_aligned(mptr)) \
575 memcpy(&x, mptr, sizeof(int)); \
576 mptr += sizeof(int); \
582 #define MBUF_READ(x,s) \
584 if ((mptr + (s)) <= mend) { \
585 memcpy(x, mptr, s); \
591 #define MBUF_SAFEREAD(x,s,z) \
593 if ((mptr + (s)) <= mend) { \
594 memcpy(x, mptr, s); \
602 #define MBUF_PUTC(c) \
605 *mptr++ = (char) c; \
608 *mptr++ = (char) c; \
613 #define MBUF_PUTINT(i) \
616 memcpy(mptr, oI(&i), 4); \
620 #define MBUF_PUTINT(i) \
622 MBUF_CHK(sizeof(int)); \
623 if (int_aligned(mptr)) \
626 memcpy(mptr, &i, sizeof(int)); \
627 mptr += sizeof(int); \
631 #define MBUF_WRITE(x,s) \
634 memcpy(mptr, x, s); \
639 * Possible return values for sv_type().
643 #define svis_SCALAR 1
647 #define svis_TIED_ITEM 5
655 #define SHF_TYPE_MASK 0x03
656 #define SHF_LARGE_CLASSLEN 0x04
657 #define SHF_LARGE_STRLEN 0x08
658 #define SHF_LARGE_LISTLEN 0x10
659 #define SHF_IDX_CLASSNAME 0x20
660 #define SHF_NEED_RECURSE 0x40
661 #define SHF_HAS_LIST 0x80
664 * Types for SX_HOOK (last 2 bits in flags).
670 #define SHT_EXTRA 3 /* Read extra byte for type */
673 * The following are held in the "extra byte"...
676 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
677 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
678 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
681 * per hash flags for flagged hashes
684 #define SHV_RESTRICTED 0x01
687 * per key flags for flagged hashes
690 #define SHV_K_UTF8 0x01
691 #define SHV_K_WASUTF8 0x02
692 #define SHV_K_LOCKED 0x04
693 #define SHV_K_ISSV 0x08
694 #define SHV_K_PLACEHOLDER 0x10
697 * Before 0.6, the magic string was "perl-store" (binary version number 0).
699 * Since 0.6 introduced many binary incompatibilities, the magic string has
700 * been changed to "pst0" to allow an old image to be properly retrieved by
701 * a newer Storable, but ensure a newer image cannot be retrieved with an
704 * At 0.7, objects are given the ability to serialize themselves, and the
705 * set of markers is extended, backward compatibility is not jeopardized,
706 * so the binary version number could have remained unchanged. To correctly
707 * spot errors if a file making use of 0.7-specific extensions is given to
708 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
709 * a "minor" version, to better track this kind of evolution from now on.
712 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
713 static const char magicstr[] = "pst0"; /* Used as a magic number */
715 #define MAGICSTR_BYTES 'p','s','t','0'
716 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
718 /* 5.6.x introduced the ability to have IVs as long long.
719 However, Configure still defined BYTEORDER based on the size of a long.
720 Storable uses the BYTEORDER value as part of the header, but doesn't
721 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
722 with IV as long long on a platform that uses Configure (ie most things
723 except VMS and Windows) headers are identical for the different IV sizes,
724 despite the files containing some fields based on sizeof(IV)
726 5.8 is consistent - the following redifinition kludge is only needed on
727 5.6.x, but the interwork is needed on 5.8 while data survives in files
732 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
733 #ifndef NO_56_INTERWORK_KLUDGE
734 #define USE_56_INTERWORK_KLUDGE
736 #if BYTEORDER == 0x1234
738 #define BYTEORDER 0x12345678
740 #if BYTEORDER == 0x4321
742 #define BYTEORDER 0x87654321
747 #if BYTEORDER == 0x1234
748 #define BYTEORDER_BYTES '1','2','3','4'
750 #if BYTEORDER == 0x12345678
751 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
752 #ifdef USE_56_INTERWORK_KLUDGE
753 #define BYTEORDER_BYTES_56 '1','2','3','4'
756 #if BYTEORDER == 0x87654321
757 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
758 #ifdef USE_56_INTERWORK_KLUDGE
759 #define BYTEORDER_BYTES_56 '4','3','2','1'
762 #if BYTEORDER == 0x4321
763 #define BYTEORDER_BYTES '4','3','2','1'
765 #error Unknown byteorder. Please append your byteorder to Storable.xs
771 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
772 #ifdef USE_56_INTERWORK_KLUDGE
773 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
776 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
777 #define STORABLE_BIN_MINOR 7 /* Binary minor "version" */
779 #if (PATCHLEVEL <= 5)
780 #define STORABLE_BIN_WRITE_MINOR 4
783 * Perl 5.6.0 onwards can do weak references.
785 #define STORABLE_BIN_WRITE_MINOR 7
786 #endif /* (PATCHLEVEL <= 5) */
788 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
789 #define PL_sv_placeholder PL_sv_undef
793 * Useful store shortcuts...
797 * Note that if you put more than one mark for storing a particular
798 * type of thing, *and* in the retrieve_foo() function you mark both
799 * the thingy's you get off with SEEN(), you *must* increase the
800 * tagnum with cxt->tagnum++ along with this macro!
807 else if (PerlIO_putc(cxt->fio, x) == EOF) \
811 #define WRITE_I32(x) \
813 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
816 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
823 if (cxt->netorder) { \
824 int y = (int) htonl(x); \
827 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
832 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
837 #define WLEN(x) WRITE_I32(x)
844 else if (PerlIO_write(cxt->fio, x, y) != y) \
848 #define STORE_PV_LEN(pv, len, small, large) \
850 if (len <= LG_SCALAR) { \
851 unsigned char clen = (unsigned char) len; \
863 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
866 * Store &PL_sv_undef in arrays without recursing through store().
868 #define STORE_SV_UNDEF() \
871 PUTMARK(SX_SV_UNDEF); \
875 * Useful retrieve shortcuts...
879 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
885 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
889 #define READ_I32(x) \
891 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
895 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
905 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
908 x = (int) ntohl(x); \
911 #define RLEN(x) READ_I32(x)
918 else if (PerlIO_read(cxt->fio, x, y) != y) \
922 #define SAFEREAD(x,y,z) \
925 MBUF_SAFEREAD(x,y,z); \
926 else if (PerlIO_read(cxt->fio, x, y) != y) { \
933 * This macro is used at retrieve time, to remember where object 'y', bearing a
934 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
935 * we'll therefore know where it has been retrieved and will be able to
936 * share the same reference, as in the original stored memory image.
938 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
939 * on the objects given to STORABLE_thaw and expect that to be defined), and
940 * also for overloaded objects (for which we might not find the stash if the
941 * object is not blessed yet--this might occur for overloaded objects that
942 * refer to themselves indirectly: if we blessed upon return from a sub
943 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
944 * restored on it because the underlying object would not be blessed yet!).
946 * To achieve that, the class name of the last retrieved object is passed down
947 * recursively, and the first SEEN() call for which the class name is not NULL
948 * will bless the object.
950 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
952 #define SEEN(y,c,i) \
956 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
958 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
959 PTR2UV(y), SvREFCNT(y)-1)); \
961 BLESS((SV *) (y), c); \
965 * Bless `s' in `p', via a temporary reference, required by sv_bless().
971 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
972 stash = gv_stashpv((p), TRUE); \
973 ref = newRV_noinc(s); \
974 (void) sv_bless(ref, stash); \
979 * sort (used in store_hash) - conditionally use qsort when
980 * sortsv is not available ( <= 5.6.1 ).
983 #if (PATCHLEVEL <= 6)
985 #if defined(USE_ITHREADS)
987 #define STORE_HASH_SORT \
989 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
990 SAVESPTR(orig_perl); \
991 PERL_SET_CONTEXT(aTHX); \
992 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
995 #else /* ! USE_ITHREADS */
997 #define STORE_HASH_SORT \
998 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1000 #endif /* USE_ITHREADS */
1002 #else /* PATCHLEVEL > 6 */
1004 #define STORE_HASH_SORT \
1005 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1007 #endif /* PATCHLEVEL <= 6 */
1009 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1010 static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname);
1013 * Dynamic dispatching table for SV store.
1016 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1017 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1018 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1019 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1020 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1021 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1022 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1023 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1024 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1026 static int (*sv_store[])(pTHX_ stcxt_t *cxt, SV *sv) = {
1027 store_ref, /* svis_REF */
1028 store_scalar, /* svis_SCALAR */
1029 (int (*)(pTHX_ stcxt_t *cxt, SV *sv)) store_array, /* svis_ARRAY */
1030 (int (*)(pTHX_ stcxt_t *cxt, SV *sv)) store_hash, /* svis_HASH */
1031 store_tied, /* svis_TIED */
1032 store_tied_item, /* svis_TIED_ITEM */
1033 (int (*)(pTHX_ stcxt_t *cxt, SV *sv)) store_code, /* svis_CODE */
1034 store_other, /* svis_OTHER */
1037 #define SV_STORE(x) (*sv_store[x])
1040 * Dynamic dispatching tables for SV retrieval.
1043 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname);
1044 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname);
1045 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
1046 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
1047 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname);
1048 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname);
1049 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname);
1050 static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname);
1051 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname);
1052 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname);
1053 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname);
1054 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname);
1055 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname);
1056 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname);
1057 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname);
1058 static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname);
1060 static SV *(*sv_old_retrieve[])(pTHX_ stcxt_t *cxt, char *cname) = {
1061 0, /* SX_OBJECT -- entry unused dynamically */
1062 retrieve_lscalar, /* SX_LSCALAR */
1063 old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1064 old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
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_other, /* SX_SV_UNDEF not supported */
1076 retrieve_other, /* SX_SV_YES not supported */
1077 retrieve_other, /* SX_SV_NO not supported */
1078 retrieve_other, /* SX_BLESS not supported */
1079 retrieve_other, /* SX_IX_BLESS not supported */
1080 retrieve_other, /* SX_HOOK not supported */
1081 retrieve_other, /* SX_OVERLOADED not supported */
1082 retrieve_other, /* SX_TIED_KEY not supported */
1083 retrieve_other, /* SX_TIED_IDX not supported */
1084 retrieve_other, /* SX_UTF8STR not supported */
1085 retrieve_other, /* SX_LUTF8STR not supported */
1086 retrieve_other, /* SX_FLAG_HASH not supported */
1087 retrieve_other, /* SX_CODE not supported */
1088 retrieve_other, /* SX_WEAKREF not supported */
1089 retrieve_other, /* SX_WEAKOVERLOAD not supported */
1090 retrieve_other, /* SX_ERROR */
1093 static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
1094 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
1095 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname);
1096 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname);
1097 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname);
1098 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname);
1099 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname);
1100 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname);
1101 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname);
1102 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname);
1103 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname);
1104 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname);
1105 static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname);
1106 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, char *cname);
1107 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, char *cname);
1109 static SV *(*sv_retrieve[])(pTHX_ stcxt_t *cxt, char *cname) = {
1110 0, /* SX_OBJECT -- entry unused dynamically */
1111 retrieve_lscalar, /* SX_LSCALAR */
1112 retrieve_array, /* SX_ARRAY */
1113 retrieve_hash, /* SX_HASH */
1114 retrieve_ref, /* SX_REF */
1115 retrieve_undef, /* SX_UNDEF */
1116 retrieve_integer, /* SX_INTEGER */
1117 retrieve_double, /* SX_DOUBLE */
1118 retrieve_byte, /* SX_BYTE */
1119 retrieve_netint, /* SX_NETINT */
1120 retrieve_scalar, /* SX_SCALAR */
1121 retrieve_tied_array, /* SX_ARRAY */
1122 retrieve_tied_hash, /* SX_HASH */
1123 retrieve_tied_scalar, /* SX_SCALAR */
1124 retrieve_sv_undef, /* SX_SV_UNDEF */
1125 retrieve_sv_yes, /* SX_SV_YES */
1126 retrieve_sv_no, /* SX_SV_NO */
1127 retrieve_blessed, /* SX_BLESS */
1128 retrieve_idx_blessed, /* SX_IX_BLESS */
1129 retrieve_hook, /* SX_HOOK */
1130 retrieve_overloaded, /* SX_OVERLOAD */
1131 retrieve_tied_key, /* SX_TIED_KEY */
1132 retrieve_tied_idx, /* SX_TIED_IDX */
1133 retrieve_utf8str, /* SX_UTF8STR */
1134 retrieve_lutf8str, /* SX_LUTF8STR */
1135 retrieve_flag_hash, /* SX_HASH */
1136 retrieve_code, /* SX_CODE */
1137 retrieve_weakref, /* SX_WEAKREF */
1138 retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
1139 retrieve_other, /* SX_ERROR */
1142 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1144 static SV *mbuf2sv(pTHX);
1147 *** Context management.
1153 * Called once per "thread" (interpreter) to initialize some global context.
1155 static void init_perinterp(pTHX)
1159 cxt->netorder = 0; /* true if network order used */
1160 cxt->forgive_me = -1; /* whether to be forgiving... */
1161 cxt->accept_future_minor = -1; /* would otherwise occur too late */
1167 * Called at the end of every context cleaning, to perform common reset
1170 static void reset_context(stcxt_t *cxt)
1174 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1178 * init_store_context
1180 * Initialize a new store context for real recursion.
1182 static void init_store_context(
1189 TRACEME(("init_store_context"));
1191 cxt->netorder = network_order;
1192 cxt->forgive_me = -1; /* Fetched from perl if needed */
1193 cxt->deparse = -1; /* Idem */
1194 cxt->eval = NULL; /* Idem */
1195 cxt->canonical = -1; /* Idem */
1196 cxt->tagnum = -1; /* Reset tag numbers */
1197 cxt->classnum = -1; /* Reset class numbers */
1198 cxt->fio = f; /* Where I/O are performed */
1199 cxt->optype = optype; /* A store, or a deep clone */
1200 cxt->entry = 1; /* No recursion yet */
1203 * The `hseen' table is used to keep track of each SV stored and their
1204 * associated tag numbers is special. It is "abused" because the
1205 * values stored are not real SV, just integers cast to (SV *),
1206 * which explains the freeing below.
1208 * It is also one possible bottlneck to achieve good storing speed,
1209 * so the "shared keys" optimization is turned off (unlikely to be
1210 * of any use here), and the hash table is "pre-extended". Together,
1211 * those optimizations increase the throughput by 12%.
1214 cxt->hseen = newHV(); /* Table where seen objects are stored */
1215 HvSHAREKEYS_off(cxt->hseen);
1218 * The following does not work well with perl5.004_04, and causes
1219 * a core dump later on, in a completely unrelated spot, which
1220 * makes me think there is a memory corruption going on.
1222 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1223 * it below does not make any difference. It seems to work fine
1224 * with perl5.004_68 but given the probable nature of the bug,
1225 * that does not prove anything.
1227 * It's a shame because increasing the amount of buckets raises
1228 * store() throughput by 5%, but until I figure this out, I can't
1229 * allow for this to go into production.
1231 * It is reported fixed in 5.005, hence the #if.
1233 #if PERL_VERSION >= 5
1234 #define HBUCKETS 4096 /* Buckets for %hseen */
1235 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1239 * The `hclass' hash uses the same settings as `hseen' above, but it is
1240 * used to assign sequential tags (numbers) to class names for blessed
1243 * We turn the shared key optimization on.
1246 cxt->hclass = newHV(); /* Where seen classnames are stored */
1248 #if PERL_VERSION >= 5
1249 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1253 * The `hook' hash table is used to keep track of the references on
1254 * the STORABLE_freeze hook routines, when found in some class name.
1256 * It is assumed that the inheritance tree will not be changed during
1257 * storing, and that no new method will be dynamically created by the
1261 cxt->hook = newHV(); /* Table where hooks are cached */
1264 * The `hook_seen' array keeps track of all the SVs returned by
1265 * STORABLE_freeze hooks for us to serialize, so that they are not
1266 * reclaimed until the end of the serialization process. Each SV is
1267 * only stored once, the first time it is seen.
1270 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1274 * clean_store_context
1276 * Clean store context by
1278 static void clean_store_context(pTHX_ stcxt_t *cxt)
1282 TRACEME(("clean_store_context"));
1284 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1287 * Insert real values into hashes where we stored faked pointers.
1291 hv_iterinit(cxt->hseen);
1292 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1293 HeVAL(he) = &PL_sv_undef;
1297 hv_iterinit(cxt->hclass);
1298 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1299 HeVAL(he) = &PL_sv_undef;
1303 * And now dispose of them...
1305 * The surrounding if() protection has been added because there might be
1306 * some cases where this routine is called more than once, during
1307 * exceptionnal events. This was reported by Marc Lehmann when Storable
1308 * is executed from mod_perl, and the fix was suggested by him.
1309 * -- RAM, 20/12/2000
1313 HV *hseen = cxt->hseen;
1316 sv_free((SV *) hseen);
1320 HV *hclass = cxt->hclass;
1323 sv_free((SV *) hclass);
1327 HV *hook = cxt->hook;
1330 sv_free((SV *) hook);
1333 if (cxt->hook_seen) {
1334 AV *hook_seen = cxt->hook_seen;
1336 av_undef(hook_seen);
1337 sv_free((SV *) hook_seen);
1340 cxt->forgive_me = -1; /* Fetched from perl if needed */
1341 cxt->deparse = -1; /* Idem */
1343 SvREFCNT_dec(cxt->eval);
1345 cxt->eval = NULL; /* Idem */
1346 cxt->canonical = -1; /* Idem */
1352 * init_retrieve_context
1354 * Initialize a new retrieve context for real recursion.
1356 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1358 TRACEME(("init_retrieve_context"));
1361 * The hook hash table is used to keep track of the references on
1362 * the STORABLE_thaw hook routines, when found in some class name.
1364 * It is assumed that the inheritance tree will not be changed during
1365 * storing, and that no new method will be dynamically created by the
1369 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1372 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1373 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1374 * the correspondance between the tags and the tag number used by the
1375 * new retrieve routines.
1378 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1381 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1382 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1383 cxt->aclass = newAV(); /* Where seen classnames are kept */
1384 cxt->tagnum = 0; /* Have to count objects... */
1385 cxt->classnum = 0; /* ...and class names as well */
1386 cxt->optype = optype;
1387 cxt->s_tainted = is_tainted;
1388 cxt->entry = 1; /* No recursion yet */
1389 #ifndef HAS_RESTRICTED_HASHES
1390 cxt->derestrict = -1; /* Fetched from perl if needed */
1392 #ifndef HAS_UTF8_ALL
1393 cxt->use_bytes = -1; /* Fetched from perl if needed */
1395 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1399 * clean_retrieve_context
1401 * Clean retrieve context by
1403 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1405 TRACEME(("clean_retrieve_context"));
1407 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1410 AV *aseen = cxt->aseen;
1413 sv_free((SV *) aseen);
1415 cxt->where_is_undef = -1;
1418 AV *aclass = cxt->aclass;
1421 sv_free((SV *) aclass);
1425 HV *hook = cxt->hook;
1428 sv_free((SV *) hook);
1432 HV *hseen = cxt->hseen;
1435 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1438 #ifndef HAS_RESTRICTED_HASHES
1439 cxt->derestrict = -1; /* Fetched from perl if needed */
1441 #ifndef HAS_UTF8_ALL
1442 cxt->use_bytes = -1; /* Fetched from perl if needed */
1444 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1452 * A workaround for the CROAK bug: cleanup the last context.
1454 static void clean_context(pTHX_ stcxt_t *cxt)
1456 TRACEME(("clean_context"));
1458 ASSERT(cxt->s_dirty, ("dirty context"));
1463 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1465 if (cxt->optype & ST_RETRIEVE)
1466 clean_retrieve_context(aTHX_ cxt);
1467 else if (cxt->optype & ST_STORE)
1468 clean_store_context(aTHX_ cxt);
1472 ASSERT(!cxt->s_dirty, ("context is clean"));
1473 ASSERT(cxt->entry == 0, ("context is reset"));
1479 * Allocate a new context and push it on top of the parent one.
1480 * This new context is made globally visible via SET_STCXT().
1482 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1486 TRACEME(("allocate_context"));
1488 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1490 NEW_STORABLE_CXT_OBJ(cxt);
1491 cxt->prev = parent_cxt->my_sv;
1494 ASSERT(!cxt->s_dirty, ("clean context"));
1502 * Free current context, which cannot be the "root" one.
1503 * Make the context underneath globally visible via SET_STCXT().
1505 static void free_context(pTHX_ stcxt_t *cxt)
1507 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1509 TRACEME(("free_context"));
1511 ASSERT(!cxt->s_dirty, ("clean context"));
1512 ASSERT(prev, ("not freeing root context"));
1514 SvREFCNT_dec(cxt->my_sv);
1517 ASSERT(cxt, ("context not void"));
1527 * Tells whether we're in the middle of a store operation.
1529 int is_storing(pTHX)
1533 return cxt->entry && (cxt->optype & ST_STORE);
1539 * Tells whether we're in the middle of a retrieve operation.
1541 int is_retrieving(pTHX)
1545 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1549 * last_op_in_netorder
1551 * Returns whether last operation was made using network order.
1553 * This is typically out-of-band information that might prove useful
1554 * to people wishing to convert native to network order data when used.
1556 int last_op_in_netorder(pTHX)
1560 return cxt->netorder;
1564 *** Hook lookup and calling routines.
1570 * A wrapper on gv_fetchmethod_autoload() which caches results.
1572 * Returns the routine reference as an SV*, or null if neither the package
1573 * nor its ancestors know about the method.
1575 static SV *pkg_fetchmeth(
1585 * The following code is the same as the one performed by UNIVERSAL::can
1589 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1590 if (gv && isGV(gv)) {
1591 sv = newRV((SV*) GvCV(gv));
1592 TRACEME(("%s->%s: 0x%"UVxf, HvNAME(pkg), method, PTR2UV(sv)));
1594 sv = newSVsv(&PL_sv_undef);
1595 TRACEME(("%s->%s: not found", HvNAME(pkg), method));
1599 * Cache the result, ignoring failure: if we can't store the value,
1600 * it just won't be cached.
1603 (void) hv_store(cache, HvNAME(pkg), strlen(HvNAME(pkg)), sv, 0);
1605 return SvOK(sv) ? sv : (SV *) 0;
1611 * Force cached value to be undef: hook ignored even if present.
1613 static void pkg_hide(
1619 (void) hv_store(cache,
1620 HvNAME(pkg), strlen(HvNAME(pkg)), newSVsv(&PL_sv_undef), 0);
1626 * Discard cached value: a whole fetch loop will be retried at next lookup.
1628 static void pkg_uncache(
1634 (void) hv_delete(cache, HvNAME(pkg), strlen(HvNAME(pkg)), G_DISCARD);
1640 * Our own "UNIVERSAL::can", which caches results.
1642 * Returns the routine reference as an SV*, or null if the object does not
1643 * know about the method.
1654 TRACEME(("pkg_can for %s->%s", HvNAME(pkg), method));
1657 * Look into the cache to see whether we already have determined
1658 * where the routine was, if any.
1660 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1661 * that only one hook (i.e. always the same) is cached in a given cache.
1664 svh = hv_fetch(cache, HvNAME(pkg), strlen(HvNAME(pkg)), FALSE);
1668 TRACEME(("cached %s->%s: not found", HvNAME(pkg), method));
1671 TRACEME(("cached %s->%s: 0x%"UVxf,
1672 HvNAME(pkg), method, PTR2UV(sv)));
1677 TRACEME(("not cached yet"));
1678 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1684 * Call routine as obj->hook(av) in scalar context.
1685 * Propagates the single returned value if not called in void context.
1687 static SV *scalar_call(
1699 TRACEME(("scalar_call (cloning=%d)", cloning));
1706 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1708 SV **ary = AvARRAY(av);
1709 int cnt = AvFILLp(av) + 1;
1711 XPUSHs(ary[0]); /* Frozen string */
1712 for (i = 1; i < cnt; i++) {
1713 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1714 i, PTR2UV(ary[i])));
1715 XPUSHs(sv_2mortal(newRV(ary[i])));
1720 TRACEME(("calling..."));
1721 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1722 TRACEME(("count = %d", count));
1728 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1741 * Call routine obj->hook(cloning) in list context.
1742 * Returns the list of returned values in an array.
1744 static AV *array_call(
1755 TRACEME(("array_call (cloning=%d)", cloning));
1761 XPUSHs(obj); /* Target object */
1762 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1765 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1770 for (i = count - 1; i >= 0; i--) {
1772 av_store(av, i, SvREFCNT_inc(sv));
1785 * Lookup the class name in the `hclass' table and either assign it a new ID
1786 * or return the existing one, by filling in `classnum'.
1788 * Return true if the class was known, false if the ID was just generated.
1790 static int known_class(
1793 char *name, /* Class name */
1794 int len, /* Name length */
1798 HV *hclass = cxt->hclass;
1800 TRACEME(("known_class (%s)", name));
1803 * Recall that we don't store pointers in this hash table, but tags.
1804 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1807 svh = hv_fetch(hclass, name, len, FALSE);
1809 *classnum = LOW_32BITS(*svh);
1814 * Unknown classname, we need to record it.
1818 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1819 CROAK(("Unable to record new classname"));
1821 *classnum = cxt->classnum;
1826 *** Sepcific store routines.
1832 * Store a reference.
1833 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1835 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1838 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1841 * Follow reference, and check if target is overloaded.
1847 TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1852 HV *stash = (HV *) SvSTASH(sv);
1853 if (stash && Gv_AMG(stash)) {
1854 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1855 PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1857 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1859 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1861 return store(aTHX_ cxt, sv);
1869 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1870 * The <data> section is omitted if <length> is 0.
1872 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1873 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1875 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
1880 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1882 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1885 * For efficiency, break the SV encapsulation by peaking at the flags
1886 * directly without using the Perl macros to avoid dereferencing
1887 * sv->sv_flags each time we wish to check the flags.
1890 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1891 if (sv == &PL_sv_undef) {
1892 TRACEME(("immortal undef"));
1893 PUTMARK(SX_SV_UNDEF);
1895 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
1902 * Always store the string representation of a scalar if it exists.
1903 * Gisle Aas provided me with this test case, better than a long speach:
1905 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1906 * SV = PVNV(0x80c8520)
1908 * FLAGS = (NOK,POK,pNOK,pPOK)
1911 * PV = 0x80c83d0 "abc"\0
1915 * Write SX_SCALAR, length, followed by the actual data.
1917 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
1918 * appropriate, followed by the actual (binary) data. A double
1919 * is written as a string if network order, for portability.
1921 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
1922 * The reason is that when the scalar value is tainted, the SvNOK(sv)
1925 * The test for a read-only scalar with both POK and NOK set is meant
1926 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
1927 * address comparison for each scalar we store.
1930 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
1932 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
1933 if (sv == &PL_sv_yes) {
1934 TRACEME(("immortal yes"));
1936 } else if (sv == &PL_sv_no) {
1937 TRACEME(("immortal no"));
1940 pv = SvPV(sv, len); /* We know it's SvPOK */
1941 goto string; /* Share code below */
1943 } else if (flags & SVf_POK) {
1944 /* public string - go direct to string read. */
1945 goto string_readlen;
1947 #if (PATCHLEVEL <= 6)
1948 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
1949 direct if NV flag is off. */
1950 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
1952 /* 5.7 rules are that if IV public flag is set, IV value is as
1953 good, if not better, than NV value. */
1959 * Will come here from below with iv set if double is an integer.
1963 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1965 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
1966 * (for example) and that ends up in the optimised small integer
1969 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
1970 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
1971 goto string_readlen;
1975 * Optimize small integers into a single byte, otherwise store as
1976 * a real integer (converted into network order if they asked).
1979 if (iv >= -128 && iv <= 127) {
1980 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
1983 TRACEME(("small integer stored as %d", siv));
1984 } else if (cxt->netorder) {
1986 TRACEME(("no htonl, fall back to string for integer"));
1987 goto string_readlen;
1995 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1996 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
1998 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
1999 /* Bigger than 32 bits. */
2000 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2001 goto string_readlen;
2005 niv = (I32) htonl((I32) iv);
2006 TRACEME(("using network order"));
2011 PUTMARK(SX_INTEGER);
2012 WRITE(&iv, sizeof(iv));
2015 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2016 } else if (flags & SVf_NOK) {
2018 #if (PATCHLEVEL <= 6)
2021 * Watch for number being an integer in disguise.
2023 if (nv == (NV) (iv = I_V(nv))) {
2024 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2025 goto integer; /* Share code above */
2030 if (SvIOK_notUV(sv)) {
2032 goto integer; /* Share code above */
2037 if (cxt->netorder) {
2038 TRACEME(("double %"NVff" stored as string", nv));
2039 goto string_readlen; /* Share code below */
2043 WRITE(&nv, sizeof(nv));
2045 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2047 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2048 I32 wlen; /* For 64-bit machines */
2054 * Will come here from above if it was readonly, POK and NOK but
2055 * neither &PL_sv_yes nor &PL_sv_no.
2059 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2061 STORE_UTF8STR(pv, wlen);
2063 STORE_SCALAR(pv, wlen);
2064 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2065 PTR2UV(sv), SvPVX(sv), (IV)len));
2067 CROAK(("Can't determine type of %s(0x%"UVxf")",
2068 sv_reftype(sv, FALSE),
2070 return 0; /* Ok, no recursion on scalars */
2078 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2079 * Each item is stored as <object>.
2081 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2084 I32 len = av_len(av) + 1;
2088 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2091 * Signal array by emitting SX_ARRAY, followed by the array length.
2096 TRACEME(("size = %d", len));
2099 * Now store each item recursively.
2102 for (i = 0; i < len; i++) {
2103 sav = av_fetch(av, i, 0);
2105 TRACEME(("(#%d) undef item", i));
2109 TRACEME(("(#%d) item", i));
2110 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2114 TRACEME(("ok (array)"));
2120 #if (PATCHLEVEL <= 6)
2126 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2129 sortcmp(const void *a, const void *b)
2131 #if defined(USE_ITHREADS)
2133 #endif /* USE_ITHREADS */
2134 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2137 #endif /* PATCHLEVEL <= 6 */
2142 * Store a hash table.
2144 * For a "normal" hash (not restricted, no utf8 keys):
2146 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2147 * Values are stored as <object>.
2148 * Keys are stored as <length> <data>, the <data> section being omitted
2151 * For a "fancy" hash (restricted or utf8 keys):
2153 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2155 * Values are stored as <object>.
2156 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2158 * Currently the only hash flag is "restriced"
2159 * Key flags are as for hv.h
2161 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2164 #ifdef HAS_RESTRICTED_HASHES
2173 int flagged_hash = ((SvREADONLY(hv)
2174 #ifdef HAS_HASH_KEY_FLAGS
2178 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2181 /* needs int cast for C++ compilers, doesn't it? */
2182 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2185 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2189 * Signal hash by emitting SX_HASH, followed by the table length.
2193 PUTMARK(SX_FLAG_HASH);
2194 PUTMARK(hash_flags);
2199 TRACEME(("size = %d", len));
2202 * Save possible iteration state via each() on that table.
2205 riter = HvRITER(hv);
2206 eiter = HvEITER(hv);
2210 * Now store each item recursively.
2212 * If canonical is defined to some true value then store each
2213 * key/value pair in sorted order otherwise the order is random.
2214 * Canonical order is irrelevant when a deep clone operation is performed.
2216 * Fetch the value from perl only once per store() operation, and only
2221 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2222 (cxt->canonical < 0 && (cxt->canonical =
2223 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2226 * Storing in order, sorted by key.
2227 * Run through the hash, building up an array of keys in a
2228 * mortal array, sort the array and then run through the
2234 /*av_extend (av, len);*/
2236 TRACEME(("using canonical order"));
2238 for (i = 0; i < len; i++) {
2239 #ifdef HAS_RESTRICTED_HASHES
2240 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2242 HE *he = hv_iternext(hv);
2244 SV *key = hv_iterkeysv(he);
2245 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2250 for (i = 0; i < len; i++) {
2251 #ifdef HAS_RESTRICTED_HASHES
2252 int placeholders = HvPLACEHOLDERS(hv);
2254 unsigned char flags = 0;
2258 SV *key = av_shift(av);
2259 /* This will fail if key is a placeholder.
2260 Track how many placeholders we have, and error if we
2262 HE *he = hv_fetch_ent(hv, key, 0, 0);
2266 if (!(val = HeVAL(he))) {
2267 /* Internal error, not I/O error */
2271 #ifdef HAS_RESTRICTED_HASHES
2272 /* Should be a placeholder. */
2273 if (placeholders-- < 0) {
2274 /* This should not happen - number of
2275 retrieves should be identical to
2276 number of placeholders. */
2279 /* Value is never needed, and PL_sv_undef is
2280 more space efficient to store. */
2283 ("Flags not 0 but %d", flags));
2284 flags = SHV_K_PLACEHOLDER;
2291 * Store value first.
2294 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2296 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2301 * Keys are written after values to make sure retrieval
2302 * can be optimal in terms of memory usage, where keys are
2303 * read into a fixed unique buffer called kbuf.
2304 * See retrieve_hash() for details.
2307 /* Implementation of restricted hashes isn't nicely
2309 if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
2310 flags |= SHV_K_LOCKED;
2313 keyval = SvPV(key, keylen_tmp);
2314 keylen = keylen_tmp;
2315 #ifdef HAS_UTF8_HASHES
2316 /* If you build without optimisation on pre 5.6
2317 then nothing spots that SvUTF8(key) is always 0,
2318 so the block isn't optimised away, at which point
2319 the linker dislikes the reference to
2322 const char *keysave = keyval;
2323 bool is_utf8 = TRUE;
2325 /* Just casting the &klen to (STRLEN) won't work
2326 well if STRLEN and I32 are of different widths.
2328 keyval = (char*)bytes_from_utf8((U8*)keyval,
2332 /* If we were able to downgrade here, then than
2333 means that we have a key which only had chars
2334 0-255, but was utf8 encoded. */
2336 if (keyval != keysave) {
2337 keylen = keylen_tmp;
2338 flags |= SHV_K_WASUTF8;
2340 /* keylen_tmp can't have changed, so no need
2341 to assign back to keylen. */
2342 flags |= SHV_K_UTF8;
2349 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2351 /* This is a workaround for a bug in 5.8.0
2352 that causes the HEK_WASUTF8 flag to be
2353 set on an HEK without the hash being
2354 marked as having key flags. We just
2355 cross our fingers and drop the flag.
2357 assert (flags == 0 || flags == SHV_K_WASUTF8);
2358 TRACEME(("(#%d) key '%s'", i, keyval));
2362 WRITE(keyval, keylen);
2363 if (flags & SHV_K_WASUTF8)
2368 * Free up the temporary array
2377 * Storing in "random" order (in the order the keys are stored
2378 * within the hash). This is the default and will be faster!
2381 for (i = 0; i < len; i++) {
2384 unsigned char flags;
2385 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2386 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2388 HE *he = hv_iternext(hv);
2390 SV *val = (he ? hv_iterval(hv, he) : 0);
2395 return 1; /* Internal error, not I/O error */
2397 /* Implementation of restricted hashes isn't nicely
2400 = (((hash_flags & SHV_RESTRICTED)
2402 ? SHV_K_LOCKED : 0);
2404 if (val == &PL_sv_placeholder) {
2405 flags |= SHV_K_PLACEHOLDER;
2410 * Store value first.
2413 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2415 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2419 hek = HeKEY_hek(he);
2421 if (len == HEf_SVKEY) {
2422 /* This is somewhat sick, but the internal APIs are
2423 * such that XS code could put one of these in in
2425 * Maybe we should be capable of storing one if
2428 key_sv = HeKEY_sv(he);
2429 flags |= SHV_K_ISSV;
2431 /* Regular string key. */
2432 #ifdef HAS_HASH_KEY_FLAGS
2434 flags |= SHV_K_UTF8;
2435 if (HEK_WASUTF8(hek))
2436 flags |= SHV_K_WASUTF8;
2442 * Keys are written after values to make sure retrieval
2443 * can be optimal in terms of memory usage, where keys are
2444 * read into a fixed unique buffer called kbuf.
2445 * See retrieve_hash() for details.
2450 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2452 /* This is a workaround for a bug in 5.8.0
2453 that causes the HEK_WASUTF8 flag to be
2454 set on an HEK without the hash being
2455 marked as having key flags. We just
2456 cross our fingers and drop the flag.
2458 assert (flags == 0 || flags == SHV_K_WASUTF8);
2459 TRACEME(("(#%d) key '%s'", i, key));
2461 if (flags & SHV_K_ISSV) {
2462 store(aTHX_ cxt, key_sv);
2471 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2474 HvRITER(hv) = riter; /* Restore hash iterator state */
2475 HvEITER(hv) = eiter;
2483 * Store a code reference.
2485 * Layout is SX_CODE <length> followed by a scalar containing the perl
2486 * source code of the code reference.
2488 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2490 #if PERL_VERSION < 6
2492 * retrieve_code does not work with perl 5.005 or less
2494 return store_other(aTHX_ cxt, (SV*)cv);
2499 SV *text, *bdeparse;
2501 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2504 cxt->deparse == 0 ||
2505 (cxt->deparse < 0 && !(cxt->deparse =
2506 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2508 return store_other(aTHX_ cxt, (SV*)cv);
2512 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2513 * blessed code references.
2515 /* Ownership of both SVs is passed to load_module, which frees them. */
2516 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2522 * create the B::Deparse object
2526 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2528 count = call_method("new", G_SCALAR);
2531 CROAK(("Unexpected return value from B::Deparse::new\n"));
2535 * call the coderef2text method
2539 XPUSHs(bdeparse); /* XXX is this already mortal? */
2540 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2542 count = call_method("coderef2text", G_SCALAR);
2545 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2549 reallen = strlen(SvPV_nolen(text));
2552 * Empty code references or XS functions are deparsed as
2553 * "(prototype) ;" or ";".
2556 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2557 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2561 * Signal code by emitting SX_CODE.
2565 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2566 TRACEME(("size = %d", len));
2567 TRACEME(("code = %s", SvPV_nolen(text)));
2570 * Now store the source code.
2573 STORE_SCALAR(SvPV_nolen(text), len);
2578 TRACEME(("ok (code)"));
2587 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2588 * a special mark, followed by the underlying tied object. For instance, when
2589 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2590 * <hash object> stands for the serialization of the tied hash.
2592 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2597 int svt = SvTYPE(sv);
2600 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2603 * We have a small run-time penalty here because we chose to factorise
2604 * all tieds objects into the same routine, and not have a store_tied_hash,
2605 * a store_tied_array, etc...
2607 * Don't use a switch() statement, as most compilers don't optimize that
2608 * well for 2/3 values. An if() else if() cascade is just fine. We put
2609 * tied hashes first, as they are the most likely beasts.
2612 if (svt == SVt_PVHV) {
2613 TRACEME(("tied hash"));
2614 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2615 } else if (svt == SVt_PVAV) {
2616 TRACEME(("tied array"));
2617 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2619 TRACEME(("tied scalar"));
2620 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2624 if (!(mg = mg_find(sv, mtype)))
2625 CROAK(("No magic '%c' found while storing tied %s", mtype,
2626 (svt == SVt_PVHV) ? "hash" :
2627 (svt == SVt_PVAV) ? "array" : "scalar"));
2630 * The mg->mg_obj found by mg_find() above actually points to the
2631 * underlying tied Perl object implementation. For instance, if the
2632 * original SV was that of a tied array, then mg->mg_obj is an AV.
2634 * Note that we store the Perl object as-is. We don't call its FETCH
2635 * method along the way. At retrieval time, we won't call its STORE
2636 * method either, but the tieing magic will be re-installed. In itself,
2637 * that ensures that the tieing semantics are preserved since futher
2638 * accesses on the retrieved object will indeed call the magic methods...
2641 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2642 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2643 if ((ret = store(aTHX_ cxt, obj)))
2646 TRACEME(("ok (tied)"));
2654 * Stores a reference to an item within a tied structure:
2656 * . \$h{key}, stores both the (tied %h) object and 'key'.
2657 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2659 * Layout is therefore either:
2660 * SX_TIED_KEY <object> <key>
2661 * SX_TIED_IDX <object> <index>
2663 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2668 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2670 if (!(mg = mg_find(sv, 'p')))
2671 CROAK(("No magic 'p' found while storing reference to tied item"));
2674 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2678 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2679 PUTMARK(SX_TIED_KEY);
2680 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2682 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2685 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2687 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2690 I32 idx = mg->mg_len;
2692 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2693 PUTMARK(SX_TIED_IDX);
2694 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2696 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2699 TRACEME(("store_tied_item: storing IDX %d", idx));
2704 TRACEME(("ok (tied item)"));
2710 * store_hook -- dispatched manually, not via sv_store[]
2712 * The blessed SV is serialized by a hook.
2716 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2718 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2719 * the trailing part [] is present, the type of object (scalar, array or hash).
2720 * There is also a bit which says how the classname is stored between:
2725 * and when the <index> form is used (classname already seen), the "large
2726 * classname" bit in <flags> indicates how large the <index> is.
2728 * The serialized string returned by the hook is of length <len2> and comes
2729 * next. It is an opaque string for us.
2731 * Those <len3> object IDs which are listed last represent the extra references
2732 * not directly serialized by the hook, but which are linked to the object.
2734 * When recursion is mandated to resolve object-IDs not yet seen, we have
2735 * instead, with <header> being flags with bits set to indicate the object type
2736 * and that recursion was indeed needed:
2738 * SX_HOOK <header> <object> <header> <object> <flags>
2740 * that same header being repeated between serialized objects obtained through
2741 * recursion, until we reach flags indicating no recursion, at which point
2742 * we know we've resynchronized with a single layout, after <flags>.
2744 * When storing a blessed ref to a tied variable, the following format is
2747 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2749 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2750 * real object type is held in the <extra> flag. At the very end of the
2751 * serialization stream, the underlying magic object is serialized, just like
2752 * any other tied variable.
2754 static int store_hook(
2768 int count; /* really len3 + 1 */
2769 unsigned char flags;
2772 int recursed = 0; /* counts recursion */
2773 int obj_type; /* object type, on 2 bits */
2776 int clone = cxt->optype & ST_CLONE;
2777 char mtype = '\0'; /* for blessed ref to tied structures */
2778 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2780 TRACEME(("store_hook, class \"%s\", tagged #%d", HvNAME(pkg), cxt->tagnum));
2783 * Determine object type on 2 bits.
2788 obj_type = SHT_SCALAR;
2791 obj_type = SHT_ARRAY;
2794 obj_type = SHT_HASH;
2798 * Produced by a blessed ref to a tied data structure, $o in the
2799 * following Perl code.
2803 * my $o = bless \%h, 'BAR';
2805 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2806 * (since we have only 2 bits in <flags> to store the type), and an
2807 * <extra> byte flag will be emitted after the FIRST <flags> in the
2808 * stream, carrying what we put in `eflags'.
2810 obj_type = SHT_EXTRA;
2811 switch (SvTYPE(sv)) {
2813 eflags = (unsigned char) SHT_THASH;
2817 eflags = (unsigned char) SHT_TARRAY;
2821 eflags = (unsigned char) SHT_TSCALAR;
2827 CROAK(("Unexpected object type (%d) in store_hook()", type));
2829 flags = SHF_NEED_RECURSE | obj_type;
2831 class = HvNAME(pkg);
2832 len = strlen(class);
2835 * To call the hook, we need to fake a call like:
2837 * $object->STORABLE_freeze($cloning);
2839 * but we don't have the $object here. For instance, if $object is
2840 * a blessed array, what we have in `sv' is the array, and we can't
2841 * call a method on those.
2843 * Therefore, we need to create a temporary reference to the object and
2844 * make the call on that reference.
2847 TRACEME(("about to call STORABLE_freeze on class %s", class));
2849 ref = newRV_noinc(sv); /* Temporary reference */
2850 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2852 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2854 count = AvFILLp(av) + 1;
2855 TRACEME(("store_hook, array holds %d items", count));
2858 * If they return an empty list, it means they wish to ignore the
2859 * hook for this class (and not just this instance -- that's for them
2860 * to handle if they so wish).
2862 * Simply disable the cached entry for the hook (it won't be recomputed
2863 * since it's present in the cache) and recurse to store_blessed().
2868 * They must not change their mind in the middle of a serialization.
2871 if (hv_fetch(cxt->hclass, class, len, FALSE))
2872 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2873 (cxt->optype & ST_CLONE) ? "cloning" : "storing", class));
2875 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
2877 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2878 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", class));
2880 return store_blessed(aTHX_ cxt, sv, type, pkg);
2884 * Get frozen string.
2888 pv = SvPV(ary[0], len2);
2891 * If they returned more than one item, we need to serialize some
2892 * extra references if not already done.
2894 * Loop over the array, starting at position #1, and for each item,
2895 * ensure it is a reference, serialize it if not already done, and
2896 * replace the entry with the tag ID of the corresponding serialized
2899 * We CHEAT by not calling av_fetch() and read directly within the
2903 for (i = 1; i < count; i++) {
2907 AV *av_hook = cxt->hook_seen;
2910 CROAK(("Item #%d returned by STORABLE_freeze "
2911 "for %s is not a reference", i, class));
2912 xsv = SvRV(rsv); /* Follow ref to know what to look for */
2915 * Look in hseen and see if we have a tag already.
2916 * Serialize entry if not done already, and get its tag.
2919 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
2920 goto sv_seen; /* Avoid moving code too far to the right */
2922 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
2925 * We need to recurse to store that object and get it to be known
2926 * so that we can resolve the list of object-IDs at retrieve time.
2928 * The first time we do this, we need to emit the proper header
2929 * indicating that we recursed, and what the type of object is (the
2930 * object we're storing via a user-hook). Indeed, during retrieval,
2931 * we'll have to create the object before recursing to retrieve the
2932 * others, in case those would point back at that object.
2935 /* [SX_HOOK] <flags> [<extra>] <object>*/
2939 if (obj_type == SHT_EXTRA)
2944 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
2947 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
2949 CROAK(("Could not serialize item #%d from hook in %s", i, class));
2952 * It was the first time we serialized `xsv'.
2954 * Keep this SV alive until the end of the serialization: if we
2955 * disposed of it right now by decrementing its refcount, and it was
2956 * a temporary value, some next temporary value allocated during
2957 * another STORABLE_freeze might take its place, and we'd wrongly
2958 * assume that new SV was already serialized, based on its presence
2961 * Therefore, push it away in cxt->hook_seen.
2964 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
2968 * Dispose of the REF they returned. If we saved the `xsv' away
2969 * in the array of returned SVs, that will not cause the underlying
2970 * referenced SV to be reclaimed.
2973 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
2974 SvREFCNT_dec(rsv); /* Dispose of reference */
2977 * Replace entry with its tag (not a real SV, so no refcnt increment)
2981 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
2982 i-1, PTR2UV(xsv), PTR2UV(*svh)));
2986 * Allocate a class ID if not already done.
2988 * This needs to be done after the recursion above, since at retrieval
2989 * time, we'll see the inner objects first. Many thanks to
2990 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
2991 * proposed the right fix. -- RAM, 15/09/2000
2994 if (!known_class(aTHX_ cxt, class, len, &classnum)) {
2995 TRACEME(("first time we see class %s, ID = %d", class, classnum));
2996 classnum = -1; /* Mark: we must store classname */
2998 TRACEME(("already seen class %s, ID = %d", class, classnum));
3002 * Compute leading flags.
3006 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3007 flags |= SHF_LARGE_CLASSLEN;
3009 flags |= SHF_IDX_CLASSNAME;
3010 if (len2 > LG_SCALAR)
3011 flags |= SHF_LARGE_STRLEN;
3013 flags |= SHF_HAS_LIST;
3014 if (count > (LG_SCALAR + 1))
3015 flags |= SHF_LARGE_LISTLEN;
3018 * We're ready to emit either serialized form:
3020 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3021 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3023 * If we recursed, the SX_HOOK has already been emitted.
3026 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3027 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3028 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3030 /* SX_HOOK <flags> [<extra>] */
3034 if (obj_type == SHT_EXTRA)
3039 /* <len> <classname> or <index> */
3040 if (flags & SHF_IDX_CLASSNAME) {
3041 if (flags & SHF_LARGE_CLASSLEN)
3044 unsigned char cnum = (unsigned char) classnum;
3048 if (flags & SHF_LARGE_CLASSLEN)
3051 unsigned char clen = (unsigned char) len;
3054 WRITE(class, len); /* Final \0 is omitted */
3057 /* <len2> <frozen-str> */
3058 if (flags & SHF_LARGE_STRLEN) {
3059 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3060 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3062 unsigned char clen = (unsigned char) len2;
3066 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3068 /* [<len3> <object-IDs>] */
3069 if (flags & SHF_HAS_LIST) {
3070 int len3 = count - 1;
3071 if (flags & SHF_LARGE_LISTLEN)
3074 unsigned char clen = (unsigned char) len3;
3079 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3080 * real pointer, rather a tag number, well under the 32-bit limit.
3083 for (i = 1; i < count; i++) {
3084 I32 tagval = htonl(LOW_32BITS(ary[i]));
3086 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3091 * Free the array. We need extra care for indices after 0, since they
3092 * don't hold real SVs but integers cast.
3096 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3101 * If object was tied, need to insert serialization of the magic object.
3104 if (obj_type == SHT_EXTRA) {
3107 if (!(mg = mg_find(sv, mtype))) {
3108 int svt = SvTYPE(sv);
3109 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3110 mtype, (svt == SVt_PVHV) ? "hash" :
3111 (svt == SVt_PVAV) ? "array" : "scalar"));
3114 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3115 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3121 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3129 * store_blessed -- dispatched manually, not via sv_store[]
3131 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3132 * of its ancestors. If there is, then redispatch to store_hook();
3134 * Otherwise, the blessed SV is stored using the following layout:
3136 * SX_BLESS <flag> <len> <classname> <object>
3138 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3139 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3140 * Otherwise, the low order bits give the length, thereby giving a compact
3141 * representation for class names less than 127 chars long.
3143 * Each <classname> seen is remembered and indexed, so that the next time
3144 * an object in the blessed in the same <classname> is stored, the following
3147 * SX_IX_BLESS <flag> <index> <object>
3149 * where <index> is the classname index, stored on 0 or 4 bytes depending
3150 * on the high-order bit in flag (same encoding as above for <len>).
3152 static int store_blessed(
3164 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME(pkg)));
3167 * Look for a hook for this blessed SV and redirect to store_hook()
3171 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3173 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3176 * This is a blessed SV without any serialization hook.
3179 class = HvNAME(pkg);
3180 len = strlen(class);
3182 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3183 PTR2UV(sv), class, cxt->tagnum));
3186 * Determine whether it is the first time we see that class name (in which
3187 * case it will be stored in the SX_BLESS form), or whether we already
3188 * saw that class name before (in which case the SX_IX_BLESS form will be
3192 if (known_class(aTHX_ cxt, class, len, &classnum)) {
3193 TRACEME(("already seen class %s, ID = %d", class, classnum));
3194 PUTMARK(SX_IX_BLESS);
3195 if (classnum <= LG_BLESS) {
3196 unsigned char cnum = (unsigned char) classnum;
3199 unsigned char flag = (unsigned char) 0x80;
3204 TRACEME(("first time we see class %s, ID = %d", class, classnum));
3206 if (len <= LG_BLESS) {
3207 unsigned char clen = (unsigned char) len;
3210 unsigned char flag = (unsigned char) 0x80;
3212 WLEN(len); /* Don't BER-encode, this should be rare */
3214 WRITE(class, len); /* Final \0 is omitted */
3218 * Now emit the <object> part.
3221 return SV_STORE(type)(aTHX_ cxt, sv);
3227 * We don't know how to store the item we reached, so return an error condition.
3228 * (it's probably a GLOB, some CODE reference, etc...)
3230 * If they defined the `forgive_me' variable at the Perl level to some
3231 * true value, then don't croak, just warn, and store a placeholder string
3234 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3237 static char buf[80];
3239 TRACEME(("store_other"));
3242 * Fetch the value from perl only once per store() operation.
3246 cxt->forgive_me == 0 ||
3247 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3248 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3250 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3252 warn("Can't store item %s(0x%"UVxf")",
3253 sv_reftype(sv, FALSE), PTR2UV(sv));
3256 * Store placeholder string as a scalar instead...
3259 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3260 PTR2UV(sv), (char) 0);
3263 STORE_SCALAR(buf, len);
3264 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3270 *** Store driving routines
3276 * WARNING: partially duplicates Perl's sv_reftype for speed.
3278 * Returns the type of the SV, identified by an integer. That integer
3279 * may then be used to index the dynamic routine dispatch table.
3281 static int sv_type(pTHX_ SV *sv)
3283 switch (SvTYPE(sv)) {
3288 * No need to check for ROK, that can't be set here since there
3289 * is no field capable of hodling the xrv_rv reference.
3297 * Starting from SVt_PV, it is possible to have the ROK flag
3298 * set, the pointer to the other SV being either stored in
3299 * the xrv_rv (in the case of a pure SVt_RV), or as the
3300 * xpv_pv field of an SVt_PV and its heirs.
3302 * However, those SV cannot be magical or they would be an
3303 * SVt_PVMG at least.
3305 return SvROK(sv) ? svis_REF : svis_SCALAR;
3307 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3308 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3309 return svis_TIED_ITEM;
3312 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3314 return SvROK(sv) ? svis_REF : svis_SCALAR;
3316 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3320 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3335 * Recursively store objects pointed to by the sv to the specified file.
3337 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3338 * object (one for which storage has started -- it may not be over if we have
3339 * a self-referenced structure). This data set forms a stored <object>.
3341 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3346 HV *hseen = cxt->hseen;
3348 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3351 * If object has already been stored, do not duplicate data.
3352 * Simply emit the SX_OBJECT marker followed by its tag data.
3353 * The tag is always written in network order.
3355 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3356 * real pointer, rather a tag number (watch the insertion code below).
3357 * That means it probably safe to assume it is well under the 32-bit limit,
3358 * and makes the truncation safe.
3359 * -- RAM, 14/09/1999
3362 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3366 if (sv == &PL_sv_undef) {
3367 /* We have seen PL_sv_undef before, but fake it as
3370 Not the simplest solution to making restricted
3371 hashes work on 5.8.0, but it does mean that
3372 repeated references to the one true undef will
3373 take up less space in the output file.
3375 /* Need to jump past the next hv_store, because on the
3376 second store of undef the old hash value will be
3377 SvREFCNT_dec()ed, and as Storable cheats horribly
3378 by storing non-SVs in the hash a SEGV will ensure.
3379 Need to increase the tag number so that the
3380 receiver has no idea what games we're up to. This
3381 special casing doesn't affect hooks that store
3382 undef, as the hook routine does its own lookup into
3383 hseen. Also this means that any references back
3384 to PL_sv_undef (from the pathological case of hooks
3385 storing references to it) will find the seen hash
3386 entry for the first time, as if we didn't have this
3387 hackery here. (That hseen lookup works even on 5.8.0
3388 because it's a key of &PL_sv_undef and a value
3389 which is a tag number, not a value which is
3393 goto undef_special_case;
3396 tagval = htonl(LOW_32BITS(*svh));
3398 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3406 * Allocate a new tag and associate it with the address of the sv being
3407 * stored, before recursing...
3409 * In order to avoid creating new SvIVs to hold the tagnum we just
3410 * cast the tagnum to an SV pointer and store that in the hash. This
3411 * means that we must clean up the hash manually afterwards, but gives
3412 * us a 15% throughput increase.
3417 if (!hv_store(hseen,
3418 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3422 * Store `sv' and everything beneath it, using appropriate routine.
3423 * Abort immediately if we get a non-zero status back.
3426 type = sv_type(aTHX_ sv);
3429 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3430 PTR2UV(sv), cxt->tagnum, type));
3433 HV *pkg = SvSTASH(sv);
3434 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3436 ret = SV_STORE(type)(aTHX_ cxt, sv);
3438 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3439 ret ? "FAILED" : "ok", PTR2UV(sv),
3440 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3448 * Write magic number and system information into the file.
3449 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3450 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3451 * All size and lenghts are written as single characters here.
3453 * Note that no byte ordering info is emitted when <network> is true, since
3454 * integers will be emitted in network order in that case.
3456 static int magic_write(pTHX_ stcxt_t *cxt)
3459 * Starting with 0.6, the "use_network_order" byte flag is also used to
3460 * indicate the version number of the binary image, encoded in the upper
3461 * bits. The bit 0 is always used to indicate network order.
3464 * Starting with 0.7, a full byte is dedicated to the minor version of
3465 * the binary format, which is incremented only when new markers are
3466 * introduced, for instance, but when backward compatibility is preserved.
3469 /* Make these at compile time. The WRITE() macro is sufficiently complex
3470 that it saves about 200 bytes doing it this way and only using it
3472 static const unsigned char network_file_header[] = {
3474 (STORABLE_BIN_MAJOR << 1) | 1,
3475 STORABLE_BIN_WRITE_MINOR
3477 static const unsigned char file_header[] = {
3479 (STORABLE_BIN_MAJOR << 1) | 0,
3480 STORABLE_BIN_WRITE_MINOR,
3481 /* sizeof the array includes the 0 byte at the end: */
3482 (char) sizeof (byteorderstr) - 1,
3484 (unsigned char) sizeof(int),
3485 (unsigned char) sizeof(long),
3486 (unsigned char) sizeof(char *),
3487 (unsigned char) sizeof(NV)
3489 #ifdef USE_56_INTERWORK_KLUDGE
3490 static const unsigned char file_header_56[] = {
3492 (STORABLE_BIN_MAJOR << 1) | 0,
3493 STORABLE_BIN_WRITE_MINOR,
3494 /* sizeof the array includes the 0 byte at the end: */
3495 (char) sizeof (byteorderstr_56) - 1,
3497 (unsigned char) sizeof(int),
3498 (unsigned char) sizeof(long),
3499 (unsigned char) sizeof(char *),
3500 (unsigned char) sizeof(NV)
3503 const unsigned char *header;
3506 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3508 if (cxt->netorder) {
3509 header = network_file_header;
3510 length = sizeof (network_file_header);
3512 #ifdef USE_56_INTERWORK_KLUDGE
3513 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3514 header = file_header_56;
3515 length = sizeof (file_header_56);
3519 header = file_header;
3520 length = sizeof (file_header);
3525 /* sizeof the array includes the 0 byte at the end. */
3526 header += sizeof (magicstr) - 1;
3527 length -= sizeof (magicstr) - 1;
3530 WRITE( (unsigned char*) header, length);
3532 if (!cxt->netorder) {
3533 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3534 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3535 (int) sizeof(int), (int) sizeof(long),
3536 (int) sizeof(char *), (int) sizeof(NV)));
3544 * Common code for store operations.
3546 * When memory store is requested (f = NULL) and a non null SV* is given in
3547 * `res', it is filled with a new SV created out of the memory buffer.
3549 * It is required to provide a non-null `res' when the operation type is not
3550 * dclone() and store() is performed to memory.
3552 static int do_store(
3563 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3564 ("must supply result SV pointer for real recursion to memory"));
3566 TRACEME(("do_store (optype=%d, netorder=%d)",
3567 optype, network_order));
3572 * Workaround for CROAK leak: if they enter with a "dirty" context,
3573 * free up memory for them now.
3577 clean_context(aTHX_ cxt);
3580 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3581 * re-enter store() via the hooks. We need to stack contexts.
3585 cxt = allocate_context(aTHX_ cxt);
3589 ASSERT(cxt->entry == 1, ("starting new recursion"));
3590 ASSERT(!cxt->s_dirty, ("clean context"));
3593 * Ensure sv is actually a reference. From perl, we called something
3595 * pstore(aTHX_ FILE, \@array);
3596 * so we must get the scalar value behing that reference.
3600 CROAK(("Not a reference"));
3601 sv = SvRV(sv); /* So follow it to know what to store */
3604 * If we're going to store to memory, reset the buffer.
3611 * Prepare context and emit headers.
3614 init_store_context(aTHX_ cxt, f, optype, network_order);
3616 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3617 return 0; /* Error */
3620 * Recursively store object...
3623 ASSERT(is_storing(), ("within store operation"));
3625 status = store(aTHX_ cxt, sv); /* Just do it! */
3628 * If they asked for a memory store and they provided an SV pointer,
3629 * make an SV string out of the buffer and fill their pointer.
3631 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3632 * an SV, since context cleanup might free the buffer if we did recurse.
3633 * (unless caller is dclone(), which is aware of that).
3636 if (!cxt->fio && res)
3637 *res = mbuf2sv(aTHX);
3642 * The "root" context is never freed, since it is meant to be always
3643 * handy for the common case where no recursion occurs at all (i.e.
3644 * we enter store() outside of any Storable code and leave it, period).
3645 * We know it's the "root" context because there's nothing stacked
3650 * When deep cloning, we don't free the context: doing so would force
3651 * us to copy the data in the memory buffer. Sicne we know we're
3652 * about to enter do_retrieve...
3655 clean_store_context(aTHX_ cxt);
3656 if (cxt->prev && !(cxt->optype & ST_CLONE))
3657 free_context(aTHX_ cxt);
3659 TRACEME(("do_store returns %d", status));
3667 * Store the transitive data closure of given object to disk.
3668 * Returns 0 on error, a true value otherwise.
3670 int pstore(pTHX_ PerlIO *f, SV *sv)
3672 TRACEME(("pstore"));
3673 return do_store(aTHX_ f, sv, 0, FALSE, (SV**) 0);
3680 * Same as pstore(), but network order is used for integers and doubles are
3681 * emitted as strings.
3683 int net_pstore(pTHX_ PerlIO *f, SV *sv)
3685 TRACEME(("net_pstore"));
3686 return do_store(aTHX_ f, sv, 0, TRUE, (SV**) 0);
3696 * Build a new SV out of the content of the internal memory buffer.
3698 static SV *mbuf2sv(pTHX)
3702 return newSVpv(mbase, MBUF_SIZE());
3708 * Store the transitive data closure of given object to memory.
3709 * Returns undef on error, a scalar value containing the data otherwise.
3711 SV *mstore(pTHX_ SV *sv)
3715 TRACEME(("mstore"));
3717 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, FALSE, &out))
3718 return &PL_sv_undef;
3726 * Same as mstore(), but network order is used for integers and doubles are
3727 * emitted as strings.
3729 SV *net_mstore(pTHX_ SV *sv)
3733 TRACEME(("net_mstore"));
3735 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, TRUE, &out))
3736 return &PL_sv_undef;
3742 *** Specific retrieve callbacks.
3748 * Return an error via croak, since it is not possible that we get here
3749 * under normal conditions, when facing a file produced via pstore().
3751 static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname)
3754 cxt->ver_major != STORABLE_BIN_MAJOR &&
3755 cxt->ver_minor != STORABLE_BIN_MINOR
3757 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3758 cxt->fio ? "file" : "string",
3759 cxt->ver_major, cxt->ver_minor,
3760 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3762 CROAK(("Corrupted storable %s (binary v%d.%d)",
3763 cxt->fio ? "file" : "string",
3764 cxt->ver_major, cxt->ver_minor));
3767 return (SV *) 0; /* Just in case */
3771 * retrieve_idx_blessed
3773 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3774 * <index> can be coded on either 1 or 5 bytes.
3776 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname)
3783 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3784 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3786 GETMARK(idx); /* Index coded on a single char? */
3791 * Fetch classname in `aclass'
3794 sva = av_fetch(cxt->aclass, idx, FALSE);
3796 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3798 class = SvPVX(*sva); /* We know it's a PV, by construction */
3800 TRACEME(("class ID %d => %s", idx, class));
3803 * Retrieve object and bless it.
3806 sv = retrieve(aTHX_ cxt, class); /* First SV which is SEEN will be blessed */
3814 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3815 * <len> can be coded on either 1 or 5 bytes.
3817 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname)
3821 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3824 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3825 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3828 * Decode class name length and read that name.
3830 * Short classnames have two advantages: their length is stored on one
3831 * single byte, and the string can be read on the stack.
3834 GETMARK(len); /* Length coded on a single char? */
3837 TRACEME(("** allocating %d bytes for class name", len+1));
3838 New(10003, class, len+1, char);
3841 class[len] = '\0'; /* Mark string end */
3844 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3847 TRACEME(("new class name \"%s\" will bear ID = %d", class, cxt->classnum));
3849 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
3853 * Retrieve object and bless it.
3856 sv = retrieve(aTHX_ cxt, class); /* First SV which is SEEN will be blessed */
3866 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3867 * with leading mark already read, as usual.
3869 * When recursion was involved during serialization of the object, there
3870 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
3871 * we reach a <flags> marker with the recursion bit cleared.
3873 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
3874 * is held in the <extra> byte, and if the object is tied, the serialized
3875 * magic object comes at the very end:
3877 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
3879 * This means the STORABLE_thaw hook will NOT get a tied variable during its
3880 * processing (since we won't have seen the magic object by the time the hook
3881 * is called). See comments below for why it was done that way.
3883 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname)
3886 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3897 int clone = cxt->optype & ST_CLONE;
3899 unsigned int extra_type = 0;
3901 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
3902 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3905 * Read flags, which tell us about the type, and whether we need to recurse.
3911 * Create the (empty) object, and mark it as seen.
3913 * This must be done now, because tags are incremented, and during
3914 * serialization, the object tag was affected before recursion could
3918 obj_type = flags & SHF_TYPE_MASK;
3924 sv = (SV *) newAV();
3927 sv = (SV *) newHV();
3931 * Read <extra> flag to know the type of the object.
3932 * Record associated magic type for later.
3934 GETMARK(extra_type);
3935 switch (extra_type) {
3941 sv = (SV *) newAV();
3945 sv = (SV *) newHV();
3949 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
3953 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
3955 SEEN(sv, 0, 0); /* Don't bless yet */
3958 * Whilst flags tell us to recurse, do so.
3960 * We don't need to remember the addresses returned by retrieval, because
3961 * all the references will be obtained through indirection via the object
3962 * tags in the object-ID list.
3964 * We need to decrement the reference count for these objects
3965 * because, if the user doesn't save a reference to them in the hook,
3966 * they must be freed when this context is cleaned.
3969 while (flags & SHF_NEED_RECURSE) {
3970 TRACEME(("retrieve_hook recursing..."));
3971 rv = retrieve(aTHX_ cxt, 0);
3975 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
3980 if (flags & SHF_IDX_CLASSNAME) {
3985 * Fetch index from `aclass'
3988 if (flags & SHF_LARGE_CLASSLEN)
3993 sva = av_fetch(cxt->aclass, idx, FALSE);
3995 CROAK(("Class name #%"IVdf" should have been seen already",
3998 class = SvPVX(*sva); /* We know it's a PV, by construction */
3999 TRACEME(("class ID %d => %s", idx, class));
4003 * Decode class name length and read that name.
4005 * NOTA BENE: even if the length is stored on one byte, we don't read
4006 * on the stack. Just like retrieve_blessed(), we limit the name to
4007 * LG_BLESS bytes. This is an arbitrary decision.
4010 if (flags & SHF_LARGE_CLASSLEN)
4015 if (len > LG_BLESS) {
4016 TRACEME(("** allocating %d bytes for class name", len+1));
4017 New(10003, class, len+1, char);
4021 class[len] = '\0'; /* Mark string end */
4024 * Record new classname.
4027 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
4031 TRACEME(("class name: %s", class));
4034 * Decode user-frozen string length and read it in an SV.
4036 * For efficiency reasons, we read data directly into the SV buffer.
4037 * To understand that code, read retrieve_scalar()
4040 if (flags & SHF_LARGE_STRLEN)
4045 frozen = NEWSV(10002, len2);
4047 SAFEREAD(SvPVX(frozen), len2, frozen);
4048 SvCUR_set(frozen, len2);
4049 *SvEND(frozen) = '\0';
4051 (void) SvPOK_only(frozen); /* Validates string pointer */
4052 if (cxt->s_tainted) /* Is input source tainted? */
4055 TRACEME(("frozen string: %d bytes", len2));
4058 * Decode object-ID list length, if present.
4061 if (flags & SHF_HAS_LIST) {
4062 if (flags & SHF_LARGE_LISTLEN)
4068 av_extend(av, len3 + 1); /* Leave room for [0] */
4069 AvFILLp(av) = len3; /* About to be filled anyway */
4073 TRACEME(("has %d object IDs to link", len3));
4076 * Read object-ID list into array.
4077 * Because we pre-extended it, we can cheat and fill it manually.
4079 * We read object tags and we can convert them into SV* on the fly
4080 * because we know all the references listed in there (as tags)
4081 * have been already serialized, hence we have a valid correspondance
4082 * between each of those tags and the recreated SV.
4086 SV **ary = AvARRAY(av);
4088 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
4095 svh = av_fetch(cxt->aseen, tag, FALSE);
4097 if (tag == cxt->where_is_undef) {
4098 /* av_fetch uses PL_sv_undef internally, hence this
4099 somewhat gruesome hack. */
4103 CROAK(("Object #%"IVdf" should have been retrieved already",
4108 ary[i] = SvREFCNT_inc(xsv);
4113 * Bless the object and look up the STORABLE_thaw hook.
4117 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4120 * Hook not found. Maybe they did not require the module where this
4121 * hook is defined yet?
4123 * If the require below succeeds, we'll be able to find the hook.
4124 * Still, it only works reliably when each class is defined in a
4128 SV *psv = newSVpvn("require ", 8);
4129 sv_catpv(psv, class);
4131 TRACEME(("No STORABLE_thaw defined for objects of class %s", class));
4132 TRACEME(("Going to require module '%s' with '%s'", class, SvPVX(psv)));
4134 perl_eval_sv(psv, G_DISCARD);
4138 * We cache results of pkg_can, so we need to uncache before attempting
4142 pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4143 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4146 CROAK(("No STORABLE_thaw defined for objects of class %s "
4147 "(even after a \"require %s;\")", class, class));
4151 * If we don't have an `av' yet, prepare one.
4152 * Then insert the frozen string as item [0].
4160 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4165 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4167 * where $object is our blessed (empty) object, $cloning is a boolean
4168 * telling whether we're running a deep clone, $frozen is the frozen
4169 * string the user gave us in his serializing hook, and @refs, which may
4170 * be empty, is the list of extra references he returned along for us
4173 * In effect, the hook is an alternate creation routine for the class,
4174 * the object itself being already created by the runtime.
4177 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4178 class, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4181 (void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
4188 SvREFCNT_dec(frozen);
4191 if (!(flags & SHF_IDX_CLASSNAME) && class != buf)
4195 * If we had an <extra> type, then the object was not as simple, and
4196 * we need to restore extra magic now.
4202 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4204 rv = retrieve(aTHX_ cxt, 0); /* Retrieve <magic object> */
4206 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4207 PTR2UV(rv), PTR2UV(sv)));
4209 switch (extra_type) {
4211 sv_upgrade(sv, SVt_PVMG);
4214 sv_upgrade(sv, SVt_PVAV);
4215 AvREAL_off((AV *)sv);
4218 sv_upgrade(sv, SVt_PVHV);
4221 CROAK(("Forgot to deal with extra type %d", extra_type));
4226 * Adding the magic only now, well after the STORABLE_thaw hook was called
4227 * means the hook cannot know it deals with an object whose variable is
4228 * tied. But this is happening when retrieving $o in the following case:
4232 * my $o = bless \%h, 'BAR';
4234 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4235 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4236 * hash but a tied one should not matter at all, and remain transparent.
4237 * This means the magic must be restored by Storable AFTER the hook is
4240 * That looks very reasonable to me, but then I've come up with this
4241 * after a bug report from David Nesting, who was trying to store such
4242 * an object and caused Storable to fail. And unfortunately, it was
4243 * also the easiest way to retrofit support for blessed ref to tied objects
4244 * into the existing design. -- RAM, 17/02/2001
4247 sv_magic(sv, rv, mtype, Nullch, 0);
4248 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4256 * Retrieve reference to some other scalar.
4257 * Layout is SX_REF <object>, with SX_REF already read.
4259 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname)
4264 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4267 * We need to create the SV that holds the reference to the yet-to-retrieve
4268 * object now, so that we may record the address in the seen table.
4269 * Otherwise, if the object to retrieve references us, we won't be able
4270 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4271 * do the retrieve first and use rv = newRV(sv) since it will be too late
4272 * for SEEN() recording.
4275 rv = NEWSV(10002, 0);
4276 SEEN(rv, cname, 0); /* Will return if rv is null */
4277 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4279 return (SV *) 0; /* Failed */
4282 * WARNING: breaks RV encapsulation.
4284 * Now for the tricky part. We have to upgrade our existing SV, so that
4285 * it is now an RV on sv... Again, we cheat by duplicating the code
4286 * held in newSVrv(), since we already got our SV from retrieve().
4290 * SvRV(rv) = SvREFCNT_inc(sv);
4292 * here because the reference count we got from retrieve() above is
4293 * already correct: if the object was retrieved from the file, then
4294 * its reference count is one. Otherwise, if it was retrieved via
4295 * an SX_OBJECT indication, a ref count increment was done.
4299 /* No need to do anything, as rv will already be PVMG. */
4300 assert (SvTYPE(rv) >= SVt_RV);
4302 sv_upgrade(rv, SVt_RV);
4305 SvRV(rv) = sv; /* $rv = \$sv */
4308 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4316 * Retrieve weak reference to some other scalar.
4317 * Layout is SX_WEAKREF <object>, with SX_WEAKREF already read.
4319 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, char *cname)
4323 TRACEME(("retrieve_weakref (#%d)", cxt->tagnum));
4325 sv = retrieve_ref(aTHX_ cxt, cname);
4337 * retrieve_overloaded
4339 * Retrieve reference to some other scalar with overloading.
4340 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4342 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname)
4348 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4351 * Same code as retrieve_ref(), duplicated to avoid extra call.
4354 rv = NEWSV(10002, 0);
4355 SEEN(rv, cname, 0); /* Will return if rv is null */
4356 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4358 return (SV *) 0; /* Failed */
4361 * WARNING: breaks RV encapsulation.
4364 sv_upgrade(rv, SVt_RV);
4365 SvRV(rv) = sv; /* $rv = \$sv */
4369 * Restore overloading magic.
4372 stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
4374 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4375 ") (package <unknown>)",
4376 sv_reftype(sv, FALSE),
4379 if (!Gv_AMG(stash)) {
4380 SV *psv = newSVpvn("require ", 8);
4381 const char *package = HvNAME(stash);
4382 sv_catpv(psv, package);
4384 TRACEME(("No overloading defined for package %s", package));
4385 TRACEME(("Going to require module '%s' with '%s'", package, SvPVX(psv)));
4387 perl_eval_sv(psv, G_DISCARD);
4389 if (!Gv_AMG(stash)) {
4390 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4391 ") (package %s) (even after a \"require %s;\")",
4392 sv_reftype(sv, FALSE),
4400 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4406 * retrieve_weakoverloaded
4408 * Retrieve weak overloaded reference to some other scalar.
4409 * Layout is SX_WEAKOVERLOADED <object>, with SX_WEAKOVERLOADED already read.
4411 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, char *cname)
4415 TRACEME(("retrieve_weakoverloaded (#%d)", cxt->tagnum));
4417 sv = retrieve_overloaded(aTHX_ cxt, cname);
4429 * retrieve_tied_array
4431 * Retrieve tied array
4432 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4434 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname)
4439 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4441 tv = NEWSV(10002, 0);
4442 SEEN(tv, cname, 0); /* Will return if tv is null */
4443 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4445 return (SV *) 0; /* Failed */
4447 sv_upgrade(tv, SVt_PVAV);
4448 AvREAL_off((AV *)tv);
4449 sv_magic(tv, sv, 'P', Nullch, 0);
4450 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4452 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4458 * retrieve_tied_hash
4460 * Retrieve tied hash
4461 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4463 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname)
4468 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4470 tv = NEWSV(10002, 0);
4471 SEEN(tv, cname, 0); /* Will return if tv is null */
4472 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4474 return (SV *) 0; /* Failed */
4476 sv_upgrade(tv, SVt_PVHV);
4477 sv_magic(tv, sv, 'P', Nullch, 0);
4478 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4480 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4486 * retrieve_tied_scalar
4488 * Retrieve tied scalar
4489 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4491 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname)
4494 SV *sv, *obj = NULL;
4496 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4498 tv = NEWSV(10002, 0);
4499 SEEN(tv, cname, 0); /* Will return if rv is null */
4500 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4502 return (SV *) 0; /* Failed */
4504 else if (SvTYPE(sv) != SVt_NULL) {
4508 sv_upgrade(tv, SVt_PVMG);
4509 sv_magic(tv, obj, 'q', Nullch, 0);
4512 /* Undo refcnt inc from sv_magic() */
4516 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4524 * Retrieve reference to value in a tied hash.
4525 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4527 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname)
4533 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4535 tv = NEWSV(10002, 0);
4536 SEEN(tv, cname, 0); /* Will return if tv is null */
4537 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4539 return (SV *) 0; /* Failed */
4541 key = retrieve(aTHX_ cxt, 0); /* Retrieve <key> */
4543 return (SV *) 0; /* Failed */
4545 sv_upgrade(tv, SVt_PVMG);
4546 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4547 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4548 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4556 * Retrieve reference to value in a tied array.
4557 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4559 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname)
4565 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4567 tv = NEWSV(10002, 0);
4568 SEEN(tv, cname, 0); /* Will return if tv is null */
4569 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4571 return (SV *) 0; /* Failed */
4573 RLEN(idx); /* Retrieve <idx> */
4575 sv_upgrade(tv, SVt_PVMG);
4576 sv_magic(tv, sv, 'p', Nullch, idx);
4577 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4586 * Retrieve defined long (string) scalar.
4588 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4589 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4590 * was not stored on a single byte.
4592 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname)
4598 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4601 * Allocate an empty scalar of the suitable length.
4604 sv = NEWSV(10002, len);
4605 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4608 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4610 * Now, for efficiency reasons, read data directly inside the SV buffer,
4611 * and perform the SV final settings directly by duplicating the final
4612 * work done by sv_setpv. Since we're going to allocate lots of scalars
4613 * this way, it's worth the hassle and risk.
4616 SAFEREAD(SvPVX(sv), len, sv);
4617 SvCUR_set(sv, len); /* Record C string length */
4618 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4619 (void) SvPOK_only(sv); /* Validate string pointer */
4620 if (cxt->s_tainted) /* Is input source tainted? */
4621 SvTAINT(sv); /* External data cannot be trusted */
4623 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4624 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4632 * Retrieve defined short (string) scalar.
4634 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4635 * The scalar is "short" so <length> is single byte. If it is 0, there
4636 * is no <data> section.
4638 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname)
4644 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4647 * Allocate an empty scalar of the suitable length.
4650 sv = NEWSV(10002, len);
4651 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4654 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4659 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4660 * To make it defined with an empty length, upgrade it now...
4661 * Don't upgrade to a PV if the original type contains more
4662 * information than a scalar.
4664 if (SvTYPE(sv) <= SVt_PV) {
4665 sv_upgrade(sv, SVt_PV);
4668 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4669 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4672 * Now, for efficiency reasons, read data directly inside the SV buffer,
4673 * and perform the SV final settings directly by duplicating the final
4674 * work done by sv_setpv. Since we're going to allocate lots of scalars
4675 * this way, it's worth the hassle and risk.
4677 SAFEREAD(SvPVX(sv), len, sv);
4678 SvCUR_set(sv, len); /* Record C string length */
4679 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4680 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4683 (void) SvPOK_only(sv); /* Validate string pointer */
4684 if (cxt->s_tainted) /* Is input source tainted? */
4685 SvTAINT(sv); /* External data cannot be trusted */
4687 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4694 * Like retrieve_scalar(), but tag result as utf8.
4695 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4697 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname)
4701 TRACEME(("retrieve_utf8str"));
4703 sv = retrieve_scalar(aTHX_ cxt, cname);
4705 #ifdef HAS_UTF8_SCALARS
4708 if (cxt->use_bytes < 0)
4710 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4712 if (cxt->use_bytes == 0)
4723 * Like retrieve_lscalar(), but tag result as utf8.
4724 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4726 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname)
4730 TRACEME(("retrieve_lutf8str"));
4732 sv = retrieve_lscalar(aTHX_ cxt, cname);
4734 #ifdef HAS_UTF8_SCALARS
4737 if (cxt->use_bytes < 0)
4739 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4741 if (cxt->use_bytes == 0)
4751 * Retrieve defined integer.
4752 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4754 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname)
4759 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4761 READ(&iv, sizeof(iv));
4763 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4765 TRACEME(("integer %"IVdf, iv));
4766 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4774 * Retrieve defined integer in network order.
4775 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4777 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname)
4782 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4786 sv = newSViv((int) ntohl(iv));
4787 TRACEME(("network integer %d", (int) ntohl(iv)));
4790 TRACEME(("network integer (as-is) %d", iv));
4792 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4794 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
4802 * Retrieve defined double.
4803 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
4805 static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname)
4810 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
4812 READ(&nv, sizeof(nv));
4814 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4816 TRACEME(("double %"NVff, nv));
4817 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
4825 * Retrieve defined byte (small integer within the [-128, +127] range).
4826 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
4828 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname)
4832 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
4834 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
4837 TRACEME(("small integer read as %d", (unsigned char) siv));
4838 tmp = (unsigned char) siv - 128;
4840 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4842 TRACEME(("byte %d", tmp));
4843 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
4851 * Return the undefined value.
4853 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname)
4857 TRACEME(("retrieve_undef"));
4868 * Return the immortal undefined value.
4870 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname)
4872 SV *sv = &PL_sv_undef;
4874 TRACEME(("retrieve_sv_undef"));
4876 /* Special case PL_sv_undef, as av_fetch uses it internally to mark
4877 deleted elements, and will return NULL (fetch failed) whenever it
4879 if (cxt->where_is_undef == -1) {
4880 cxt->where_is_undef = cxt->tagnum;
4889 * Return the immortal yes value.
4891 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname)
4893 SV *sv = &PL_sv_yes;
4895 TRACEME(("retrieve_sv_yes"));
4904 * Return the immortal no value.
4906 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname)
4910 TRACEME(("retrieve_sv_no"));
4919 * Retrieve a whole array.
4920 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
4921 * Each item is stored as <object>.
4923 * When we come here, SX_ARRAY has been read already.
4925 static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname)
4932 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
4935 * Read length, and allocate array, then pre-extend it.
4939 TRACEME(("size = %d", len));
4941 SEEN(av, cname, 0); /* Will return if array not allocated nicely */
4945 return (SV *) av; /* No data follow if array is empty */
4948 * Now get each item in turn...
4951 for (i = 0; i < len; i++) {
4952 TRACEME(("(#%d) item", i));
4953 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
4956 if (av_store(av, i, sv) == 0)
4960 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
4968 * Retrieve a whole hash table.
4969 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4970 * Keys are stored as <length> <data>, the <data> section being omitted
4972 * Values are stored as <object>.
4974 * When we come here, SX_HASH has been read already.
4976 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname)
4984 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
4987 * Read length, allocate table.
4991 TRACEME(("size = %d", len));
4993 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
4995 return (SV *) hv; /* No data follow if table empty */
4996 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
4999 * Now get each key/value pair in turn...
5002 for (i = 0; i < len; i++) {
5007 TRACEME(("(#%d) value", i));
5008 sv = retrieve(aTHX_ cxt, 0);
5014 * Since we're reading into kbuf, we must ensure we're not
5015 * recursing between the read and the hv_store() where it's used.
5016 * Hence the key comes after the value.
5019 RLEN(size); /* Get key size */
5020 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5023 kbuf[size] = '\0'; /* Mark string end, just in case */
5024 TRACEME(("(#%d) key '%s'", i, kbuf));
5027 * Enter key/value pair into hash table.
5030 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5034 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5042 * Retrieve a whole hash table.
5043 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5044 * Keys are stored as <length> <data>, the <data> section being omitted
5046 * Values are stored as <object>.
5048 * When we come here, SX_HASH has been read already.
5050 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname)
5059 GETMARK(hash_flags);
5060 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
5062 * Read length, allocate table.
5065 #ifndef HAS_RESTRICTED_HASHES
5066 if (hash_flags & SHV_RESTRICTED) {
5067 if (cxt->derestrict < 0)
5069 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
5071 if (cxt->derestrict == 0)
5072 RESTRICTED_HASH_CROAK();
5077 TRACEME(("size = %d, flags = %d", len, hash_flags));
5079 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5081 return (SV *) hv; /* No data follow if table empty */
5082 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5085 * Now get each key/value pair in turn...
5088 for (i = 0; i < len; i++) {
5090 int store_flags = 0;
5095 TRACEME(("(#%d) value", i));
5096 sv = retrieve(aTHX_ cxt, 0);
5101 #ifdef HAS_RESTRICTED_HASHES
5102 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
5106 if (flags & SHV_K_ISSV) {
5107 /* XXX you can't set a placeholder with an SV key.
5108 Then again, you can't get an SV key.
5109 Without messing around beyond what the API is supposed to do.
5112 TRACEME(("(#%d) keysv, flags=%d", i, flags));
5113 keysv = retrieve(aTHX_ cxt, 0);
5117 if (!hv_store_ent(hv, keysv, sv, 0))
5122 * Since we're reading into kbuf, we must ensure we're not
5123 * recursing between the read and the hv_store() where it's used.
5124 * Hence the key comes after the value.
5127 if (flags & SHV_K_PLACEHOLDER) {
5129 sv = &PL_sv_placeholder;
5130 store_flags |= HVhek_PLACEHOLD;
5132 if (flags & SHV_K_UTF8) {
5133 #ifdef HAS_UTF8_HASHES
5134 store_flags |= HVhek_UTF8;
5136 if (cxt->use_bytes < 0)
5138 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
5140 if (cxt->use_bytes == 0)
5144 #ifdef HAS_UTF8_HASHES
5145 if (flags & SHV_K_WASUTF8)
5146 store_flags |= HVhek_WASUTF8;
5149 RLEN(size); /* Get key size */
5150 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5153 kbuf[size] = '\0'; /* Mark string end, just in case */
5154 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5155 flags, store_flags));
5158 * Enter key/value pair into hash table.
5161 #ifdef HAS_RESTRICTED_HASHES
5162 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5165 if (!(store_flags & HVhek_PLACEHOLD))
5166 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5171 #ifdef HAS_RESTRICTED_HASHES
5172 if (hash_flags & SHV_RESTRICTED)
5176 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5184 * Return a code reference.
5186 static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname)
5188 #if PERL_VERSION < 6
5189 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5192 int type, count, tagnum;
5194 SV *sv, *text, *sub;
5196 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5199 * Insert dummy SV in the aseen array so that we don't screw
5200 * up the tag numbers. We would just make the internal
5201 * scalar an untagged item in the stream, but
5202 * retrieve_scalar() calls SEEN(). So we just increase the
5205 tagnum = cxt->tagnum;
5210 * Retrieve the source of the code reference
5211 * as a small or large scalar
5217 text = retrieve_scalar(aTHX_ cxt, cname);
5220 text = retrieve_lscalar(aTHX_ cxt, cname);
5223 CROAK(("Unexpected type %d in retrieve_code\n", type));
5227 * prepend "sub " to the source
5230 sub = newSVpvn("sub ", 4);
5231 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5235 * evaluate the source to a code reference and use the CV value
5238 if (cxt->eval == NULL) {
5239 cxt->eval = perl_get_sv("Storable::Eval", TRUE);
5240 SvREFCNT_inc(cxt->eval);
5242 if (!SvTRUE(cxt->eval)) {
5244 cxt->forgive_me == 0 ||
5245 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5246 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
5248 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5251 /* fix up the dummy entry... */
5252 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5260 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5261 SV* errsv = get_sv("@", TRUE);
5262 sv_setpv(errsv, ""); /* clear $@ */
5264 XPUSHs(sv_2mortal(newSVsv(sub)));
5266 count = call_sv(cxt->eval, G_SCALAR);
5269 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5271 if (SvTRUE(errsv)) {
5272 CROAK(("code %s caused an error: %s",
5273 SvPV_nolen(sub), SvPV_nolen(errsv)));
5277 cv = eval_pv(SvPV_nolen(sub), TRUE);
5279 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5282 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5285 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5290 /* fix up the dummy entry... */
5291 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5298 * old_retrieve_array
5300 * Retrieve a whole array in pre-0.6 binary format.
5302 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5303 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5305 * When we come here, SX_ARRAY has been read already.
5307 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname)
5315 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5318 * Read length, and allocate array, then pre-extend it.
5322 TRACEME(("size = %d", len));
5324 SEEN(av, 0, 0); /* Will return if array not allocated nicely */
5328 return (SV *) av; /* No data follow if array is empty */
5331 * Now get each item in turn...
5334 for (i = 0; i < len; i++) {
5336 if (c == SX_IT_UNDEF) {
5337 TRACEME(("(#%d) undef item", i));
5338 continue; /* av_extend() already filled us with undef */
5341 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5342 TRACEME(("(#%d) item", i));
5343 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5346 if (av_store(av, i, sv) == 0)
5350 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5358 * Retrieve a whole hash table in pre-0.6 binary format.
5360 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5361 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5363 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5365 * When we come here, SX_HASH has been read already.
5367 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname)
5375 static SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5377 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5380 * Read length, allocate table.
5384 TRACEME(("size = %d", len));
5386 SEEN(hv, 0, 0); /* Will return if table not allocated properly */
5388 return (SV *) hv; /* No data follow if table empty */
5389 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5392 * Now get each key/value pair in turn...
5395 for (i = 0; i < len; i++) {
5401 if (c == SX_VL_UNDEF) {
5402 TRACEME(("(#%d) undef value", i));
5404 * Due to a bug in hv_store(), it's not possible to pass
5405 * &PL_sv_undef to hv_store() as a value, otherwise the
5406 * associated key will not be creatable any more. -- RAM, 14/01/97
5409 sv_h_undef = newSVsv(&PL_sv_undef);
5410 sv = SvREFCNT_inc(sv_h_undef);
5411 } else if (c == SX_VALUE) {
5412 TRACEME(("(#%d) value", i));
5413 sv = retrieve(aTHX_ cxt, 0);
5417 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5421 * Since we're reading into kbuf, we must ensure we're not
5422 * recursing between the read and the hv_store() where it's used.
5423 * Hence the key comes after the value.
5428 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5429 RLEN(size); /* Get key size */
5430 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5433 kbuf[size] = '\0'; /* Mark string end, just in case */
5434 TRACEME(("(#%d) key '%s'", i, kbuf));
5437 * Enter key/value pair into hash table.
5440 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5444 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5450 *** Retrieval engine.
5456 * Make sure the stored data we're trying to retrieve has been produced
5457 * on an ILP compatible system with the same byteorder. It croaks out in
5458 * case an error is detected. [ILP = integer-long-pointer sizes]
5459 * Returns null if error is detected, &PL_sv_undef otherwise.
5461 * Note that there's no byte ordering info emitted when network order was
5462 * used at store time.
5464 static SV *magic_check(pTHX_ stcxt_t *cxt)
5466 /* The worst case for a malicious header would be old magic (which is
5467 longer), major, minor, byteorder length byte of 255, 255 bytes of
5468 garbage, sizeof int, long, pointer, NV.
5469 So the worse of that we can read is 255 bytes of garbage plus 4.
5470 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5471 compiling perl on a system with chars that are larger than 8 bits.
5472 (Even Crays aren't *that* perverse).
5474 unsigned char buf[4 + 255];
5475 unsigned char *current;
5478 int use_network_order;
5481 int version_minor = 0;
5483 TRACEME(("magic_check"));
5486 * The "magic number" is only for files, not when freezing in memory.
5490 /* This includes the '\0' at the end. I want to read the extra byte,
5491 which is usually going to be the major version number. */
5492 STRLEN len = sizeof(magicstr);
5495 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5497 /* Point at the byte after the byte we read. */
5498 current = buf + --len; /* Do the -- outside of macros. */
5500 if (memNE(buf, magicstr, len)) {
5502 * Try to read more bytes to check for the old magic number, which
5506 TRACEME(("trying for old magic number"));
5508 old_len = sizeof(old_magicstr) - 1;
5509 READ(current + 1, (SSize_t)(old_len - len));
5511 if (memNE(buf, old_magicstr, old_len))
5512 CROAK(("File is not a perl storable"));
5513 current = buf + old_len;
5515 use_network_order = *current;
5517 GETMARK(use_network_order);
5520 * Starting with 0.6, the "use_network_order" byte flag is also used to
5521 * indicate the version number of the binary, and therefore governs the
5522 * setting of sv_retrieve_vtbl. See magic_write().
5525 version_major = use_network_order >> 1;
5526 cxt->retrieve_vtbl = version_major ? sv_retrieve : sv_old_retrieve;
5528 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5532 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5533 * minor version of the protocol. See magic_write().
5536 if (version_major > 1)
5537 GETMARK(version_minor);
5539 cxt->ver_major = version_major;
5540 cxt->ver_minor = version_minor;
5542 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5545 * Inter-operability sanity check: we can't retrieve something stored
5546 * using a format more recent than ours, because we have no way to
5547 * know what has changed, and letting retrieval go would mean a probable
5548 * failure reporting a "corrupted" storable file.
5552 version_major > STORABLE_BIN_MAJOR ||
5553 (version_major == STORABLE_BIN_MAJOR &&
5554 version_minor > STORABLE_BIN_MINOR)
5557 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5558 STORABLE_BIN_MINOR));
5560 if (version_major == STORABLE_BIN_MAJOR) {
5561 TRACEME(("cxt->accept_future_minor is %d",
5562 cxt->accept_future_minor));
5563 if (cxt->accept_future_minor < 0)
5564 cxt->accept_future_minor
5565 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5568 if (cxt->accept_future_minor == 1)
5569 croak_now = 0; /* Don't croak yet. */
5572 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5573 version_major, version_minor,
5574 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5579 * If they stored using network order, there's no byte ordering
5580 * information to check.
5583 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5584 return &PL_sv_undef; /* No byte ordering info */
5586 /* In C truth is 1, falsehood is 0. Very convienient. */
5587 use_NV_size = version_major >= 2 && version_minor >= 2;
5590 length = c + 3 + use_NV_size;
5591 READ(buf, length); /* Not null-terminated */
5593 TRACEME(("byte order '%.*s' %d", c, buf, c));
5595 #ifdef USE_56_INTERWORK_KLUDGE
5596 /* No point in caching this in the context as we only need it once per
5597 retrieve, and we need to recheck it each read. */
5598 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5599 if ((c != (sizeof (byteorderstr_56) - 1))
5600 || memNE(buf, byteorderstr_56, c))
5601 CROAK(("Byte order is not compatible"));
5605 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5606 CROAK(("Byte order is not compatible"));
5612 if ((int) *current++ != sizeof(int))
5613 CROAK(("Integer size is not compatible"));
5616 if ((int) *current++ != sizeof(long))
5617 CROAK(("Long integer size is not compatible"));
5619 /* sizeof(char *) */
5620 if ((int) *current != sizeof(char *))
5621 CROAK(("Pointer size is not compatible"));
5625 if ((int) *++current != sizeof(NV))
5626 CROAK(("Double size is not compatible"));
5629 return &PL_sv_undef; /* OK */
5635 * Recursively retrieve objects from the specified file and return their
5636 * root SV (which may be an AV or an HV for what we care).
5637 * Returns null if there is a problem.
5639 static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname)
5645 TRACEME(("retrieve"));
5648 * Grab address tag which identifies the object if we are retrieving
5649 * an older format. Since the new binary format counts objects and no
5650 * longer explicitely tags them, we must keep track of the correspondance
5653 * The following section will disappear one day when the old format is
5654 * no longer supported, hence the final "goto" in the "if" block.
5657 if (cxt->hseen) { /* Retrieving old binary */
5659 if (cxt->netorder) {
5661 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5662 tag = (stag_t) nettag;
5664 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5667 if (type == SX_OBJECT) {
5669 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5671 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5673 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5676 * The following code is common with the SX_OBJECT case below.
5679 svh = av_fetch(cxt->aseen, tagn, FALSE);
5681 CROAK(("Object #%"IVdf" should have been retrieved already",
5684 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5685 SvREFCNT_inc(sv); /* One more reference to this same sv */
5686 return sv; /* The SV pointer where object was retrieved */
5690 * Map new object, but don't increase tagnum. This will be done
5691 * by each of the retrieve_* functions when they call SEEN().
5693 * The mapping associates the "tag" initially present with a unique
5694 * tag number. See test for SX_OBJECT above to see how this is perused.
5697 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5698 newSViv(cxt->tagnum), 0))
5705 * Regular post-0.6 binary format.
5710 TRACEME(("retrieve type = %d", type));
5713 * Are we dealing with an object we should have already retrieved?
5716 if (type == SX_OBJECT) {
5720 svh = av_fetch(cxt->aseen, tag, FALSE);
5722 CROAK(("Object #%"IVdf" should have been retrieved already",
5725 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5726 SvREFCNT_inc(sv); /* One more reference to this same sv */
5727 return sv; /* The SV pointer where object was retrieved */
5728 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5729 if (cxt->accept_future_minor < 0)
5730 cxt->accept_future_minor
5731 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5734 if (cxt->accept_future_minor == 1) {
5735 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5736 "This Storable is v%d.%d and can only handle data types up to %d",
5737 cxt->ver_major, cxt->ver_minor, type,
5738 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5742 first_time: /* Will disappear when support for old format is dropped */
5745 * Okay, first time through for this one.
5748 sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
5750 return (SV *) 0; /* Failed */
5753 * Old binary formats (pre-0.7).
5755 * Final notifications, ended by SX_STORED may now follow.
5756 * Currently, the only pertinent notification to apply on the
5757 * freshly retrieved object is either:
5758 * SX_CLASS <char-len> <classname> for short classnames.
5759 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5760 * Class name is then read into the key buffer pool used by
5761 * hash table key retrieval.
5764 if (cxt->ver_major < 2) {
5765 while ((type = GETCHAR()) != SX_STORED) {
5769 GETMARK(len); /* Length coded on a single char */
5771 case SX_LG_CLASS: /* Length coded on a regular integer */
5776 return (SV *) 0; /* Failed */
5778 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5781 kbuf[len] = '\0'; /* Mark string end */
5786 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5787 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
5795 * Retrieve data held in file and return the root object.
5796 * Common routine for pretrieve and mretrieve.
5798 static SV *do_retrieve(
5806 int is_tainted; /* Is input source tainted? */
5807 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
5809 TRACEME(("do_retrieve (optype = 0x%x)", optype));
5811 optype |= ST_RETRIEVE;
5814 * Sanity assertions for retrieve dispatch tables.
5817 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
5818 ("old and new retrieve dispatch table have same size"));
5819 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
5820 ("SX_ERROR entry correctly initialized in old dispatch table"));
5821 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
5822 ("SX_ERROR entry correctly initialized in new dispatch table"));
5825 * Workaround for CROAK leak: if they enter with a "dirty" context,
5826 * free up memory for them now.
5830 clean_context(aTHX_ cxt);
5833 * Now that STORABLE_xxx hooks exist, it is possible that they try to
5834 * re-enter retrieve() via the hooks.
5838 cxt = allocate_context(aTHX_ cxt);
5842 ASSERT(cxt->entry == 1, ("starting new recursion"));
5843 ASSERT(!cxt->s_dirty, ("clean context"));
5848 * Data is loaded into the memory buffer when f is NULL, unless `in' is
5849 * also NULL, in which case we're expecting the data to already lie
5850 * in the buffer (dclone case).
5853 KBUFINIT(); /* Allocate hash key reading pool once */
5859 const char *orig = SvPV(in, length);
5861 /* This is quite deliberate. I want the UTF8 routines
5862 to encounter the '\0' which perl adds at the end
5863 of all scalars, so that any new string also has
5866 STRLEN klen_tmp = length + 1;
5867 bool is_utf8 = TRUE;
5869 /* Just casting the &klen to (STRLEN) won't work
5870 well if STRLEN and I32 are of different widths.
5872 asbytes = (char*)bytes_from_utf8((U8*)orig,
5876 CROAK(("Frozen string corrupt - contains characters outside 0-255"));
5878 if (asbytes != orig) {
5879 /* String has been converted.
5880 There is no need to keep any reference to
5882 in = sv_newmortal();
5883 /* We donate the SV the malloc()ed string
5884 bytes_from_utf8 returned us. */
5885 SvUPGRADE(in, SVt_PV);
5887 SvPVX(in) = asbytes;
5888 SvLEN(in) = klen_tmp;
5889 SvCUR(in) = klen_tmp - 1;
5893 MBUF_SAVE_AND_LOAD(in);
5897 * Magic number verifications.
5899 * This needs to be done before calling init_retrieve_context()
5900 * since the format indication in the file are necessary to conduct
5901 * some of the initializations.
5904 cxt->fio = f; /* Where I/O are performed */
5906 if (!magic_check(aTHX_ cxt))
5907 CROAK(("Magic number checking on storable %s failed",
5908 cxt->fio ? "file" : "string"));
5910 TRACEME(("data stored in %s format",
5911 cxt->netorder ? "net order" : "native"));
5914 * Check whether input source is tainted, so that we don't wrongly
5915 * taint perfectly good values...
5917 * We assume file input is always tainted. If both `f' and `in' are
5918 * NULL, then we come from dclone, and tainted is already filled in
5919 * the context. That's a kludge, but the whole dclone() thing is
5920 * already quite a kludge anyway! -- RAM, 15/09/2000.
5923 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
5924 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
5925 init_retrieve_context(aTHX_ cxt, optype, is_tainted);
5927 ASSERT(is_retrieving(), ("within retrieve operation"));
5929 sv = retrieve(aTHX_ cxt, 0); /* Recursively retrieve object, get root SV */
5938 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
5941 * The "root" context is never freed.
5944 clean_retrieve_context(aTHX_ cxt);
5945 if (cxt->prev) /* This context was stacked */
5946 free_context(aTHX_ cxt); /* It was not the "root" context */
5949 * Prepare returned value.
5953 TRACEME(("retrieve ERROR"));
5954 #if (PATCHLEVEL <= 4)
5955 /* perl 5.00405 seems to screw up at this point with an
5956 'attempt to modify a read only value' error reported in the
5957 eval { $self = pretrieve(*FILE) } in _retrieve.
5958 I can't see what the cause of this error is, but I suspect a
5959 bug in 5.004, as it seems to be capable of issuing spurious
5960 errors or core dumping with matches on $@. I'm not going to
5961 spend time on what could be a fruitless search for the cause,
5962 so here's a bodge. If you're running 5.004 and don't like
5963 this inefficiency, either upgrade to a newer perl, or you are
5964 welcome to find the problem and send in a patch.
5968 return &PL_sv_undef; /* Something went wrong, return undef */
5972 TRACEME(("retrieve got %s(0x%"UVxf")",
5973 sv_reftype(sv, FALSE), PTR2UV(sv)));
5976 * Backward compatibility with Storable-0.5@9 (which we know we
5977 * are retrieving if hseen is non-null): don't create an extra RV
5978 * for objects since we special-cased it at store time.
5980 * Build a reference to the SV returned by pretrieve even if it is
5981 * already one and not a scalar, for consistency reasons.
5984 if (pre_06_fmt) { /* Was not handling overloading by then */
5986 TRACEME(("fixing for old formats -- pre 0.6"));
5987 if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
5988 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
5994 * If reference is overloaded, restore behaviour.
5996 * NB: minor glitch here: normally, overloaded refs are stored specially
5997 * so that we can croak when behaviour cannot be re-installed, and also
5998 * avoid testing for overloading magic at each reference retrieval.
6000 * Unfortunately, the root reference is implicitely stored, so we must
6001 * check for possible overloading now. Furthermore, if we don't restore
6002 * overloading, we cannot croak as if the original ref was, because we
6003 * have no way to determine whether it was an overloaded ref or not in
6006 * It's a pity that overloading magic is attached to the rv, and not to
6007 * the underlying sv as blessing is.
6011 HV *stash = (HV *) SvSTASH(sv);
6012 SV *rv = newRV_noinc(sv);
6013 if (stash && Gv_AMG(stash)) {
6015 TRACEME(("restored overloading on root reference"));
6017 TRACEME(("ended do_retrieve() with an object"));
6021 TRACEME(("regular do_retrieve() end"));
6023 return newRV_noinc(sv);
6029 * Retrieve data held in file and return the root object, undef on error.
6031 SV *pretrieve(pTHX_ PerlIO *f)
6033 TRACEME(("pretrieve"));
6034 return do_retrieve(aTHX_ f, Nullsv, 0);
6040 * Retrieve data held in scalar and return the root object, undef on error.
6042 SV *mretrieve(pTHX_ SV *sv)
6044 TRACEME(("mretrieve"));
6045 return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
6055 * Deep clone: returns a fresh copy of the original referenced SV tree.
6057 * This is achieved by storing the object in memory and restoring from
6058 * there. Not that efficient, but it should be faster than doing it from
6061 SV *dclone(pTHX_ SV *sv)
6065 stcxt_t *real_context;
6068 TRACEME(("dclone"));
6071 * Workaround for CROAK leak: if they enter with a "dirty" context,
6072 * free up memory for them now.
6076 clean_context(aTHX_ cxt);
6079 * do_store() optimizes for dclone by not freeing its context, should
6080 * we need to allocate one because we're deep cloning from a hook.
6083 if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
6084 return &PL_sv_undef; /* Error during store */
6087 * Because of the above optimization, we have to refresh the context,
6088 * since a new one could have been allocated and stacked by do_store().
6091 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
6092 cxt = real_context; /* And we need this temporary... */
6095 * Now, `cxt' may refer to a new context.
6098 ASSERT(!cxt->s_dirty, ("clean context"));
6099 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
6102 TRACEME(("dclone stored %d bytes", size));
6106 * Since we're passing do_retrieve() both a NULL file and sv, we need
6107 * to pre-compute the taintedness of the input by setting cxt->tainted
6108 * to whatever state our own input string was. -- RAM, 15/09/2000
6110 * do_retrieve() will free non-root context.
6113 cxt->s_tainted = SvTAINTED(sv);
6114 out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
6116 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
6126 * The Perl IO GV object distinguishes between input and output for sockets
6127 * but not for plain files. To allow Storable to transparently work on
6128 * plain files and sockets transparently, we have to ask xsubpp to fetch the
6129 * right object for us. Hence the OutputStream and InputStream declarations.
6131 * Before perl 5.004_05, those entries in the standard typemap are not
6132 * defined in perl include files, so we do that here.
6135 #ifndef OutputStream
6136 #define OutputStream PerlIO *
6137 #define InputStream PerlIO *
6138 #endif /* !OutputStream */
6140 MODULE = Storable PACKAGE = Storable::Cxt
6146 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
6150 if (!cxt->membuf_ro && mbase)
6152 if (cxt->membuf_ro && (cxt->msaved).arena)
6153 Safefree((cxt->msaved).arena);
6156 MODULE = Storable PACKAGE = Storable
6161 init_perinterp(aTHX);
6162 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
6164 /* Only disable the used only once warning if we are in debugging mode. */
6165 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
6167 #ifdef USE_56_INTERWORK_KLUDGE
6168 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
6174 init_perinterp(aTHX);
6181 RETVAL = pstore(aTHX_ f, obj);
6190 RETVAL = net_pstore(aTHX_ f, obj);
6198 RETVAL = mstore(aTHX_ obj);
6206 RETVAL = net_mstore(aTHX_ obj);
6214 RETVAL = pretrieve(aTHX_ f);
6222 RETVAL = mretrieve(aTHX_ sv);
6230 RETVAL = dclone(aTHX_ sv);
6235 last_op_in_netorder()
6237 RETVAL = last_op_in_netorder(aTHX);
6244 RETVAL = is_storing(aTHX);
6251 RETVAL = is_retrieving(aTHX);
projects / p5sagit/p5-mst-13.2.git / blob