2 * Store and retrieve mechanism.
4 * Copyright (c) 1995-2000, Raphael Manfredi
6 * You may redistribute only under the same terms as Perl 5, as specified
7 * in the README file that comes with the distribution.
11 #define PERL_NO_GET_CONTEXT /* we want efficiency */
17 #include <patchlevel.h> /* Perl's one, needed since 5.6 */
20 #if !defined(PERL_VERSION) || PERL_VERSION < 8 || (PERL_VERSION == 8 && PERL_SUBVERSION < 9) || (PERL_VERSION == 10 && PERL_SUBVERSION < 1)
21 #define NEED_load_module
22 #define NEED_vload_module
23 #define NEED_newCONSTSUB
24 #define NEED_newSVpvn_flags
25 #include "ppport.h" /* handle old perls */
29 #define DEBUGME /* Debug mode, turns assertions on as well */
30 #define DASSERT /* Assertion mode */
34 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
35 * Provide them with the necessary defines so they can build with pre-5.004.
38 #ifndef PERLIO_IS_STDIO
40 #define PerlIO_getc(x) getc(x)
41 #define PerlIO_putc(f,x) putc(x,f)
42 #define PerlIO_read(x,y,z) fread(y,1,z,x)
43 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
44 #define PerlIO_stdoutf printf
45 #endif /* PERLIO_IS_STDIO */
46 #endif /* USE_PERLIO */
49 * Earlier versions of perl might be used, we can't assume they have the latest!
52 #ifndef PERL_VERSION /* For perls < 5.6 */
53 #define PERL_VERSION PATCHLEVEL
55 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
57 #if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
58 #define PL_sv_yes sv_yes
59 #define PL_sv_no sv_no
60 #define PL_sv_undef sv_undef
61 #if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
62 #define newSVpvn newSVpv
64 #endif /* PATCHLEVEL <= 4 */
65 #ifndef HvSHAREKEYS_off
66 #define HvSHAREKEYS_off(hv) /* Ignore */
68 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
69 #define AvFILLp AvFILL
71 typedef double NV; /* Older perls lack the NV type */
72 #define IVdf "ld" /* Various printf formats for Perl types */
76 #define INT2PTR(t,v) (t)(IV)(v)
77 #define PTR2UV(v) (unsigned long)(v)
78 #endif /* PERL_VERSION -- perls < 5.6 */
80 #ifndef NVef /* The following were not part of perl 5.6 */
81 #if defined(USE_LONG_DOUBLE) && \
82 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
83 #define NVef PERL_PRIeldbl
84 #define NVff PERL_PRIfldbl
85 #define NVgf PERL_PRIgldbl
94 #define SvRV_set(sv, val) \
96 assert(SvTYPE(sv) >= SVt_RV); \
97 (((XRV*)SvANY(sv))->xrv_rv = (val)); \
101 #ifndef PERL_UNUSED_DECL
103 # if (defined(__GNUC__) && defined(__cplusplus)) || defined(__INTEL_COMPILER)
104 # define PERL_UNUSED_DECL
106 # define PERL_UNUSED_DECL __attribute__((unused))
109 # define PERL_UNUSED_DECL
114 #define dNOOP extern int Perl___notused PERL_UNUSED_DECL
122 # define HvRITER_set(hv,r) (HvRITER(hv) = r)
125 # define HvEITER_set(hv,r) (HvEITER(hv) = r)
129 # define HvRITER_get HvRITER
132 # define HvEITER_get HvEITER
136 #define HvNAME_get HvNAME
139 #ifndef HvPLACEHOLDERS_get
140 # define HvPLACEHOLDERS_get HvPLACEHOLDERS
150 * TRACEME() will only output things when the $Storable::DEBUGME is true.
155 if (SvTRUE(perl_get_sv("Storable::DEBUGME", GV_ADD))) \
156 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
163 #define ASSERT(x,y) \
166 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
167 __FILE__, __LINE__); \
168 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
179 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
181 #define SX_OBJECT C(0) /* Already stored object */
182 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
183 #define SX_ARRAY C(2) /* Array forthcoming (size, item list) */
184 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
185 #define SX_REF C(4) /* Reference to object forthcoming */
186 #define SX_UNDEF C(5) /* Undefined scalar */
187 #define SX_INTEGER C(6) /* Integer forthcoming */
188 #define SX_DOUBLE C(7) /* Double forthcoming */
189 #define SX_BYTE C(8) /* (signed) byte forthcoming */
190 #define SX_NETINT C(9) /* Integer in network order forthcoming */
191 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
192 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
193 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
194 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
195 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
196 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
197 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
198 #define SX_BLESS C(17) /* Object is blessed */
199 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
200 #define SX_HOOK C(19) /* Stored via hook, user-defined */
201 #define SX_OVERLOAD C(20) /* Overloaded reference */
202 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
203 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
204 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
205 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
206 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
207 #define SX_CODE C(26) /* Code references as perl source code */
208 #define SX_WEAKREF C(27) /* Weak reference to object forthcoming */
209 #define SX_WEAKOVERLOAD C(28) /* Overloaded weak reference */
210 #define SX_ERROR C(29) /* Error */
213 * Those are only used to retrieve "old" pre-0.6 binary images.
215 #define SX_ITEM 'i' /* An array item introducer */
216 #define SX_IT_UNDEF 'I' /* Undefined array item */
217 #define SX_KEY 'k' /* A hash key introducer */
218 #define SX_VALUE 'v' /* A hash value introducer */
219 #define SX_VL_UNDEF 'V' /* Undefined hash value */
222 * Those are only used to retrieve "old" pre-0.7 binary images
225 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
226 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
227 #define SX_STORED 'X' /* End of object */
230 * Limits between short/long length representation.
233 #define LG_SCALAR 255 /* Large scalar length limit */
234 #define LG_BLESS 127 /* Large classname bless limit */
240 #define ST_STORE 0x1 /* Store operation */
241 #define ST_RETRIEVE 0x2 /* Retrieval operation */
242 #define ST_CLONE 0x4 /* Deep cloning operation */
245 * The following structure is used for hash table key retrieval. Since, when
246 * retrieving objects, we'll be facing blessed hash references, it's best
247 * to pre-allocate that buffer once and resize it as the need arises, never
248 * freeing it (keys will be saved away someplace else anyway, so even large
249 * keys are not enough a motivation to reclaim that space).
251 * This structure is also used for memory store/retrieve operations which
252 * happen in a fixed place before being malloc'ed elsewhere if persistence
253 * is required. Hence the aptr pointer.
256 char *arena; /* Will hold hash key strings, resized as needed */
257 STRLEN asiz; /* Size of aforementioned buffer */
258 char *aptr; /* Arena pointer, for in-place read/write ops */
259 char *aend; /* First invalid address */
264 * A hash table records the objects which have already been stored.
265 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
266 * an arbitrary sequence number) is used to identify them.
269 * An array table records the objects which have already been retrieved,
270 * as seen by the tag determined by counting the objects themselves. The
271 * reference to that retrieved object is kept in the table, and is returned
272 * when an SX_OBJECT is found bearing that same tag.
274 * The same processing is used to record "classname" for blessed objects:
275 * indexing by a hash at store time, and via an array at retrieve time.
278 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
281 * The following "thread-safe" related defines were contributed by
282 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
283 * only renamed things a little bit to ensure consistency with surrounding
284 * code. -- RAM, 14/09/1999
286 * The original patch suffered from the fact that the stcxt_t structure
287 * was global. Murray tried to minimize the impact on the code as much as
290 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
291 * on objects. Therefore, the notion of context needs to be generalized,
295 #define MY_VERSION "Storable(" XS_VERSION ")"
299 * Conditional UTF8 support.
303 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
304 #define HAS_UTF8_SCALARS
306 #define HAS_UTF8_HASHES
309 /* 5.6 perl has utf8 scalars but not hashes */
313 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
316 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
319 #define WEAKREF_CROAK() CROAK(("Cannot retrieve weak references in this perl"))
322 #ifdef HvPLACEHOLDERS
323 #define HAS_RESTRICTED_HASHES
325 #define HVhek_PLACEHOLD 0x200
326 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
330 #define HAS_HASH_KEY_FLAGS
334 #define USE_PTR_TABLE
338 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
339 * files remap tainted and dirty when threading is enabled. That's bad for
340 * perl to remap such common words. -- RAM, 29/09/00
344 typedef struct stcxt {
345 int entry; /* flags recursion */
346 int optype; /* type of traversal operation */
347 /* which objects have been seen, store time.
348 tags are numbers, which are cast to (SV *) and stored directly */
350 /* use pseen if we have ptr_tables. We have to store tag+1, because
351 tag numbers start at 0, and we can't store (SV *) 0 in a ptr_table
352 without it being confused for a fetch lookup failure. */
353 struct ptr_tbl *pseen;
354 /* Still need hseen for the 0.6 file format code. */
357 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
358 AV *aseen; /* which objects have been seen, retrieve time */
359 IV where_is_undef; /* index in aseen of PL_sv_undef */
360 HV *hclass; /* which classnames have been seen, store time */
361 AV *aclass; /* which classnames have been seen, retrieve time */
362 HV *hook; /* cache for hook methods per class name */
363 IV tagnum; /* incremented at store time for each seen object */
364 IV classnum; /* incremented at store time for each seen classname */
365 int netorder; /* true if network order used */
366 int s_tainted; /* true if input source is tainted, at retrieve time */
367 int forgive_me; /* whether to be forgiving... */
368 int deparse; /* whether to deparse code refs */
369 SV *eval; /* whether to eval source code */
370 int canonical; /* whether to store hashes sorted by key */
371 #ifndef HAS_RESTRICTED_HASHES
372 int derestrict; /* whether to downgrade restricted hashes */
375 int use_bytes; /* whether to bytes-ify utf8 */
377 int accept_future_minor; /* croak immediately on future minor versions? */
378 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
379 int membuf_ro; /* true means membuf is read-only and msaved is rw */
380 struct extendable keybuf; /* for hash key retrieval */
381 struct extendable membuf; /* for memory store/retrieve operations */
382 struct extendable msaved; /* where potentially valid mbuf is saved */
383 PerlIO *fio; /* where I/O are performed, NULL for memory */
384 int ver_major; /* major of version for retrieved object */
385 int ver_minor; /* minor of version for retrieved object */
386 SV *(**retrieve_vtbl)(pTHX_ struct stcxt *, const char *); /* retrieve dispatch table */
387 SV *prev; /* contexts chained backwards in real recursion */
388 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
389 int in_retrieve_overloaded; /* performance hack for retrieving overloaded objects */
392 #define NEW_STORABLE_CXT_OBJ(cxt) \
394 SV *self = newSV(sizeof(stcxt_t) - 1); \
395 SV *my_sv = newRV_noinc(self); \
396 sv_bless(my_sv, gv_stashpv("Storable::Cxt", GV_ADD)); \
397 cxt = (stcxt_t *)SvPVX(self); \
398 Zero(cxt, 1, stcxt_t); \
399 cxt->my_sv = my_sv; \
402 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
404 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
406 SV *perinterp_sv = perl_get_sv(MY_VERSION, 0)
407 #else /* >= perl5.004_68 */
409 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
410 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
411 #endif /* < perl5.004_68 */
413 #define dSTCXT_PTR(T,name) \
414 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
415 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
418 dSTCXT_PTR(stcxt_t *, cxt)
422 NEW_STORABLE_CXT_OBJ(cxt); \
423 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
425 #define SET_STCXT(x) \
428 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
431 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
433 static stcxt_t *Context_ptr = NULL;
434 #define dSTCXT stcxt_t *cxt = Context_ptr
435 #define SET_STCXT(x) Context_ptr = x
438 NEW_STORABLE_CXT_OBJ(cxt); \
442 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
446 * Croaking implies a memory leak, since we don't use setjmp/longjmp
447 * to catch the exit and free memory used during store or retrieve
448 * operations. This is not too difficult to fix, but I need to understand
449 * how Perl does it, and croaking is exceptional anyway, so I lack the
450 * motivation to do it.
452 * The current workaround is to mark the context as dirty when croaking,
453 * so that data structures can be freed whenever we renter Storable code
454 * (but only *then*: it's a workaround, not a fix).
456 * This is also imperfect, because we don't really know how far they trapped
457 * the croak(), and when we were recursing, we won't be able to clean anything
458 * but the topmost context stacked.
461 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
464 * End of "thread-safe" related definitions.
470 * Keep only the low 32 bits of a pointer (used for tags, which are not
475 #define LOW_32BITS(x) ((I32) (x))
477 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
483 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
484 * Used in the WLEN and RLEN macros.
488 #define oI(x) ((I32 *) ((char *) (x) + 4))
489 #define oS(x) ((x) - 4)
490 #define oC(x) (x = 0)
499 * key buffer handling
501 #define kbuf (cxt->keybuf).arena
502 #define ksiz (cxt->keybuf).asiz
506 TRACEME(("** allocating kbuf of 128 bytes")); \
507 New(10003, kbuf, 128, char); \
514 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
515 Renew(kbuf, x+1, char); \
521 * memory buffer handling
523 #define mbase (cxt->membuf).arena
524 #define msiz (cxt->membuf).asiz
525 #define mptr (cxt->membuf).aptr
526 #define mend (cxt->membuf).aend
528 #define MGROW (1 << 13)
529 #define MMASK (MGROW - 1)
531 #define round_mgrow(x) \
532 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
533 #define trunc_int(x) \
534 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
535 #define int_aligned(x) \
536 ((unsigned long) (x) == trunc_int(x))
538 #define MBUF_INIT(x) \
541 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
542 New(10003, mbase, MGROW, char); \
543 msiz = (STRLEN)MGROW; \
549 mend = mbase + msiz; \
552 #define MBUF_TRUNC(x) mptr = mbase + x
553 #define MBUF_SIZE() (mptr - mbase)
559 * Those macros are used in do_retrieve() to save the current memory
560 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
561 * data from a string.
563 #define MBUF_SAVE_AND_LOAD(in) \
565 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
566 cxt->membuf_ro = 1; \
567 TRACEME(("saving mbuf")); \
568 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
572 #define MBUF_RESTORE() \
574 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
575 cxt->membuf_ro = 0; \
576 TRACEME(("restoring mbuf")); \
577 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
581 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
582 * See store_scalar() for other usage of this workaround.
584 #define MBUF_LOAD(v) \
586 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
588 CROAK(("Not a scalar string")); \
589 mptr = mbase = SvPV(v, msiz); \
590 mend = mbase + msiz; \
593 #define MBUF_XTEND(x) \
595 int nsz = (int) round_mgrow((x)+msiz); \
596 int offset = mptr - mbase; \
597 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
598 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
600 Renew(mbase, nsz, char); \
602 mptr = mbase + offset; \
603 mend = mbase + nsz; \
606 #define MBUF_CHK(x) \
608 if ((mptr + (x)) > mend) \
612 #define MBUF_GETC(x) \
615 x = (int) (unsigned char) *mptr++; \
621 #define MBUF_GETINT(x) \
624 if ((mptr + 4) <= mend) { \
625 memcpy(oI(&x), mptr, 4); \
631 #define MBUF_GETINT(x) \
633 if ((mptr + sizeof(int)) <= mend) { \
634 if (int_aligned(mptr)) \
637 memcpy(&x, mptr, sizeof(int)); \
638 mptr += sizeof(int); \
644 #define MBUF_READ(x,s) \
646 if ((mptr + (s)) <= mend) { \
647 memcpy(x, mptr, s); \
653 #define MBUF_SAFEREAD(x,s,z) \
655 if ((mptr + (s)) <= mend) { \
656 memcpy(x, mptr, s); \
664 #define MBUF_SAFEPVREAD(x,s,z) \
666 if ((mptr + (s)) <= mend) { \
667 memcpy(x, mptr, s); \
675 #define MBUF_PUTC(c) \
678 *mptr++ = (char) c; \
681 *mptr++ = (char) c; \
686 #define MBUF_PUTINT(i) \
689 memcpy(mptr, oI(&i), 4); \
693 #define MBUF_PUTINT(i) \
695 MBUF_CHK(sizeof(int)); \
696 if (int_aligned(mptr)) \
699 memcpy(mptr, &i, sizeof(int)); \
700 mptr += sizeof(int); \
704 #define MBUF_WRITE(x,s) \
707 memcpy(mptr, x, s); \
712 * Possible return values for sv_type().
716 #define svis_SCALAR 1
720 #define svis_TIED_ITEM 5
728 #define SHF_TYPE_MASK 0x03
729 #define SHF_LARGE_CLASSLEN 0x04
730 #define SHF_LARGE_STRLEN 0x08
731 #define SHF_LARGE_LISTLEN 0x10
732 #define SHF_IDX_CLASSNAME 0x20
733 #define SHF_NEED_RECURSE 0x40
734 #define SHF_HAS_LIST 0x80
737 * Types for SX_HOOK (last 2 bits in flags).
743 #define SHT_EXTRA 3 /* Read extra byte for type */
746 * The following are held in the "extra byte"...
749 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
750 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
751 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
754 * per hash flags for flagged hashes
757 #define SHV_RESTRICTED 0x01
760 * per key flags for flagged hashes
763 #define SHV_K_UTF8 0x01
764 #define SHV_K_WASUTF8 0x02
765 #define SHV_K_LOCKED 0x04
766 #define SHV_K_ISSV 0x08
767 #define SHV_K_PLACEHOLDER 0x10
770 * Before 0.6, the magic string was "perl-store" (binary version number 0).
772 * Since 0.6 introduced many binary incompatibilities, the magic string has
773 * been changed to "pst0" to allow an old image to be properly retrieved by
774 * a newer Storable, but ensure a newer image cannot be retrieved with an
777 * At 0.7, objects are given the ability to serialize themselves, and the
778 * set of markers is extended, backward compatibility is not jeopardized,
779 * so the binary version number could have remained unchanged. To correctly
780 * spot errors if a file making use of 0.7-specific extensions is given to
781 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
782 * a "minor" version, to better track this kind of evolution from now on.
785 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
786 static const char magicstr[] = "pst0"; /* Used as a magic number */
788 #define MAGICSTR_BYTES 'p','s','t','0'
789 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
791 /* 5.6.x introduced the ability to have IVs as long long.
792 However, Configure still defined BYTEORDER based on the size of a long.
793 Storable uses the BYTEORDER value as part of the header, but doesn't
794 explicitly store sizeof(IV) anywhere in the header. Hence on 5.6.x built
795 with IV as long long on a platform that uses Configure (ie most things
796 except VMS and Windows) headers are identical for the different IV sizes,
797 despite the files containing some fields based on sizeof(IV)
799 5.8 is consistent - the following redefinition kludge is only needed on
800 5.6.x, but the interwork is needed on 5.8 while data survives in files
805 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
806 #ifndef NO_56_INTERWORK_KLUDGE
807 #define USE_56_INTERWORK_KLUDGE
809 #if BYTEORDER == 0x1234
811 #define BYTEORDER 0x12345678
813 #if BYTEORDER == 0x4321
815 #define BYTEORDER 0x87654321
820 #if BYTEORDER == 0x1234
821 #define BYTEORDER_BYTES '1','2','3','4'
823 #if BYTEORDER == 0x12345678
824 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
825 #ifdef USE_56_INTERWORK_KLUDGE
826 #define BYTEORDER_BYTES_56 '1','2','3','4'
829 #if BYTEORDER == 0x87654321
830 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
831 #ifdef USE_56_INTERWORK_KLUDGE
832 #define BYTEORDER_BYTES_56 '4','3','2','1'
835 #if BYTEORDER == 0x4321
836 #define BYTEORDER_BYTES '4','3','2','1'
838 #error Unknown byteorder. Please append your byteorder to Storable.xs
844 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
845 #ifdef USE_56_INTERWORK_KLUDGE
846 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
849 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
850 #define STORABLE_BIN_MINOR 8 /* Binary minor "version" */
852 #if (PATCHLEVEL <= 5)
853 #define STORABLE_BIN_WRITE_MINOR 4
856 * Perl 5.6.0 onwards can do weak references.
858 #define STORABLE_BIN_WRITE_MINOR 8
859 #endif /* (PATCHLEVEL <= 5) */
861 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
862 #define PL_sv_placeholder PL_sv_undef
866 * Useful store shortcuts...
870 * Note that if you put more than one mark for storing a particular
871 * type of thing, *and* in the retrieve_foo() function you mark both
872 * the thingy's you get off with SEEN(), you *must* increase the
873 * tagnum with cxt->tagnum++ along with this macro!
880 else if (PerlIO_putc(cxt->fio, x) == EOF) \
884 #define WRITE_I32(x) \
886 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
889 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
896 if (cxt->netorder) { \
897 int y = (int) htonl(x); \
900 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
905 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
910 #define WLEN(x) WRITE_I32(x)
917 else if (PerlIO_write(cxt->fio, x, y) != y) \
921 #define STORE_PV_LEN(pv, len, small, large) \
923 if (len <= LG_SCALAR) { \
924 unsigned char clen = (unsigned char) len; \
936 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
939 * Store &PL_sv_undef in arrays without recursing through store().
941 #define STORE_SV_UNDEF() \
944 PUTMARK(SX_SV_UNDEF); \
948 * Useful retrieve shortcuts...
952 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
958 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
962 #define READ_I32(x) \
964 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
968 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
978 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
981 x = (int) ntohl(x); \
984 #define RLEN(x) READ_I32(x)
991 else if (PerlIO_read(cxt->fio, x, y) != y) \
995 #define SAFEREAD(x,y,z) \
998 MBUF_SAFEREAD(x,y,z); \
999 else if (PerlIO_read(cxt->fio, x, y) != y) { \
1005 #define SAFEPVREAD(x,y,z) \
1008 MBUF_SAFEPVREAD(x,y,z); \
1009 else if (PerlIO_read(cxt->fio, x, y) != y) { \
1016 * This macro is used at retrieve time, to remember where object 'y', bearing a
1017 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
1018 * we'll therefore know where it has been retrieved and will be able to
1019 * share the same reference, as in the original stored memory image.
1021 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
1022 * on the objects given to STORABLE_thaw and expect that to be defined), and
1023 * also for overloaded objects (for which we might not find the stash if the
1024 * object is not blessed yet--this might occur for overloaded objects that
1025 * refer to themselves indirectly: if we blessed upon return from a sub
1026 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
1027 * restored on it because the underlying object would not be blessed yet!).
1029 * To achieve that, the class name of the last retrieved object is passed down
1030 * recursively, and the first SEEN() call for which the class name is not NULL
1031 * will bless the object.
1033 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
1035 #define SEEN(y,c,i) \
1039 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
1041 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
1042 PTR2UV(y), SvREFCNT(y)-1)); \
1044 BLESS((SV *) (y), c); \
1048 * Bless `s' in `p', via a temporary reference, required by sv_bless().
1049 * "A" magic is added before the sv_bless for overloaded classes, this avoids
1050 * an expensive call to S_reset_amagic in sv_bless.
1052 #define BLESS(s,p) \
1056 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
1057 stash = gv_stashpv((p), GV_ADD); \
1058 ref = newRV_noinc(s); \
1059 if (cxt->in_retrieve_overloaded && Gv_AMG(stash)) \
1061 cxt->in_retrieve_overloaded = 0; \
1064 (void) sv_bless(ref, stash); \
1065 SvRV_set(ref, NULL); \
1066 SvREFCNT_dec(ref); \
1069 * sort (used in store_hash) - conditionally use qsort when
1070 * sortsv is not available ( <= 5.6.1 ).
1073 #if (PATCHLEVEL <= 6)
1075 #if defined(USE_ITHREADS)
1077 #define STORE_HASH_SORT \
1079 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
1080 SAVESPTR(orig_perl); \
1081 PERL_SET_CONTEXT(aTHX); \
1082 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
1085 #else /* ! USE_ITHREADS */
1087 #define STORE_HASH_SORT \
1088 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1090 #endif /* USE_ITHREADS */
1092 #else /* PATCHLEVEL > 6 */
1094 #define STORE_HASH_SORT \
1095 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1097 #endif /* PATCHLEVEL <= 6 */
1099 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1100 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname);
1103 * Dynamic dispatching table for SV store.
1106 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1107 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1108 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1109 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1110 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1111 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1112 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1113 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1114 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1116 typedef int (*sv_store_t)(pTHX_ stcxt_t *cxt, SV *sv);
1118 static const sv_store_t sv_store[] = {
1119 (sv_store_t)store_ref, /* svis_REF */
1120 (sv_store_t)store_scalar, /* svis_SCALAR */
1121 (sv_store_t)store_array, /* svis_ARRAY */
1122 (sv_store_t)store_hash, /* svis_HASH */
1123 (sv_store_t)store_tied, /* svis_TIED */
1124 (sv_store_t)store_tied_item, /* svis_TIED_ITEM */
1125 (sv_store_t)store_code, /* svis_CODE */
1126 (sv_store_t)store_other, /* svis_OTHER */
1129 #define SV_STORE(x) (*sv_store[x])
1132 * Dynamic dispatching tables for SV retrieval.
1135 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname);
1136 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname);
1137 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1138 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1139 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname);
1140 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname);
1141 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname);
1142 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname);
1143 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname);
1144 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname);
1145 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1146 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname);
1147 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname);
1148 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname);
1149 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1150 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname);
1152 typedef SV* (*sv_retrieve_t)(pTHX_ stcxt_t *cxt, const char *name);
1154 static const sv_retrieve_t sv_old_retrieve[] = {
1155 0, /* SX_OBJECT -- entry unused dynamically */
1156 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1157 (sv_retrieve_t)old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1158 (sv_retrieve_t)old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1159 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1160 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1161 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1162 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1163 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1164 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1165 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1166 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1167 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1168 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1169 (sv_retrieve_t)retrieve_other, /* SX_SV_UNDEF not supported */
1170 (sv_retrieve_t)retrieve_other, /* SX_SV_YES not supported */
1171 (sv_retrieve_t)retrieve_other, /* SX_SV_NO not supported */
1172 (sv_retrieve_t)retrieve_other, /* SX_BLESS not supported */
1173 (sv_retrieve_t)retrieve_other, /* SX_IX_BLESS not supported */
1174 (sv_retrieve_t)retrieve_other, /* SX_HOOK not supported */
1175 (sv_retrieve_t)retrieve_other, /* SX_OVERLOADED not supported */
1176 (sv_retrieve_t)retrieve_other, /* SX_TIED_KEY not supported */
1177 (sv_retrieve_t)retrieve_other, /* SX_TIED_IDX not supported */
1178 (sv_retrieve_t)retrieve_other, /* SX_UTF8STR not supported */
1179 (sv_retrieve_t)retrieve_other, /* SX_LUTF8STR not supported */
1180 (sv_retrieve_t)retrieve_other, /* SX_FLAG_HASH not supported */
1181 (sv_retrieve_t)retrieve_other, /* SX_CODE not supported */
1182 (sv_retrieve_t)retrieve_other, /* SX_WEAKREF not supported */
1183 (sv_retrieve_t)retrieve_other, /* SX_WEAKOVERLOAD not supported */
1184 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1187 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1188 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1189 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname);
1190 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname);
1191 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname);
1192 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1193 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1194 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname);
1195 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname);
1196 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname);
1197 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname);
1198 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname);
1199 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname);
1200 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname);
1201 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname);
1203 static const sv_retrieve_t sv_retrieve[] = {
1204 0, /* SX_OBJECT -- entry unused dynamically */
1205 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1206 (sv_retrieve_t)retrieve_array, /* SX_ARRAY */
1207 (sv_retrieve_t)retrieve_hash, /* SX_HASH */
1208 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1209 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1210 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1211 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1212 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1213 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1214 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1215 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1216 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1217 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1218 (sv_retrieve_t)retrieve_sv_undef, /* SX_SV_UNDEF */
1219 (sv_retrieve_t)retrieve_sv_yes, /* SX_SV_YES */
1220 (sv_retrieve_t)retrieve_sv_no, /* SX_SV_NO */
1221 (sv_retrieve_t)retrieve_blessed, /* SX_BLESS */
1222 (sv_retrieve_t)retrieve_idx_blessed, /* SX_IX_BLESS */
1223 (sv_retrieve_t)retrieve_hook, /* SX_HOOK */
1224 (sv_retrieve_t)retrieve_overloaded, /* SX_OVERLOAD */
1225 (sv_retrieve_t)retrieve_tied_key, /* SX_TIED_KEY */
1226 (sv_retrieve_t)retrieve_tied_idx, /* SX_TIED_IDX */
1227 (sv_retrieve_t)retrieve_utf8str, /* SX_UTF8STR */
1228 (sv_retrieve_t)retrieve_lutf8str, /* SX_LUTF8STR */
1229 (sv_retrieve_t)retrieve_flag_hash, /* SX_HASH */
1230 (sv_retrieve_t)retrieve_code, /* SX_CODE */
1231 (sv_retrieve_t)retrieve_weakref, /* SX_WEAKREF */
1232 (sv_retrieve_t)retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
1233 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1236 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1238 static SV *mbuf2sv(pTHX);
1241 *** Context management.
1247 * Called once per "thread" (interpreter) to initialize some global context.
1249 static void init_perinterp(pTHX)
1253 cxt->netorder = 0; /* true if network order used */
1254 cxt->forgive_me = -1; /* whether to be forgiving... */
1255 cxt->accept_future_minor = -1; /* would otherwise occur too late */
1261 * Called at the end of every context cleaning, to perform common reset
1264 static void reset_context(stcxt_t *cxt)
1268 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1272 * init_store_context
1274 * Initialize a new store context for real recursion.
1276 static void init_store_context(
1283 TRACEME(("init_store_context"));
1285 cxt->netorder = network_order;
1286 cxt->forgive_me = -1; /* Fetched from perl if needed */
1287 cxt->deparse = -1; /* Idem */
1288 cxt->eval = NULL; /* Idem */
1289 cxt->canonical = -1; /* Idem */
1290 cxt->tagnum = -1; /* Reset tag numbers */
1291 cxt->classnum = -1; /* Reset class numbers */
1292 cxt->fio = f; /* Where I/O are performed */
1293 cxt->optype = optype; /* A store, or a deep clone */
1294 cxt->entry = 1; /* No recursion yet */
1297 * The `hseen' table is used to keep track of each SV stored and their
1298 * associated tag numbers is special. It is "abused" because the
1299 * values stored are not real SV, just integers cast to (SV *),
1300 * which explains the freeing below.
1302 * It is also one possible bottleneck to achieve good storing speed,
1303 * so the "shared keys" optimization is turned off (unlikely to be
1304 * of any use here), and the hash table is "pre-extended". Together,
1305 * those optimizations increase the throughput by 12%.
1308 #ifdef USE_PTR_TABLE
1309 cxt->pseen = ptr_table_new();
1312 cxt->hseen = newHV(); /* Table where seen objects are stored */
1313 HvSHAREKEYS_off(cxt->hseen);
1316 * The following does not work well with perl5.004_04, and causes
1317 * a core dump later on, in a completely unrelated spot, which
1318 * makes me think there is a memory corruption going on.
1320 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1321 * it below does not make any difference. It seems to work fine
1322 * with perl5.004_68 but given the probable nature of the bug,
1323 * that does not prove anything.
1325 * It's a shame because increasing the amount of buckets raises
1326 * store() throughput by 5%, but until I figure this out, I can't
1327 * allow for this to go into production.
1329 * It is reported fixed in 5.005, hence the #if.
1331 #if PERL_VERSION >= 5
1332 #define HBUCKETS 4096 /* Buckets for %hseen */
1333 #ifndef USE_PTR_TABLE
1334 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1339 * The `hclass' hash uses the same settings as `hseen' above, but it is
1340 * used to assign sequential tags (numbers) to class names for blessed
1343 * We turn the shared key optimization on.
1346 cxt->hclass = newHV(); /* Where seen classnames are stored */
1348 #if PERL_VERSION >= 5
1349 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1353 * The `hook' hash table is used to keep track of the references on
1354 * the STORABLE_freeze hook routines, when found in some class name.
1356 * It is assumed that the inheritance tree will not be changed during
1357 * storing, and that no new method will be dynamically created by the
1361 cxt->hook = newHV(); /* Table where hooks are cached */
1364 * The `hook_seen' array keeps track of all the SVs returned by
1365 * STORABLE_freeze hooks for us to serialize, so that they are not
1366 * reclaimed until the end of the serialization process. Each SV is
1367 * only stored once, the first time it is seen.
1370 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1374 * clean_store_context
1376 * Clean store context by
1378 static void clean_store_context(pTHX_ stcxt_t *cxt)
1382 TRACEME(("clean_store_context"));
1384 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1387 * Insert real values into hashes where we stored faked pointers.
1390 #ifndef USE_PTR_TABLE
1392 hv_iterinit(cxt->hseen);
1393 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1394 HeVAL(he) = &PL_sv_undef;
1399 hv_iterinit(cxt->hclass);
1400 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1401 HeVAL(he) = &PL_sv_undef;
1405 * And now dispose of them...
1407 * The surrounding if() protection has been added because there might be
1408 * some cases where this routine is called more than once, during
1409 * exceptional events. This was reported by Marc Lehmann when Storable
1410 * is executed from mod_perl, and the fix was suggested by him.
1411 * -- RAM, 20/12/2000
1414 #ifdef USE_PTR_TABLE
1416 struct ptr_tbl *pseen = cxt->pseen;
1418 ptr_table_free(pseen);
1420 assert(!cxt->hseen);
1423 HV *hseen = cxt->hseen;
1426 sv_free((SV *) hseen);
1431 HV *hclass = cxt->hclass;
1434 sv_free((SV *) hclass);
1438 HV *hook = cxt->hook;
1441 sv_free((SV *) hook);
1444 if (cxt->hook_seen) {
1445 AV *hook_seen = cxt->hook_seen;
1447 av_undef(hook_seen);
1448 sv_free((SV *) hook_seen);
1451 cxt->forgive_me = -1; /* Fetched from perl if needed */
1452 cxt->deparse = -1; /* Idem */
1454 SvREFCNT_dec(cxt->eval);
1456 cxt->eval = NULL; /* Idem */
1457 cxt->canonical = -1; /* Idem */
1463 * init_retrieve_context
1465 * Initialize a new retrieve context for real recursion.
1467 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1469 TRACEME(("init_retrieve_context"));
1472 * The hook hash table is used to keep track of the references on
1473 * the STORABLE_thaw hook routines, when found in some class name.
1475 * It is assumed that the inheritance tree will not be changed during
1476 * storing, and that no new method will be dynamically created by the
1480 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1482 #ifdef USE_PTR_TABLE
1487 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1488 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1489 * the correspondence between the tags and the tag number used by the
1490 * new retrieve routines.
1493 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1496 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1497 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1498 cxt->aclass = newAV(); /* Where seen classnames are kept */
1499 cxt->tagnum = 0; /* Have to count objects... */
1500 cxt->classnum = 0; /* ...and class names as well */
1501 cxt->optype = optype;
1502 cxt->s_tainted = is_tainted;
1503 cxt->entry = 1; /* No recursion yet */
1504 #ifndef HAS_RESTRICTED_HASHES
1505 cxt->derestrict = -1; /* Fetched from perl if needed */
1507 #ifndef HAS_UTF8_ALL
1508 cxt->use_bytes = -1; /* Fetched from perl if needed */
1510 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1511 cxt->in_retrieve_overloaded = 0;
1515 * clean_retrieve_context
1517 * Clean retrieve context by
1519 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1521 TRACEME(("clean_retrieve_context"));
1523 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1526 AV *aseen = cxt->aseen;
1529 sv_free((SV *) aseen);
1531 cxt->where_is_undef = -1;
1534 AV *aclass = cxt->aclass;
1537 sv_free((SV *) aclass);
1541 HV *hook = cxt->hook;
1544 sv_free((SV *) hook);
1548 HV *hseen = cxt->hseen;
1551 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1554 #ifndef HAS_RESTRICTED_HASHES
1555 cxt->derestrict = -1; /* Fetched from perl if needed */
1557 #ifndef HAS_UTF8_ALL
1558 cxt->use_bytes = -1; /* Fetched from perl if needed */
1560 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1562 cxt->in_retrieve_overloaded = 0;
1569 * A workaround for the CROAK bug: cleanup the last context.
1571 static void clean_context(pTHX_ stcxt_t *cxt)
1573 TRACEME(("clean_context"));
1575 ASSERT(cxt->s_dirty, ("dirty context"));
1580 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1582 if (cxt->optype & ST_RETRIEVE)
1583 clean_retrieve_context(aTHX_ cxt);
1584 else if (cxt->optype & ST_STORE)
1585 clean_store_context(aTHX_ cxt);
1589 ASSERT(!cxt->s_dirty, ("context is clean"));
1590 ASSERT(cxt->entry == 0, ("context is reset"));
1596 * Allocate a new context and push it on top of the parent one.
1597 * This new context is made globally visible via SET_STCXT().
1599 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1603 TRACEME(("allocate_context"));
1605 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1607 NEW_STORABLE_CXT_OBJ(cxt);
1608 cxt->prev = parent_cxt->my_sv;
1611 ASSERT(!cxt->s_dirty, ("clean context"));
1619 * Free current context, which cannot be the "root" one.
1620 * Make the context underneath globally visible via SET_STCXT().
1622 static void free_context(pTHX_ stcxt_t *cxt)
1624 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1626 TRACEME(("free_context"));
1628 ASSERT(!cxt->s_dirty, ("clean context"));
1629 ASSERT(prev, ("not freeing root context"));
1631 SvREFCNT_dec(cxt->my_sv);
1634 ASSERT(cxt, ("context not void"));
1644 * Tells whether we're in the middle of a store operation.
1646 static int is_storing(pTHX)
1650 return cxt->entry && (cxt->optype & ST_STORE);
1656 * Tells whether we're in the middle of a retrieve operation.
1658 static int is_retrieving(pTHX)
1662 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1666 * last_op_in_netorder
1668 * Returns whether last operation was made using network order.
1670 * This is typically out-of-band information that might prove useful
1671 * to people wishing to convert native to network order data when used.
1673 static int last_op_in_netorder(pTHX)
1677 return cxt->netorder;
1681 *** Hook lookup and calling routines.
1687 * A wrapper on gv_fetchmethod_autoload() which caches results.
1689 * Returns the routine reference as an SV*, or null if neither the package
1690 * nor its ancestors know about the method.
1692 static SV *pkg_fetchmeth(
1700 const char *hvname = HvNAME_get(pkg);
1704 * The following code is the same as the one performed by UNIVERSAL::can
1708 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1709 if (gv && isGV(gv)) {
1710 sv = newRV((SV*) GvCV(gv));
1711 TRACEME(("%s->%s: 0x%"UVxf, hvname, method, PTR2UV(sv)));
1713 sv = newSVsv(&PL_sv_undef);
1714 TRACEME(("%s->%s: not found", hvname, method));
1718 * Cache the result, ignoring failure: if we can't store the value,
1719 * it just won't be cached.
1722 (void) hv_store(cache, hvname, strlen(hvname), sv, 0);
1724 return SvOK(sv) ? sv : (SV *) 0;
1730 * Force cached value to be undef: hook ignored even if present.
1732 static void pkg_hide(
1738 const char *hvname = HvNAME_get(pkg);
1739 PERL_UNUSED_ARG(method);
1740 (void) hv_store(cache,
1741 hvname, strlen(hvname), newSVsv(&PL_sv_undef), 0);
1747 * Discard cached value: a whole fetch loop will be retried at next lookup.
1749 static void pkg_uncache(
1755 const char *hvname = HvNAME_get(pkg);
1756 PERL_UNUSED_ARG(method);
1757 (void) hv_delete(cache, hvname, strlen(hvname), G_DISCARD);
1763 * Our own "UNIVERSAL::can", which caches results.
1765 * Returns the routine reference as an SV*, or null if the object does not
1766 * know about the method.
1776 const char *hvname = HvNAME_get(pkg);
1778 TRACEME(("pkg_can for %s->%s", hvname, method));
1781 * Look into the cache to see whether we already have determined
1782 * where the routine was, if any.
1784 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1785 * that only one hook (i.e. always the same) is cached in a given cache.
1788 svh = hv_fetch(cache, hvname, strlen(hvname), FALSE);
1792 TRACEME(("cached %s->%s: not found", hvname, method));
1795 TRACEME(("cached %s->%s: 0x%"UVxf,
1796 hvname, method, PTR2UV(sv)));
1801 TRACEME(("not cached yet"));
1802 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1808 * Call routine as obj->hook(av) in scalar context.
1809 * Propagates the single returned value if not called in void context.
1811 static SV *scalar_call(
1823 TRACEME(("scalar_call (cloning=%d)", cloning));
1830 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1832 SV **ary = AvARRAY(av);
1833 int cnt = AvFILLp(av) + 1;
1835 XPUSHs(ary[0]); /* Frozen string */
1836 for (i = 1; i < cnt; i++) {
1837 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1838 i, PTR2UV(ary[i])));
1839 XPUSHs(sv_2mortal(newRV(ary[i])));
1844 TRACEME(("calling..."));
1845 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1846 TRACEME(("count = %d", count));
1852 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1865 * Call routine obj->hook(cloning) in list context.
1866 * Returns the list of returned values in an array.
1868 static AV *array_call(
1879 TRACEME(("array_call (cloning=%d)", cloning));
1885 XPUSHs(obj); /* Target object */
1886 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1889 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1894 for (i = count - 1; i >= 0; i--) {
1896 av_store(av, i, SvREFCNT_inc(sv));
1909 * Lookup the class name in the `hclass' table and either assign it a new ID
1910 * or return the existing one, by filling in `classnum'.
1912 * Return true if the class was known, false if the ID was just generated.
1914 static int known_class(
1917 char *name, /* Class name */
1918 int len, /* Name length */
1922 HV *hclass = cxt->hclass;
1924 TRACEME(("known_class (%s)", name));
1927 * Recall that we don't store pointers in this hash table, but tags.
1928 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1931 svh = hv_fetch(hclass, name, len, FALSE);
1933 *classnum = LOW_32BITS(*svh);
1938 * Unknown classname, we need to record it.
1942 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1943 CROAK(("Unable to record new classname"));
1945 *classnum = cxt->classnum;
1950 *** Specific store routines.
1956 * Store a reference.
1957 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1959 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1962 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1965 * Follow reference, and check if target is overloaded.
1971 TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1976 HV *stash = (HV *) SvSTASH(sv);
1977 if (stash && Gv_AMG(stash)) {
1978 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1979 PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1981 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1983 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1985 return store(aTHX_ cxt, sv);
1993 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1994 * The <data> section is omitted if <length> is 0.
1996 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1997 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1999 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
2004 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
2006 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
2009 * For efficiency, break the SV encapsulation by peaking at the flags
2010 * directly without using the Perl macros to avoid dereferencing
2011 * sv->sv_flags each time we wish to check the flags.
2014 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
2015 if (sv == &PL_sv_undef) {
2016 TRACEME(("immortal undef"));
2017 PUTMARK(SX_SV_UNDEF);
2019 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
2026 * Always store the string representation of a scalar if it exists.
2027 * Gisle Aas provided me with this test case, better than a long speach:
2029 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
2030 * SV = PVNV(0x80c8520)
2032 * FLAGS = (NOK,POK,pNOK,pPOK)
2035 * PV = 0x80c83d0 "abc"\0
2039 * Write SX_SCALAR, length, followed by the actual data.
2041 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
2042 * appropriate, followed by the actual (binary) data. A double
2043 * is written as a string if network order, for portability.
2045 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
2046 * The reason is that when the scalar value is tainted, the SvNOK(sv)
2049 * The test for a read-only scalar with both POK and NOK set is meant
2050 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
2051 * address comparison for each scalar we store.
2054 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
2056 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
2057 if (sv == &PL_sv_yes) {
2058 TRACEME(("immortal yes"));
2060 } else if (sv == &PL_sv_no) {
2061 TRACEME(("immortal no"));
2064 pv = SvPV(sv, len); /* We know it's SvPOK */
2065 goto string; /* Share code below */
2067 } else if (flags & SVf_POK) {
2068 /* public string - go direct to string read. */
2069 goto string_readlen;
2071 #if (PATCHLEVEL <= 6)
2072 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
2073 direct if NV flag is off. */
2074 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
2076 /* 5.7 rules are that if IV public flag is set, IV value is as
2077 good, if not better, than NV value. */
2083 * Will come here from below with iv set if double is an integer.
2087 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2089 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
2090 * (for example) and that ends up in the optimised small integer
2093 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
2094 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
2095 goto string_readlen;
2099 * Optimize small integers into a single byte, otherwise store as
2100 * a real integer (converted into network order if they asked).
2103 if (iv >= -128 && iv <= 127) {
2104 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
2107 TRACEME(("small integer stored as %d", siv));
2108 } else if (cxt->netorder) {
2110 TRACEME(("no htonl, fall back to string for integer"));
2111 goto string_readlen;
2119 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2120 ((flags & SVf_IVisUV) && SvUV(sv) > (UV)0x7FFFFFFF) ||
2122 (iv > (IV)0x7FFFFFFF) || (iv < -(IV)0x80000000)) {
2123 /* Bigger than 32 bits. */
2124 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2125 goto string_readlen;
2129 niv = (I32) htonl((I32) iv);
2130 TRACEME(("using network order"));
2135 PUTMARK(SX_INTEGER);
2136 WRITE(&iv, sizeof(iv));
2139 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2140 } else if (flags & SVf_NOK) {
2142 #if (PATCHLEVEL <= 6)
2145 * Watch for number being an integer in disguise.
2147 if (nv == (NV) (iv = I_V(nv))) {
2148 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2149 goto integer; /* Share code above */
2154 if (SvIOK_notUV(sv)) {
2156 goto integer; /* Share code above */
2161 if (cxt->netorder) {
2162 TRACEME(("double %"NVff" stored as string", nv));
2163 goto string_readlen; /* Share code below */
2167 WRITE(&nv, sizeof(nv));
2169 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2171 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2172 I32 wlen; /* For 64-bit machines */
2178 * Will come here from above if it was readonly, POK and NOK but
2179 * neither &PL_sv_yes nor &PL_sv_no.
2183 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2185 STORE_UTF8STR(pv, wlen);
2187 STORE_SCALAR(pv, wlen);
2188 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2189 PTR2UV(sv), SvPVX(sv), (IV)len));
2191 CROAK(("Can't determine type of %s(0x%"UVxf")",
2192 sv_reftype(sv, FALSE),
2194 return 0; /* Ok, no recursion on scalars */
2202 * Layout is SX_ARRAY <size> followed by each item, in increasing index order.
2203 * Each item is stored as <object>.
2205 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2208 I32 len = av_len(av) + 1;
2212 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2215 * Signal array by emitting SX_ARRAY, followed by the array length.
2220 TRACEME(("size = %d", len));
2223 * Now store each item recursively.
2226 for (i = 0; i < len; i++) {
2227 sav = av_fetch(av, i, 0);
2229 TRACEME(("(#%d) undef item", i));
2233 TRACEME(("(#%d) item", i));
2234 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2238 TRACEME(("ok (array)"));
2244 #if (PATCHLEVEL <= 6)
2250 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2253 sortcmp(const void *a, const void *b)
2255 #if defined(USE_ITHREADS)
2257 #endif /* USE_ITHREADS */
2258 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2261 #endif /* PATCHLEVEL <= 6 */
2266 * Store a hash table.
2268 * For a "normal" hash (not restricted, no utf8 keys):
2270 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2271 * Values are stored as <object>.
2272 * Keys are stored as <length> <data>, the <data> section being omitted
2275 * For a "fancy" hash (restricted or utf8 keys):
2277 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2279 * Values are stored as <object>.
2280 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2282 * Currently the only hash flag is "restricted"
2283 * Key flags are as for hv.h
2285 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2289 #ifdef HAS_RESTRICTED_HASHES
2298 int flagged_hash = ((SvREADONLY(hv)
2299 #ifdef HAS_HASH_KEY_FLAGS
2303 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2306 /* needs int cast for C++ compilers, doesn't it? */
2307 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2310 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2314 * Signal hash by emitting SX_HASH, followed by the table length.
2318 PUTMARK(SX_FLAG_HASH);
2319 PUTMARK(hash_flags);
2324 TRACEME(("size = %d", len));
2327 * Save possible iteration state via each() on that table.
2330 riter = HvRITER_get(hv);
2331 eiter = HvEITER_get(hv);
2335 * Now store each item recursively.
2337 * If canonical is defined to some true value then store each
2338 * key/value pair in sorted order otherwise the order is random.
2339 * Canonical order is irrelevant when a deep clone operation is performed.
2341 * Fetch the value from perl only once per store() operation, and only
2346 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2347 (cxt->canonical < 0 && (cxt->canonical =
2348 (SvTRUE(perl_get_sv("Storable::canonical", GV_ADD)) ? 1 : 0))))
2351 * Storing in order, sorted by key.
2352 * Run through the hash, building up an array of keys in a
2353 * mortal array, sort the array and then run through the
2359 /*av_extend (av, len);*/
2361 TRACEME(("using canonical order"));
2363 for (i = 0; i < len; i++) {
2364 #ifdef HAS_RESTRICTED_HASHES
2365 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2367 HE *he = hv_iternext(hv);
2372 CROAK(("Hash %p inconsistent - expected %d keys, %dth is NULL", hv, (int)len, (int)i));
2373 key = hv_iterkeysv(he);
2374 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2379 for (i = 0; i < len; i++) {
2380 #ifdef HAS_RESTRICTED_HASHES
2381 int placeholders = (int)HvPLACEHOLDERS_get(hv);
2383 unsigned char flags = 0;
2387 SV *key = av_shift(av);
2388 /* This will fail if key is a placeholder.
2389 Track how many placeholders we have, and error if we
2391 HE *he = hv_fetch_ent(hv, key, 0, 0);
2395 if (!(val = HeVAL(he))) {
2396 /* Internal error, not I/O error */
2400 #ifdef HAS_RESTRICTED_HASHES
2401 /* Should be a placeholder. */
2402 if (placeholders-- < 0) {
2403 /* This should not happen - number of
2404 retrieves should be identical to
2405 number of placeholders. */
2408 /* Value is never needed, and PL_sv_undef is
2409 more space efficient to store. */
2412 ("Flags not 0 but %d", flags));
2413 flags = SHV_K_PLACEHOLDER;
2420 * Store value first.
2423 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2425 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2430 * Keys are written after values to make sure retrieval
2431 * can be optimal in terms of memory usage, where keys are
2432 * read into a fixed unique buffer called kbuf.
2433 * See retrieve_hash() for details.
2436 /* Implementation of restricted hashes isn't nicely
2438 if ((hash_flags & SHV_RESTRICTED)
2439 && SvREADONLY(val) && !SvIsCOW(val)) {
2440 flags |= SHV_K_LOCKED;
2443 keyval = SvPV(key, keylen_tmp);
2444 keylen = keylen_tmp;
2445 #ifdef HAS_UTF8_HASHES
2446 /* If you build without optimisation on pre 5.6
2447 then nothing spots that SvUTF8(key) is always 0,
2448 so the block isn't optimised away, at which point
2449 the linker dislikes the reference to
2452 const char *keysave = keyval;
2453 bool is_utf8 = TRUE;
2455 /* Just casting the &klen to (STRLEN) won't work
2456 well if STRLEN and I32 are of different widths.
2458 keyval = (char*)bytes_from_utf8((U8*)keyval,
2462 /* If we were able to downgrade here, then than
2463 means that we have a key which only had chars
2464 0-255, but was utf8 encoded. */
2466 if (keyval != keysave) {
2467 keylen = keylen_tmp;
2468 flags |= SHV_K_WASUTF8;
2470 /* keylen_tmp can't have changed, so no need
2471 to assign back to keylen. */
2472 flags |= SHV_K_UTF8;
2479 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2481 /* This is a workaround for a bug in 5.8.0
2482 that causes the HEK_WASUTF8 flag to be
2483 set on an HEK without the hash being
2484 marked as having key flags. We just
2485 cross our fingers and drop the flag.
2487 assert (flags == 0 || flags == SHV_K_WASUTF8);
2488 TRACEME(("(#%d) key '%s'", i, keyval));
2492 WRITE(keyval, keylen);
2493 if (flags & SHV_K_WASUTF8)
2498 * Free up the temporary array
2507 * Storing in "random" order (in the order the keys are stored
2508 * within the hash). This is the default and will be faster!
2511 for (i = 0; i < len; i++) {
2514 unsigned char flags;
2515 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2516 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2518 HE *he = hv_iternext(hv);
2520 SV *val = (he ? hv_iterval(hv, he) : 0);
2525 return 1; /* Internal error, not I/O error */
2527 /* Implementation of restricted hashes isn't nicely
2530 = (((hash_flags & SHV_RESTRICTED)
2531 && SvREADONLY(val) && !SvIsCOW(val))
2532 ? SHV_K_LOCKED : 0);
2534 if (val == &PL_sv_placeholder) {
2535 flags |= SHV_K_PLACEHOLDER;
2540 * Store value first.
2543 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2545 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2549 hek = HeKEY_hek(he);
2551 if (len == HEf_SVKEY) {
2552 /* This is somewhat sick, but the internal APIs are
2553 * such that XS code could put one of these in in
2555 * Maybe we should be capable of storing one if
2558 key_sv = HeKEY_sv(he);
2559 flags |= SHV_K_ISSV;
2561 /* Regular string key. */
2562 #ifdef HAS_HASH_KEY_FLAGS
2564 flags |= SHV_K_UTF8;
2565 if (HEK_WASUTF8(hek))
2566 flags |= SHV_K_WASUTF8;
2572 * Keys are written after values to make sure retrieval
2573 * can be optimal in terms of memory usage, where keys are
2574 * read into a fixed unique buffer called kbuf.
2575 * See retrieve_hash() for details.
2580 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2582 /* This is a workaround for a bug in 5.8.0
2583 that causes the HEK_WASUTF8 flag to be
2584 set on an HEK without the hash being
2585 marked as having key flags. We just
2586 cross our fingers and drop the flag.
2588 assert (flags == 0 || flags == SHV_K_WASUTF8);
2589 TRACEME(("(#%d) key '%s'", i, key));
2591 if (flags & SHV_K_ISSV) {
2592 store(aTHX_ cxt, key_sv);
2601 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2604 HvRITER_set(hv, riter); /* Restore hash iterator state */
2605 HvEITER_set(hv, eiter);
2613 * Store a code reference.
2615 * Layout is SX_CODE <length> followed by a scalar containing the perl
2616 * source code of the code reference.
2618 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2620 #if PERL_VERSION < 6
2622 * retrieve_code does not work with perl 5.005 or less
2624 return store_other(aTHX_ cxt, (SV*)cv);
2629 SV *text, *bdeparse;
2631 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2634 cxt->deparse == 0 ||
2635 (cxt->deparse < 0 && !(cxt->deparse =
2636 SvTRUE(perl_get_sv("Storable::Deparse", GV_ADD)) ? 1 : 0))
2638 return store_other(aTHX_ cxt, (SV*)cv);
2642 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2643 * blessed code references.
2645 /* Ownership of both SVs is passed to load_module, which frees them. */
2646 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2653 * create the B::Deparse object
2657 XPUSHs(newSVpvs_flags("B::Deparse", SVs_TEMP));
2659 count = call_method("new", G_SCALAR);
2662 CROAK(("Unexpected return value from B::Deparse::new\n"));
2666 * call the coderef2text method
2670 XPUSHs(bdeparse); /* XXX is this already mortal? */
2671 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2673 count = call_method("coderef2text", G_SCALAR);
2676 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2680 reallen = strlen(SvPV_nolen(text));
2683 * Empty code references or XS functions are deparsed as
2684 * "(prototype) ;" or ";".
2687 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2688 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2692 * Signal code by emitting SX_CODE.
2696 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2697 TRACEME(("size = %d", len));
2698 TRACEME(("code = %s", SvPV_nolen(text)));
2701 * Now store the source code.
2705 STORE_UTF8STR(SvPV_nolen(text), len);
2707 STORE_SCALAR(SvPV_nolen(text), len);
2712 TRACEME(("ok (code)"));
2721 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2722 * a special mark, followed by the underlying tied object. For instance, when
2723 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2724 * <hash object> stands for the serialization of the tied hash.
2726 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2731 int svt = SvTYPE(sv);
2734 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2737 * We have a small run-time penalty here because we chose to factorise
2738 * all tieds objects into the same routine, and not have a store_tied_hash,
2739 * a store_tied_array, etc...
2741 * Don't use a switch() statement, as most compilers don't optimize that
2742 * well for 2/3 values. An if() else if() cascade is just fine. We put
2743 * tied hashes first, as they are the most likely beasts.
2746 if (svt == SVt_PVHV) {
2747 TRACEME(("tied hash"));
2748 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2749 } else if (svt == SVt_PVAV) {
2750 TRACEME(("tied array"));
2751 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2753 TRACEME(("tied scalar"));
2754 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2758 if (!(mg = mg_find(sv, mtype)))
2759 CROAK(("No magic '%c' found while storing tied %s", mtype,
2760 (svt == SVt_PVHV) ? "hash" :
2761 (svt == SVt_PVAV) ? "array" : "scalar"));
2764 * The mg->mg_obj found by mg_find() above actually points to the
2765 * underlying tied Perl object implementation. For instance, if the
2766 * original SV was that of a tied array, then mg->mg_obj is an AV.
2768 * Note that we store the Perl object as-is. We don't call its FETCH
2769 * method along the way. At retrieval time, we won't call its STORE
2770 * method either, but the tieing magic will be re-installed. In itself,
2771 * that ensures that the tieing semantics are preserved since further
2772 * accesses on the retrieved object will indeed call the magic methods...
2775 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2776 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2777 if ((ret = store(aTHX_ cxt, obj)))
2780 TRACEME(("ok (tied)"));
2788 * Stores a reference to an item within a tied structure:
2790 * . \$h{key}, stores both the (tied %h) object and 'key'.
2791 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2793 * Layout is therefore either:
2794 * SX_TIED_KEY <object> <key>
2795 * SX_TIED_IDX <object> <index>
2797 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2802 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2804 if (!(mg = mg_find(sv, 'p')))
2805 CROAK(("No magic 'p' found while storing reference to tied item"));
2808 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2812 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2813 PUTMARK(SX_TIED_KEY);
2814 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2816 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2819 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2821 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2824 I32 idx = mg->mg_len;
2826 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2827 PUTMARK(SX_TIED_IDX);
2828 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2830 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2833 TRACEME(("store_tied_item: storing IDX %d", idx));
2838 TRACEME(("ok (tied item)"));
2844 * store_hook -- dispatched manually, not via sv_store[]
2846 * The blessed SV is serialized by a hook.
2850 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2852 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2853 * the trailing part [] is present, the type of object (scalar, array or hash).
2854 * There is also a bit which says how the classname is stored between:
2859 * and when the <index> form is used (classname already seen), the "large
2860 * classname" bit in <flags> indicates how large the <index> is.
2862 * The serialized string returned by the hook is of length <len2> and comes
2863 * next. It is an opaque string for us.
2865 * Those <len3> object IDs which are listed last represent the extra references
2866 * not directly serialized by the hook, but which are linked to the object.
2868 * When recursion is mandated to resolve object-IDs not yet seen, we have
2869 * instead, with <header> being flags with bits set to indicate the object type
2870 * and that recursion was indeed needed:
2872 * SX_HOOK <header> <object> <header> <object> <flags>
2874 * that same header being repeated between serialized objects obtained through
2875 * recursion, until we reach flags indicating no recursion, at which point
2876 * we know we've resynchronized with a single layout, after <flags>.
2878 * When storing a blessed ref to a tied variable, the following format is
2881 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2883 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2884 * real object type is held in the <extra> flag. At the very end of the
2885 * serialization stream, the underlying magic object is serialized, just like
2886 * any other tied variable.
2888 static int store_hook(
2902 int count; /* really len3 + 1 */
2903 unsigned char flags;
2906 int recursed = 0; /* counts recursion */
2907 int obj_type; /* object type, on 2 bits */
2910 int clone = cxt->optype & ST_CLONE;
2911 char mtype = '\0'; /* for blessed ref to tied structures */
2912 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2914 TRACEME(("store_hook, classname \"%s\", tagged #%d", HvNAME_get(pkg), cxt->tagnum));
2917 * Determine object type on 2 bits.
2922 obj_type = SHT_SCALAR;
2925 obj_type = SHT_ARRAY;
2928 obj_type = SHT_HASH;
2932 * Produced by a blessed ref to a tied data structure, $o in the
2933 * following Perl code.
2937 * my $o = bless \%h, 'BAR';
2939 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2940 * (since we have only 2 bits in <flags> to store the type), and an
2941 * <extra> byte flag will be emitted after the FIRST <flags> in the
2942 * stream, carrying what we put in `eflags'.
2944 obj_type = SHT_EXTRA;
2945 switch (SvTYPE(sv)) {
2947 eflags = (unsigned char) SHT_THASH;
2951 eflags = (unsigned char) SHT_TARRAY;
2955 eflags = (unsigned char) SHT_TSCALAR;
2961 CROAK(("Unexpected object type (%d) in store_hook()", type));
2963 flags = SHF_NEED_RECURSE | obj_type;
2965 classname = HvNAME_get(pkg);
2966 len = strlen(classname);
2969 * To call the hook, we need to fake a call like:
2971 * $object->STORABLE_freeze($cloning);
2973 * but we don't have the $object here. For instance, if $object is
2974 * a blessed array, what we have in `sv' is the array, and we can't
2975 * call a method on those.
2977 * Therefore, we need to create a temporary reference to the object and
2978 * make the call on that reference.
2981 TRACEME(("about to call STORABLE_freeze on class %s", classname));
2983 ref = newRV_noinc(sv); /* Temporary reference */
2984 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2985 SvRV_set(ref, NULL);
2986 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2988 count = AvFILLp(av) + 1;
2989 TRACEME(("store_hook, array holds %d items", count));
2992 * If they return an empty list, it means they wish to ignore the
2993 * hook for this class (and not just this instance -- that's for them
2994 * to handle if they so wish).
2996 * Simply disable the cached entry for the hook (it won't be recomputed
2997 * since it's present in the cache) and recurse to store_blessed().
3002 * They must not change their mind in the middle of a serialization.
3005 if (hv_fetch(cxt->hclass, classname, len, FALSE))
3006 CROAK(("Too late to ignore hooks for %s class \"%s\"",
3007 (cxt->optype & ST_CLONE) ? "cloning" : "storing", classname));
3009 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3011 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
3012 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", classname));
3014 return store_blessed(aTHX_ cxt, sv, type, pkg);
3018 * Get frozen string.
3022 pv = SvPV(ary[0], len2);
3023 /* We can't use pkg_can here because it only caches one method per
3026 GV* gv = gv_fetchmethod_autoload(pkg, "STORABLE_attach", FALSE);
3027 if (gv && isGV(gv)) {
3029 CROAK(("Freeze cannot return references if %s class is using STORABLE_attach", classname));
3035 * If they returned more than one item, we need to serialize some
3036 * extra references if not already done.
3038 * Loop over the array, starting at position #1, and for each item,
3039 * ensure it is a reference, serialize it if not already done, and
3040 * replace the entry with the tag ID of the corresponding serialized
3043 * We CHEAT by not calling av_fetch() and read directly within the
3047 for (i = 1; i < count; i++) {
3048 #ifdef USE_PTR_TABLE
3056 AV *av_hook = cxt->hook_seen;
3059 CROAK(("Item #%d returned by STORABLE_freeze "
3060 "for %s is not a reference", i, classname));
3061 xsv = SvRV(rsv); /* Follow ref to know what to look for */
3064 * Look in hseen and see if we have a tag already.
3065 * Serialize entry if not done already, and get its tag.
3068 #ifdef USE_PTR_TABLE
3069 /* Fakery needed because ptr_table_fetch returns zero for a
3070 failure, whereas the existing code assumes that it can
3071 safely store a tag zero. So for ptr_tables we store tag+1
3073 if ((fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv)))
3074 goto sv_seen; /* Avoid moving code too far to the right */
3076 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
3077 goto sv_seen; /* Avoid moving code too far to the right */
3080 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
3083 * We need to recurse to store that object and get it to be known
3084 * so that we can resolve the list of object-IDs at retrieve time.
3086 * The first time we do this, we need to emit the proper header
3087 * indicating that we recursed, and what the type of object is (the
3088 * object we're storing via a user-hook). Indeed, during retrieval,
3089 * we'll have to create the object before recursing to retrieve the
3090 * others, in case those would point back at that object.
3093 /* [SX_HOOK] <flags> [<extra>] <object>*/
3097 if (obj_type == SHT_EXTRA)
3102 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
3105 #ifdef USE_PTR_TABLE
3106 fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv);
3108 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3110 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
3112 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3115 * It was the first time we serialized `xsv'.
3117 * Keep this SV alive until the end of the serialization: if we
3118 * disposed of it right now by decrementing its refcount, and it was
3119 * a temporary value, some next temporary value allocated during
3120 * another STORABLE_freeze might take its place, and we'd wrongly
3121 * assume that new SV was already serialized, based on its presence
3124 * Therefore, push it away in cxt->hook_seen.
3127 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
3131 * Dispose of the REF they returned. If we saved the `xsv' away
3132 * in the array of returned SVs, that will not cause the underlying
3133 * referenced SV to be reclaimed.
3136 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
3137 SvREFCNT_dec(rsv); /* Dispose of reference */
3140 * Replace entry with its tag (not a real SV, so no refcnt increment)
3143 #ifdef USE_PTR_TABLE
3144 tag = (SV *)--fake_tag;
3149 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
3150 i-1, PTR2UV(xsv), PTR2UV(tag)));
3154 * Allocate a class ID if not already done.
3156 * This needs to be done after the recursion above, since at retrieval
3157 * time, we'll see the inner objects first. Many thanks to
3158 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
3159 * proposed the right fix. -- RAM, 15/09/2000
3163 if (!known_class(aTHX_ cxt, classname, len, &classnum)) {
3164 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3165 classnum = -1; /* Mark: we must store classname */
3167 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3171 * Compute leading flags.
3175 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3176 flags |= SHF_LARGE_CLASSLEN;
3178 flags |= SHF_IDX_CLASSNAME;
3179 if (len2 > LG_SCALAR)
3180 flags |= SHF_LARGE_STRLEN;
3182 flags |= SHF_HAS_LIST;
3183 if (count > (LG_SCALAR + 1))
3184 flags |= SHF_LARGE_LISTLEN;
3187 * We're ready to emit either serialized form:
3189 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3190 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3192 * If we recursed, the SX_HOOK has already been emitted.
3195 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3196 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3197 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3199 /* SX_HOOK <flags> [<extra>] */
3203 if (obj_type == SHT_EXTRA)
3208 /* <len> <classname> or <index> */
3209 if (flags & SHF_IDX_CLASSNAME) {
3210 if (flags & SHF_LARGE_CLASSLEN)
3213 unsigned char cnum = (unsigned char) classnum;
3217 if (flags & SHF_LARGE_CLASSLEN)
3220 unsigned char clen = (unsigned char) len;
3223 WRITE(classname, len); /* Final \0 is omitted */
3226 /* <len2> <frozen-str> */
3227 if (flags & SHF_LARGE_STRLEN) {
3228 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3229 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3231 unsigned char clen = (unsigned char) len2;
3235 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3237 /* [<len3> <object-IDs>] */
3238 if (flags & SHF_HAS_LIST) {
3239 int len3 = count - 1;
3240 if (flags & SHF_LARGE_LISTLEN)
3243 unsigned char clen = (unsigned char) len3;
3248 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3249 * real pointer, rather a tag number, well under the 32-bit limit.
3252 for (i = 1; i < count; i++) {
3253 I32 tagval = htonl(LOW_32BITS(ary[i]));
3255 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3260 * Free the array. We need extra care for indices after 0, since they
3261 * don't hold real SVs but integers cast.
3265 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3270 * If object was tied, need to insert serialization of the magic object.
3273 if (obj_type == SHT_EXTRA) {
3276 if (!(mg = mg_find(sv, mtype))) {
3277 int svt = SvTYPE(sv);
3278 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3279 mtype, (svt == SVt_PVHV) ? "hash" :
3280 (svt == SVt_PVAV) ? "array" : "scalar"));
3283 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3284 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3290 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3298 * store_blessed -- dispatched manually, not via sv_store[]
3300 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3301 * of its ancestors. If there is, then redispatch to store_hook();
3303 * Otherwise, the blessed SV is stored using the following layout:
3305 * SX_BLESS <flag> <len> <classname> <object>
3307 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3308 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3309 * Otherwise, the low order bits give the length, thereby giving a compact
3310 * representation for class names less than 127 chars long.
3312 * Each <classname> seen is remembered and indexed, so that the next time
3313 * an object in the blessed in the same <classname> is stored, the following
3316 * SX_IX_BLESS <flag> <index> <object>
3318 * where <index> is the classname index, stored on 0 or 4 bytes depending
3319 * on the high-order bit in flag (same encoding as above for <len>).
3321 static int store_blessed(
3333 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME_get(pkg)));
3336 * Look for a hook for this blessed SV and redirect to store_hook()
3340 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3342 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3345 * This is a blessed SV without any serialization hook.
3348 classname = HvNAME_get(pkg);
3349 len = strlen(classname);
3351 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3352 PTR2UV(sv), classname, cxt->tagnum));
3355 * Determine whether it is the first time we see that class name (in which
3356 * case it will be stored in the SX_BLESS form), or whether we already
3357 * saw that class name before (in which case the SX_IX_BLESS form will be
3361 if (known_class(aTHX_ cxt, classname, len, &classnum)) {
3362 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3363 PUTMARK(SX_IX_BLESS);
3364 if (classnum <= LG_BLESS) {
3365 unsigned char cnum = (unsigned char) classnum;
3368 unsigned char flag = (unsigned char) 0x80;
3373 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3375 if (len <= LG_BLESS) {
3376 unsigned char clen = (unsigned char) len;
3379 unsigned char flag = (unsigned char) 0x80;
3381 WLEN(len); /* Don't BER-encode, this should be rare */
3383 WRITE(classname, len); /* Final \0 is omitted */
3387 * Now emit the <object> part.
3390 return SV_STORE(type)(aTHX_ cxt, sv);
3396 * We don't know how to store the item we reached, so return an error condition.
3397 * (it's probably a GLOB, some CODE reference, etc...)
3399 * If they defined the `forgive_me' variable at the Perl level to some
3400 * true value, then don't croak, just warn, and store a placeholder string
3403 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3408 TRACEME(("store_other"));
3411 * Fetch the value from perl only once per store() operation.
3415 cxt->forgive_me == 0 ||
3416 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3417 SvTRUE(perl_get_sv("Storable::forgive_me", GV_ADD)) ? 1 : 0))
3419 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3421 warn("Can't store item %s(0x%"UVxf")",
3422 sv_reftype(sv, FALSE), PTR2UV(sv));
3425 * Store placeholder string as a scalar instead...
3428 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3429 PTR2UV(sv), (char) 0);
3432 STORE_SCALAR(buf, len);
3433 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3439 *** Store driving routines
3445 * WARNING: partially duplicates Perl's sv_reftype for speed.
3447 * Returns the type of the SV, identified by an integer. That integer
3448 * may then be used to index the dynamic routine dispatch table.
3450 static int sv_type(pTHX_ SV *sv)
3452 switch (SvTYPE(sv)) {
3454 #if PERL_VERSION <= 10
3459 * No need to check for ROK, that can't be set here since there
3460 * is no field capable of hodling the xrv_rv reference.
3464 #if PERL_VERSION <= 10
3472 * Starting from SVt_PV, it is possible to have the ROK flag
3473 * set, the pointer to the other SV being either stored in
3474 * the xrv_rv (in the case of a pure SVt_RV), or as the
3475 * xpv_pv field of an SVt_PV and its heirs.
3477 * However, those SV cannot be magical or they would be an
3478 * SVt_PVMG at least.
3480 return SvROK(sv) ? svis_REF : svis_SCALAR;
3482 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3483 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3484 return svis_TIED_ITEM;
3486 #if PERL_VERSION < 9
3489 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3491 return SvROK(sv) ? svis_REF : svis_SCALAR;
3493 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3497 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3502 #if PERL_VERSION > 8
3503 /* case SVt_BIND: */
3515 * Recursively store objects pointed to by the sv to the specified file.
3517 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3518 * object (one for which storage has started -- it may not be over if we have
3519 * a self-referenced structure). This data set forms a stored <object>.
3521 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3526 #ifdef USE_PTR_TABLE
3527 struct ptr_tbl *pseen = cxt->pseen;
3529 HV *hseen = cxt->hseen;
3532 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3535 * If object has already been stored, do not duplicate data.
3536 * Simply emit the SX_OBJECT marker followed by its tag data.
3537 * The tag is always written in network order.
3539 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3540 * real pointer, rather a tag number (watch the insertion code below).
3541 * That means it probably safe to assume it is well under the 32-bit limit,
3542 * and makes the truncation safe.
3543 * -- RAM, 14/09/1999
3546 #ifdef USE_PTR_TABLE
3547 svh = (SV **)ptr_table_fetch(pseen, sv);
3549 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3554 if (sv == &PL_sv_undef) {
3555 /* We have seen PL_sv_undef before, but fake it as
3558 Not the simplest solution to making restricted
3559 hashes work on 5.8.0, but it does mean that
3560 repeated references to the one true undef will
3561 take up less space in the output file.
3563 /* Need to jump past the next hv_store, because on the
3564 second store of undef the old hash value will be
3565 SvREFCNT_dec()ed, and as Storable cheats horribly
3566 by storing non-SVs in the hash a SEGV will ensure.
3567 Need to increase the tag number so that the
3568 receiver has no idea what games we're up to. This
3569 special casing doesn't affect hooks that store
3570 undef, as the hook routine does its own lookup into
3571 hseen. Also this means that any references back
3572 to PL_sv_undef (from the pathological case of hooks
3573 storing references to it) will find the seen hash
3574 entry for the first time, as if we didn't have this
3575 hackery here. (That hseen lookup works even on 5.8.0
3576 because it's a key of &PL_sv_undef and a value
3577 which is a tag number, not a value which is
3581 goto undef_special_case;
3584 #ifdef USE_PTR_TABLE
3585 tagval = htonl(LOW_32BITS(((char *)svh)-1));
3587 tagval = htonl(LOW_32BITS(*svh));
3590 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3598 * Allocate a new tag and associate it with the address of the sv being
3599 * stored, before recursing...
3601 * In order to avoid creating new SvIVs to hold the tagnum we just
3602 * cast the tagnum to an SV pointer and store that in the hash. This
3603 * means that we must clean up the hash manually afterwards, but gives
3604 * us a 15% throughput increase.
3609 #ifdef USE_PTR_TABLE
3610 ptr_table_store(pseen, sv, INT2PTR(SV*, 1 + cxt->tagnum));
3612 if (!hv_store(hseen,
3613 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3618 * Store `sv' and everything beneath it, using appropriate routine.
3619 * Abort immediately if we get a non-zero status back.
3622 type = sv_type(aTHX_ sv);
3625 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3626 PTR2UV(sv), cxt->tagnum, type));
3629 HV *pkg = SvSTASH(sv);
3630 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3632 ret = SV_STORE(type)(aTHX_ cxt, sv);
3634 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3635 ret ? "FAILED" : "ok", PTR2UV(sv),
3636 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3644 * Write magic number and system information into the file.
3645 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3646 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3647 * All size and lenghts are written as single characters here.
3649 * Note that no byte ordering info is emitted when <network> is true, since
3650 * integers will be emitted in network order in that case.
3652 static int magic_write(pTHX_ stcxt_t *cxt)
3655 * Starting with 0.6, the "use_network_order" byte flag is also used to
3656 * indicate the version number of the binary image, encoded in the upper
3657 * bits. The bit 0 is always used to indicate network order.
3660 * Starting with 0.7, a full byte is dedicated to the minor version of
3661 * the binary format, which is incremented only when new markers are
3662 * introduced, for instance, but when backward compatibility is preserved.
3665 /* Make these at compile time. The WRITE() macro is sufficiently complex
3666 that it saves about 200 bytes doing it this way and only using it
3668 static const unsigned char network_file_header[] = {
3670 (STORABLE_BIN_MAJOR << 1) | 1,
3671 STORABLE_BIN_WRITE_MINOR
3673 static const unsigned char file_header[] = {
3675 (STORABLE_BIN_MAJOR << 1) | 0,
3676 STORABLE_BIN_WRITE_MINOR,
3677 /* sizeof the array includes the 0 byte at the end: */
3678 (char) sizeof (byteorderstr) - 1,
3680 (unsigned char) sizeof(int),
3681 (unsigned char) sizeof(long),
3682 (unsigned char) sizeof(char *),
3683 (unsigned char) sizeof(NV)
3685 #ifdef USE_56_INTERWORK_KLUDGE
3686 static const unsigned char file_header_56[] = {
3688 (STORABLE_BIN_MAJOR << 1) | 0,
3689 STORABLE_BIN_WRITE_MINOR,
3690 /* sizeof the array includes the 0 byte at the end: */
3691 (char) sizeof (byteorderstr_56) - 1,
3693 (unsigned char) sizeof(int),
3694 (unsigned char) sizeof(long),
3695 (unsigned char) sizeof(char *),
3696 (unsigned char) sizeof(NV)
3699 const unsigned char *header;
3702 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3704 if (cxt->netorder) {
3705 header = network_file_header;
3706 length = sizeof (network_file_header);
3708 #ifdef USE_56_INTERWORK_KLUDGE
3709 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", GV_ADD))) {
3710 header = file_header_56;
3711 length = sizeof (file_header_56);
3715 header = file_header;
3716 length = sizeof (file_header);
3721 /* sizeof the array includes the 0 byte at the end. */
3722 header += sizeof (magicstr) - 1;
3723 length -= sizeof (magicstr) - 1;
3726 WRITE( (unsigned char*) header, length);
3728 if (!cxt->netorder) {
3729 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3730 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3731 (int) sizeof(int), (int) sizeof(long),
3732 (int) sizeof(char *), (int) sizeof(NV)));
3740 * Common code for store operations.
3742 * When memory store is requested (f = NULL) and a non null SV* is given in
3743 * `res', it is filled with a new SV created out of the memory buffer.
3745 * It is required to provide a non-null `res' when the operation type is not
3746 * dclone() and store() is performed to memory.
3748 static int do_store(
3759 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3760 ("must supply result SV pointer for real recursion to memory"));
3762 TRACEME(("do_store (optype=%d, netorder=%d)",
3763 optype, network_order));
3768 * Workaround for CROAK leak: if they enter with a "dirty" context,
3769 * free up memory for them now.
3773 clean_context(aTHX_ cxt);
3776 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3777 * re-enter store() via the hooks. We need to stack contexts.
3781 cxt = allocate_context(aTHX_ cxt);
3785 ASSERT(cxt->entry == 1, ("starting new recursion"));
3786 ASSERT(!cxt->s_dirty, ("clean context"));
3789 * Ensure sv is actually a reference. From perl, we called something
3791 * pstore(aTHX_ FILE, \@array);
3792 * so we must get the scalar value behind that reference.
3796 CROAK(("Not a reference"));
3797 sv = SvRV(sv); /* So follow it to know what to store */
3800 * If we're going to store to memory, reset the buffer.
3807 * Prepare context and emit headers.
3810 init_store_context(aTHX_ cxt, f, optype, network_order);
3812 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3813 return 0; /* Error */
3816 * Recursively store object...
3819 ASSERT(is_storing(aTHX), ("within store operation"));
3821 status = store(aTHX_ cxt, sv); /* Just do it! */
3824 * If they asked for a memory store and they provided an SV pointer,
3825 * make an SV string out of the buffer and fill their pointer.
3827 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3828 * an SV, since context cleanup might free the buffer if we did recurse.
3829 * (unless caller is dclone(), which is aware of that).
3832 if (!cxt->fio && res)
3833 *res = mbuf2sv(aTHX);
3838 * The "root" context is never freed, since it is meant to be always
3839 * handy for the common case where no recursion occurs at all (i.e.
3840 * we enter store() outside of any Storable code and leave it, period).
3841 * We know it's the "root" context because there's nothing stacked
3846 * When deep cloning, we don't free the context: doing so would force
3847 * us to copy the data in the memory buffer. Sicne we know we're
3848 * about to enter do_retrieve...
3851 clean_store_context(aTHX_ cxt);
3852 if (cxt->prev && !(cxt->optype & ST_CLONE))
3853 free_context(aTHX_ cxt);
3855 TRACEME(("do_store returns %d", status));
3867 * Build a new SV out of the content of the internal memory buffer.
3869 static SV *mbuf2sv(pTHX)
3873 return newSVpv(mbase, MBUF_SIZE());
3877 *** Specific retrieve callbacks.
3883 * Return an error via croak, since it is not possible that we get here
3884 * under normal conditions, when facing a file produced via pstore().
3886 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname)
3888 PERL_UNUSED_ARG(cname);
3890 cxt->ver_major != STORABLE_BIN_MAJOR &&
3891 cxt->ver_minor != STORABLE_BIN_MINOR
3893 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3894 cxt->fio ? "file" : "string",
3895 cxt->ver_major, cxt->ver_minor,
3896 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3898 CROAK(("Corrupted storable %s (binary v%d.%d)",
3899 cxt->fio ? "file" : "string",
3900 cxt->ver_major, cxt->ver_minor));
3903 return (SV *) 0; /* Just in case */
3907 * retrieve_idx_blessed
3909 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3910 * <index> can be coded on either 1 or 5 bytes.
3912 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3915 const char *classname;
3919 PERL_UNUSED_ARG(cname);
3920 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3921 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3923 GETMARK(idx); /* Index coded on a single char? */
3928 * Fetch classname in `aclass'
3931 sva = av_fetch(cxt->aclass, idx, FALSE);
3933 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3935 classname = SvPVX(*sva); /* We know it's a PV, by construction */
3937 TRACEME(("class ID %d => %s", idx, classname));
3940 * Retrieve object and bless it.
3943 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3951 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3952 * <len> can be coded on either 1 or 5 bytes.
3954 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3958 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3959 char *classname = buf;
3960 char *malloced_classname = NULL;
3962 PERL_UNUSED_ARG(cname);
3963 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3964 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3967 * Decode class name length and read that name.
3969 * Short classnames have two advantages: their length is stored on one
3970 * single byte, and the string can be read on the stack.
3973 GETMARK(len); /* Length coded on a single char? */
3976 TRACEME(("** allocating %d bytes for class name", len+1));
3977 New(10003, classname, len+1, char);
3978 malloced_classname = classname;
3980 SAFEPVREAD(classname, len, malloced_classname);
3981 classname[len] = '\0'; /* Mark string end */
3984 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3987 TRACEME(("new class name \"%s\" will bear ID = %d", classname, cxt->classnum));
3989 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len))) {
3990 Safefree(malloced_classname);
3995 * Retrieve object and bless it.
3998 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3999 if (malloced_classname)
4000 Safefree(malloced_classname);
4008 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
4009 * with leading mark already read, as usual.
4011 * When recursion was involved during serialization of the object, there
4012 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
4013 * we reach a <flags> marker with the recursion bit cleared.
4015 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
4016 * is held in the <extra> byte, and if the object is tied, the serialized
4017 * magic object comes at the very end:
4019 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
4021 * This means the STORABLE_thaw hook will NOT get a tied variable during its
4022 * processing (since we won't have seen the magic object by the time the hook
4023 * is called). See comments below for why it was done that way.
4025 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname)
4028 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
4029 char *classname = buf;
4040 int clone = cxt->optype & ST_CLONE;
4042 unsigned int extra_type = 0;
4044 PERL_UNUSED_ARG(cname);
4045 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
4046 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
4049 * Read flags, which tell us about the type, and whether we need to recurse.
4055 * Create the (empty) object, and mark it as seen.
4057 * This must be done now, because tags are incremented, and during
4058 * serialization, the object tag was affected before recursion could
4062 obj_type = flags & SHF_TYPE_MASK;
4068 sv = (SV *) newAV();
4071 sv = (SV *) newHV();
4075 * Read <extra> flag to know the type of the object.
4076 * Record associated magic type for later.
4078 GETMARK(extra_type);
4079 switch (extra_type) {
4085 sv = (SV *) newAV();
4089 sv = (SV *) newHV();
4093 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4097 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4099 SEEN(sv, 0, 0); /* Don't bless yet */
4102 * Whilst flags tell us to recurse, do so.
4104 * We don't need to remember the addresses returned by retrieval, because
4105 * all the references will be obtained through indirection via the object
4106 * tags in the object-ID list.
4108 * We need to decrement the reference count for these objects
4109 * because, if the user doesn't save a reference to them in the hook,
4110 * they must be freed when this context is cleaned.
4113 while (flags & SHF_NEED_RECURSE) {
4114 TRACEME(("retrieve_hook recursing..."));
4115 rv = retrieve(aTHX_ cxt, 0);
4119 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
4124 if (flags & SHF_IDX_CLASSNAME) {
4129 * Fetch index from `aclass'
4132 if (flags & SHF_LARGE_CLASSLEN)
4137 sva = av_fetch(cxt->aclass, idx, FALSE);
4139 CROAK(("Class name #%"IVdf" should have been seen already",
4142 classname = SvPVX(*sva); /* We know it's a PV, by construction */
4143 TRACEME(("class ID %d => %s", idx, classname));
4147 * Decode class name length and read that name.
4149 * NOTA BENE: even if the length is stored on one byte, we don't read
4150 * on the stack. Just like retrieve_blessed(), we limit the name to
4151 * LG_BLESS bytes. This is an arbitrary decision.
4153 char *malloced_classname = NULL;
4155 if (flags & SHF_LARGE_CLASSLEN)
4160 if (len > LG_BLESS) {
4161 TRACEME(("** allocating %d bytes for class name", len+1));
4162 New(10003, classname, len+1, char);
4163 malloced_classname = classname;
4166 SAFEPVREAD(classname, len, malloced_classname);
4167 classname[len] = '\0'; /* Mark string end */
4170 * Record new classname.
4173 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len))) {
4174 Safefree(malloced_classname);
4179 TRACEME(("class name: %s", classname));
4182 * Decode user-frozen string length and read it in an SV.
4184 * For efficiency reasons, we read data directly into the SV buffer.
4185 * To understand that code, read retrieve_scalar()
4188 if (flags & SHF_LARGE_STRLEN)
4193 frozen = NEWSV(10002, len2);
4195 SAFEREAD(SvPVX(frozen), len2, frozen);
4196 SvCUR_set(frozen, len2);
4197 *SvEND(frozen) = '\0';
4199 (void) SvPOK_only(frozen); /* Validates string pointer */
4200 if (cxt->s_tainted) /* Is input source tainted? */
4203 TRACEME(("frozen string: %d bytes", len2));
4206 * Decode object-ID list length, if present.
4209 if (flags & SHF_HAS_LIST) {
4210 if (flags & SHF_LARGE_LISTLEN)
4216 av_extend(av, len3 + 1); /* Leave room for [0] */
4217 AvFILLp(av) = len3; /* About to be filled anyway */
4221 TRACEME(("has %d object IDs to link", len3));
4224 * Read object-ID list into array.
4225 * Because we pre-extended it, we can cheat and fill it manually.
4227 * We read object tags and we can convert them into SV* on the fly
4228 * because we know all the references listed in there (as tags)
4229 * have been already serialized, hence we have a valid correspondence
4230 * between each of those tags and the recreated SV.
4234 SV **ary = AvARRAY(av);
4236 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
4243 svh = av_fetch(cxt->aseen, tag, FALSE);
4245 if (tag == cxt->where_is_undef) {
4246 /* av_fetch uses PL_sv_undef internally, hence this
4247 somewhat gruesome hack. */
4251 CROAK(("Object #%"IVdf" should have been retrieved already",
4256 ary[i] = SvREFCNT_inc(xsv);
4261 * Bless the object and look up the STORABLE_thaw hook.
4264 BLESS(sv, classname);
4266 /* Handle attach case; again can't use pkg_can because it only
4267 * caches one method */
4268 attach = gv_fetchmethod_autoload(SvSTASH(sv), "STORABLE_attach", FALSE);
4269 if (attach && isGV(attach)) {
4271 SV* attach_hook = newRV((SV*) GvCV(attach));
4274 CROAK(("STORABLE_attach called with unexpected references"));
4278 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4279 rv = newSVpv(classname, 0);
4280 attached = scalar_call(aTHX_ rv, attach_hook, clone, av, G_SCALAR);
4283 sv_derived_from(attached, classname))
4284 return SvRV(attached);
4285 CROAK(("STORABLE_attach did not return a %s object", classname));
4288 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4291 * Hook not found. Maybe they did not require the module where this
4292 * hook is defined yet?
4294 * If the load below succeeds, we'll be able to find the hook.
4295 * Still, it only works reliably when each class is defined in a
4299 TRACEME(("No STORABLE_thaw defined for objects of class %s", classname));
4300 TRACEME(("Going to load module '%s'", classname));
4301 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(classname, 0), Nullsv);
4304 * We cache results of pkg_can, so we need to uncache before attempting
4308 pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4309 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4312 CROAK(("No STORABLE_thaw defined for objects of class %s "
4313 "(even after a \"require %s;\")", classname, classname));
4317 * If we don't have an `av' yet, prepare one.
4318 * Then insert the frozen string as item [0].
4326 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4331 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4333 * where $object is our blessed (empty) object, $cloning is a boolean
4334 * telling whether we're running a deep clone, $frozen is the frozen
4335 * string the user gave us in his serializing hook, and @refs, which may
4336 * be empty, is the list of extra references he returned along for us
4339 * In effect, the hook is an alternate creation routine for the class,
4340 * the object itself being already created by the runtime.
4343 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4344 classname, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4347 (void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
4354 SvREFCNT_dec(frozen);
4357 if (!(flags & SHF_IDX_CLASSNAME) && classname != buf)
4358 Safefree(classname);
4361 * If we had an <extra> type, then the object was not as simple, and
4362 * we need to restore extra magic now.
4368 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4370 rv = retrieve(aTHX_ cxt, 0); /* Retrieve <magic object> */
4372 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4373 PTR2UV(rv), PTR2UV(sv)));
4375 switch (extra_type) {
4377 sv_upgrade(sv, SVt_PVMG);
4380 sv_upgrade(sv, SVt_PVAV);
4381 AvREAL_off((AV *)sv);
4384 sv_upgrade(sv, SVt_PVHV);
4387 CROAK(("Forgot to deal with extra type %d", extra_type));
4392 * Adding the magic only now, well after the STORABLE_thaw hook was called
4393 * means the hook cannot know it deals with an object whose variable is
4394 * tied. But this is happening when retrieving $o in the following case:
4398 * my $o = bless \%h, 'BAR';
4400 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4401 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4402 * hash but a tied one should not matter at all, and remain transparent.
4403 * This means the magic must be restored by Storable AFTER the hook is
4406 * That looks very reasonable to me, but then I've come up with this
4407 * after a bug report from David Nesting, who was trying to store such
4408 * an object and caused Storable to fail. And unfortunately, it was
4409 * also the easiest way to retrofit support for blessed ref to tied objects
4410 * into the existing design. -- RAM, 17/02/2001
4413 sv_magic(sv, rv, mtype, (char *)NULL, 0);
4414 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4422 * Retrieve reference to some other scalar.
4423 * Layout is SX_REF <object>, with SX_REF already read.
4425 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname)
4430 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4433 * We need to create the SV that holds the reference to the yet-to-retrieve
4434 * object now, so that we may record the address in the seen table.
4435 * Otherwise, if the object to retrieve references us, we won't be able
4436 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4437 * do the retrieve first and use rv = newRV(sv) since it will be too late
4438 * for SEEN() recording.
4441 rv = NEWSV(10002, 0);
4442 SEEN(rv, cname, 0); /* Will return if rv is null */
4443 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4445 return (SV *) 0; /* Failed */
4448 * WARNING: breaks RV encapsulation.
4450 * Now for the tricky part. We have to upgrade our existing SV, so that
4451 * it is now an RV on sv... Again, we cheat by duplicating the code
4452 * held in newSVrv(), since we already got our SV from retrieve().
4456 * SvRV(rv) = SvREFCNT_inc(sv);
4458 * here because the reference count we got from retrieve() above is
4459 * already correct: if the object was retrieved from the file, then
4460 * its reference count is one. Otherwise, if it was retrieved via
4461 * an SX_OBJECT indication, a ref count increment was done.
4465 /* No need to do anything, as rv will already be PVMG. */
4466 assert (SvTYPE(rv) == SVt_RV || SvTYPE(rv) >= SVt_PV);
4468 sv_upgrade(rv, SVt_RV);
4471 SvRV_set(rv, sv); /* $rv = \$sv */
4474 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4482 * Retrieve weak reference to some other scalar.
4483 * Layout is SX_WEAKREF <object>, with SX_WEAKREF already read.
4485 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname)
4489 TRACEME(("retrieve_weakref (#%d)", cxt->tagnum));
4491 sv = retrieve_ref(aTHX_ cxt, cname);
4503 * retrieve_overloaded
4505 * Retrieve reference to some other scalar with overloading.
4506 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4508 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname)
4514 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4517 * Same code as retrieve_ref(), duplicated to avoid extra call.
4520 rv = NEWSV(10002, 0);
4521 SEEN(rv, cname, 0); /* Will return if rv is null */
4522 cxt->in_retrieve_overloaded = 1; /* so sv_bless doesn't call S_reset_amagic */
4523 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4524 cxt->in_retrieve_overloaded = 0;
4526 return (SV *) 0; /* Failed */
4529 * WARNING: breaks RV encapsulation.
4532 SvUPGRADE(rv, SVt_RV);
4533 SvRV_set(rv, sv); /* $rv = \$sv */
4537 * Restore overloading magic.
4540 stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
4542 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4543 ") (package <unknown>)",
4544 sv_reftype(sv, FALSE),
4547 if (!Gv_AMG(stash)) {
4548 const char *package = HvNAME_get(stash);
4549 TRACEME(("No overloading defined for package %s", package));
4550 TRACEME(("Going to load module '%s'", package));
4551 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(package, 0), Nullsv);
4552 if (!Gv_AMG(stash)) {
4553 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4554 ") (package %s) (even after a \"require %s;\")",
4555 sv_reftype(sv, FALSE),
4563 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4569 * retrieve_weakoverloaded
4571 * Retrieve weak overloaded reference to some other scalar.
4572 * Layout is SX_WEAKOVERLOADED <object>, with SX_WEAKOVERLOADED already read.
4574 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname)
4578 TRACEME(("retrieve_weakoverloaded (#%d)", cxt->tagnum));
4580 sv = retrieve_overloaded(aTHX_ cxt, cname);
4592 * retrieve_tied_array
4594 * Retrieve tied array
4595 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4597 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname)
4602 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4604 tv = NEWSV(10002, 0);
4605 SEEN(tv, cname, 0); /* Will return if tv is null */
4606 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4608 return (SV *) 0; /* Failed */
4610 sv_upgrade(tv, SVt_PVAV);
4611 AvREAL_off((AV *)tv);
4612 sv_magic(tv, sv, 'P', (char *)NULL, 0);
4613 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4615 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4621 * retrieve_tied_hash
4623 * Retrieve tied hash
4624 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4626 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname)
4631 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4633 tv = NEWSV(10002, 0);
4634 SEEN(tv, cname, 0); /* Will return if tv is null */
4635 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4637 return (SV *) 0; /* Failed */
4639 sv_upgrade(tv, SVt_PVHV);
4640 sv_magic(tv, sv, 'P', (char *)NULL, 0);
4641 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4643 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4649 * retrieve_tied_scalar
4651 * Retrieve tied scalar
4652 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4654 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4657 SV *sv, *obj = NULL;
4659 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4661 tv = NEWSV(10002, 0);
4662 SEEN(tv, cname, 0); /* Will return if rv is null */
4663 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4665 return (SV *) 0; /* Failed */
4667 else if (SvTYPE(sv) != SVt_NULL) {
4671 sv_upgrade(tv, SVt_PVMG);
4672 sv_magic(tv, obj, 'q', (char *)NULL, 0);
4675 /* Undo refcnt inc from sv_magic() */
4679 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4687 * Retrieve reference to value in a tied hash.
4688 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4690 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname)
4696 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4698 tv = NEWSV(10002, 0);
4699 SEEN(tv, cname, 0); /* Will return if tv is null */
4700 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4702 return (SV *) 0; /* Failed */
4704 key = retrieve(aTHX_ cxt, 0); /* Retrieve <key> */
4706 return (SV *) 0; /* Failed */
4708 sv_upgrade(tv, SVt_PVMG);
4709 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4710 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4711 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4719 * Retrieve reference to value in a tied array.
4720 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4722 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname)
4728 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4730 tv = NEWSV(10002, 0);
4731 SEEN(tv, cname, 0); /* Will return if tv is null */
4732 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4734 return (SV *) 0; /* Failed */
4736 RLEN(idx); /* Retrieve <idx> */
4738 sv_upgrade(tv, SVt_PVMG);
4739 sv_magic(tv, sv, 'p', (char *)NULL, idx);
4740 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4749 * Retrieve defined long (string) scalar.
4751 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4752 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4753 * was not stored on a single byte.
4755 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname)
4761 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4764 * Allocate an empty scalar of the suitable length.
4767 sv = NEWSV(10002, len);
4768 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4771 sv_setpvn(sv, "", 0);
4776 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4778 * Now, for efficiency reasons, read data directly inside the SV buffer,
4779 * and perform the SV final settings directly by duplicating the final
4780 * work done by sv_setpv. Since we're going to allocate lots of scalars
4781 * this way, it's worth the hassle and risk.
4784 SAFEREAD(SvPVX(sv), len, sv);
4785 SvCUR_set(sv, len); /* Record C string length */
4786 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4787 (void) SvPOK_only(sv); /* Validate string pointer */
4788 if (cxt->s_tainted) /* Is input source tainted? */
4789 SvTAINT(sv); /* External data cannot be trusted */
4791 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4792 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4800 * Retrieve defined short (string) scalar.
4802 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4803 * The scalar is "short" so <length> is single byte. If it is 0, there
4804 * is no <data> section.
4806 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4812 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4815 * Allocate an empty scalar of the suitable length.
4818 sv = NEWSV(10002, len);
4819 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4822 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4827 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4828 * To make it defined with an empty length, upgrade it now...
4829 * Don't upgrade to a PV if the original type contains more
4830 * information than a scalar.
4832 if (SvTYPE(sv) <= SVt_PV) {
4833 sv_upgrade(sv, SVt_PV);
4836 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4837 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4840 * Now, for efficiency reasons, read data directly inside the SV buffer,
4841 * and perform the SV final settings directly by duplicating the final
4842 * work done by sv_setpv. Since we're going to allocate lots of scalars
4843 * this way, it's worth the hassle and risk.
4845 SAFEREAD(SvPVX(sv), len, sv);
4846 SvCUR_set(sv, len); /* Record C string length */
4847 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4848 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4851 (void) SvPOK_only(sv); /* Validate string pointer */
4852 if (cxt->s_tainted) /* Is input source tainted? */
4853 SvTAINT(sv); /* External data cannot be trusted */
4855 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4862 * Like retrieve_scalar(), but tag result as utf8.
4863 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4865 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname)
4869 TRACEME(("retrieve_utf8str"));
4871 sv = retrieve_scalar(aTHX_ cxt, cname);
4873 #ifdef HAS_UTF8_SCALARS
4876 if (cxt->use_bytes < 0)
4878 = (SvTRUE(perl_get_sv("Storable::drop_utf8", GV_ADD))
4880 if (cxt->use_bytes == 0)
4891 * Like retrieve_lscalar(), but tag result as utf8.
4892 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4894 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname)
4898 TRACEME(("retrieve_lutf8str"));
4900 sv = retrieve_lscalar(aTHX_ cxt, cname);
4902 #ifdef HAS_UTF8_SCALARS
4905 if (cxt->use_bytes < 0)
4907 = (SvTRUE(perl_get_sv("Storable::drop_utf8", GV_ADD))
4909 if (cxt->use_bytes == 0)
4919 * Retrieve defined integer.
4920 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4922 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname)
4927 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4929 READ(&iv, sizeof(iv));
4931 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4933 TRACEME(("integer %"IVdf, iv));
4934 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4942 * Retrieve defined integer in network order.
4943 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4945 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname)
4950 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4954 sv = newSViv((int) ntohl(iv));
4955 TRACEME(("network integer %d", (int) ntohl(iv)));
4958 TRACEME(("network integer (as-is) %d", iv));
4960 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4962 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
4970 * Retrieve defined double.
4971 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
4973 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname)
4978 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
4980 READ(&nv, sizeof(nv));
4982 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4984 TRACEME(("double %"NVff, nv));
4985 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
4993 * Retrieve defined byte (small integer within the [-128, +127] range).
4994 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
4996 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname)
5000 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
5002 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
5005 TRACEME(("small integer read as %d", (unsigned char) siv));
5006 tmp = (unsigned char) siv - 128;
5008 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5010 TRACEME(("byte %d", tmp));
5011 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
5019 * Return the undefined value.
5021 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname)
5025 TRACEME(("retrieve_undef"));
5036 * Return the immortal undefined value.
5038 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname)
5040 SV *sv = &PL_sv_undef;
5042 TRACEME(("retrieve_sv_undef"));
5044 /* Special case PL_sv_undef, as av_fetch uses it internally to mark
5045 deleted elements, and will return NULL (fetch failed) whenever it
5047 if (cxt->where_is_undef == -1) {
5048 cxt->where_is_undef = cxt->tagnum;
5057 * Return the immortal yes value.
5059 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname)
5061 SV *sv = &PL_sv_yes;
5063 TRACEME(("retrieve_sv_yes"));
5072 * Return the immortal no value.
5074 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname)
5078 TRACEME(("retrieve_sv_no"));
5087 * Retrieve a whole array.
5088 * Layout is SX_ARRAY <size> followed by each item, in increasing index order.
5089 * Each item is stored as <object>.
5091 * When we come here, SX_ARRAY has been read already.
5093 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5100 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
5103 * Read length, and allocate array, then pre-extend it.
5107 TRACEME(("size = %d", len));
5109 SEEN(av, cname, 0); /* Will return if array not allocated nicely */
5113 return (SV *) av; /* No data follow if array is empty */
5116 * Now get each item in turn...
5119 for (i = 0; i < len; i++) {
5120 TRACEME(("(#%d) item", i));
5121 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5124 if (av_store(av, i, sv) == 0)
5128 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5136 * Retrieve a whole hash table.
5137 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5138 * Keys are stored as <length> <data>, the <data> section being omitted
5140 * Values are stored as <object>.
5142 * When we come here, SX_HASH has been read already.
5144 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5152 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
5155 * Read length, allocate table.
5159 TRACEME(("size = %d", len));
5161 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5163 return (SV *) hv; /* No data follow if table empty */
5164 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5167 * Now get each key/value pair in turn...
5170 for (i = 0; i < len; i++) {
5175 TRACEME(("(#%d) value", i));
5176 sv = retrieve(aTHX_ cxt, 0);
5182 * Since we're reading into kbuf, we must ensure we're not
5183 * recursing between the read and the hv_store() where it's used.
5184 * Hence the key comes after the value.
5187 RLEN(size); /* Get key size */
5188 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5191 kbuf[size] = '\0'; /* Mark string end, just in case */
5192 TRACEME(("(#%d) key '%s'", i, kbuf));
5195 * Enter key/value pair into hash table.
5198 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5202 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5210 * Retrieve a whole hash table.
5211 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5212 * Keys are stored as <length> <data>, the <data> section being omitted
5214 * Values are stored as <object>.
5216 * When we come here, SX_HASH has been read already.
5218 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname)
5228 GETMARK(hash_flags);
5229 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
5231 * Read length, allocate table.
5234 #ifndef HAS_RESTRICTED_HASHES
5235 if (hash_flags & SHV_RESTRICTED) {
5236 if (cxt->derestrict < 0)
5238 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", GV_ADD))
5240 if (cxt->derestrict == 0)
5241 RESTRICTED_HASH_CROAK();
5246 TRACEME(("size = %d, flags = %d", len, hash_flags));
5248 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5250 return (SV *) hv; /* No data follow if table empty */
5251 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5254 * Now get each key/value pair in turn...
5257 for (i = 0; i < len; i++) {
5259 int store_flags = 0;
5264 TRACEME(("(#%d) value", i));
5265 sv = retrieve(aTHX_ cxt, 0);
5270 #ifdef HAS_RESTRICTED_HASHES
5271 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
5275 if (flags & SHV_K_ISSV) {
5276 /* XXX you can't set a placeholder with an SV key.
5277 Then again, you can't get an SV key.
5278 Without messing around beyond what the API is supposed to do.
5281 TRACEME(("(#%d) keysv, flags=%d", i, flags));
5282 keysv = retrieve(aTHX_ cxt, 0);
5286 if (!hv_store_ent(hv, keysv, sv, 0))
5291 * Since we're reading into kbuf, we must ensure we're not
5292 * recursing between the read and the hv_store() where it's used.
5293 * Hence the key comes after the value.
5296 if (flags & SHV_K_PLACEHOLDER) {
5298 sv = &PL_sv_placeholder;
5299 store_flags |= HVhek_PLACEHOLD;
5301 if (flags & SHV_K_UTF8) {
5302 #ifdef HAS_UTF8_HASHES
5303 store_flags |= HVhek_UTF8;
5305 if (cxt->use_bytes < 0)
5307 = (SvTRUE(perl_get_sv("Storable::drop_utf8", GV_ADD))
5309 if (cxt->use_bytes == 0)
5313 #ifdef HAS_UTF8_HASHES
5314 if (flags & SHV_K_WASUTF8)
5315 store_flags |= HVhek_WASUTF8;
5318 RLEN(size); /* Get key size */
5319 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5322 kbuf[size] = '\0'; /* Mark string end, just in case */
5323 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5324 flags, store_flags));
5327 * Enter key/value pair into hash table.
5330 #ifdef HAS_RESTRICTED_HASHES
5331 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5334 if (!(store_flags & HVhek_PLACEHOLD))
5335 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5340 #ifdef HAS_RESTRICTED_HASHES
5341 if (hash_flags & SHV_RESTRICTED)
5345 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5353 * Return a code reference.
5355 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname)
5357 #if PERL_VERSION < 6
5358 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5361 int type, count, tagnum;
5363 SV *sv, *text, *sub, *errsv;
5365 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5368 * Insert dummy SV in the aseen array so that we don't screw
5369 * up the tag numbers. We would just make the internal
5370 * scalar an untagged item in the stream, but
5371 * retrieve_scalar() calls SEEN(). So we just increase the
5374 tagnum = cxt->tagnum;
5379 * Retrieve the source of the code reference
5380 * as a small or large scalar
5386 text = retrieve_scalar(aTHX_ cxt, cname);
5389 text = retrieve_lscalar(aTHX_ cxt, cname);
5392 text = retrieve_utf8str(aTHX_ cxt, cname);
5395 text = retrieve_lutf8str(aTHX_ cxt, cname);
5398 CROAK(("Unexpected type %d in retrieve_code\n", type));
5402 * prepend "sub " to the source
5405 sub = newSVpvn("sub ", 4);
5408 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5412 * evaluate the source to a code reference and use the CV value
5415 if (cxt->eval == NULL) {
5416 cxt->eval = perl_get_sv("Storable::Eval", GV_ADD);
5417 SvREFCNT_inc(cxt->eval);
5419 if (!SvTRUE(cxt->eval)) {
5421 cxt->forgive_me == 0 ||
5422 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5423 SvTRUE(perl_get_sv("Storable::forgive_me", GV_ADD)) ? 1 : 0))
5425 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5428 /* fix up the dummy entry... */
5429 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5437 errsv = get_sv("@", GV_ADD);
5438 sv_setpvn(errsv, "", 0); /* clear $@ */
5439 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5441 XPUSHs(sv_2mortal(newSVsv(sub)));
5443 count = call_sv(cxt->eval, G_SCALAR);
5445 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5447 eval_sv(sub, G_SCALAR);
5453 if (SvTRUE(errsv)) {
5454 CROAK(("code %s caused an error: %s",
5455 SvPV_nolen(sub), SvPV_nolen(errsv)));
5458 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5461 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5464 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5469 /* fix up the dummy entry... */
5470 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5477 * old_retrieve_array
5479 * Retrieve a whole array in pre-0.6 binary format.
5481 * Layout is SX_ARRAY <size> followed by each item, in increasing index order.
5482 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5484 * When we come here, SX_ARRAY has been read already.
5486 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5494 PERL_UNUSED_ARG(cname);
5495 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5498 * Read length, and allocate array, then pre-extend it.
5502 TRACEME(("size = %d", len));
5504 SEEN(av, 0, 0); /* Will return if array not allocated nicely */
5508 return (SV *) av; /* No data follow if array is empty */
5511 * Now get each item in turn...
5514 for (i = 0; i < len; i++) {
5516 if (c == SX_IT_UNDEF) {
5517 TRACEME(("(#%d) undef item", i));
5518 continue; /* av_extend() already filled us with undef */
5521 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5522 TRACEME(("(#%d) item", i));
5523 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5526 if (av_store(av, i, sv) == 0)
5530 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5538 * Retrieve a whole hash table in pre-0.6 binary format.
5540 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5541 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5543 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5545 * When we come here, SX_HASH has been read already.
5547 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5555 SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5557 PERL_UNUSED_ARG(cname);
5558 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5561 * Read length, allocate table.
5565 TRACEME(("size = %d", len));
5567 SEEN(hv, 0, 0); /* Will return if table not allocated properly */
5569 return (SV *) hv; /* No data follow if table empty */
5570 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5573 * Now get each key/value pair in turn...
5576 for (i = 0; i < len; i++) {
5582 if (c == SX_VL_UNDEF) {
5583 TRACEME(("(#%d) undef value", i));
5585 * Due to a bug in hv_store(), it's not possible to pass
5586 * &PL_sv_undef to hv_store() as a value, otherwise the
5587 * associated key will not be creatable any more. -- RAM, 14/01/97
5590 sv_h_undef = newSVsv(&PL_sv_undef);
5591 sv = SvREFCNT_inc(sv_h_undef);
5592 } else if (c == SX_VALUE) {
5593 TRACEME(("(#%d) value", i));
5594 sv = retrieve(aTHX_ cxt, 0);
5598 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5602 * Since we're reading into kbuf, we must ensure we're not
5603 * recursing between the read and the hv_store() where it's used.
5604 * Hence the key comes after the value.
5609 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5610 RLEN(size); /* Get key size */
5611 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5614 kbuf[size] = '\0'; /* Mark string end, just in case */
5615 TRACEME(("(#%d) key '%s'", i, kbuf));
5618 * Enter key/value pair into hash table.
5621 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5625 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5631 *** Retrieval engine.
5637 * Make sure the stored data we're trying to retrieve has been produced
5638 * on an ILP compatible system with the same byteorder. It croaks out in
5639 * case an error is detected. [ILP = integer-long-pointer sizes]
5640 * Returns null if error is detected, &PL_sv_undef otherwise.
5642 * Note that there's no byte ordering info emitted when network order was
5643 * used at store time.
5645 static SV *magic_check(pTHX_ stcxt_t *cxt)
5647 /* The worst case for a malicious header would be old magic (which is
5648 longer), major, minor, byteorder length byte of 255, 255 bytes of
5649 garbage, sizeof int, long, pointer, NV.
5650 So the worse of that we can read is 255 bytes of garbage plus 4.
5651 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5652 compiling perl on a system with chars that are larger than 8 bits.
5653 (Even Crays aren't *that* perverse).
5655 unsigned char buf[4 + 255];
5656 unsigned char *current;
5659 int use_network_order;
5663 int version_minor = 0;
5665 TRACEME(("magic_check"));
5668 * The "magic number" is only for files, not when freezing in memory.
5672 /* This includes the '\0' at the end. I want to read the extra byte,
5673 which is usually going to be the major version number. */
5674 STRLEN len = sizeof(magicstr);
5677 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5679 /* Point at the byte after the byte we read. */
5680 current = buf + --len; /* Do the -- outside of macros. */
5682 if (memNE(buf, magicstr, len)) {
5684 * Try to read more bytes to check for the old magic number, which
5688 TRACEME(("trying for old magic number"));
5690 old_len = sizeof(old_magicstr) - 1;
5691 READ(current + 1, (SSize_t)(old_len - len));
5693 if (memNE(buf, old_magicstr, old_len))
5694 CROAK(("File is not a perl storable"));
5696 current = buf + old_len;
5698 use_network_order = *current;
5700 GETMARK(use_network_order);
5703 * Starting with 0.6, the "use_network_order" byte flag is also used to
5704 * indicate the version number of the binary, and therefore governs the
5705 * setting of sv_retrieve_vtbl. See magic_write().
5707 if (old_magic && use_network_order > 1) {
5708 /* 0.1 dump - use_network_order is really byte order length */
5712 version_major = use_network_order >> 1;
5714 cxt->retrieve_vtbl = (SV*(**)(pTHX_ stcxt_t *cxt, const char *cname)) (version_major > 0 ? sv_retrieve : sv_old_retrieve);
5716 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5720 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5721 * minor version of the protocol. See magic_write().
5724 if (version_major > 1)
5725 GETMARK(version_minor);
5727 cxt->ver_major = version_major;
5728 cxt->ver_minor = version_minor;
5730 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5733 * Inter-operability sanity check: we can't retrieve something stored
5734 * using a format more recent than ours, because we have no way to
5735 * know what has changed, and letting retrieval go would mean a probable
5736 * failure reporting a "corrupted" storable file.
5740 version_major > STORABLE_BIN_MAJOR ||
5741 (version_major == STORABLE_BIN_MAJOR &&
5742 version_minor > STORABLE_BIN_MINOR)
5745 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5746 STORABLE_BIN_MINOR));
5748 if (version_major == STORABLE_BIN_MAJOR) {
5749 TRACEME(("cxt->accept_future_minor is %d",
5750 cxt->accept_future_minor));
5751 if (cxt->accept_future_minor < 0)
5752 cxt->accept_future_minor
5753 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5756 if (cxt->accept_future_minor == 1)
5757 croak_now = 0; /* Don't croak yet. */
5760 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5761 version_major, version_minor,
5762 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5767 * If they stored using network order, there's no byte ordering
5768 * information to check.
5771 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5772 return &PL_sv_undef; /* No byte ordering info */
5774 /* In C truth is 1, falsehood is 0. Very convenient. */
5775 use_NV_size = version_major >= 2 && version_minor >= 2;
5777 if (version_major >= 0) {
5781 c = use_network_order;
5783 length = c + 3 + use_NV_size;
5784 READ(buf, length); /* Not null-terminated */
5786 TRACEME(("byte order '%.*s' %d", c, buf, c));
5788 #ifdef USE_56_INTERWORK_KLUDGE
5789 /* No point in caching this in the context as we only need it once per
5790 retrieve, and we need to recheck it each read. */
5791 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", GV_ADD))) {
5792 if ((c != (sizeof (byteorderstr_56) - 1))
5793 || memNE(buf, byteorderstr_56, c))
5794 CROAK(("Byte order is not compatible"));
5798 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5799 CROAK(("Byte order is not compatible"));
5805 if ((int) *current++ != sizeof(int))
5806 CROAK(("Integer size is not compatible"));
5809 if ((int) *current++ != sizeof(long))
5810 CROAK(("Long integer size is not compatible"));
5812 /* sizeof(char *) */
5813 if ((int) *current != sizeof(char *))
5814 CROAK(("Pointer size is not compatible"));
5818 if ((int) *++current != sizeof(NV))
5819 CROAK(("Double size is not compatible"));
5822 return &PL_sv_undef; /* OK */
5828 * Recursively retrieve objects from the specified file and return their
5829 * root SV (which may be an AV or an HV for what we care).
5830 * Returns null if there is a problem.
5832 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname)
5838 TRACEME(("retrieve"));
5841 * Grab address tag which identifies the object if we are retrieving
5842 * an older format. Since the new binary format counts objects and no
5843 * longer explicitly tags them, we must keep track of the correspondence
5846 * The following section will disappear one day when the old format is
5847 * no longer supported, hence the final "goto" in the "if" block.
5850 if (cxt->hseen) { /* Retrieving old binary */
5852 if (cxt->netorder) {
5854 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5855 tag = (stag_t) nettag;
5857 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5860 if (type == SX_OBJECT) {
5862 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5864 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5866 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5869 * The following code is common with the SX_OBJECT case below.
5872 svh = av_fetch(cxt->aseen, tagn, FALSE);
5874 CROAK(("Object #%"IVdf" should have been retrieved already",
5877 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5878 SvREFCNT_inc(sv); /* One more reference to this same sv */
5879 return sv; /* The SV pointer where object was retrieved */
5883 * Map new object, but don't increase tagnum. This will be done
5884 * by each of the retrieve_* functions when they call SEEN().
5886 * The mapping associates the "tag" initially present with a unique
5887 * tag number. See test for SX_OBJECT above to see how this is perused.
5890 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5891 newSViv(cxt->tagnum), 0))
5898 * Regular post-0.6 binary format.
5903 TRACEME(("retrieve type = %d", type));
5906 * Are we dealing with an object we should have already retrieved?
5909 if (type == SX_OBJECT) {
5913 svh = av_fetch(cxt->aseen, tag, FALSE);
5915 CROAK(("Object #%"IVdf" should have been retrieved already",
5918 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5919 SvREFCNT_inc(sv); /* One more reference to this same sv */
5920 return sv; /* The SV pointer where object was retrieved */
5921 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5922 if (cxt->accept_future_minor < 0)
5923 cxt->accept_future_minor
5924 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5927 if (cxt->accept_future_minor == 1) {
5928 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5929 "This Storable is v%d.%d and can only handle data types up to %d",
5930 cxt->ver_major, cxt->ver_minor, type,
5931 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5935 first_time: /* Will disappear when support for old format is dropped */
5938 * Okay, first time through for this one.
5941 sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
5943 return (SV *) 0; /* Failed */
5946 * Old binary formats (pre-0.7).
5948 * Final notifications, ended by SX_STORED may now follow.
5949 * Currently, the only pertinent notification to apply on the
5950 * freshly retrieved object is either:
5951 * SX_CLASS <char-len> <classname> for short classnames.
5952 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5953 * Class name is then read into the key buffer pool used by
5954 * hash table key retrieval.
5957 if (cxt->ver_major < 2) {
5958 while ((type = GETCHAR()) != SX_STORED) {
5962 GETMARK(len); /* Length coded on a single char */
5964 case SX_LG_CLASS: /* Length coded on a regular integer */
5969 return (SV *) 0; /* Failed */
5971 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5974 kbuf[len] = '\0'; /* Mark string end */
5979 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5980 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
5988 * Retrieve data held in file and return the root object.
5989 * Common routine for pretrieve and mretrieve.
5991 static SV *do_retrieve(
5999 int is_tainted; /* Is input source tainted? */
6000 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
6002 TRACEME(("do_retrieve (optype = 0x%x)", optype));
6004 optype |= ST_RETRIEVE;
6007 * Sanity assertions for retrieve dispatch tables.
6010 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
6011 ("old and new retrieve dispatch table have same size"));
6012 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
6013 ("SX_ERROR entry correctly initialized in old dispatch table"));
6014 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
6015 ("SX_ERROR entry correctly initialized in new dispatch table"));
6018 * Workaround for CROAK leak: if they enter with a "dirty" context,
6019 * free up memory for them now.
6023 clean_context(aTHX_ cxt);
6026 * Now that STORABLE_xxx hooks exist, it is possible that they try to
6027 * re-enter retrieve() via the hooks.
6031 cxt = allocate_context(aTHX_ cxt);
6035 ASSERT(cxt->entry == 1, ("starting new recursion"));
6036 ASSERT(!cxt->s_dirty, ("clean context"));
6041 * Data is loaded into the memory buffer when f is NULL, unless `in' is
6042 * also NULL, in which case we're expecting the data to already lie
6043 * in the buffer (dclone case).
6046 KBUFINIT(); /* Allocate hash key reading pool once */
6052 const char *orig = SvPV(in, length);
6054 /* This is quite deliberate. I want the UTF8 routines
6055 to encounter the '\0' which perl adds at the end
6056 of all scalars, so that any new string also has
6059 STRLEN klen_tmp = length + 1;
6060 bool is_utf8 = TRUE;
6062 /* Just casting the &klen to (STRLEN) won't work
6063 well if STRLEN and I32 are of different widths.
6065 asbytes = (char*)bytes_from_utf8((U8*)orig,
6069 CROAK(("Frozen string corrupt - contains characters outside 0-255"));
6071 if (asbytes != orig) {
6072 /* String has been converted.
6073 There is no need to keep any reference to
6075 in = sv_newmortal();
6076 /* We donate the SV the malloc()ed string
6077 bytes_from_utf8 returned us. */
6078 SvUPGRADE(in, SVt_PV);
6080 SvPV_set(in, asbytes);
6081 SvLEN_set(in, klen_tmp);
6082 SvCUR_set(in, klen_tmp - 1);
6086 MBUF_SAVE_AND_LOAD(in);
6090 * Magic number verifications.
6092 * This needs to be done before calling init_retrieve_context()
6093 * since the format indication in the file are necessary to conduct
6094 * some of the initializations.
6097 cxt->fio = f; /* Where I/O are performed */
6099 if (!magic_check(aTHX_ cxt))
6100 CROAK(("Magic number checking on storable %s failed",
6101 cxt->fio ? "file" : "string"));
6103 TRACEME(("data stored in %s format",
6104 cxt->netorder ? "net order" : "native"));
6107 * Check whether input source is tainted, so that we don't wrongly
6108 * taint perfectly good values...
6110 * We assume file input is always tainted. If both `f' and `in' are
6111 * NULL, then we come from dclone, and tainted is already filled in
6112 * the context. That's a kludge, but the whole dclone() thing is
6113 * already quite a kludge anyway! -- RAM, 15/09/2000.
6116 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
6117 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
6118 init_retrieve_context(aTHX_ cxt, optype, is_tainted);
6120 ASSERT(is_retrieving(aTHX), ("within retrieve operation"));
6122 sv = retrieve(aTHX_ cxt, 0); /* Recursively retrieve object, get root SV */
6131 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
6134 * The "root" context is never freed.
6137 clean_retrieve_context(aTHX_ cxt);
6138 if (cxt->prev) /* This context was stacked */
6139 free_context(aTHX_ cxt); /* It was not the "root" context */
6142 * Prepare returned value.
6146 TRACEME(("retrieve ERROR"));
6147 #if (PATCHLEVEL <= 4)
6148 /* perl 5.00405 seems to screw up at this point with an
6149 'attempt to modify a read only value' error reported in the
6150 eval { $self = pretrieve(*FILE) } in _retrieve.
6151 I can't see what the cause of this error is, but I suspect a
6152 bug in 5.004, as it seems to be capable of issuing spurious
6153 errors or core dumping with matches on $@. I'm not going to
6154 spend time on what could be a fruitless search for the cause,
6155 so here's a bodge. If you're running 5.004 and don't like
6156 this inefficiency, either upgrade to a newer perl, or you are
6157 welcome to find the problem and send in a patch.
6161 return &PL_sv_undef; /* Something went wrong, return undef */
6165 TRACEME(("retrieve got %s(0x%"UVxf")",
6166 sv_reftype(sv, FALSE), PTR2UV(sv)));
6169 * Backward compatibility with Storable-0.5@9 (which we know we
6170 * are retrieving if hseen is non-null): don't create an extra RV
6171 * for objects since we special-cased it at store time.
6173 * Build a reference to the SV returned by pretrieve even if it is
6174 * already one and not a scalar, for consistency reasons.
6177 if (pre_06_fmt) { /* Was not handling overloading by then */
6179 TRACEME(("fixing for old formats -- pre 0.6"));
6180 if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
6181 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
6187 * If reference is overloaded, restore behaviour.
6189 * NB: minor glitch here: normally, overloaded refs are stored specially
6190 * so that we can croak when behaviour cannot be re-installed, and also
6191 * avoid testing for overloading magic at each reference retrieval.
6193 * Unfortunately, the root reference is implicitly stored, so we must
6194 * check for possible overloading now. Furthermore, if we don't restore
6195 * overloading, we cannot croak as if the original ref was, because we
6196 * have no way to determine whether it was an overloaded ref or not in
6199 * It's a pity that overloading magic is attached to the rv, and not to
6200 * the underlying sv as blessing is.
6204 HV *stash = (HV *) SvSTASH(sv);
6205 SV *rv = newRV_noinc(sv);
6206 if (stash && Gv_AMG(stash)) {
6208 TRACEME(("restored overloading on root reference"));
6210 TRACEME(("ended do_retrieve() with an object"));
6214 TRACEME(("regular do_retrieve() end"));
6216 return newRV_noinc(sv);
6222 * Retrieve data held in file and return the root object, undef on error.
6224 static SV *pretrieve(pTHX_ PerlIO *f)
6226 TRACEME(("pretrieve"));
6227 return do_retrieve(aTHX_ f, Nullsv, 0);
6233 * Retrieve data held in scalar and return the root object, undef on error.
6235 static SV *mretrieve(pTHX_ SV *sv)
6237 TRACEME(("mretrieve"));
6238 return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
6248 * Deep clone: returns a fresh copy of the original referenced SV tree.
6250 * This is achieved by storing the object in memory and restoring from
6251 * there. Not that efficient, but it should be faster than doing it from
6254 static SV *dclone(pTHX_ SV *sv)
6258 stcxt_t *real_context;
6261 TRACEME(("dclone"));
6264 * Workaround for CROAK leak: if they enter with a "dirty" context,
6265 * free up memory for them now.
6269 clean_context(aTHX_ cxt);
6272 * Tied elements seem to need special handling.
6275 if ((SvTYPE(sv) == SVt_PVLV
6276 #if PERL_VERSION < 8
6277 || SvTYPE(sv) == SVt_PVMG
6279 ) && SvRMAGICAL(sv) && mg_find(sv, 'p')) {
6284 * do_store() optimizes for dclone by not freeing its context, should
6285 * we need to allocate one because we're deep cloning from a hook.
6288 if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
6289 return &PL_sv_undef; /* Error during store */
6292 * Because of the above optimization, we have to refresh the context,
6293 * since a new one could have been allocated and stacked by do_store().
6296 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
6297 cxt = real_context; /* And we need this temporary... */
6300 * Now, `cxt' may refer to a new context.
6303 ASSERT(!cxt->s_dirty, ("clean context"));
6304 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
6307 TRACEME(("dclone stored %d bytes", size));
6311 * Since we're passing do_retrieve() both a NULL file and sv, we need
6312 * to pre-compute the taintedness of the input by setting cxt->tainted
6313 * to whatever state our own input string was. -- RAM, 15/09/2000
6315 * do_retrieve() will free non-root context.
6318 cxt->s_tainted = SvTAINTED(sv);
6319 out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
6321 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
6331 * The Perl IO GV object distinguishes between input and output for sockets
6332 * but not for plain files. To allow Storable to transparently work on
6333 * plain files and sockets transparently, we have to ask xsubpp to fetch the
6334 * right object for us. Hence the OutputStream and InputStream declarations.
6336 * Before perl 5.004_05, those entries in the standard typemap are not
6337 * defined in perl include files, so we do that here.
6340 #ifndef OutputStream
6341 #define OutputStream PerlIO *
6342 #define InputStream PerlIO *
6343 #endif /* !OutputStream */
6345 MODULE = Storable PACKAGE = Storable::Cxt
6351 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
6355 if (!cxt->membuf_ro && mbase)
6357 if (cxt->membuf_ro && (cxt->msaved).arena)
6358 Safefree((cxt->msaved).arena);
6361 MODULE = Storable PACKAGE = Storable
6367 HV *stash = gv_stashpvn("Storable", 8, GV_ADD);
6368 newCONSTSUB(stash, "BIN_MAJOR", newSViv(STORABLE_BIN_MAJOR));
6369 newCONSTSUB(stash, "BIN_MINOR", newSViv(STORABLE_BIN_MINOR));
6370 newCONSTSUB(stash, "BIN_WRITE_MINOR", newSViv(STORABLE_BIN_WRITE_MINOR));
6372 init_perinterp(aTHX);
6373 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
6375 /* Only disable the used only once warning if we are in debugging mode. */
6376 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
6378 #ifdef USE_56_INTERWORK_KLUDGE
6379 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
6386 init_perinterp(aTHX);
6390 # Store the transitive data closure of given object to disk.
6391 # Returns undef on error, a true value otherwise.
6395 # Same as pstore(), but network order is used for integers and doubles are
6396 # emitted as strings.
6405 RETVAL = do_store(aTHX_ f, obj, 0, ix, (SV **)0) ? &PL_sv_yes : &PL_sv_undef;
6406 /* do_store() can reallocate the stack, so need a sequence point to ensure
6407 that ST(0) knows about it. Hence using two statements. */
6413 # Store the transitive data closure of given object to memory.
6414 # Returns undef on error, a scalar value containing the data otherwise.
6418 # Same as mstore(), but network order is used for integers and doubles are
6419 # emitted as strings.
6427 if (!do_store(aTHX_ (PerlIO*) 0, obj, 0, ix, &RETVAL))
6428 RETVAL = &PL_sv_undef;
6436 RETVAL = pretrieve(aTHX_ f);
6444 RETVAL = mretrieve(aTHX_ sv);
6452 RETVAL = dclone(aTHX_ sv);
6457 last_op_in_netorder()
6459 RETVAL = !!last_op_in_netorder(aTHX);
6466 is_storing = ST_STORE
6467 is_retrieving = ST_RETRIEVE
6472 RETVAL = cxt->entry && (cxt->optype & ix) ? TRUE : FALSE;