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 */
18 # if !(defined(PERL_VERSION) || (SUBVERSION > 0 && defined(PATCHLEVEL)))
19 # include <could_not_find_Perl_patchlevel.h>
24 #include "ppport.h" /* handle old perls */
29 #define DEBUGME /* Debug mode, turns assertions on as well */
30 #define DASSERT /* Assertion mode */
33 #if 0 /* On NetWare USE_PERLIO is not used */
34 #define DEBUGME /* Debug mode, turns assertions on as well */
35 #define DASSERT /* Assertion mode */
40 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
41 * Provide them with the necessary defines so they can build with pre-5.004.
44 #ifndef PERLIO_IS_STDIO
46 #define PerlIO_getc(x) getc(x)
47 #define PerlIO_putc(f,x) putc(x,f)
48 #define PerlIO_read(x,y,z) fread(y,1,z,x)
49 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
50 #define PerlIO_stdoutf printf
51 #endif /* PERLIO_IS_STDIO */
52 #endif /* USE_PERLIO */
55 * Earlier versions of perl might be used, we can't assume they have the latest!
58 #ifndef PERL_VERSION /* For perls < 5.6 */
59 #define PERL_VERSION PATCHLEVEL
61 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
63 #if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
64 #define PL_sv_yes sv_yes
65 #define PL_sv_no sv_no
66 #define PL_sv_undef sv_undef
67 #if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
68 #define newSVpvn newSVpv
70 #endif /* PATCHLEVEL <= 4 */
71 #ifndef HvSHAREKEYS_off
72 #define HvSHAREKEYS_off(hv) /* Ignore */
74 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
75 #define AvFILLp AvFILL
77 typedef double NV; /* Older perls lack the NV type */
78 #define IVdf "ld" /* Various printf formats for Perl types */
82 #define INT2PTR(t,v) (t)(IV)(v)
83 #define PTR2UV(v) (unsigned long)(v)
84 #endif /* PERL_VERSION -- perls < 5.6 */
86 #ifndef NVef /* The following were not part of perl 5.6 */
87 #if defined(USE_LONG_DOUBLE) && \
88 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
89 #define NVef PERL_PRIeldbl
90 #define NVff PERL_PRIfldbl
91 #define NVgf PERL_PRIgldbl
106 * TRACEME() will only output things when the $Storable::DEBUGME is true.
111 if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
112 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
119 #define ASSERT(x,y) \
122 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
123 __FILE__, __LINE__); \
124 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
135 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
137 #define SX_OBJECT C(0) /* Already stored object */
138 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
139 #define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
140 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
141 #define SX_REF C(4) /* Reference to object forthcoming */
142 #define SX_UNDEF C(5) /* Undefined scalar */
143 #define SX_INTEGER C(6) /* Integer forthcoming */
144 #define SX_DOUBLE C(7) /* Double forthcoming */
145 #define SX_BYTE C(8) /* (signed) byte forthcoming */
146 #define SX_NETINT C(9) /* Integer in network order forthcoming */
147 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
148 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
149 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
150 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
151 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
152 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
153 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
154 #define SX_BLESS C(17) /* Object is blessed */
155 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
156 #define SX_HOOK C(19) /* Stored via hook, user-defined */
157 #define SX_OVERLOAD C(20) /* Overloaded reference */
158 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
159 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
160 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
161 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
162 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
163 #define SX_CODE C(26) /* Code references as perl source code */
164 #define SX_WEAKREF C(27) /* Weak reference to object forthcoming */
165 #define SX_WEAKOVERLOAD C(28) /* Overloaded weak reference */
166 #define SX_ERROR C(29) /* Error */
169 * Those are only used to retrieve "old" pre-0.6 binary images.
171 #define SX_ITEM 'i' /* An array item introducer */
172 #define SX_IT_UNDEF 'I' /* Undefined array item */
173 #define SX_KEY 'k' /* A hash key introducer */
174 #define SX_VALUE 'v' /* A hash value introducer */
175 #define SX_VL_UNDEF 'V' /* Undefined hash value */
178 * Those are only used to retrieve "old" pre-0.7 binary images
181 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
182 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
183 #define SX_STORED 'X' /* End of object */
186 * Limits between short/long length representation.
189 #define LG_SCALAR 255 /* Large scalar length limit */
190 #define LG_BLESS 127 /* Large classname bless limit */
196 #define ST_STORE 0x1 /* Store operation */
197 #define ST_RETRIEVE 0x2 /* Retrieval operation */
198 #define ST_CLONE 0x4 /* Deep cloning operation */
201 * The following structure is used for hash table key retrieval. Since, when
202 * retrieving objects, we'll be facing blessed hash references, it's best
203 * to pre-allocate that buffer once and resize it as the need arises, never
204 * freeing it (keys will be saved away someplace else anyway, so even large
205 * keys are not enough a motivation to reclaim that space).
207 * This structure is also used for memory store/retrieve operations which
208 * happen in a fixed place before being malloc'ed elsewhere if persistency
209 * is required. Hence the aptr pointer.
212 char *arena; /* Will hold hash key strings, resized as needed */
213 STRLEN asiz; /* Size of aforementionned buffer */
214 char *aptr; /* Arena pointer, for in-place read/write ops */
215 char *aend; /* First invalid address */
220 * A hash table records the objects which have already been stored.
221 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
222 * an arbitrary sequence number) is used to identify them.
225 * An array table records the objects which have already been retrieved,
226 * as seen by the tag determind by counting the objects themselves. The
227 * reference to that retrieved object is kept in the table, and is returned
228 * when an SX_OBJECT is found bearing that same tag.
230 * The same processing is used to record "classname" for blessed objects:
231 * indexing by a hash at store time, and via an array at retrieve time.
234 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
237 * The following "thread-safe" related defines were contributed by
238 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
239 * only renamed things a little bit to ensure consistency with surrounding
240 * code. -- RAM, 14/09/1999
242 * The original patch suffered from the fact that the stcxt_t structure
243 * was global. Murray tried to minimize the impact on the code as much as
246 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
247 * on objects. Therefore, the notion of context needs to be generalized,
251 #define MY_VERSION "Storable(" XS_VERSION ")"
255 * Conditional UTF8 support.
259 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
260 #define HAS_UTF8_SCALARS
262 #define HAS_UTF8_HASHES
265 /* 5.6 perl has utf8 scalars but not hashes */
269 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
272 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
275 #define WEAKREF_CROAK() CROAK(("Cannot retrieve weak references in this perl"))
278 #ifdef HvPLACEHOLDERS
279 #define HAS_RESTRICTED_HASHES
281 #define HVhek_PLACEHOLD 0x200
282 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
286 #define HAS_HASH_KEY_FLAGS
290 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
291 * files remap tainted and dirty when threading is enabled. That's bad for
292 * perl to remap such common words. -- RAM, 29/09/00
295 typedef struct stcxt {
296 int entry; /* flags recursion */
297 int optype; /* type of traversal operation */
298 HV *hseen; /* which objects have been seen, store time */
299 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
300 AV *aseen; /* which objects have been seen, retrieve time */
301 IV where_is_undef; /* index in aseen of PL_sv_undef */
302 HV *hclass; /* which classnames have been seen, store time */
303 AV *aclass; /* which classnames have been seen, retrieve time */
304 HV *hook; /* cache for hook methods per class name */
305 IV tagnum; /* incremented at store time for each seen object */
306 IV classnum; /* incremented at store time for each seen classname */
307 int netorder; /* true if network order used */
308 int s_tainted; /* true if input source is tainted, at retrieve time */
309 int forgive_me; /* whether to be forgiving... */
310 int deparse; /* whether to deparse code refs */
311 SV *eval; /* whether to eval source code */
312 int canonical; /* whether to store hashes sorted by key */
313 #ifndef HAS_RESTRICTED_HASHES
314 int derestrict; /* whether to downgrade restrcted hashes */
317 int use_bytes; /* whether to bytes-ify utf8 */
319 int accept_future_minor; /* croak immediately on future minor versions? */
320 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
321 int membuf_ro; /* true means membuf is read-only and msaved is rw */
322 struct extendable keybuf; /* for hash key retrieval */
323 struct extendable membuf; /* for memory store/retrieve operations */
324 struct extendable msaved; /* where potentially valid mbuf is saved */
325 PerlIO *fio; /* where I/O are performed, NULL for memory */
326 int ver_major; /* major of version for retrieved object */
327 int ver_minor; /* minor of version for retrieved object */
328 SV *(**retrieve_vtbl)(); /* retrieve dispatch table */
329 SV *prev; /* contexts chained backwards in real recursion */
330 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
333 #define NEW_STORABLE_CXT_OBJ(cxt) \
335 SV *self = newSV(sizeof(stcxt_t) - 1); \
336 SV *my_sv = newRV_noinc(self); \
337 sv_bless(my_sv, gv_stashpv("Storable::Cxt", TRUE)); \
338 cxt = (stcxt_t *)SvPVX(self); \
339 Zero(cxt, 1, stcxt_t); \
340 cxt->my_sv = my_sv; \
343 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
345 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
347 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
348 #else /* >= perl5.004_68 */
350 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
351 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
352 #endif /* < perl5.004_68 */
354 #define dSTCXT_PTR(T,name) \
355 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
356 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
359 dSTCXT_PTR(stcxt_t *, cxt)
363 NEW_STORABLE_CXT_OBJ(cxt); \
364 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
366 #define SET_STCXT(x) \
369 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
372 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
374 static stcxt_t *Context_ptr = NULL;
375 #define dSTCXT stcxt_t *cxt = Context_ptr
376 #define SET_STCXT(x) Context_ptr = x
379 NEW_STORABLE_CXT_OBJ(cxt); \
383 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
387 * Croaking implies a memory leak, since we don't use setjmp/longjmp
388 * to catch the exit and free memory used during store or retrieve
389 * operations. This is not too difficult to fix, but I need to understand
390 * how Perl does it, and croaking is exceptional anyway, so I lack the
391 * motivation to do it.
393 * The current workaround is to mark the context as dirty when croaking,
394 * so that data structures can be freed whenever we renter Storable code
395 * (but only *then*: it's a workaround, not a fix).
397 * This is also imperfect, because we don't really know how far they trapped
398 * the croak(), and when we were recursing, we won't be able to clean anything
399 * but the topmost context stacked.
402 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
405 * End of "thread-safe" related definitions.
411 * Keep only the low 32 bits of a pointer (used for tags, which are not
416 #define LOW_32BITS(x) ((I32) (x))
418 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
424 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
425 * Used in the WLEN and RLEN macros.
429 #define oI(x) ((I32 *) ((char *) (x) + 4))
430 #define oS(x) ((x) - 4)
431 #define oC(x) (x = 0)
440 * key buffer handling
442 #define kbuf (cxt->keybuf).arena
443 #define ksiz (cxt->keybuf).asiz
447 TRACEME(("** allocating kbuf of 128 bytes")); \
448 New(10003, kbuf, 128, char); \
455 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
456 Renew(kbuf, x+1, char); \
462 * memory buffer handling
464 #define mbase (cxt->membuf).arena
465 #define msiz (cxt->membuf).asiz
466 #define mptr (cxt->membuf).aptr
467 #define mend (cxt->membuf).aend
469 #define MGROW (1 << 13)
470 #define MMASK (MGROW - 1)
472 #define round_mgrow(x) \
473 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
474 #define trunc_int(x) \
475 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
476 #define int_aligned(x) \
477 ((unsigned long) (x) == trunc_int(x))
479 #define MBUF_INIT(x) \
482 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
483 New(10003, mbase, MGROW, char); \
484 msiz = (STRLEN)MGROW; \
490 mend = mbase + msiz; \
493 #define MBUF_TRUNC(x) mptr = mbase + x
494 #define MBUF_SIZE() (mptr - mbase)
500 * Those macros are used in do_retrieve() to save the current memory
501 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
502 * data from a string.
504 #define MBUF_SAVE_AND_LOAD(in) \
506 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
507 cxt->membuf_ro = 1; \
508 TRACEME(("saving mbuf")); \
509 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
513 #define MBUF_RESTORE() \
515 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
516 cxt->membuf_ro = 0; \
517 TRACEME(("restoring mbuf")); \
518 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
522 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
523 * See store_scalar() for other usage of this workaround.
525 #define MBUF_LOAD(v) \
527 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
529 CROAK(("Not a scalar string")); \
530 mptr = mbase = SvPV(v, msiz); \
531 mend = mbase + msiz; \
534 #define MBUF_XTEND(x) \
536 int nsz = (int) round_mgrow((x)+msiz); \
537 int offset = mptr - mbase; \
538 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
539 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
541 Renew(mbase, nsz, char); \
543 mptr = mbase + offset; \
544 mend = mbase + nsz; \
547 #define MBUF_CHK(x) \
549 if ((mptr + (x)) > mend) \
553 #define MBUF_GETC(x) \
556 x = (int) (unsigned char) *mptr++; \
562 #define MBUF_GETINT(x) \
565 if ((mptr + 4) <= mend) { \
566 memcpy(oI(&x), mptr, 4); \
572 #define MBUF_GETINT(x) \
574 if ((mptr + sizeof(int)) <= mend) { \
575 if (int_aligned(mptr)) \
578 memcpy(&x, mptr, sizeof(int)); \
579 mptr += sizeof(int); \
585 #define MBUF_READ(x,s) \
587 if ((mptr + (s)) <= mend) { \
588 memcpy(x, mptr, s); \
594 #define MBUF_SAFEREAD(x,s,z) \
596 if ((mptr + (s)) <= mend) { \
597 memcpy(x, mptr, s); \
605 #define MBUF_PUTC(c) \
608 *mptr++ = (char) c; \
611 *mptr++ = (char) c; \
616 #define MBUF_PUTINT(i) \
619 memcpy(mptr, oI(&i), 4); \
623 #define MBUF_PUTINT(i) \
625 MBUF_CHK(sizeof(int)); \
626 if (int_aligned(mptr)) \
629 memcpy(mptr, &i, sizeof(int)); \
630 mptr += sizeof(int); \
634 #define MBUF_WRITE(x,s) \
637 memcpy(mptr, x, s); \
642 * Possible return values for sv_type().
646 #define svis_SCALAR 1
650 #define svis_TIED_ITEM 5
658 #define SHF_TYPE_MASK 0x03
659 #define SHF_LARGE_CLASSLEN 0x04
660 #define SHF_LARGE_STRLEN 0x08
661 #define SHF_LARGE_LISTLEN 0x10
662 #define SHF_IDX_CLASSNAME 0x20
663 #define SHF_NEED_RECURSE 0x40
664 #define SHF_HAS_LIST 0x80
667 * Types for SX_HOOK (last 2 bits in flags).
673 #define SHT_EXTRA 3 /* Read extra byte for type */
676 * The following are held in the "extra byte"...
679 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
680 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
681 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
684 * per hash flags for flagged hashes
687 #define SHV_RESTRICTED 0x01
690 * per key flags for flagged hashes
693 #define SHV_K_UTF8 0x01
694 #define SHV_K_WASUTF8 0x02
695 #define SHV_K_LOCKED 0x04
696 #define SHV_K_ISSV 0x08
697 #define SHV_K_PLACEHOLDER 0x10
700 * Before 0.6, the magic string was "perl-store" (binary version number 0).
702 * Since 0.6 introduced many binary incompatibilities, the magic string has
703 * been changed to "pst0" to allow an old image to be properly retrieved by
704 * a newer Storable, but ensure a newer image cannot be retrieved with an
707 * At 0.7, objects are given the ability to serialize themselves, and the
708 * set of markers is extended, backward compatibility is not jeopardized,
709 * so the binary version number could have remained unchanged. To correctly
710 * spot errors if a file making use of 0.7-specific extensions is given to
711 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
712 * a "minor" version, to better track this kind of evolution from now on.
715 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
716 static const char magicstr[] = "pst0"; /* Used as a magic number */
718 #define MAGICSTR_BYTES 'p','s','t','0'
719 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
721 /* 5.6.x introduced the ability to have IVs as long long.
722 However, Configure still defined BYTEORDER based on the size of a long.
723 Storable uses the BYTEORDER value as part of the header, but doesn't
724 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
725 with IV as long long on a platform that uses Configure (ie most things
726 except VMS and Windows) headers are identical for the different IV sizes,
727 despite the files containing some fields based on sizeof(IV)
729 5.8 is consistent - the following redifinition kludge is only needed on
730 5.6.x, but the interwork is needed on 5.8 while data survives in files
735 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
736 #ifndef NO_56_INTERWORK_KLUDGE
737 #define USE_56_INTERWORK_KLUDGE
739 #if BYTEORDER == 0x1234
741 #define BYTEORDER 0x12345678
743 #if BYTEORDER == 0x4321
745 #define BYTEORDER 0x87654321
750 #if BYTEORDER == 0x1234
751 #define BYTEORDER_BYTES '1','2','3','4'
753 #if BYTEORDER == 0x12345678
754 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
755 #ifdef USE_56_INTERWORK_KLUDGE
756 #define BYTEORDER_BYTES_56 '1','2','3','4'
759 #if BYTEORDER == 0x87654321
760 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
761 #ifdef USE_56_INTERWORK_KLUDGE
762 #define BYTEORDER_BYTES_56 '4','3','2','1'
765 #if BYTEORDER == 0x4321
766 #define BYTEORDER_BYTES '4','3','2','1'
768 #error Unknown byteoder. Please append your byteorder to Storable.xs
774 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
775 #ifdef USE_56_INTERWORK_KLUDGE
776 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
779 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
780 #define STORABLE_BIN_MINOR 7 /* Binary minor "version" */
782 #if (PATCHLEVEL <= 5)
783 #define STORABLE_BIN_WRITE_MINOR 4
786 * Perl 5.6.0 onwards can do weak references.
788 #define STORABLE_BIN_WRITE_MINOR 7
789 #endif /* (PATCHLEVEL <= 5) */
791 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
792 #define PL_sv_placeholder PL_sv_undef
796 * Useful store shortcuts...
800 * Note that if you put more than one mark for storing a particular
801 * type of thing, *and* in the retrieve_foo() function you mark both
802 * the thingy's you get off with SEEN(), you *must* increase the
803 * tagnum with cxt->tagnum++ along with this macro!
810 else if (PerlIO_putc(cxt->fio, x) == EOF) \
814 #define WRITE_I32(x) \
816 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
819 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
826 if (cxt->netorder) { \
827 int y = (int) htonl(x); \
830 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
835 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
840 #define WLEN(x) WRITE_I32(x)
847 else if (PerlIO_write(cxt->fio, x, y) != y) \
851 #define STORE_PV_LEN(pv, len, small, large) \
853 if (len <= LG_SCALAR) { \
854 unsigned char clen = (unsigned char) len; \
866 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
869 * Store &PL_sv_undef in arrays without recursing through store().
871 #define STORE_SV_UNDEF() \
874 PUTMARK(SX_SV_UNDEF); \
878 * Useful retrieve shortcuts...
882 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
888 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
892 #define READ_I32(x) \
894 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
898 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
908 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
911 x = (int) ntohl(x); \
914 #define RLEN(x) READ_I32(x)
921 else if (PerlIO_read(cxt->fio, x, y) != y) \
925 #define SAFEREAD(x,y,z) \
928 MBUF_SAFEREAD(x,y,z); \
929 else if (PerlIO_read(cxt->fio, x, y) != y) { \
936 * This macro is used at retrieve time, to remember where object 'y', bearing a
937 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
938 * we'll therefore know where it has been retrieved and will be able to
939 * share the same reference, as in the original stored memory image.
941 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
942 * on the objects given to STORABLE_thaw and expect that to be defined), and
943 * also for overloaded objects (for which we might not find the stash if the
944 * object is not blessed yet--this might occur for overloaded objects that
945 * refer to themselves indirectly: if we blessed upon return from a sub
946 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
947 * restored on it because the underlying object would not be blessed yet!).
949 * To achieve that, the class name of the last retrieved object is passed down
950 * recursively, and the first SEEN() call for which the class name is not NULL
951 * will bless the object.
953 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
955 #define SEEN(y,c,i) \
959 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
961 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
962 PTR2UV(y), SvREFCNT(y)-1)); \
964 BLESS((SV *) (y), c); \
968 * Bless `s' in `p', via a temporary reference, required by sv_bless().
974 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
975 stash = gv_stashpv((p), TRUE); \
976 ref = newRV_noinc(s); \
977 (void) sv_bless(ref, stash); \
982 * sort (used in store_hash) - conditionally use qsort when
983 * sortsv is not available ( <= 5.6.1 ).
986 #if (PATCHLEVEL <= 6)
988 #if defined(USE_ITHREADS)
990 #define STORE_HASH_SORT \
992 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
993 SAVESPTR(orig_perl); \
994 PERL_SET_CONTEXT(aTHX); \
995 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
998 #else /* ! USE_ITHREADS */
1000 #define STORE_HASH_SORT \
1001 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1003 #endif /* USE_ITHREADS */
1005 #else /* PATCHLEVEL > 6 */
1007 #define STORE_HASH_SORT \
1008 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1010 #endif /* PATCHLEVEL <= 6 */
1012 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1013 static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname);
1016 * Dynamic dispatching table for SV store.
1019 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1020 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1021 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1022 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1023 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1024 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1025 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1026 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1027 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1029 static int (*sv_store[])(pTHX_ stcxt_t *cxt, SV *sv) = {
1030 store_ref, /* svis_REF */
1031 store_scalar, /* svis_SCALAR */
1032 (int (*)(pTHX_ stcxt_t *cxt, SV *sv)) store_array, /* svis_ARRAY */
1033 (int (*)(pTHX_ stcxt_t *cxt, SV *sv)) store_hash, /* svis_HASH */
1034 store_tied, /* svis_TIED */
1035 store_tied_item, /* svis_TIED_ITEM */
1036 (int (*)(pTHX_ stcxt_t *cxt, SV *sv)) store_code, /* svis_CODE */
1037 store_other, /* svis_OTHER */
1040 #define SV_STORE(x) (*sv_store[x])
1043 * Dynamic dispatching tables for SV retrieval.
1046 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname);
1047 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname);
1048 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
1049 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
1050 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname);
1051 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname);
1052 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname);
1053 static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname);
1054 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname);
1055 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname);
1056 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname);
1057 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname);
1058 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname);
1059 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname);
1060 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname);
1061 static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname);
1063 static SV *(*sv_old_retrieve[])(pTHX_ stcxt_t *cxt, char *cname) = {
1064 0, /* SX_OBJECT -- entry unused dynamically */
1065 retrieve_lscalar, /* SX_LSCALAR */
1066 old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1067 old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1068 retrieve_ref, /* SX_REF */
1069 retrieve_undef, /* SX_UNDEF */
1070 retrieve_integer, /* SX_INTEGER */
1071 retrieve_double, /* SX_DOUBLE */
1072 retrieve_byte, /* SX_BYTE */
1073 retrieve_netint, /* SX_NETINT */
1074 retrieve_scalar, /* SX_SCALAR */
1075 retrieve_tied_array, /* SX_ARRAY */
1076 retrieve_tied_hash, /* SX_HASH */
1077 retrieve_tied_scalar, /* SX_SCALAR */
1078 retrieve_other, /* SX_SV_UNDEF not supported */
1079 retrieve_other, /* SX_SV_YES not supported */
1080 retrieve_other, /* SX_SV_NO not supported */
1081 retrieve_other, /* SX_BLESS not supported */
1082 retrieve_other, /* SX_IX_BLESS not supported */
1083 retrieve_other, /* SX_HOOK not supported */
1084 retrieve_other, /* SX_OVERLOADED not supported */
1085 retrieve_other, /* SX_TIED_KEY not supported */
1086 retrieve_other, /* SX_TIED_IDX not supported */
1087 retrieve_other, /* SX_UTF8STR not supported */
1088 retrieve_other, /* SX_LUTF8STR not supported */
1089 retrieve_other, /* SX_FLAG_HASH not supported */
1090 retrieve_other, /* SX_CODE not supported */
1091 retrieve_other, /* SX_WEAKREF not supported */
1092 retrieve_other, /* SX_WEAKOVERLOAD not supported */
1093 retrieve_other, /* SX_ERROR */
1096 static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
1097 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
1098 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname);
1099 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname);
1100 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname);
1101 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname);
1102 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname);
1103 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname);
1104 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname);
1105 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname);
1106 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname);
1107 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname);
1108 static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname);
1109 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, char *cname);
1110 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, char *cname);
1112 static SV *(*sv_retrieve[])(pTHX_ stcxt_t *cxt, char *cname) = {
1113 0, /* SX_OBJECT -- entry unused dynamically */
1114 retrieve_lscalar, /* SX_LSCALAR */
1115 retrieve_array, /* SX_ARRAY */
1116 retrieve_hash, /* SX_HASH */
1117 retrieve_ref, /* SX_REF */
1118 retrieve_undef, /* SX_UNDEF */
1119 retrieve_integer, /* SX_INTEGER */
1120 retrieve_double, /* SX_DOUBLE */
1121 retrieve_byte, /* SX_BYTE */
1122 retrieve_netint, /* SX_NETINT */
1123 retrieve_scalar, /* SX_SCALAR */
1124 retrieve_tied_array, /* SX_ARRAY */
1125 retrieve_tied_hash, /* SX_HASH */
1126 retrieve_tied_scalar, /* SX_SCALAR */
1127 retrieve_sv_undef, /* SX_SV_UNDEF */
1128 retrieve_sv_yes, /* SX_SV_YES */
1129 retrieve_sv_no, /* SX_SV_NO */
1130 retrieve_blessed, /* SX_BLESS */
1131 retrieve_idx_blessed, /* SX_IX_BLESS */
1132 retrieve_hook, /* SX_HOOK */
1133 retrieve_overloaded, /* SX_OVERLOAD */
1134 retrieve_tied_key, /* SX_TIED_KEY */
1135 retrieve_tied_idx, /* SX_TIED_IDX */
1136 retrieve_utf8str, /* SX_UTF8STR */
1137 retrieve_lutf8str, /* SX_LUTF8STR */
1138 retrieve_flag_hash, /* SX_HASH */
1139 retrieve_code, /* SX_CODE */
1140 retrieve_weakref, /* SX_WEAKREF */
1141 retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
1142 retrieve_other, /* SX_ERROR */
1145 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1147 static SV *mbuf2sv(pTHX);
1150 *** Context management.
1156 * Called once per "thread" (interpreter) to initialize some global context.
1158 static void init_perinterp(pTHX)
1162 cxt->netorder = 0; /* true if network order used */
1163 cxt->forgive_me = -1; /* whether to be forgiving... */
1169 * Called at the end of every context cleaning, to perform common reset
1172 static void reset_context(stcxt_t *cxt)
1176 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1180 * init_store_context
1182 * Initialize a new store context for real recursion.
1184 static void init_store_context(
1191 TRACEME(("init_store_context"));
1193 cxt->netorder = network_order;
1194 cxt->forgive_me = -1; /* Fetched from perl if needed */
1195 cxt->deparse = -1; /* Idem */
1196 cxt->eval = NULL; /* Idem */
1197 cxt->canonical = -1; /* Idem */
1198 cxt->tagnum = -1; /* Reset tag numbers */
1199 cxt->classnum = -1; /* Reset class numbers */
1200 cxt->fio = f; /* Where I/O are performed */
1201 cxt->optype = optype; /* A store, or a deep clone */
1202 cxt->entry = 1; /* No recursion yet */
1205 * The `hseen' table is used to keep track of each SV stored and their
1206 * associated tag numbers is special. It is "abused" because the
1207 * values stored are not real SV, just integers cast to (SV *),
1208 * which explains the freeing below.
1210 * It is also one possible bottlneck to achieve good storing speed,
1211 * so the "shared keys" optimization is turned off (unlikely to be
1212 * of any use here), and the hash table is "pre-extended". Together,
1213 * those optimizations increase the throughput by 12%.
1216 cxt->hseen = newHV(); /* Table where seen objects are stored */
1217 HvSHAREKEYS_off(cxt->hseen);
1220 * The following does not work well with perl5.004_04, and causes
1221 * a core dump later on, in a completely unrelated spot, which
1222 * makes me think there is a memory corruption going on.
1224 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1225 * it below does not make any difference. It seems to work fine
1226 * with perl5.004_68 but given the probable nature of the bug,
1227 * that does not prove anything.
1229 * It's a shame because increasing the amount of buckets raises
1230 * store() throughput by 5%, but until I figure this out, I can't
1231 * allow for this to go into production.
1233 * It is reported fixed in 5.005, hence the #if.
1235 #if PERL_VERSION >= 5
1236 #define HBUCKETS 4096 /* Buckets for %hseen */
1237 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1241 * The `hclass' hash uses the same settings as `hseen' above, but it is
1242 * used to assign sequential tags (numbers) to class names for blessed
1245 * We turn the shared key optimization on.
1248 cxt->hclass = newHV(); /* Where seen classnames are stored */
1250 #if PERL_VERSION >= 5
1251 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1255 * The `hook' hash table is used to keep track of the references on
1256 * the STORABLE_freeze hook routines, when found in some class name.
1258 * It is assumed that the inheritance tree will not be changed during
1259 * storing, and that no new method will be dynamically created by the
1263 cxt->hook = newHV(); /* Table where hooks are cached */
1266 * The `hook_seen' array keeps track of all the SVs returned by
1267 * STORABLE_freeze hooks for us to serialize, so that they are not
1268 * reclaimed until the end of the serialization process. Each SV is
1269 * only stored once, the first time it is seen.
1272 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1276 * clean_store_context
1278 * Clean store context by
1280 static void clean_store_context(pTHX_ stcxt_t *cxt)
1284 TRACEME(("clean_store_context"));
1286 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1289 * Insert real values into hashes where we stored faked pointers.
1293 hv_iterinit(cxt->hseen);
1294 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1295 HeVAL(he) = &PL_sv_undef;
1299 hv_iterinit(cxt->hclass);
1300 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1301 HeVAL(he) = &PL_sv_undef;
1305 * And now dispose of them...
1307 * The surrounding if() protection has been added because there might be
1308 * some cases where this routine is called more than once, during
1309 * exceptionnal events. This was reported by Marc Lehmann when Storable
1310 * is executed from mod_perl, and the fix was suggested by him.
1311 * -- RAM, 20/12/2000
1315 HV *hseen = cxt->hseen;
1318 sv_free((SV *) hseen);
1322 HV *hclass = cxt->hclass;
1325 sv_free((SV *) hclass);
1329 HV *hook = cxt->hook;
1332 sv_free((SV *) hook);
1335 if (cxt->hook_seen) {
1336 AV *hook_seen = cxt->hook_seen;
1338 av_undef(hook_seen);
1339 sv_free((SV *) hook_seen);
1342 cxt->forgive_me = -1; /* Fetched from perl if needed */
1343 cxt->deparse = -1; /* Idem */
1345 SvREFCNT_dec(cxt->eval);
1347 cxt->eval = NULL; /* Idem */
1348 cxt->canonical = -1; /* Idem */
1354 * init_retrieve_context
1356 * Initialize a new retrieve context for real recursion.
1358 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1360 TRACEME(("init_retrieve_context"));
1363 * The hook hash table is used to keep track of the references on
1364 * the STORABLE_thaw hook routines, when found in some class name.
1366 * It is assumed that the inheritance tree will not be changed during
1367 * storing, and that no new method will be dynamically created by the
1371 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1374 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1375 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1376 * the correspondance between the tags and the tag number used by the
1377 * new retrieve routines.
1380 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1383 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1384 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1385 cxt->aclass = newAV(); /* Where seen classnames are kept */
1386 cxt->tagnum = 0; /* Have to count objects... */
1387 cxt->classnum = 0; /* ...and class names as well */
1388 cxt->optype = optype;
1389 cxt->s_tainted = is_tainted;
1390 cxt->entry = 1; /* No recursion yet */
1391 #ifndef HAS_RESTRICTED_HASHES
1392 cxt->derestrict = -1; /* Fetched from perl if needed */
1394 #ifndef HAS_UTF8_ALL
1395 cxt->use_bytes = -1; /* Fetched from perl if needed */
1397 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1401 * clean_retrieve_context
1403 * Clean retrieve context by
1405 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1407 TRACEME(("clean_retrieve_context"));
1409 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1412 AV *aseen = cxt->aseen;
1415 sv_free((SV *) aseen);
1417 cxt->where_is_undef = -1;
1420 AV *aclass = cxt->aclass;
1423 sv_free((SV *) aclass);
1427 HV *hook = cxt->hook;
1430 sv_free((SV *) hook);
1434 HV *hseen = cxt->hseen;
1437 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1440 #ifndef HAS_RESTRICTED_HASHES
1441 cxt->derestrict = -1; /* Fetched from perl if needed */
1443 #ifndef HAS_UTF8_ALL
1444 cxt->use_bytes = -1; /* Fetched from perl if needed */
1446 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1454 * A workaround for the CROAK bug: cleanup the last context.
1456 static void clean_context(pTHX_ stcxt_t *cxt)
1458 TRACEME(("clean_context"));
1460 ASSERT(cxt->s_dirty, ("dirty context"));
1465 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1467 if (cxt->optype & ST_RETRIEVE)
1468 clean_retrieve_context(aTHX_ cxt);
1469 else if (cxt->optype & ST_STORE)
1470 clean_store_context(aTHX_ cxt);
1474 ASSERT(!cxt->s_dirty, ("context is clean"));
1475 ASSERT(cxt->entry == 0, ("context is reset"));
1481 * Allocate a new context and push it on top of the parent one.
1482 * This new context is made globally visible via SET_STCXT().
1484 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1488 TRACEME(("allocate_context"));
1490 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1492 NEW_STORABLE_CXT_OBJ(cxt);
1493 cxt->prev = parent_cxt->my_sv;
1496 ASSERT(!cxt->s_dirty, ("clean context"));
1504 * Free current context, which cannot be the "root" one.
1505 * Make the context underneath globally visible via SET_STCXT().
1507 static void free_context(pTHX_ stcxt_t *cxt)
1509 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1511 TRACEME(("free_context"));
1513 ASSERT(!cxt->s_dirty, ("clean context"));
1514 ASSERT(prev, ("not freeing root context"));
1516 SvREFCNT_dec(cxt->my_sv);
1519 ASSERT(cxt, ("context not void"));
1529 * Tells whether we're in the middle of a store operation.
1531 int is_storing(pTHX)
1535 return cxt->entry && (cxt->optype & ST_STORE);
1541 * Tells whether we're in the middle of a retrieve operation.
1543 int is_retrieving(pTHX)
1547 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1551 * last_op_in_netorder
1553 * Returns whether last operation was made using network order.
1555 * This is typically out-of-band information that might prove useful
1556 * to people wishing to convert native to network order data when used.
1558 int last_op_in_netorder(pTHX)
1562 return cxt->netorder;
1566 *** Hook lookup and calling routines.
1572 * A wrapper on gv_fetchmethod_autoload() which caches results.
1574 * Returns the routine reference as an SV*, or null if neither the package
1575 * nor its ancestors know about the method.
1577 static SV *pkg_fetchmeth(
1587 * The following code is the same as the one performed by UNIVERSAL::can
1591 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1592 if (gv && isGV(gv)) {
1593 sv = newRV((SV*) GvCV(gv));
1594 TRACEME(("%s->%s: 0x%"UVxf, HvNAME(pkg), method, PTR2UV(sv)));
1596 sv = newSVsv(&PL_sv_undef);
1597 TRACEME(("%s->%s: not found", HvNAME(pkg), method));
1601 * Cache the result, ignoring failure: if we can't store the value,
1602 * it just won't be cached.
1605 (void) hv_store(cache, HvNAME(pkg), strlen(HvNAME(pkg)), sv, 0);
1607 return SvOK(sv) ? sv : (SV *) 0;
1613 * Force cached value to be undef: hook ignored even if present.
1615 static void pkg_hide(
1621 (void) hv_store(cache,
1622 HvNAME(pkg), strlen(HvNAME(pkg)), newSVsv(&PL_sv_undef), 0);
1628 * Discard cached value: a whole fetch loop will be retried at next lookup.
1630 static void pkg_uncache(
1636 (void) hv_delete(cache, HvNAME(pkg), strlen(HvNAME(pkg)), G_DISCARD);
1642 * Our own "UNIVERSAL::can", which caches results.
1644 * Returns the routine reference as an SV*, or null if the object does not
1645 * know about the method.
1656 TRACEME(("pkg_can for %s->%s", HvNAME(pkg), method));
1659 * Look into the cache to see whether we already have determined
1660 * where the routine was, if any.
1662 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1663 * that only one hook (i.e. always the same) is cached in a given cache.
1666 svh = hv_fetch(cache, HvNAME(pkg), strlen(HvNAME(pkg)), FALSE);
1670 TRACEME(("cached %s->%s: not found", HvNAME(pkg), method));
1673 TRACEME(("cached %s->%s: 0x%"UVxf,
1674 HvNAME(pkg), method, PTR2UV(sv)));
1679 TRACEME(("not cached yet"));
1680 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1686 * Call routine as obj->hook(av) in scalar context.
1687 * Propagates the single returned value if not called in void context.
1689 static SV *scalar_call(
1701 TRACEME(("scalar_call (cloning=%d)", cloning));
1708 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1710 SV **ary = AvARRAY(av);
1711 int cnt = AvFILLp(av) + 1;
1713 XPUSHs(ary[0]); /* Frozen string */
1714 for (i = 1; i < cnt; i++) {
1715 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1716 i, PTR2UV(ary[i])));
1717 XPUSHs(sv_2mortal(newRV(ary[i])));
1722 TRACEME(("calling..."));
1723 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1724 TRACEME(("count = %d", count));
1730 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1743 * Call routine obj->hook(cloning) in list context.
1744 * Returns the list of returned values in an array.
1746 static AV *array_call(
1757 TRACEME(("array_call (cloning=%d)", cloning));
1763 XPUSHs(obj); /* Target object */
1764 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1767 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1772 for (i = count - 1; i >= 0; i--) {
1774 av_store(av, i, SvREFCNT_inc(sv));
1787 * Lookup the class name in the `hclass' table and either assign it a new ID
1788 * or return the existing one, by filling in `classnum'.
1790 * Return true if the class was known, false if the ID was just generated.
1792 static int known_class(
1795 char *name, /* Class name */
1796 int len, /* Name length */
1800 HV *hclass = cxt->hclass;
1802 TRACEME(("known_class (%s)", name));
1805 * Recall that we don't store pointers in this hash table, but tags.
1806 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1809 svh = hv_fetch(hclass, name, len, FALSE);
1811 *classnum = LOW_32BITS(*svh);
1816 * Unknown classname, we need to record it.
1820 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1821 CROAK(("Unable to record new classname"));
1823 *classnum = cxt->classnum;
1828 *** Sepcific store routines.
1834 * Store a reference.
1835 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1837 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1840 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1843 * Follow reference, and check if target is overloaded.
1849 TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1854 HV *stash = (HV *) SvSTASH(sv);
1855 if (stash && Gv_AMG(stash)) {
1856 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1857 PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1859 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1861 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1863 return store(aTHX_ cxt, sv);
1871 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1872 * The <data> section is omitted if <length> is 0.
1874 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1875 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1877 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
1882 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1884 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1887 * For efficiency, break the SV encapsulation by peaking at the flags
1888 * directly without using the Perl macros to avoid dereferencing
1889 * sv->sv_flags each time we wish to check the flags.
1892 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1893 if (sv == &PL_sv_undef) {
1894 TRACEME(("immortal undef"));
1895 PUTMARK(SX_SV_UNDEF);
1897 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
1904 * Always store the string representation of a scalar if it exists.
1905 * Gisle Aas provided me with this test case, better than a long speach:
1907 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1908 * SV = PVNV(0x80c8520)
1910 * FLAGS = (NOK,POK,pNOK,pPOK)
1913 * PV = 0x80c83d0 "abc"\0
1917 * Write SX_SCALAR, length, followed by the actual data.
1919 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
1920 * appropriate, followed by the actual (binary) data. A double
1921 * is written as a string if network order, for portability.
1923 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
1924 * The reason is that when the scalar value is tainted, the SvNOK(sv)
1927 * The test for a read-only scalar with both POK and NOK set is meant
1928 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
1929 * address comparison for each scalar we store.
1932 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
1934 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
1935 if (sv == &PL_sv_yes) {
1936 TRACEME(("immortal yes"));
1938 } else if (sv == &PL_sv_no) {
1939 TRACEME(("immortal no"));
1942 pv = SvPV(sv, len); /* We know it's SvPOK */
1943 goto string; /* Share code below */
1945 } else if (flags & SVf_POK) {
1946 /* public string - go direct to string read. */
1947 goto string_readlen;
1949 #if (PATCHLEVEL <= 6)
1950 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
1951 direct if NV flag is off. */
1952 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
1954 /* 5.7 rules are that if IV public flag is set, IV value is as
1955 good, if not better, than NV value. */
1961 * Will come here from below with iv set if double is an integer.
1965 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1967 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
1968 * (for example) and that ends up in the optimised small integer
1971 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
1972 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
1973 goto string_readlen;
1977 * Optimize small integers into a single byte, otherwise store as
1978 * a real integer (converted into network order if they asked).
1981 if (iv >= -128 && iv <= 127) {
1982 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
1985 TRACEME(("small integer stored as %d", siv));
1986 } else if (cxt->netorder) {
1988 TRACEME(("no htonl, fall back to string for integer"));
1989 goto string_readlen;
1997 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1998 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
2000 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
2001 /* Bigger than 32 bits. */
2002 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2003 goto string_readlen;
2007 niv = (I32) htonl((I32) iv);
2008 TRACEME(("using network order"));
2013 PUTMARK(SX_INTEGER);
2014 WRITE(&iv, sizeof(iv));
2017 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2018 } else if (flags & SVf_NOK) {
2020 #if (PATCHLEVEL <= 6)
2023 * Watch for number being an integer in disguise.
2025 if (nv == (NV) (iv = I_V(nv))) {
2026 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2027 goto integer; /* Share code above */
2032 if (SvIOK_notUV(sv)) {
2034 goto integer; /* Share code above */
2039 if (cxt->netorder) {
2040 TRACEME(("double %"NVff" stored as string", nv));
2041 goto string_readlen; /* Share code below */
2045 WRITE(&nv, sizeof(nv));
2047 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2049 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2050 I32 wlen; /* For 64-bit machines */
2056 * Will come here from above if it was readonly, POK and NOK but
2057 * neither &PL_sv_yes nor &PL_sv_no.
2061 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2063 STORE_UTF8STR(pv, wlen);
2065 STORE_SCALAR(pv, wlen);
2066 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2067 PTR2UV(sv), SvPVX(sv), (IV)len));
2069 CROAK(("Can't determine type of %s(0x%"UVxf")",
2070 sv_reftype(sv, FALSE),
2072 return 0; /* Ok, no recursion on scalars */
2080 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2081 * Each item is stored as <object>.
2083 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2086 I32 len = av_len(av) + 1;
2090 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2093 * Signal array by emitting SX_ARRAY, followed by the array length.
2098 TRACEME(("size = %d", len));
2101 * Now store each item recursively.
2104 for (i = 0; i < len; i++) {
2105 sav = av_fetch(av, i, 0);
2107 TRACEME(("(#%d) undef item", i));
2111 TRACEME(("(#%d) item", i));
2112 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2116 TRACEME(("ok (array)"));
2122 #if (PATCHLEVEL <= 6)
2128 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2131 sortcmp(const void *a, const void *b)
2133 #if defined(USE_ITHREADS)
2135 #endif /* USE_ITHREADS */
2136 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2139 #endif /* PATCHLEVEL <= 6 */
2144 * Store a hash table.
2146 * For a "normal" hash (not restricted, no utf8 keys):
2148 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2149 * Values are stored as <object>.
2150 * Keys are stored as <length> <data>, the <data> section being omitted
2153 * For a "fancy" hash (restricted or utf8 keys):
2155 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2157 * Values are stored as <object>.
2158 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2160 * Currently the only hash flag is "restriced"
2161 * Key flags are as for hv.h
2163 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2166 #ifdef HAS_RESTRICTED_HASHES
2175 int flagged_hash = ((SvREADONLY(hv)
2176 #ifdef HAS_HASH_KEY_FLAGS
2180 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2183 /* needs int cast for C++ compilers, doesn't it? */
2184 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2187 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2191 * Signal hash by emitting SX_HASH, followed by the table length.
2195 PUTMARK(SX_FLAG_HASH);
2196 PUTMARK(hash_flags);
2201 TRACEME(("size = %d", len));
2204 * Save possible iteration state via each() on that table.
2207 riter = HvRITER(hv);
2208 eiter = HvEITER(hv);
2212 * Now store each item recursively.
2214 * If canonical is defined to some true value then store each
2215 * key/value pair in sorted order otherwise the order is random.
2216 * Canonical order is irrelevant when a deep clone operation is performed.
2218 * Fetch the value from perl only once per store() operation, and only
2223 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2224 (cxt->canonical < 0 && (cxt->canonical =
2225 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2228 * Storing in order, sorted by key.
2229 * Run through the hash, building up an array of keys in a
2230 * mortal array, sort the array and then run through the
2236 /*av_extend (av, len);*/
2238 TRACEME(("using canonical order"));
2240 for (i = 0; i < len; i++) {
2241 #ifdef HAS_RESTRICTED_HASHES
2242 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2244 HE *he = hv_iternext(hv);
2246 SV *key = hv_iterkeysv(he);
2247 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2252 for (i = 0; i < len; i++) {
2253 #ifdef HAS_RESTRICTED_HASHES
2254 int placeholders = HvPLACEHOLDERS(hv);
2256 unsigned char flags = 0;
2260 SV *key = av_shift(av);
2261 /* This will fail if key is a placeholder.
2262 Track how many placeholders we have, and error if we
2264 HE *he = hv_fetch_ent(hv, key, 0, 0);
2268 if (!(val = HeVAL(he))) {
2269 /* Internal error, not I/O error */
2273 #ifdef HAS_RESTRICTED_HASHES
2274 /* Should be a placeholder. */
2275 if (placeholders-- < 0) {
2276 /* This should not happen - number of
2277 retrieves should be identical to
2278 number of placeholders. */
2281 /* Value is never needed, and PL_sv_undef is
2282 more space efficient to store. */
2285 ("Flags not 0 but %d", flags));
2286 flags = SHV_K_PLACEHOLDER;
2293 * Store value first.
2296 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2298 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2303 * Keys are written after values to make sure retrieval
2304 * can be optimal in terms of memory usage, where keys are
2305 * read into a fixed unique buffer called kbuf.
2306 * See retrieve_hash() for details.
2309 /* Implementation of restricted hashes isn't nicely
2311 if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
2312 flags |= SHV_K_LOCKED;
2315 keyval = SvPV(key, keylen_tmp);
2316 keylen = keylen_tmp;
2317 #ifdef HAS_UTF8_HASHES
2318 /* If you build without optimisation on pre 5.6
2319 then nothing spots that SvUTF8(key) is always 0,
2320 so the block isn't optimised away, at which point
2321 the linker dislikes the reference to
2324 const char *keysave = keyval;
2325 bool is_utf8 = TRUE;
2327 /* Just casting the &klen to (STRLEN) won't work
2328 well if STRLEN and I32 are of different widths.
2330 keyval = (char*)bytes_from_utf8((U8*)keyval,
2334 /* If we were able to downgrade here, then than
2335 means that we have a key which only had chars
2336 0-255, but was utf8 encoded. */
2338 if (keyval != keysave) {
2339 keylen = keylen_tmp;
2340 flags |= SHV_K_WASUTF8;
2342 /* keylen_tmp can't have changed, so no need
2343 to assign back to keylen. */
2344 flags |= SHV_K_UTF8;
2351 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2353 /* This is a workaround for a bug in 5.8.0
2354 that causes the HEK_WASUTF8 flag to be
2355 set on an HEK without the hash being
2356 marked as having key flags. We just
2357 cross our fingers and drop the flag.
2359 assert (flags == 0 || flags == SHV_K_WASUTF8);
2360 TRACEME(("(#%d) key '%s'", i, keyval));
2364 WRITE(keyval, keylen);
2365 if (flags & SHV_K_WASUTF8)
2370 * Free up the temporary array
2379 * Storing in "random" order (in the order the keys are stored
2380 * within the hash). This is the default and will be faster!
2383 for (i = 0; i < len; i++) {
2386 unsigned char flags;
2387 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2388 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2390 HE *he = hv_iternext(hv);
2392 SV *val = (he ? hv_iterval(hv, he) : 0);
2397 return 1; /* Internal error, not I/O error */
2399 /* Implementation of restricted hashes isn't nicely
2402 = (((hash_flags & SHV_RESTRICTED)
2404 ? SHV_K_LOCKED : 0);
2406 if (val == &PL_sv_placeholder) {
2407 flags |= SHV_K_PLACEHOLDER;
2412 * Store value first.
2415 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2417 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2421 hek = HeKEY_hek(he);
2423 if (len == HEf_SVKEY) {
2424 /* This is somewhat sick, but the internal APIs are
2425 * such that XS code could put one of these in in
2427 * Maybe we should be capable of storing one if
2430 key_sv = HeKEY_sv(he);
2431 flags |= SHV_K_ISSV;
2433 /* Regular string key. */
2434 #ifdef HAS_HASH_KEY_FLAGS
2436 flags |= SHV_K_UTF8;
2437 if (HEK_WASUTF8(hek))
2438 flags |= SHV_K_WASUTF8;
2444 * Keys are written after values to make sure retrieval
2445 * can be optimal in terms of memory usage, where keys are
2446 * read into a fixed unique buffer called kbuf.
2447 * See retrieve_hash() for details.
2452 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2454 /* This is a workaround for a bug in 5.8.0
2455 that causes the HEK_WASUTF8 flag to be
2456 set on an HEK without the hash being
2457 marked as having key flags. We just
2458 cross our fingers and drop the flag.
2460 assert (flags == 0 || flags == SHV_K_WASUTF8);
2461 TRACEME(("(#%d) key '%s'", i, key));
2463 if (flags & SHV_K_ISSV) {
2464 store(aTHX_ cxt, key_sv);
2473 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2476 HvRITER(hv) = riter; /* Restore hash iterator state */
2477 HvEITER(hv) = eiter;
2485 * Store a code reference.
2487 * Layout is SX_CODE <length> followed by a scalar containing the perl
2488 * source code of the code reference.
2490 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2492 #if PERL_VERSION < 6
2494 * retrieve_code does not work with perl 5.005 or less
2496 return store_other(aTHX_ cxt, (SV*)cv);
2501 SV *text, *bdeparse;
2503 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2506 cxt->deparse == 0 ||
2507 (cxt->deparse < 0 && !(cxt->deparse =
2508 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2510 return store_other(aTHX_ cxt, (SV*)cv);
2514 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2515 * blessed code references.
2517 /* Ownership of both SVs is passed to load_module, which frees them. */
2518 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2524 * create the B::Deparse object
2528 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2530 count = call_method("new", G_SCALAR);
2533 CROAK(("Unexpected return value from B::Deparse::new\n"));
2537 * call the coderef2text method
2541 XPUSHs(bdeparse); /* XXX is this already mortal? */
2542 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2544 count = call_method("coderef2text", G_SCALAR);
2547 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2551 reallen = strlen(SvPV_nolen(text));
2554 * Empty code references or XS functions are deparsed as
2555 * "(prototype) ;" or ";".
2558 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2559 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2563 * Signal code by emitting SX_CODE.
2567 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2568 TRACEME(("size = %d", len));
2569 TRACEME(("code = %s", SvPV_nolen(text)));
2572 * Now store the source code.
2575 STORE_SCALAR(SvPV_nolen(text), len);
2580 TRACEME(("ok (code)"));
2589 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2590 * a special mark, followed by the underlying tied object. For instance, when
2591 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2592 * <hash object> stands for the serialization of the tied hash.
2594 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2599 int svt = SvTYPE(sv);
2602 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2605 * We have a small run-time penalty here because we chose to factorise
2606 * all tieds objects into the same routine, and not have a store_tied_hash,
2607 * a store_tied_array, etc...
2609 * Don't use a switch() statement, as most compilers don't optimize that
2610 * well for 2/3 values. An if() else if() cascade is just fine. We put
2611 * tied hashes first, as they are the most likely beasts.
2614 if (svt == SVt_PVHV) {
2615 TRACEME(("tied hash"));
2616 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2617 } else if (svt == SVt_PVAV) {
2618 TRACEME(("tied array"));
2619 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2621 TRACEME(("tied scalar"));
2622 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2626 if (!(mg = mg_find(sv, mtype)))
2627 CROAK(("No magic '%c' found while storing tied %s", mtype,
2628 (svt == SVt_PVHV) ? "hash" :
2629 (svt == SVt_PVAV) ? "array" : "scalar"));
2632 * The mg->mg_obj found by mg_find() above actually points to the
2633 * underlying tied Perl object implementation. For instance, if the
2634 * original SV was that of a tied array, then mg->mg_obj is an AV.
2636 * Note that we store the Perl object as-is. We don't call its FETCH
2637 * method along the way. At retrieval time, we won't call its STORE
2638 * method either, but the tieing magic will be re-installed. In itself,
2639 * that ensures that the tieing semantics are preserved since futher
2640 * accesses on the retrieved object will indeed call the magic methods...
2643 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2644 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2645 if ((ret = store(aTHX_ cxt, obj)))
2648 TRACEME(("ok (tied)"));
2656 * Stores a reference to an item within a tied structure:
2658 * . \$h{key}, stores both the (tied %h) object and 'key'.
2659 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2661 * Layout is therefore either:
2662 * SX_TIED_KEY <object> <key>
2663 * SX_TIED_IDX <object> <index>
2665 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2670 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2672 if (!(mg = mg_find(sv, 'p')))
2673 CROAK(("No magic 'p' found while storing reference to tied item"));
2676 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2680 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2681 PUTMARK(SX_TIED_KEY);
2682 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2684 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2687 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2689 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2692 I32 idx = mg->mg_len;
2694 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2695 PUTMARK(SX_TIED_IDX);
2696 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2698 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2701 TRACEME(("store_tied_item: storing IDX %d", idx));
2706 TRACEME(("ok (tied item)"));
2712 * store_hook -- dispatched manually, not via sv_store[]
2714 * The blessed SV is serialized by a hook.
2718 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2720 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2721 * the trailing part [] is present, the type of object (scalar, array or hash).
2722 * There is also a bit which says how the classname is stored between:
2727 * and when the <index> form is used (classname already seen), the "large
2728 * classname" bit in <flags> indicates how large the <index> is.
2730 * The serialized string returned by the hook is of length <len2> and comes
2731 * next. It is an opaque string for us.
2733 * Those <len3> object IDs which are listed last represent the extra references
2734 * not directly serialized by the hook, but which are linked to the object.
2736 * When recursion is mandated to resolve object-IDs not yet seen, we have
2737 * instead, with <header> being flags with bits set to indicate the object type
2738 * and that recursion was indeed needed:
2740 * SX_HOOK <header> <object> <header> <object> <flags>
2742 * that same header being repeated between serialized objects obtained through
2743 * recursion, until we reach flags indicating no recursion, at which point
2744 * we know we've resynchronized with a single layout, after <flags>.
2746 * When storing a blessed ref to a tied variable, the following format is
2749 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2751 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2752 * real object type is held in the <extra> flag. At the very end of the
2753 * serialization stream, the underlying magic object is serialized, just like
2754 * any other tied variable.
2756 static int store_hook(
2770 int count; /* really len3 + 1 */
2771 unsigned char flags;
2774 int recursed = 0; /* counts recursion */
2775 int obj_type; /* object type, on 2 bits */
2778 int clone = cxt->optype & ST_CLONE;
2779 char mtype = '\0'; /* for blessed ref to tied structures */
2780 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2782 TRACEME(("store_hook, class \"%s\", tagged #%d", HvNAME(pkg), cxt->tagnum));
2785 * Determine object type on 2 bits.
2790 obj_type = SHT_SCALAR;
2793 obj_type = SHT_ARRAY;
2796 obj_type = SHT_HASH;
2800 * Produced by a blessed ref to a tied data structure, $o in the
2801 * following Perl code.
2805 * my $o = bless \%h, 'BAR';
2807 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2808 * (since we have only 2 bits in <flags> to store the type), and an
2809 * <extra> byte flag will be emitted after the FIRST <flags> in the
2810 * stream, carrying what we put in `eflags'.
2812 obj_type = SHT_EXTRA;
2813 switch (SvTYPE(sv)) {
2815 eflags = (unsigned char) SHT_THASH;
2819 eflags = (unsigned char) SHT_TARRAY;
2823 eflags = (unsigned char) SHT_TSCALAR;
2829 CROAK(("Unexpected object type (%d) in store_hook()", type));
2831 flags = SHF_NEED_RECURSE | obj_type;
2833 class = HvNAME(pkg);
2834 len = strlen(class);
2837 * To call the hook, we need to fake a call like:
2839 * $object->STORABLE_freeze($cloning);
2841 * but we don't have the $object here. For instance, if $object is
2842 * a blessed array, what we have in `sv' is the array, and we can't
2843 * call a method on those.
2845 * Therefore, we need to create a temporary reference to the object and
2846 * make the call on that reference.
2849 TRACEME(("about to call STORABLE_freeze on class %s", class));
2851 ref = newRV_noinc(sv); /* Temporary reference */
2852 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2854 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2856 count = AvFILLp(av) + 1;
2857 TRACEME(("store_hook, array holds %d items", count));
2860 * If they return an empty list, it means they wish to ignore the
2861 * hook for this class (and not just this instance -- that's for them
2862 * to handle if they so wish).
2864 * Simply disable the cached entry for the hook (it won't be recomputed
2865 * since it's present in the cache) and recurse to store_blessed().
2870 * They must not change their mind in the middle of a serialization.
2873 if (hv_fetch(cxt->hclass, class, len, FALSE))
2874 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2875 (cxt->optype & ST_CLONE) ? "cloning" : "storing", class));
2877 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
2879 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2880 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", class));
2882 return store_blessed(aTHX_ cxt, sv, type, pkg);
2886 * Get frozen string.
2890 pv = SvPV(ary[0], len2);
2893 * If they returned more than one item, we need to serialize some
2894 * extra references if not already done.
2896 * Loop over the array, starting at position #1, and for each item,
2897 * ensure it is a reference, serialize it if not already done, and
2898 * replace the entry with the tag ID of the corresponding serialized
2901 * We CHEAT by not calling av_fetch() and read directly within the
2905 for (i = 1; i < count; i++) {
2909 AV *av_hook = cxt->hook_seen;
2912 CROAK(("Item #%d returned by STORABLE_freeze "
2913 "for %s is not a reference", i, class));
2914 xsv = SvRV(rsv); /* Follow ref to know what to look for */
2917 * Look in hseen and see if we have a tag already.
2918 * Serialize entry if not done already, and get its tag.
2921 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
2922 goto sv_seen; /* Avoid moving code too far to the right */
2924 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
2927 * We need to recurse to store that object and get it to be known
2928 * so that we can resolve the list of object-IDs at retrieve time.
2930 * The first time we do this, we need to emit the proper header
2931 * indicating that we recursed, and what the type of object is (the
2932 * object we're storing via a user-hook). Indeed, during retrieval,
2933 * we'll have to create the object before recursing to retrieve the
2934 * others, in case those would point back at that object.
2937 /* [SX_HOOK] <flags> [<extra>] <object>*/
2941 if (obj_type == SHT_EXTRA)
2946 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
2949 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
2951 CROAK(("Could not serialize item #%d from hook in %s", i, class));
2954 * It was the first time we serialized `xsv'.
2956 * Keep this SV alive until the end of the serialization: if we
2957 * disposed of it right now by decrementing its refcount, and it was
2958 * a temporary value, some next temporary value allocated during
2959 * another STORABLE_freeze might take its place, and we'd wrongly
2960 * assume that new SV was already serialized, based on its presence
2963 * Therefore, push it away in cxt->hook_seen.
2966 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
2970 * Dispose of the REF they returned. If we saved the `xsv' away
2971 * in the array of returned SVs, that will not cause the underlying
2972 * referenced SV to be reclaimed.
2975 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
2976 SvREFCNT_dec(rsv); /* Dispose of reference */
2979 * Replace entry with its tag (not a real SV, so no refcnt increment)
2983 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
2984 i-1, PTR2UV(xsv), PTR2UV(*svh)));
2988 * Allocate a class ID if not already done.
2990 * This needs to be done after the recursion above, since at retrieval
2991 * time, we'll see the inner objects first. Many thanks to
2992 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
2993 * proposed the right fix. -- RAM, 15/09/2000
2996 if (!known_class(aTHX_ cxt, class, len, &classnum)) {
2997 TRACEME(("first time we see class %s, ID = %d", class, classnum));
2998 classnum = -1; /* Mark: we must store classname */
3000 TRACEME(("already seen class %s, ID = %d", class, classnum));
3004 * Compute leading flags.
3008 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3009 flags |= SHF_LARGE_CLASSLEN;
3011 flags |= SHF_IDX_CLASSNAME;
3012 if (len2 > LG_SCALAR)
3013 flags |= SHF_LARGE_STRLEN;
3015 flags |= SHF_HAS_LIST;
3016 if (count > (LG_SCALAR + 1))
3017 flags |= SHF_LARGE_LISTLEN;
3020 * We're ready to emit either serialized form:
3022 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3023 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3025 * If we recursed, the SX_HOOK has already been emitted.
3028 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3029 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3030 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3032 /* SX_HOOK <flags> [<extra>] */
3036 if (obj_type == SHT_EXTRA)
3041 /* <len> <classname> or <index> */
3042 if (flags & SHF_IDX_CLASSNAME) {
3043 if (flags & SHF_LARGE_CLASSLEN)
3046 unsigned char cnum = (unsigned char) classnum;
3050 if (flags & SHF_LARGE_CLASSLEN)
3053 unsigned char clen = (unsigned char) len;
3056 WRITE(class, len); /* Final \0 is omitted */
3059 /* <len2> <frozen-str> */
3060 if (flags & SHF_LARGE_STRLEN) {
3061 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3062 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3064 unsigned char clen = (unsigned char) len2;
3068 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3070 /* [<len3> <object-IDs>] */
3071 if (flags & SHF_HAS_LIST) {
3072 int len3 = count - 1;
3073 if (flags & SHF_LARGE_LISTLEN)
3076 unsigned char clen = (unsigned char) len3;
3081 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3082 * real pointer, rather a tag number, well under the 32-bit limit.
3085 for (i = 1; i < count; i++) {
3086 I32 tagval = htonl(LOW_32BITS(ary[i]));
3088 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3093 * Free the array. We need extra care for indices after 0, since they
3094 * don't hold real SVs but integers cast.
3098 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3103 * If object was tied, need to insert serialization of the magic object.
3106 if (obj_type == SHT_EXTRA) {
3109 if (!(mg = mg_find(sv, mtype))) {
3110 int svt = SvTYPE(sv);
3111 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3112 mtype, (svt == SVt_PVHV) ? "hash" :
3113 (svt == SVt_PVAV) ? "array" : "scalar"));
3116 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3117 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3123 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3131 * store_blessed -- dispatched manually, not via sv_store[]
3133 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3134 * of its ancestors. If there is, then redispatch to store_hook();
3136 * Otherwise, the blessed SV is stored using the following layout:
3138 * SX_BLESS <flag> <len> <classname> <object>
3140 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3141 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3142 * Otherwise, the low order bits give the length, thereby giving a compact
3143 * representation for class names less than 127 chars long.
3145 * Each <classname> seen is remembered and indexed, so that the next time
3146 * an object in the blessed in the same <classname> is stored, the following
3149 * SX_IX_BLESS <flag> <index> <object>
3151 * where <index> is the classname index, stored on 0 or 4 bytes depending
3152 * on the high-order bit in flag (same encoding as above for <len>).
3154 static int store_blessed(
3166 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME(pkg)));
3169 * Look for a hook for this blessed SV and redirect to store_hook()
3173 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3175 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3178 * This is a blessed SV without any serialization hook.
3181 class = HvNAME(pkg);
3182 len = strlen(class);
3184 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3185 PTR2UV(sv), class, cxt->tagnum));
3188 * Determine whether it is the first time we see that class name (in which
3189 * case it will be stored in the SX_BLESS form), or whether we already
3190 * saw that class name before (in which case the SX_IX_BLESS form will be
3194 if (known_class(aTHX_ cxt, class, len, &classnum)) {
3195 TRACEME(("already seen class %s, ID = %d", class, classnum));
3196 PUTMARK(SX_IX_BLESS);
3197 if (classnum <= LG_BLESS) {
3198 unsigned char cnum = (unsigned char) classnum;
3201 unsigned char flag = (unsigned char) 0x80;
3206 TRACEME(("first time we see class %s, ID = %d", class, classnum));
3208 if (len <= LG_BLESS) {
3209 unsigned char clen = (unsigned char) len;
3212 unsigned char flag = (unsigned char) 0x80;
3214 WLEN(len); /* Don't BER-encode, this should be rare */
3216 WRITE(class, len); /* Final \0 is omitted */
3220 * Now emit the <object> part.
3223 return SV_STORE(type)(aTHX_ cxt, sv);
3229 * We don't know how to store the item we reached, so return an error condition.
3230 * (it's probably a GLOB, some CODE reference, etc...)
3232 * If they defined the `forgive_me' variable at the Perl level to some
3233 * true value, then don't croak, just warn, and store a placeholder string
3236 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3239 static char buf[80];
3241 TRACEME(("store_other"));
3244 * Fetch the value from perl only once per store() operation.
3248 cxt->forgive_me == 0 ||
3249 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3250 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3252 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3254 warn("Can't store item %s(0x%"UVxf")",
3255 sv_reftype(sv, FALSE), PTR2UV(sv));
3258 * Store placeholder string as a scalar instead...
3261 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3262 PTR2UV(sv), (char) 0);
3265 STORE_SCALAR(buf, len);
3266 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3272 *** Store driving routines
3278 * WARNING: partially duplicates Perl's sv_reftype for speed.
3280 * Returns the type of the SV, identified by an integer. That integer
3281 * may then be used to index the dynamic routine dispatch table.
3283 static int sv_type(pTHX_ SV *sv)
3285 switch (SvTYPE(sv)) {
3290 * No need to check for ROK, that can't be set here since there
3291 * is no field capable of hodling the xrv_rv reference.
3299 * Starting from SVt_PV, it is possible to have the ROK flag
3300 * set, the pointer to the other SV being either stored in
3301 * the xrv_rv (in the case of a pure SVt_RV), or as the
3302 * xpv_pv field of an SVt_PV and its heirs.
3304 * However, those SV cannot be magical or they would be an
3305 * SVt_PVMG at least.
3307 return SvROK(sv) ? svis_REF : svis_SCALAR;
3309 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3310 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3311 return svis_TIED_ITEM;
3314 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3316 return SvROK(sv) ? svis_REF : svis_SCALAR;
3318 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3322 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3337 * Recursively store objects pointed to by the sv to the specified file.
3339 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3340 * object (one for which storage has started -- it may not be over if we have
3341 * a self-referenced structure). This data set forms a stored <object>.
3343 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3348 HV *hseen = cxt->hseen;
3350 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3353 * If object has already been stored, do not duplicate data.
3354 * Simply emit the SX_OBJECT marker followed by its tag data.
3355 * The tag is always written in network order.
3357 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3358 * real pointer, rather a tag number (watch the insertion code below).
3359 * That means it probably safe to assume it is well under the 32-bit limit,
3360 * and makes the truncation safe.
3361 * -- RAM, 14/09/1999
3364 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3368 if (sv == &PL_sv_undef) {
3369 /* We have seen PL_sv_undef before, but fake it as
3372 Not the simplest solution to making restricted
3373 hashes work on 5.8.0, but it does mean that
3374 repeated references to the one true undef will
3375 take up less space in the output file.
3377 /* Need to jump past the next hv_store, because on the
3378 second store of undef the old hash value will be
3379 SvREFCNT_dec()ed, and as Storable cheats horribly
3380 by storing non-SVs in the hash a SEGV will ensure.
3381 Need to increase the tag number so that the
3382 receiver has no idea what games we're up to. This
3383 special casing doesn't affect hooks that store
3384 undef, as the hook routine does its own lookup into
3385 hseen. Also this means that any references back
3386 to PL_sv_undef (from the pathological case of hooks
3387 storing references to it) will find the seen hash
3388 entry for the first time, as if we didn't have this
3389 hackery here. (That hseen lookup works even on 5.8.0
3390 because it's a key of &PL_sv_undef and a value
3391 which is a tag number, not a value which is
3395 goto undef_special_case;
3398 tagval = htonl(LOW_32BITS(*svh));
3400 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3408 * Allocate a new tag and associate it with the address of the sv being
3409 * stored, before recursing...
3411 * In order to avoid creating new SvIVs to hold the tagnum we just
3412 * cast the tagnum to an SV pointer and store that in the hash. This
3413 * means that we must clean up the hash manually afterwards, but gives
3414 * us a 15% throughput increase.
3419 if (!hv_store(hseen,
3420 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3424 * Store `sv' and everything beneath it, using appropriate routine.
3425 * Abort immediately if we get a non-zero status back.
3428 type = sv_type(aTHX_ sv);
3431 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3432 PTR2UV(sv), cxt->tagnum, type));
3435 HV *pkg = SvSTASH(sv);
3436 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3438 ret = SV_STORE(type)(aTHX_ cxt, sv);
3440 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3441 ret ? "FAILED" : "ok", PTR2UV(sv),
3442 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3450 * Write magic number and system information into the file.
3451 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3452 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3453 * All size and lenghts are written as single characters here.
3455 * Note that no byte ordering info is emitted when <network> is true, since
3456 * integers will be emitted in network order in that case.
3458 static int magic_write(pTHX_ stcxt_t *cxt)
3461 * Starting with 0.6, the "use_network_order" byte flag is also used to
3462 * indicate the version number of the binary image, encoded in the upper
3463 * bits. The bit 0 is always used to indicate network order.
3466 * Starting with 0.7, a full byte is dedicated to the minor version of
3467 * the binary format, which is incremented only when new markers are
3468 * introduced, for instance, but when backward compatibility is preserved.
3471 /* Make these at compile time. The WRITE() macro is sufficiently complex
3472 that it saves about 200 bytes doing it this way and only using it
3474 static const unsigned char network_file_header[] = {
3476 (STORABLE_BIN_MAJOR << 1) | 1,
3477 STORABLE_BIN_WRITE_MINOR
3479 static const unsigned char file_header[] = {
3481 (STORABLE_BIN_MAJOR << 1) | 0,
3482 STORABLE_BIN_WRITE_MINOR,
3483 /* sizeof the array includes the 0 byte at the end: */
3484 (char) sizeof (byteorderstr) - 1,
3486 (unsigned char) sizeof(int),
3487 (unsigned char) sizeof(long),
3488 (unsigned char) sizeof(char *),
3489 (unsigned char) sizeof(NV)
3491 #ifdef USE_56_INTERWORK_KLUDGE
3492 static const unsigned char file_header_56[] = {
3494 (STORABLE_BIN_MAJOR << 1) | 0,
3495 STORABLE_BIN_WRITE_MINOR,
3496 /* sizeof the array includes the 0 byte at the end: */
3497 (char) sizeof (byteorderstr_56) - 1,
3499 (unsigned char) sizeof(int),
3500 (unsigned char) sizeof(long),
3501 (unsigned char) sizeof(char *),
3502 (unsigned char) sizeof(NV)
3505 const unsigned char *header;
3508 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3510 if (cxt->netorder) {
3511 header = network_file_header;
3512 length = sizeof (network_file_header);
3514 #ifdef USE_56_INTERWORK_KLUDGE
3515 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3516 header = file_header_56;
3517 length = sizeof (file_header_56);
3521 header = file_header;
3522 length = sizeof (file_header);
3527 /* sizeof the array includes the 0 byte at the end. */
3528 header += sizeof (magicstr) - 1;
3529 length -= sizeof (magicstr) - 1;
3532 WRITE( (unsigned char*) header, length);
3534 if (!cxt->netorder) {
3535 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3536 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3537 (int) sizeof(int), (int) sizeof(long),
3538 (int) sizeof(char *), (int) sizeof(NV)));
3546 * Common code for store operations.
3548 * When memory store is requested (f = NULL) and a non null SV* is given in
3549 * `res', it is filled with a new SV created out of the memory buffer.
3551 * It is required to provide a non-null `res' when the operation type is not
3552 * dclone() and store() is performed to memory.
3554 static int do_store(
3565 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3566 ("must supply result SV pointer for real recursion to memory"));
3568 TRACEME(("do_store (optype=%d, netorder=%d)",
3569 optype, network_order));
3574 * Workaround for CROAK leak: if they enter with a "dirty" context,
3575 * free up memory for them now.
3579 clean_context(aTHX_ cxt);
3582 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3583 * re-enter store() via the hooks. We need to stack contexts.
3587 cxt = allocate_context(aTHX_ cxt);
3591 ASSERT(cxt->entry == 1, ("starting new recursion"));
3592 ASSERT(!cxt->s_dirty, ("clean context"));
3595 * Ensure sv is actually a reference. From perl, we called something
3597 * pstore(aTHX_ FILE, \@array);
3598 * so we must get the scalar value behing that reference.
3602 CROAK(("Not a reference"));
3603 sv = SvRV(sv); /* So follow it to know what to store */
3606 * If we're going to store to memory, reset the buffer.
3613 * Prepare context and emit headers.
3616 init_store_context(aTHX_ cxt, f, optype, network_order);
3618 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3619 return 0; /* Error */
3622 * Recursively store object...
3625 ASSERT(is_storing(), ("within store operation"));
3627 status = store(aTHX_ cxt, sv); /* Just do it! */
3630 * If they asked for a memory store and they provided an SV pointer,
3631 * make an SV string out of the buffer and fill their pointer.
3633 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3634 * an SV, since context cleanup might free the buffer if we did recurse.
3635 * (unless caller is dclone(), which is aware of that).
3638 if (!cxt->fio && res)
3639 *res = mbuf2sv(aTHX);
3644 * The "root" context is never freed, since it is meant to be always
3645 * handy for the common case where no recursion occurs at all (i.e.
3646 * we enter store() outside of any Storable code and leave it, period).
3647 * We know it's the "root" context because there's nothing stacked
3652 * When deep cloning, we don't free the context: doing so would force
3653 * us to copy the data in the memory buffer. Sicne we know we're
3654 * about to enter do_retrieve...
3657 clean_store_context(aTHX_ cxt);
3658 if (cxt->prev && !(cxt->optype & ST_CLONE))
3659 free_context(aTHX_ cxt);
3661 TRACEME(("do_store returns %d", status));
3669 * Store the transitive data closure of given object to disk.
3670 * Returns 0 on error, a true value otherwise.
3672 int pstore(pTHX_ PerlIO *f, SV *sv)
3674 TRACEME(("pstore"));
3675 return do_store(aTHX_ f, sv, 0, FALSE, (SV**) 0);
3682 * Same as pstore(), but network order is used for integers and doubles are
3683 * emitted as strings.
3685 int net_pstore(pTHX_ PerlIO *f, SV *sv)
3687 TRACEME(("net_pstore"));
3688 return do_store(aTHX_ f, sv, 0, TRUE, (SV**) 0);
3698 * Build a new SV out of the content of the internal memory buffer.
3700 static SV *mbuf2sv(pTHX)
3704 return newSVpv(mbase, MBUF_SIZE());
3710 * Store the transitive data closure of given object to memory.
3711 * Returns undef on error, a scalar value containing the data otherwise.
3713 SV *mstore(pTHX_ SV *sv)
3717 TRACEME(("mstore"));
3719 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, FALSE, &out))
3720 return &PL_sv_undef;
3728 * Same as mstore(), but network order is used for integers and doubles are
3729 * emitted as strings.
3731 SV *net_mstore(pTHX_ SV *sv)
3735 TRACEME(("net_mstore"));
3737 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, TRUE, &out))
3738 return &PL_sv_undef;
3744 *** Specific retrieve callbacks.
3750 * Return an error via croak, since it is not possible that we get here
3751 * under normal conditions, when facing a file produced via pstore().
3753 static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname)
3756 cxt->ver_major != STORABLE_BIN_MAJOR &&
3757 cxt->ver_minor != STORABLE_BIN_MINOR
3759 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3760 cxt->fio ? "file" : "string",
3761 cxt->ver_major, cxt->ver_minor,
3762 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3764 CROAK(("Corrupted storable %s (binary v%d.%d)",
3765 cxt->fio ? "file" : "string",
3766 cxt->ver_major, cxt->ver_minor));
3769 return (SV *) 0; /* Just in case */
3773 * retrieve_idx_blessed
3775 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3776 * <index> can be coded on either 1 or 5 bytes.
3778 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname)
3785 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3786 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3788 GETMARK(idx); /* Index coded on a single char? */
3793 * Fetch classname in `aclass'
3796 sva = av_fetch(cxt->aclass, idx, FALSE);
3798 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3800 class = SvPVX(*sva); /* We know it's a PV, by construction */
3802 TRACEME(("class ID %d => %s", idx, class));
3805 * Retrieve object and bless it.
3808 sv = retrieve(aTHX_ cxt, class); /* First SV which is SEEN will be blessed */
3816 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3817 * <len> can be coded on either 1 or 5 bytes.
3819 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname)
3823 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3826 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3827 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3830 * Decode class name length and read that name.
3832 * Short classnames have two advantages: their length is stored on one
3833 * single byte, and the string can be read on the stack.
3836 GETMARK(len); /* Length coded on a single char? */
3839 TRACEME(("** allocating %d bytes for class name", len+1));
3840 New(10003, class, len+1, char);
3843 class[len] = '\0'; /* Mark string end */
3846 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3849 TRACEME(("new class name \"%s\" will bear ID = %d", class, cxt->classnum));
3851 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
3855 * Retrieve object and bless it.
3858 sv = retrieve(aTHX_ cxt, class); /* First SV which is SEEN will be blessed */
3868 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3869 * with leading mark already read, as usual.
3871 * When recursion was involved during serialization of the object, there
3872 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
3873 * we reach a <flags> marker with the recursion bit cleared.
3875 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
3876 * is held in the <extra> byte, and if the object is tied, the serialized
3877 * magic object comes at the very end:
3879 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
3881 * This means the STORABLE_thaw hook will NOT get a tied variable during its
3882 * processing (since we won't have seen the magic object by the time the hook
3883 * is called). See comments below for why it was done that way.
3885 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname)
3888 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3899 int clone = cxt->optype & ST_CLONE;
3901 unsigned int extra_type = 0;
3903 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
3904 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3907 * Read flags, which tell us about the type, and whether we need to recurse.
3913 * Create the (empty) object, and mark it as seen.
3915 * This must be done now, because tags are incremented, and during
3916 * serialization, the object tag was affected before recursion could
3920 obj_type = flags & SHF_TYPE_MASK;
3926 sv = (SV *) newAV();
3929 sv = (SV *) newHV();
3933 * Read <extra> flag to know the type of the object.
3934 * Record associated magic type for later.
3936 GETMARK(extra_type);
3937 switch (extra_type) {
3943 sv = (SV *) newAV();
3947 sv = (SV *) newHV();
3951 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
3955 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
3957 SEEN(sv, 0, 0); /* Don't bless yet */
3960 * Whilst flags tell us to recurse, do so.
3962 * We don't need to remember the addresses returned by retrieval, because
3963 * all the references will be obtained through indirection via the object
3964 * tags in the object-ID list.
3966 * We need to decrement the reference count for these objects
3967 * because, if the user doesn't save a reference to them in the hook,
3968 * they must be freed when this context is cleaned.
3971 while (flags & SHF_NEED_RECURSE) {
3972 TRACEME(("retrieve_hook recursing..."));
3973 rv = retrieve(aTHX_ cxt, 0);
3977 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
3982 if (flags & SHF_IDX_CLASSNAME) {
3987 * Fetch index from `aclass'
3990 if (flags & SHF_LARGE_CLASSLEN)
3995 sva = av_fetch(cxt->aclass, idx, FALSE);
3997 CROAK(("Class name #%"IVdf" should have been seen already",
4000 class = SvPVX(*sva); /* We know it's a PV, by construction */
4001 TRACEME(("class ID %d => %s", idx, class));
4005 * Decode class name length and read that name.
4007 * NOTA BENE: even if the length is stored on one byte, we don't read
4008 * on the stack. Just like retrieve_blessed(), we limit the name to
4009 * LG_BLESS bytes. This is an arbitrary decision.
4012 if (flags & SHF_LARGE_CLASSLEN)
4017 if (len > LG_BLESS) {
4018 TRACEME(("** allocating %d bytes for class name", len+1));
4019 New(10003, class, len+1, char);
4023 class[len] = '\0'; /* Mark string end */
4026 * Record new classname.
4029 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
4033 TRACEME(("class name: %s", class));
4036 * Decode user-frozen string length and read it in an SV.
4038 * For efficiency reasons, we read data directly into the SV buffer.
4039 * To understand that code, read retrieve_scalar()
4042 if (flags & SHF_LARGE_STRLEN)
4047 frozen = NEWSV(10002, len2);
4049 SAFEREAD(SvPVX(frozen), len2, frozen);
4050 SvCUR_set(frozen, len2);
4051 *SvEND(frozen) = '\0';
4053 (void) SvPOK_only(frozen); /* Validates string pointer */
4054 if (cxt->s_tainted) /* Is input source tainted? */
4057 TRACEME(("frozen string: %d bytes", len2));
4060 * Decode object-ID list length, if present.
4063 if (flags & SHF_HAS_LIST) {
4064 if (flags & SHF_LARGE_LISTLEN)
4070 av_extend(av, len3 + 1); /* Leave room for [0] */
4071 AvFILLp(av) = len3; /* About to be filled anyway */
4075 TRACEME(("has %d object IDs to link", len3));
4078 * Read object-ID list into array.
4079 * Because we pre-extended it, we can cheat and fill it manually.
4081 * We read object tags and we can convert them into SV* on the fly
4082 * because we know all the references listed in there (as tags)
4083 * have been already serialized, hence we have a valid correspondance
4084 * between each of those tags and the recreated SV.
4088 SV **ary = AvARRAY(av);
4090 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
4097 svh = av_fetch(cxt->aseen, tag, FALSE);
4099 if (tag == cxt->where_is_undef) {
4100 /* av_fetch uses PL_sv_undef internally, hence this
4101 somewhat gruesome hack. */
4105 CROAK(("Object #%"IVdf" should have been retrieved already",
4110 ary[i] = SvREFCNT_inc(xsv);
4115 * Bless the object and look up the STORABLE_thaw hook.
4119 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4122 * Hook not found. Maybe they did not require the module where this
4123 * hook is defined yet?
4125 * If the require below succeeds, we'll be able to find the hook.
4126 * Still, it only works reliably when each class is defined in a
4130 SV *psv = newSVpvn("require ", 8);
4131 sv_catpv(psv, class);
4133 TRACEME(("No STORABLE_thaw defined for objects of class %s", class));
4134 TRACEME(("Going to require module '%s' with '%s'", class, SvPVX(psv)));
4136 perl_eval_sv(psv, G_DISCARD);
4140 * We cache results of pkg_can, so we need to uncache before attempting
4144 pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4145 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4148 CROAK(("No STORABLE_thaw defined for objects of class %s "
4149 "(even after a \"require %s;\")", class, class));
4153 * If we don't have an `av' yet, prepare one.
4154 * Then insert the frozen string as item [0].
4162 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4167 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4169 * where $object is our blessed (empty) object, $cloning is a boolean
4170 * telling whether we're running a deep clone, $frozen is the frozen
4171 * string the user gave us in his serializing hook, and @refs, which may
4172 * be empty, is the list of extra references he returned along for us
4175 * In effect, the hook is an alternate creation routine for the class,
4176 * the object itself being already created by the runtime.
4179 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4180 class, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4183 (void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
4190 SvREFCNT_dec(frozen);
4193 if (!(flags & SHF_IDX_CLASSNAME) && class != buf)
4197 * If we had an <extra> type, then the object was not as simple, and
4198 * we need to restore extra magic now.
4204 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4206 rv = retrieve(aTHX_ cxt, 0); /* Retrieve <magic object> */
4208 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4209 PTR2UV(rv), PTR2UV(sv)));
4211 switch (extra_type) {
4213 sv_upgrade(sv, SVt_PVMG);
4216 sv_upgrade(sv, SVt_PVAV);
4217 AvREAL_off((AV *)sv);
4220 sv_upgrade(sv, SVt_PVHV);
4223 CROAK(("Forgot to deal with extra type %d", extra_type));
4228 * Adding the magic only now, well after the STORABLE_thaw hook was called
4229 * means the hook cannot know it deals with an object whose variable is
4230 * tied. But this is happening when retrieving $o in the following case:
4234 * my $o = bless \%h, 'BAR';
4236 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4237 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4238 * hash but a tied one should not matter at all, and remain transparent.
4239 * This means the magic must be restored by Storable AFTER the hook is
4242 * That looks very reasonable to me, but then I've come up with this
4243 * after a bug report from David Nesting, who was trying to store such
4244 * an object and caused Storable to fail. And unfortunately, it was
4245 * also the easiest way to retrofit support for blessed ref to tied objects
4246 * into the existing design. -- RAM, 17/02/2001
4249 sv_magic(sv, rv, mtype, Nullch, 0);
4250 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4258 * Retrieve reference to some other scalar.
4259 * Layout is SX_REF <object>, with SX_REF already read.
4261 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname)
4266 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4269 * We need to create the SV that holds the reference to the yet-to-retrieve
4270 * object now, so that we may record the address in the seen table.
4271 * Otherwise, if the object to retrieve references us, we won't be able
4272 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4273 * do the retrieve first and use rv = newRV(sv) since it will be too late
4274 * for SEEN() recording.
4277 rv = NEWSV(10002, 0);
4278 SEEN(rv, cname, 0); /* Will return if rv is null */
4279 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4281 return (SV *) 0; /* Failed */
4284 * WARNING: breaks RV encapsulation.
4286 * Now for the tricky part. We have to upgrade our existing SV, so that
4287 * it is now an RV on sv... Again, we cheat by duplicating the code
4288 * held in newSVrv(), since we already got our SV from retrieve().
4292 * SvRV(rv) = SvREFCNT_inc(sv);
4294 * here because the reference count we got from retrieve() above is
4295 * already correct: if the object was retrieved from the file, then
4296 * its reference count is one. Otherwise, if it was retrieved via
4297 * an SX_OBJECT indication, a ref count increment was done.
4301 /* No need to do anything, as rv will already be PVMG. */
4302 assert (SvTYPE(rv) >= SVt_RV);
4304 sv_upgrade(rv, SVt_RV);
4307 SvRV(rv) = sv; /* $rv = \$sv */
4310 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4318 * Retrieve weak reference to some other scalar.
4319 * Layout is SX_WEAKREF <object>, with SX_WEAKREF already read.
4321 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, char *cname)
4325 TRACEME(("retrieve_weakref (#%d)", cxt->tagnum));
4327 sv = retrieve_ref(aTHX_ cxt, cname);
4339 * retrieve_overloaded
4341 * Retrieve reference to some other scalar with overloading.
4342 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4344 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname)
4350 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4353 * Same code as retrieve_ref(), duplicated to avoid extra call.
4356 rv = NEWSV(10002, 0);
4357 SEEN(rv, cname, 0); /* Will return if rv is null */
4358 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4360 return (SV *) 0; /* Failed */
4363 * WARNING: breaks RV encapsulation.
4366 sv_upgrade(rv, SVt_RV);
4367 SvRV(rv) = sv; /* $rv = \$sv */
4371 * Restore overloading magic.
4374 stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
4376 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4377 ") (package <unknown>)",
4378 sv_reftype(sv, FALSE),
4381 if (!Gv_AMG(stash)) {
4382 SV *psv = newSVpvn("require ", 8);
4383 const char *package = HvNAME(stash);
4384 sv_catpv(psv, package);
4386 TRACEME(("No overloading defined for package %s", package));
4387 TRACEME(("Going to require module '%s' with '%s'", package, SvPVX(psv)));
4389 perl_eval_sv(psv, G_DISCARD);
4391 if (!Gv_AMG(stash)) {
4392 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4393 ") (package %s) (even after a \"require %s;\")",
4394 sv_reftype(sv, FALSE),
4402 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4408 * retrieve_weakoverloaded
4410 * Retrieve weak overloaded reference to some other scalar.
4411 * Layout is SX_WEAKOVERLOADED <object>, with SX_WEAKOVERLOADED already read.
4413 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, char *cname)
4417 TRACEME(("retrieve_weakoverloaded (#%d)", cxt->tagnum));
4419 sv = retrieve_overloaded(aTHX_ cxt, cname);
4431 * retrieve_tied_array
4433 * Retrieve tied array
4434 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4436 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname)
4441 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4443 tv = NEWSV(10002, 0);
4444 SEEN(tv, cname, 0); /* Will return if tv is null */
4445 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4447 return (SV *) 0; /* Failed */
4449 sv_upgrade(tv, SVt_PVAV);
4450 AvREAL_off((AV *)tv);
4451 sv_magic(tv, sv, 'P', Nullch, 0);
4452 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4454 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4460 * retrieve_tied_hash
4462 * Retrieve tied hash
4463 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4465 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname)
4470 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4472 tv = NEWSV(10002, 0);
4473 SEEN(tv, cname, 0); /* Will return if tv is null */
4474 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4476 return (SV *) 0; /* Failed */
4478 sv_upgrade(tv, SVt_PVHV);
4479 sv_magic(tv, sv, 'P', Nullch, 0);
4480 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4482 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4488 * retrieve_tied_scalar
4490 * Retrieve tied scalar
4491 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4493 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname)
4496 SV *sv, *obj = NULL;
4498 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4500 tv = NEWSV(10002, 0);
4501 SEEN(tv, cname, 0); /* Will return if rv is null */
4502 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4504 return (SV *) 0; /* Failed */
4506 else if (SvTYPE(sv) != SVt_NULL) {
4510 sv_upgrade(tv, SVt_PVMG);
4511 sv_magic(tv, obj, 'q', Nullch, 0);
4514 /* Undo refcnt inc from sv_magic() */
4518 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4526 * Retrieve reference to value in a tied hash.
4527 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4529 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname)
4535 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4537 tv = NEWSV(10002, 0);
4538 SEEN(tv, cname, 0); /* Will return if tv is null */
4539 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4541 return (SV *) 0; /* Failed */
4543 key = retrieve(aTHX_ cxt, 0); /* Retrieve <key> */
4545 return (SV *) 0; /* Failed */
4547 sv_upgrade(tv, SVt_PVMG);
4548 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4549 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4550 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4558 * Retrieve reference to value in a tied array.
4559 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4561 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname)
4567 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4569 tv = NEWSV(10002, 0);
4570 SEEN(tv, cname, 0); /* Will return if tv is null */
4571 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4573 return (SV *) 0; /* Failed */
4575 RLEN(idx); /* Retrieve <idx> */
4577 sv_upgrade(tv, SVt_PVMG);
4578 sv_magic(tv, sv, 'p', Nullch, idx);
4579 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4588 * Retrieve defined long (string) scalar.
4590 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4591 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4592 * was not stored on a single byte.
4594 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname)
4600 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4603 * Allocate an empty scalar of the suitable length.
4606 sv = NEWSV(10002, len);
4607 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4610 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4612 * Now, for efficiency reasons, read data directly inside the SV buffer,
4613 * and perform the SV final settings directly by duplicating the final
4614 * work done by sv_setpv. Since we're going to allocate lots of scalars
4615 * this way, it's worth the hassle and risk.
4618 SAFEREAD(SvPVX(sv), len, sv);
4619 SvCUR_set(sv, len); /* Record C string length */
4620 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4621 (void) SvPOK_only(sv); /* Validate string pointer */
4622 if (cxt->s_tainted) /* Is input source tainted? */
4623 SvTAINT(sv); /* External data cannot be trusted */
4625 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4626 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4634 * Retrieve defined short (string) scalar.
4636 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4637 * The scalar is "short" so <length> is single byte. If it is 0, there
4638 * is no <data> section.
4640 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname)
4646 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4649 * Allocate an empty scalar of the suitable length.
4652 sv = NEWSV(10002, len);
4653 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4656 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4661 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4662 * To make it defined with an empty length, upgrade it now...
4663 * Don't upgrade to a PV if the original type contains more
4664 * information than a scalar.
4666 if (SvTYPE(sv) <= SVt_PV) {
4667 sv_upgrade(sv, SVt_PV);
4670 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4671 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4674 * Now, for efficiency reasons, read data directly inside the SV buffer,
4675 * and perform the SV final settings directly by duplicating the final
4676 * work done by sv_setpv. Since we're going to allocate lots of scalars
4677 * this way, it's worth the hassle and risk.
4679 SAFEREAD(SvPVX(sv), len, sv);
4680 SvCUR_set(sv, len); /* Record C string length */
4681 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4682 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4685 (void) SvPOK_only(sv); /* Validate string pointer */
4686 if (cxt->s_tainted) /* Is input source tainted? */
4687 SvTAINT(sv); /* External data cannot be trusted */
4689 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4696 * Like retrieve_scalar(), but tag result as utf8.
4697 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4699 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname)
4703 TRACEME(("retrieve_utf8str"));
4705 sv = retrieve_scalar(aTHX_ cxt, cname);
4707 #ifdef HAS_UTF8_SCALARS
4710 if (cxt->use_bytes < 0)
4712 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4714 if (cxt->use_bytes == 0)
4725 * Like retrieve_lscalar(), but tag result as utf8.
4726 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4728 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname)
4732 TRACEME(("retrieve_lutf8str"));
4734 sv = retrieve_lscalar(aTHX_ cxt, cname);
4736 #ifdef HAS_UTF8_SCALARS
4739 if (cxt->use_bytes < 0)
4741 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4743 if (cxt->use_bytes == 0)
4753 * Retrieve defined integer.
4754 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4756 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname)
4761 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4763 READ(&iv, sizeof(iv));
4765 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4767 TRACEME(("integer %"IVdf, iv));
4768 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4776 * Retrieve defined integer in network order.
4777 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4779 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname)
4784 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4788 sv = newSViv((int) ntohl(iv));
4789 TRACEME(("network integer %d", (int) ntohl(iv)));
4792 TRACEME(("network integer (as-is) %d", iv));
4794 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4796 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
4804 * Retrieve defined double.
4805 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
4807 static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname)
4812 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
4814 READ(&nv, sizeof(nv));
4816 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4818 TRACEME(("double %"NVff, nv));
4819 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
4827 * Retrieve defined byte (small integer within the [-128, +127] range).
4828 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
4830 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname)
4834 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
4836 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
4839 TRACEME(("small integer read as %d", (unsigned char) siv));
4840 tmp = (unsigned char) siv - 128;
4842 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4844 TRACEME(("byte %d", tmp));
4845 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
4853 * Return the undefined value.
4855 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname)
4859 TRACEME(("retrieve_undef"));
4870 * Return the immortal undefined value.
4872 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname)
4874 SV *sv = &PL_sv_undef;
4876 TRACEME(("retrieve_sv_undef"));
4878 /* Special case PL_sv_undef, as av_fetch uses it internally to mark
4879 deleted elements, and will return NULL (fetch failed) whenever it
4881 if (cxt->where_is_undef == -1) {
4882 cxt->where_is_undef = cxt->tagnum;
4891 * Return the immortal yes value.
4893 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname)
4895 SV *sv = &PL_sv_yes;
4897 TRACEME(("retrieve_sv_yes"));
4906 * Return the immortal no value.
4908 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname)
4912 TRACEME(("retrieve_sv_no"));
4921 * Retrieve a whole array.
4922 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
4923 * Each item is stored as <object>.
4925 * When we come here, SX_ARRAY has been read already.
4927 static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname)
4934 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
4937 * Read length, and allocate array, then pre-extend it.
4941 TRACEME(("size = %d", len));
4943 SEEN(av, cname, 0); /* Will return if array not allocated nicely */
4947 return (SV *) av; /* No data follow if array is empty */
4950 * Now get each item in turn...
4953 for (i = 0; i < len; i++) {
4954 TRACEME(("(#%d) item", i));
4955 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
4958 if (av_store(av, i, sv) == 0)
4962 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
4970 * Retrieve a whole hash table.
4971 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4972 * Keys are stored as <length> <data>, the <data> section being omitted
4974 * Values are stored as <object>.
4976 * When we come here, SX_HASH has been read already.
4978 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname)
4986 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
4989 * Read length, allocate table.
4993 TRACEME(("size = %d", len));
4995 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
4997 return (SV *) hv; /* No data follow if table empty */
4998 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5001 * Now get each key/value pair in turn...
5004 for (i = 0; i < len; i++) {
5009 TRACEME(("(#%d) value", i));
5010 sv = retrieve(aTHX_ cxt, 0);
5016 * Since we're reading into kbuf, we must ensure we're not
5017 * recursing between the read and the hv_store() where it's used.
5018 * Hence the key comes after the value.
5021 RLEN(size); /* Get key size */
5022 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5025 kbuf[size] = '\0'; /* Mark string end, just in case */
5026 TRACEME(("(#%d) key '%s'", i, kbuf));
5029 * Enter key/value pair into hash table.
5032 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5036 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5044 * Retrieve a whole hash table.
5045 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5046 * Keys are stored as <length> <data>, the <data> section being omitted
5048 * Values are stored as <object>.
5050 * When we come here, SX_HASH has been read already.
5052 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname)
5061 GETMARK(hash_flags);
5062 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
5064 * Read length, allocate table.
5067 #ifndef HAS_RESTRICTED_HASHES
5068 if (hash_flags & SHV_RESTRICTED) {
5069 if (cxt->derestrict < 0)
5071 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
5073 if (cxt->derestrict == 0)
5074 RESTRICTED_HASH_CROAK();
5079 TRACEME(("size = %d, flags = %d", len, hash_flags));
5081 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5083 return (SV *) hv; /* No data follow if table empty */
5084 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5087 * Now get each key/value pair in turn...
5090 for (i = 0; i < len; i++) {
5092 int store_flags = 0;
5097 TRACEME(("(#%d) value", i));
5098 sv = retrieve(aTHX_ cxt, 0);
5103 #ifdef HAS_RESTRICTED_HASHES
5104 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
5108 if (flags & SHV_K_ISSV) {
5109 /* XXX you can't set a placeholder with an SV key.
5110 Then again, you can't get an SV key.
5111 Without messing around beyond what the API is supposed to do.
5114 TRACEME(("(#%d) keysv, flags=%d", i, flags));
5115 keysv = retrieve(aTHX_ cxt, 0);
5119 if (!hv_store_ent(hv, keysv, sv, 0))
5124 * Since we're reading into kbuf, we must ensure we're not
5125 * recursing between the read and the hv_store() where it's used.
5126 * Hence the key comes after the value.
5129 if (flags & SHV_K_PLACEHOLDER) {
5131 sv = &PL_sv_placeholder;
5132 store_flags |= HVhek_PLACEHOLD;
5134 if (flags & SHV_K_UTF8) {
5135 #ifdef HAS_UTF8_HASHES
5136 store_flags |= HVhek_UTF8;
5138 if (cxt->use_bytes < 0)
5140 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
5142 if (cxt->use_bytes == 0)
5146 #ifdef HAS_UTF8_HASHES
5147 if (flags & SHV_K_WASUTF8)
5148 store_flags |= HVhek_WASUTF8;
5151 RLEN(size); /* Get key size */
5152 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5155 kbuf[size] = '\0'; /* Mark string end, just in case */
5156 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5157 flags, store_flags));
5160 * Enter key/value pair into hash table.
5163 #ifdef HAS_RESTRICTED_HASHES
5164 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5167 if (!(store_flags & HVhek_PLACEHOLD))
5168 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5173 #ifdef HAS_RESTRICTED_HASHES
5174 if (hash_flags & SHV_RESTRICTED)
5178 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5186 * Return a code reference.
5188 static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname)
5190 #if PERL_VERSION < 6
5191 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5194 int type, count, tagnum;
5196 SV *sv, *text, *sub;
5198 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5201 * Insert dummy SV in the aseen array so that we don't screw
5202 * up the tag numbers. We would just make the internal
5203 * scalar an untagged item in the stream, but
5204 * retrieve_scalar() calls SEEN(). So we just increase the
5207 tagnum = cxt->tagnum;
5212 * Retrieve the source of the code reference
5213 * as a small or large scalar
5219 text = retrieve_scalar(aTHX_ cxt, cname);
5222 text = retrieve_lscalar(aTHX_ cxt, cname);
5225 CROAK(("Unexpected type %d in retrieve_code\n", type));
5229 * prepend "sub " to the source
5232 sub = newSVpvn("sub ", 4);
5233 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5237 * evaluate the source to a code reference and use the CV value
5240 if (cxt->eval == NULL) {
5241 cxt->eval = perl_get_sv("Storable::Eval", TRUE);
5242 SvREFCNT_inc(cxt->eval);
5244 if (!SvTRUE(cxt->eval)) {
5246 cxt->forgive_me == 0 ||
5247 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5248 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
5250 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5253 /* fix up the dummy entry... */
5254 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5262 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5263 SV* errsv = get_sv("@", TRUE);
5264 sv_setpv(errsv, ""); /* clear $@ */
5266 XPUSHs(sv_2mortal(newSVsv(sub)));
5268 count = call_sv(cxt->eval, G_SCALAR);
5271 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5273 if (SvTRUE(errsv)) {
5274 CROAK(("code %s caused an error: %s",
5275 SvPV_nolen(sub), SvPV_nolen(errsv)));
5279 cv = eval_pv(SvPV_nolen(sub), TRUE);
5281 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5284 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5287 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5292 /* fix up the dummy entry... */
5293 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5300 * old_retrieve_array
5302 * Retrieve a whole array in pre-0.6 binary format.
5304 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5305 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5307 * When we come here, SX_ARRAY has been read already.
5309 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname)
5317 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5320 * Read length, and allocate array, then pre-extend it.
5324 TRACEME(("size = %d", len));
5326 SEEN(av, 0, 0); /* Will return if array not allocated nicely */
5330 return (SV *) av; /* No data follow if array is empty */
5333 * Now get each item in turn...
5336 for (i = 0; i < len; i++) {
5338 if (c == SX_IT_UNDEF) {
5339 TRACEME(("(#%d) undef item", i));
5340 continue; /* av_extend() already filled us with undef */
5343 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5344 TRACEME(("(#%d) item", i));
5345 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5348 if (av_store(av, i, sv) == 0)
5352 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5360 * Retrieve a whole hash table in pre-0.6 binary format.
5362 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5363 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5365 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5367 * When we come here, SX_HASH has been read already.
5369 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname)
5377 static SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5379 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5382 * Read length, allocate table.
5386 TRACEME(("size = %d", len));
5388 SEEN(hv, 0, 0); /* Will return if table not allocated properly */
5390 return (SV *) hv; /* No data follow if table empty */
5391 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5394 * Now get each key/value pair in turn...
5397 for (i = 0; i < len; i++) {
5403 if (c == SX_VL_UNDEF) {
5404 TRACEME(("(#%d) undef value", i));
5406 * Due to a bug in hv_store(), it's not possible to pass
5407 * &PL_sv_undef to hv_store() as a value, otherwise the
5408 * associated key will not be creatable any more. -- RAM, 14/01/97
5411 sv_h_undef = newSVsv(&PL_sv_undef);
5412 sv = SvREFCNT_inc(sv_h_undef);
5413 } else if (c == SX_VALUE) {
5414 TRACEME(("(#%d) value", i));
5415 sv = retrieve(aTHX_ cxt, 0);
5419 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5423 * Since we're reading into kbuf, we must ensure we're not
5424 * recursing between the read and the hv_store() where it's used.
5425 * Hence the key comes after the value.
5430 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5431 RLEN(size); /* Get key size */
5432 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5435 kbuf[size] = '\0'; /* Mark string end, just in case */
5436 TRACEME(("(#%d) key '%s'", i, kbuf));
5439 * Enter key/value pair into hash table.
5442 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5446 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5452 *** Retrieval engine.
5458 * Make sure the stored data we're trying to retrieve has been produced
5459 * on an ILP compatible system with the same byteorder. It croaks out in
5460 * case an error is detected. [ILP = integer-long-pointer sizes]
5461 * Returns null if error is detected, &PL_sv_undef otherwise.
5463 * Note that there's no byte ordering info emitted when network order was
5464 * used at store time.
5466 static SV *magic_check(pTHX_ stcxt_t *cxt)
5468 /* The worst case for a malicious header would be old magic (which is
5469 longer), major, minor, byteorder length byte of 255, 255 bytes of
5470 garbage, sizeof int, long, pointer, NV.
5471 So the worse of that we can read is 255 bytes of garbage plus 4.
5472 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5473 compiling perl on a system with chars that are larger than 8 bits.
5474 (Even Crays aren't *that* perverse).
5476 unsigned char buf[4 + 255];
5477 unsigned char *current;
5480 int use_network_order;
5483 int version_minor = 0;
5485 TRACEME(("magic_check"));
5488 * The "magic number" is only for files, not when freezing in memory.
5492 /* This includes the '\0' at the end. I want to read the extra byte,
5493 which is usually going to be the major version number. */
5494 STRLEN len = sizeof(magicstr);
5497 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5499 /* Point at the byte after the byte we read. */
5500 current = buf + --len; /* Do the -- outside of macros. */
5502 if (memNE(buf, magicstr, len)) {
5504 * Try to read more bytes to check for the old magic number, which
5508 TRACEME(("trying for old magic number"));
5510 old_len = sizeof(old_magicstr) - 1;
5511 READ(current + 1, (SSize_t)(old_len - len));
5513 if (memNE(buf, old_magicstr, old_len))
5514 CROAK(("File is not a perl storable"));
5515 current = buf + old_len;
5517 use_network_order = *current;
5519 GETMARK(use_network_order);
5522 * Starting with 0.6, the "use_network_order" byte flag is also used to
5523 * indicate the version number of the binary, and therefore governs the
5524 * setting of sv_retrieve_vtbl. See magic_write().
5527 version_major = use_network_order >> 1;
5528 cxt->retrieve_vtbl = version_major ? sv_retrieve : sv_old_retrieve;
5530 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5534 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5535 * minor version of the protocol. See magic_write().
5538 if (version_major > 1)
5539 GETMARK(version_minor);
5541 cxt->ver_major = version_major;
5542 cxt->ver_minor = version_minor;
5544 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5547 * Inter-operability sanity check: we can't retrieve something stored
5548 * using a format more recent than ours, because we have no way to
5549 * know what has changed, and letting retrieval go would mean a probable
5550 * failure reporting a "corrupted" storable file.
5554 version_major > STORABLE_BIN_MAJOR ||
5555 (version_major == STORABLE_BIN_MAJOR &&
5556 version_minor > STORABLE_BIN_MINOR)
5559 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5560 STORABLE_BIN_MINOR));
5562 if (version_major == STORABLE_BIN_MAJOR) {
5563 TRACEME(("cxt->accept_future_minor is %d",
5564 cxt->accept_future_minor));
5565 if (cxt->accept_future_minor < 0)
5566 cxt->accept_future_minor
5567 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5570 if (cxt->accept_future_minor == 1)
5571 croak_now = 0; /* Don't croak yet. */
5574 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5575 version_major, version_minor,
5576 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5581 * If they stored using network order, there's no byte ordering
5582 * information to check.
5585 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5586 return &PL_sv_undef; /* No byte ordering info */
5588 /* In C truth is 1, falsehood is 0. Very convienient. */
5589 use_NV_size = version_major >= 2 && version_minor >= 2;
5592 length = c + 3 + use_NV_size;
5593 READ(buf, length); /* Not null-terminated */
5595 TRACEME(("byte order '%.*s' %d", c, buf, c));
5597 #ifdef USE_56_INTERWORK_KLUDGE
5598 /* No point in caching this in the context as we only need it once per
5599 retrieve, and we need to recheck it each read. */
5600 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5601 if ((c != (sizeof (byteorderstr_56) - 1))
5602 || memNE(buf, byteorderstr_56, c))
5603 CROAK(("Byte order is not compatible"));
5607 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5608 CROAK(("Byte order is not compatible"));
5614 if ((int) *current++ != sizeof(int))
5615 CROAK(("Integer size is not compatible"));
5618 if ((int) *current++ != sizeof(long))
5619 CROAK(("Long integer size is not compatible"));
5621 /* sizeof(char *) */
5622 if ((int) *current != sizeof(char *))
5623 CROAK(("Pointer size is not compatible"));
5627 if ((int) *++current != sizeof(NV))
5628 CROAK(("Double size is not compatible"));
5631 return &PL_sv_undef; /* OK */
5637 * Recursively retrieve objects from the specified file and return their
5638 * root SV (which may be an AV or an HV for what we care).
5639 * Returns null if there is a problem.
5641 static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname)
5647 TRACEME(("retrieve"));
5650 * Grab address tag which identifies the object if we are retrieving
5651 * an older format. Since the new binary format counts objects and no
5652 * longer explicitely tags them, we must keep track of the correspondance
5655 * The following section will disappear one day when the old format is
5656 * no longer supported, hence the final "goto" in the "if" block.
5659 if (cxt->hseen) { /* Retrieving old binary */
5661 if (cxt->netorder) {
5663 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5664 tag = (stag_t) nettag;
5666 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5669 if (type == SX_OBJECT) {
5671 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5673 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5675 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5678 * The following code is common with the SX_OBJECT case below.
5681 svh = av_fetch(cxt->aseen, tagn, FALSE);
5683 CROAK(("Object #%"IVdf" should have been retrieved already",
5686 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5687 SvREFCNT_inc(sv); /* One more reference to this same sv */
5688 return sv; /* The SV pointer where object was retrieved */
5692 * Map new object, but don't increase tagnum. This will be done
5693 * by each of the retrieve_* functions when they call SEEN().
5695 * The mapping associates the "tag" initially present with a unique
5696 * tag number. See test for SX_OBJECT above to see how this is perused.
5699 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5700 newSViv(cxt->tagnum), 0))
5707 * Regular post-0.6 binary format.
5712 TRACEME(("retrieve type = %d", type));
5715 * Are we dealing with an object we should have already retrieved?
5718 if (type == SX_OBJECT) {
5722 svh = av_fetch(cxt->aseen, tag, FALSE);
5724 CROAK(("Object #%"IVdf" should have been retrieved already",
5727 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5728 SvREFCNT_inc(sv); /* One more reference to this same sv */
5729 return sv; /* The SV pointer where object was retrieved */
5730 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5731 if (cxt->accept_future_minor < 0)
5732 cxt->accept_future_minor
5733 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5736 if (cxt->accept_future_minor == 1) {
5737 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5738 "This Storable is v%d.%d and can only handle data types up to %d",
5739 cxt->ver_major, cxt->ver_minor, type,
5740 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5744 first_time: /* Will disappear when support for old format is dropped */
5747 * Okay, first time through for this one.
5750 sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
5752 return (SV *) 0; /* Failed */
5755 * Old binary formats (pre-0.7).
5757 * Final notifications, ended by SX_STORED may now follow.
5758 * Currently, the only pertinent notification to apply on the
5759 * freshly retrieved object is either:
5760 * SX_CLASS <char-len> <classname> for short classnames.
5761 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5762 * Class name is then read into the key buffer pool used by
5763 * hash table key retrieval.
5766 if (cxt->ver_major < 2) {
5767 while ((type = GETCHAR()) != SX_STORED) {
5771 GETMARK(len); /* Length coded on a single char */
5773 case SX_LG_CLASS: /* Length coded on a regular integer */
5778 return (SV *) 0; /* Failed */
5780 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5783 kbuf[len] = '\0'; /* Mark string end */
5788 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5789 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
5797 * Retrieve data held in file and return the root object.
5798 * Common routine for pretrieve and mretrieve.
5800 static SV *do_retrieve(
5808 int is_tainted; /* Is input source tainted? */
5809 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
5811 TRACEME(("do_retrieve (optype = 0x%x)", optype));
5813 optype |= ST_RETRIEVE;
5816 * Sanity assertions for retrieve dispatch tables.
5819 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
5820 ("old and new retrieve dispatch table have same size"));
5821 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
5822 ("SX_ERROR entry correctly initialized in old dispatch table"));
5823 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
5824 ("SX_ERROR entry correctly initialized in new dispatch table"));
5827 * Workaround for CROAK leak: if they enter with a "dirty" context,
5828 * free up memory for them now.
5832 clean_context(aTHX_ cxt);
5835 * Now that STORABLE_xxx hooks exist, it is possible that they try to
5836 * re-enter retrieve() via the hooks.
5840 cxt = allocate_context(aTHX_ cxt);
5844 ASSERT(cxt->entry == 1, ("starting new recursion"));
5845 ASSERT(!cxt->s_dirty, ("clean context"));
5850 * Data is loaded into the memory buffer when f is NULL, unless `in' is
5851 * also NULL, in which case we're expecting the data to already lie
5852 * in the buffer (dclone case).
5855 KBUFINIT(); /* Allocate hash key reading pool once */
5861 const char *orig = SvPV(in, length);
5863 /* This is quite deliberate. I want the UTF8 routines
5864 to encounter the '\0' which perl adds at the end
5865 of all scalars, so that any new string also has
5868 STRLEN klen_tmp = length + 1;
5869 bool is_utf8 = TRUE;
5871 /* Just casting the &klen to (STRLEN) won't work
5872 well if STRLEN and I32 are of different widths.
5874 asbytes = (char*)bytes_from_utf8((U8*)orig,
5878 CROAK(("Frozen string corrupt - contains characters outside 0-255"));
5880 if (asbytes != orig) {
5881 /* String has been converted.
5882 There is no need to keep any reference to
5884 in = sv_newmortal();
5885 /* We donate the SV the malloc()ed string
5886 bytes_from_utf8 returned us. */
5887 SvUPGRADE(in, SVt_PV);
5889 SvPVX(in) = asbytes;
5890 SvLEN(in) = klen_tmp;
5891 SvCUR(in) = klen_tmp - 1;
5895 MBUF_SAVE_AND_LOAD(in);
5899 * Magic number verifications.
5901 * This needs to be done before calling init_retrieve_context()
5902 * since the format indication in the file are necessary to conduct
5903 * some of the initializations.
5906 cxt->fio = f; /* Where I/O are performed */
5908 if (!magic_check(aTHX_ cxt))
5909 CROAK(("Magic number checking on storable %s failed",
5910 cxt->fio ? "file" : "string"));
5912 TRACEME(("data stored in %s format",
5913 cxt->netorder ? "net order" : "native"));
5916 * Check whether input source is tainted, so that we don't wrongly
5917 * taint perfectly good values...
5919 * We assume file input is always tainted. If both `f' and `in' are
5920 * NULL, then we come from dclone, and tainted is already filled in
5921 * the context. That's a kludge, but the whole dclone() thing is
5922 * already quite a kludge anyway! -- RAM, 15/09/2000.
5925 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
5926 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
5927 init_retrieve_context(aTHX_ cxt, optype, is_tainted);
5929 ASSERT(is_retrieving(), ("within retrieve operation"));
5931 sv = retrieve(aTHX_ cxt, 0); /* Recursively retrieve object, get root SV */
5940 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
5943 * The "root" context is never freed.
5946 clean_retrieve_context(aTHX_ cxt);
5947 if (cxt->prev) /* This context was stacked */
5948 free_context(aTHX_ cxt); /* It was not the "root" context */
5951 * Prepare returned value.
5955 TRACEME(("retrieve ERROR"));
5956 #if (PATCHLEVEL <= 4)
5957 /* perl 5.00405 seems to screw up at this point with an
5958 'attempt to modify a read only value' error reported in the
5959 eval { $self = pretrieve(*FILE) } in _retrieve.
5960 I can't see what the cause of this error is, but I suspect a
5961 bug in 5.004, as it seems to be capable of issuing spurious
5962 errors or core dumping with matches on $@. I'm not going to
5963 spend time on what could be a fruitless search for the cause,
5964 so here's a bodge. If you're running 5.004 and don't like
5965 this inefficiency, either upgrade to a newer perl, or you are
5966 welcome to find the problem and send in a patch.
5970 return &PL_sv_undef; /* Something went wrong, return undef */
5974 TRACEME(("retrieve got %s(0x%"UVxf")",
5975 sv_reftype(sv, FALSE), PTR2UV(sv)));
5978 * Backward compatibility with Storable-0.5@9 (which we know we
5979 * are retrieving if hseen is non-null): don't create an extra RV
5980 * for objects since we special-cased it at store time.
5982 * Build a reference to the SV returned by pretrieve even if it is
5983 * already one and not a scalar, for consistency reasons.
5986 if (pre_06_fmt) { /* Was not handling overloading by then */
5988 TRACEME(("fixing for old formats -- pre 0.6"));
5989 if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
5990 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
5996 * If reference is overloaded, restore behaviour.
5998 * NB: minor glitch here: normally, overloaded refs are stored specially
5999 * so that we can croak when behaviour cannot be re-installed, and also
6000 * avoid testing for overloading magic at each reference retrieval.
6002 * Unfortunately, the root reference is implicitely stored, so we must
6003 * check for possible overloading now. Furthermore, if we don't restore
6004 * overloading, we cannot croak as if the original ref was, because we
6005 * have no way to determine whether it was an overloaded ref or not in
6008 * It's a pity that overloading magic is attached to the rv, and not to
6009 * the underlying sv as blessing is.
6013 HV *stash = (HV *) SvSTASH(sv);
6014 SV *rv = newRV_noinc(sv);
6015 if (stash && Gv_AMG(stash)) {
6017 TRACEME(("restored overloading on root reference"));
6019 TRACEME(("ended do_retrieve() with an object"));
6023 TRACEME(("regular do_retrieve() end"));
6025 return newRV_noinc(sv);
6031 * Retrieve data held in file and return the root object, undef on error.
6033 SV *pretrieve(pTHX_ PerlIO *f)
6035 TRACEME(("pretrieve"));
6036 return do_retrieve(aTHX_ f, Nullsv, 0);
6042 * Retrieve data held in scalar and return the root object, undef on error.
6044 SV *mretrieve(pTHX_ SV *sv)
6046 TRACEME(("mretrieve"));
6047 return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
6057 * Deep clone: returns a fresh copy of the original referenced SV tree.
6059 * This is achieved by storing the object in memory and restoring from
6060 * there. Not that efficient, but it should be faster than doing it from
6063 SV *dclone(pTHX_ SV *sv)
6067 stcxt_t *real_context;
6070 TRACEME(("dclone"));
6073 * Workaround for CROAK leak: if they enter with a "dirty" context,
6074 * free up memory for them now.
6078 clean_context(aTHX_ cxt);
6081 * do_store() optimizes for dclone by not freeing its context, should
6082 * we need to allocate one because we're deep cloning from a hook.
6085 if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
6086 return &PL_sv_undef; /* Error during store */
6089 * Because of the above optimization, we have to refresh the context,
6090 * since a new one could have been allocated and stacked by do_store().
6093 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
6094 cxt = real_context; /* And we need this temporary... */
6097 * Now, `cxt' may refer to a new context.
6100 ASSERT(!cxt->s_dirty, ("clean context"));
6101 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
6104 TRACEME(("dclone stored %d bytes", size));
6108 * Since we're passing do_retrieve() both a NULL file and sv, we need
6109 * to pre-compute the taintedness of the input by setting cxt->tainted
6110 * to whatever state our own input string was. -- RAM, 15/09/2000
6112 * do_retrieve() will free non-root context.
6115 cxt->s_tainted = SvTAINTED(sv);
6116 out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
6118 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
6128 * The Perl IO GV object distinguishes between input and output for sockets
6129 * but not for plain files. To allow Storable to transparently work on
6130 * plain files and sockets transparently, we have to ask xsubpp to fetch the
6131 * right object for us. Hence the OutputStream and InputStream declarations.
6133 * Before perl 5.004_05, those entries in the standard typemap are not
6134 * defined in perl include files, so we do that here.
6137 #ifndef OutputStream
6138 #define OutputStream PerlIO *
6139 #define InputStream PerlIO *
6140 #endif /* !OutputStream */
6142 MODULE = Storable PACKAGE = Storable::Cxt
6148 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
6152 if (!cxt->membuf_ro && mbase)
6154 if (cxt->membuf_ro && (cxt->msaved).arena)
6155 Safefree((cxt->msaved).arena);
6158 MODULE = Storable PACKAGE = Storable
6163 init_perinterp(aTHX);
6164 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
6166 /* Only disable the used only once warning if we are in debugging mode. */
6167 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
6169 #ifdef USE_56_INTERWORK_KLUDGE
6170 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
6176 init_perinterp(aTHX);
6183 RETVAL = pstore(aTHX_ f, obj);
6192 RETVAL = net_pstore(aTHX_ f, obj);
6200 RETVAL = mstore(aTHX_ obj);
6208 RETVAL = net_mstore(aTHX_ obj);
6216 RETVAL = pretrieve(aTHX_ f);
6224 RETVAL = mretrieve(aTHX_ sv);
6232 RETVAL = dclone(aTHX_ sv);
6237 last_op_in_netorder()
6239 RETVAL = last_op_in_netorder(aTHX);
6246 RETVAL = is_storing(aTHX);
6253 RETVAL = is_retrieving(aTHX);