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 forthcominng (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 persistency
253 * is required. Hence the aptr pointer.
256 char *arena; /* Will hold hash key strings, resized as needed */
257 STRLEN asiz; /* Size of aforementionned 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 determind 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 restrcted 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 */
391 #define NEW_STORABLE_CXT_OBJ(cxt) \
393 SV *self = newSV(sizeof(stcxt_t) - 1); \
394 SV *my_sv = newRV_noinc(self); \
395 sv_bless(my_sv, gv_stashpv("Storable::Cxt", GV_ADD)); \
396 cxt = (stcxt_t *)SvPVX(self); \
397 Zero(cxt, 1, stcxt_t); \
398 cxt->my_sv = my_sv; \
401 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
403 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
405 SV *perinterp_sv = perl_get_sv(MY_VERSION, 0)
406 #else /* >= perl5.004_68 */
408 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
409 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
410 #endif /* < perl5.004_68 */
412 #define dSTCXT_PTR(T,name) \
413 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
414 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
417 dSTCXT_PTR(stcxt_t *, cxt)
421 NEW_STORABLE_CXT_OBJ(cxt); \
422 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
424 #define SET_STCXT(x) \
427 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
430 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
432 static stcxt_t *Context_ptr = NULL;
433 #define dSTCXT stcxt_t *cxt = Context_ptr
434 #define SET_STCXT(x) Context_ptr = x
437 NEW_STORABLE_CXT_OBJ(cxt); \
441 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
445 * Croaking implies a memory leak, since we don't use setjmp/longjmp
446 * to catch the exit and free memory used during store or retrieve
447 * operations. This is not too difficult to fix, but I need to understand
448 * how Perl does it, and croaking is exceptional anyway, so I lack the
449 * motivation to do it.
451 * The current workaround is to mark the context as dirty when croaking,
452 * so that data structures can be freed whenever we renter Storable code
453 * (but only *then*: it's a workaround, not a fix).
455 * This is also imperfect, because we don't really know how far they trapped
456 * the croak(), and when we were recursing, we won't be able to clean anything
457 * but the topmost context stacked.
460 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
463 * End of "thread-safe" related definitions.
469 * Keep only the low 32 bits of a pointer (used for tags, which are not
474 #define LOW_32BITS(x) ((I32) (x))
476 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
482 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
483 * Used in the WLEN and RLEN macros.
487 #define oI(x) ((I32 *) ((char *) (x) + 4))
488 #define oS(x) ((x) - 4)
489 #define oC(x) (x = 0)
498 * key buffer handling
500 #define kbuf (cxt->keybuf).arena
501 #define ksiz (cxt->keybuf).asiz
505 TRACEME(("** allocating kbuf of 128 bytes")); \
506 New(10003, kbuf, 128, char); \
513 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
514 Renew(kbuf, x+1, char); \
520 * memory buffer handling
522 #define mbase (cxt->membuf).arena
523 #define msiz (cxt->membuf).asiz
524 #define mptr (cxt->membuf).aptr
525 #define mend (cxt->membuf).aend
527 #define MGROW (1 << 13)
528 #define MMASK (MGROW - 1)
530 #define round_mgrow(x) \
531 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
532 #define trunc_int(x) \
533 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
534 #define int_aligned(x) \
535 ((unsigned long) (x) == trunc_int(x))
537 #define MBUF_INIT(x) \
540 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
541 New(10003, mbase, MGROW, char); \
542 msiz = (STRLEN)MGROW; \
548 mend = mbase + msiz; \
551 #define MBUF_TRUNC(x) mptr = mbase + x
552 #define MBUF_SIZE() (mptr - mbase)
558 * Those macros are used in do_retrieve() to save the current memory
559 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
560 * data from a string.
562 #define MBUF_SAVE_AND_LOAD(in) \
564 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
565 cxt->membuf_ro = 1; \
566 TRACEME(("saving mbuf")); \
567 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
571 #define MBUF_RESTORE() \
573 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
574 cxt->membuf_ro = 0; \
575 TRACEME(("restoring mbuf")); \
576 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
580 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
581 * See store_scalar() for other usage of this workaround.
583 #define MBUF_LOAD(v) \
585 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
587 CROAK(("Not a scalar string")); \
588 mptr = mbase = SvPV(v, msiz); \
589 mend = mbase + msiz; \
592 #define MBUF_XTEND(x) \
594 int nsz = (int) round_mgrow((x)+msiz); \
595 int offset = mptr - mbase; \
596 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
597 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
599 Renew(mbase, nsz, char); \
601 mptr = mbase + offset; \
602 mend = mbase + nsz; \
605 #define MBUF_CHK(x) \
607 if ((mptr + (x)) > mend) \
611 #define MBUF_GETC(x) \
614 x = (int) (unsigned char) *mptr++; \
620 #define MBUF_GETINT(x) \
623 if ((mptr + 4) <= mend) { \
624 memcpy(oI(&x), mptr, 4); \
630 #define MBUF_GETINT(x) \
632 if ((mptr + sizeof(int)) <= mend) { \
633 if (int_aligned(mptr)) \
636 memcpy(&x, mptr, sizeof(int)); \
637 mptr += sizeof(int); \
643 #define MBUF_READ(x,s) \
645 if ((mptr + (s)) <= mend) { \
646 memcpy(x, mptr, s); \
652 #define MBUF_SAFEREAD(x,s,z) \
654 if ((mptr + (s)) <= mend) { \
655 memcpy(x, mptr, s); \
663 #define MBUF_SAFEPVREAD(x,s,z) \
665 if ((mptr + (s)) <= mend) { \
666 memcpy(x, mptr, s); \
674 #define MBUF_PUTC(c) \
677 *mptr++ = (char) c; \
680 *mptr++ = (char) c; \
685 #define MBUF_PUTINT(i) \
688 memcpy(mptr, oI(&i), 4); \
692 #define MBUF_PUTINT(i) \
694 MBUF_CHK(sizeof(int)); \
695 if (int_aligned(mptr)) \
698 memcpy(mptr, &i, sizeof(int)); \
699 mptr += sizeof(int); \
703 #define MBUF_WRITE(x,s) \
706 memcpy(mptr, x, s); \
711 * Possible return values for sv_type().
715 #define svis_SCALAR 1
719 #define svis_TIED_ITEM 5
727 #define SHF_TYPE_MASK 0x03
728 #define SHF_LARGE_CLASSLEN 0x04
729 #define SHF_LARGE_STRLEN 0x08
730 #define SHF_LARGE_LISTLEN 0x10
731 #define SHF_IDX_CLASSNAME 0x20
732 #define SHF_NEED_RECURSE 0x40
733 #define SHF_HAS_LIST 0x80
736 * Types for SX_HOOK (last 2 bits in flags).
742 #define SHT_EXTRA 3 /* Read extra byte for type */
745 * The following are held in the "extra byte"...
748 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
749 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
750 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
753 * per hash flags for flagged hashes
756 #define SHV_RESTRICTED 0x01
759 * per key flags for flagged hashes
762 #define SHV_K_UTF8 0x01
763 #define SHV_K_WASUTF8 0x02
764 #define SHV_K_LOCKED 0x04
765 #define SHV_K_ISSV 0x08
766 #define SHV_K_PLACEHOLDER 0x10
769 * Before 0.6, the magic string was "perl-store" (binary version number 0).
771 * Since 0.6 introduced many binary incompatibilities, the magic string has
772 * been changed to "pst0" to allow an old image to be properly retrieved by
773 * a newer Storable, but ensure a newer image cannot be retrieved with an
776 * At 0.7, objects are given the ability to serialize themselves, and the
777 * set of markers is extended, backward compatibility is not jeopardized,
778 * so the binary version number could have remained unchanged. To correctly
779 * spot errors if a file making use of 0.7-specific extensions is given to
780 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
781 * a "minor" version, to better track this kind of evolution from now on.
784 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
785 static const char magicstr[] = "pst0"; /* Used as a magic number */
787 #define MAGICSTR_BYTES 'p','s','t','0'
788 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
790 /* 5.6.x introduced the ability to have IVs as long long.
791 However, Configure still defined BYTEORDER based on the size of a long.
792 Storable uses the BYTEORDER value as part of the header, but doesn't
793 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
794 with IV as long long on a platform that uses Configure (ie most things
795 except VMS and Windows) headers are identical for the different IV sizes,
796 despite the files containing some fields based on sizeof(IV)
798 5.8 is consistent - the following redifinition kludge is only needed on
799 5.6.x, but the interwork is needed on 5.8 while data survives in files
804 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
805 #ifndef NO_56_INTERWORK_KLUDGE
806 #define USE_56_INTERWORK_KLUDGE
808 #if BYTEORDER == 0x1234
810 #define BYTEORDER 0x12345678
812 #if BYTEORDER == 0x4321
814 #define BYTEORDER 0x87654321
819 #if BYTEORDER == 0x1234
820 #define BYTEORDER_BYTES '1','2','3','4'
822 #if BYTEORDER == 0x12345678
823 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
824 #ifdef USE_56_INTERWORK_KLUDGE
825 #define BYTEORDER_BYTES_56 '1','2','3','4'
828 #if BYTEORDER == 0x87654321
829 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
830 #ifdef USE_56_INTERWORK_KLUDGE
831 #define BYTEORDER_BYTES_56 '4','3','2','1'
834 #if BYTEORDER == 0x4321
835 #define BYTEORDER_BYTES '4','3','2','1'
837 #error Unknown byteorder. Please append your byteorder to Storable.xs
843 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
844 #ifdef USE_56_INTERWORK_KLUDGE
845 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
848 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
849 #define STORABLE_BIN_MINOR 7 /* Binary minor "version" */
851 #if (PATCHLEVEL <= 5)
852 #define STORABLE_BIN_WRITE_MINOR 4
855 * Perl 5.6.0 onwards can do weak references.
857 #define STORABLE_BIN_WRITE_MINOR 7
858 #endif /* (PATCHLEVEL <= 5) */
860 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
861 #define PL_sv_placeholder PL_sv_undef
865 * Useful store shortcuts...
869 * Note that if you put more than one mark for storing a particular
870 * type of thing, *and* in the retrieve_foo() function you mark both
871 * the thingy's you get off with SEEN(), you *must* increase the
872 * tagnum with cxt->tagnum++ along with this macro!
879 else if (PerlIO_putc(cxt->fio, x) == EOF) \
883 #define WRITE_I32(x) \
885 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
888 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
895 if (cxt->netorder) { \
896 int y = (int) htonl(x); \
899 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
904 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
909 #define WLEN(x) WRITE_I32(x)
916 else if (PerlIO_write(cxt->fio, x, y) != y) \
920 #define STORE_PV_LEN(pv, len, small, large) \
922 if (len <= LG_SCALAR) { \
923 unsigned char clen = (unsigned char) len; \
935 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
938 * Store &PL_sv_undef in arrays without recursing through store().
940 #define STORE_SV_UNDEF() \
943 PUTMARK(SX_SV_UNDEF); \
947 * Useful retrieve shortcuts...
951 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
957 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
961 #define READ_I32(x) \
963 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
967 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
977 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
980 x = (int) ntohl(x); \
983 #define RLEN(x) READ_I32(x)
990 else if (PerlIO_read(cxt->fio, x, y) != y) \
994 #define SAFEREAD(x,y,z) \
997 MBUF_SAFEREAD(x,y,z); \
998 else if (PerlIO_read(cxt->fio, x, y) != y) { \
1004 #define SAFEPVREAD(x,y,z) \
1007 MBUF_SAFEPVREAD(x,y,z); \
1008 else if (PerlIO_read(cxt->fio, x, y) != y) { \
1015 * This macro is used at retrieve time, to remember where object 'y', bearing a
1016 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
1017 * we'll therefore know where it has been retrieved and will be able to
1018 * share the same reference, as in the original stored memory image.
1020 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
1021 * on the objects given to STORABLE_thaw and expect that to be defined), and
1022 * also for overloaded objects (for which we might not find the stash if the
1023 * object is not blessed yet--this might occur for overloaded objects that
1024 * refer to themselves indirectly: if we blessed upon return from a sub
1025 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
1026 * restored on it because the underlying object would not be blessed yet!).
1028 * To achieve that, the class name of the last retrieved object is passed down
1029 * recursively, and the first SEEN() call for which the class name is not NULL
1030 * will bless the object.
1032 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
1034 #define SEEN(y,c,i) \
1038 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
1040 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
1041 PTR2UV(y), SvREFCNT(y)-1)); \
1043 BLESS((SV *) (y), c); \
1047 * Bless `s' in `p', via a temporary reference, required by sv_bless().
1049 #define BLESS(s,p) \
1053 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
1054 stash = gv_stashpv((p), GV_ADD); \
1055 ref = newRV_noinc(s); \
1056 (void) sv_bless(ref, stash); \
1057 SvRV_set(ref, NULL); \
1058 SvREFCNT_dec(ref); \
1061 * sort (used in store_hash) - conditionally use qsort when
1062 * sortsv is not available ( <= 5.6.1 ).
1065 #if (PATCHLEVEL <= 6)
1067 #if defined(USE_ITHREADS)
1069 #define STORE_HASH_SORT \
1071 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
1072 SAVESPTR(orig_perl); \
1073 PERL_SET_CONTEXT(aTHX); \
1074 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
1077 #else /* ! USE_ITHREADS */
1079 #define STORE_HASH_SORT \
1080 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1082 #endif /* USE_ITHREADS */
1084 #else /* PATCHLEVEL > 6 */
1086 #define STORE_HASH_SORT \
1087 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1089 #endif /* PATCHLEVEL <= 6 */
1091 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1092 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname);
1095 * Dynamic dispatching table for SV store.
1098 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1099 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1100 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1101 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1102 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1103 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1104 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1105 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1106 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1108 typedef int (*sv_store_t)(pTHX_ stcxt_t *cxt, SV *sv);
1110 static const sv_store_t sv_store[] = {
1111 (sv_store_t)store_ref, /* svis_REF */
1112 (sv_store_t)store_scalar, /* svis_SCALAR */
1113 (sv_store_t)store_array, /* svis_ARRAY */
1114 (sv_store_t)store_hash, /* svis_HASH */
1115 (sv_store_t)store_tied, /* svis_TIED */
1116 (sv_store_t)store_tied_item, /* svis_TIED_ITEM */
1117 (sv_store_t)store_code, /* svis_CODE */
1118 (sv_store_t)store_other, /* svis_OTHER */
1121 #define SV_STORE(x) (*sv_store[x])
1124 * Dynamic dispatching tables for SV retrieval.
1127 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname);
1128 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname);
1129 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1130 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1131 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname);
1132 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname);
1133 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname);
1134 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname);
1135 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname);
1136 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname);
1137 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1138 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname);
1139 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname);
1140 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname);
1141 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1142 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname);
1144 typedef SV* (*sv_retrieve_t)(pTHX_ stcxt_t *cxt, const char *name);
1146 static const sv_retrieve_t sv_old_retrieve[] = {
1147 0, /* SX_OBJECT -- entry unused dynamically */
1148 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1149 (sv_retrieve_t)old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1150 (sv_retrieve_t)old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1151 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1152 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1153 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1154 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1155 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1156 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1157 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1158 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1159 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1160 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1161 (sv_retrieve_t)retrieve_other, /* SX_SV_UNDEF not supported */
1162 (sv_retrieve_t)retrieve_other, /* SX_SV_YES not supported */
1163 (sv_retrieve_t)retrieve_other, /* SX_SV_NO not supported */
1164 (sv_retrieve_t)retrieve_other, /* SX_BLESS not supported */
1165 (sv_retrieve_t)retrieve_other, /* SX_IX_BLESS not supported */
1166 (sv_retrieve_t)retrieve_other, /* SX_HOOK not supported */
1167 (sv_retrieve_t)retrieve_other, /* SX_OVERLOADED not supported */
1168 (sv_retrieve_t)retrieve_other, /* SX_TIED_KEY not supported */
1169 (sv_retrieve_t)retrieve_other, /* SX_TIED_IDX not supported */
1170 (sv_retrieve_t)retrieve_other, /* SX_UTF8STR not supported */
1171 (sv_retrieve_t)retrieve_other, /* SX_LUTF8STR not supported */
1172 (sv_retrieve_t)retrieve_other, /* SX_FLAG_HASH not supported */
1173 (sv_retrieve_t)retrieve_other, /* SX_CODE not supported */
1174 (sv_retrieve_t)retrieve_other, /* SX_WEAKREF not supported */
1175 (sv_retrieve_t)retrieve_other, /* SX_WEAKOVERLOAD not supported */
1176 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1179 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1180 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1181 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname);
1182 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname);
1183 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname);
1184 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1185 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1186 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname);
1187 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname);
1188 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname);
1189 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname);
1190 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname);
1191 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname);
1192 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname);
1193 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname);
1195 static const sv_retrieve_t sv_retrieve[] = {
1196 0, /* SX_OBJECT -- entry unused dynamically */
1197 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1198 (sv_retrieve_t)retrieve_array, /* SX_ARRAY */
1199 (sv_retrieve_t)retrieve_hash, /* SX_HASH */
1200 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1201 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1202 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1203 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1204 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1205 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1206 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1207 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1208 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1209 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1210 (sv_retrieve_t)retrieve_sv_undef, /* SX_SV_UNDEF */
1211 (sv_retrieve_t)retrieve_sv_yes, /* SX_SV_YES */
1212 (sv_retrieve_t)retrieve_sv_no, /* SX_SV_NO */
1213 (sv_retrieve_t)retrieve_blessed, /* SX_BLESS */
1214 (sv_retrieve_t)retrieve_idx_blessed, /* SX_IX_BLESS */
1215 (sv_retrieve_t)retrieve_hook, /* SX_HOOK */
1216 (sv_retrieve_t)retrieve_overloaded, /* SX_OVERLOAD */
1217 (sv_retrieve_t)retrieve_tied_key, /* SX_TIED_KEY */
1218 (sv_retrieve_t)retrieve_tied_idx, /* SX_TIED_IDX */
1219 (sv_retrieve_t)retrieve_utf8str, /* SX_UTF8STR */
1220 (sv_retrieve_t)retrieve_lutf8str, /* SX_LUTF8STR */
1221 (sv_retrieve_t)retrieve_flag_hash, /* SX_HASH */
1222 (sv_retrieve_t)retrieve_code, /* SX_CODE */
1223 (sv_retrieve_t)retrieve_weakref, /* SX_WEAKREF */
1224 (sv_retrieve_t)retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
1225 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1228 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1230 static SV *mbuf2sv(pTHX);
1233 *** Context management.
1239 * Called once per "thread" (interpreter) to initialize some global context.
1241 static void init_perinterp(pTHX)
1245 cxt->netorder = 0; /* true if network order used */
1246 cxt->forgive_me = -1; /* whether to be forgiving... */
1247 cxt->accept_future_minor = -1; /* would otherwise occur too late */
1253 * Called at the end of every context cleaning, to perform common reset
1256 static void reset_context(stcxt_t *cxt)
1260 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1264 * init_store_context
1266 * Initialize a new store context for real recursion.
1268 static void init_store_context(
1275 TRACEME(("init_store_context"));
1277 cxt->netorder = network_order;
1278 cxt->forgive_me = -1; /* Fetched from perl if needed */
1279 cxt->deparse = -1; /* Idem */
1280 cxt->eval = NULL; /* Idem */
1281 cxt->canonical = -1; /* Idem */
1282 cxt->tagnum = -1; /* Reset tag numbers */
1283 cxt->classnum = -1; /* Reset class numbers */
1284 cxt->fio = f; /* Where I/O are performed */
1285 cxt->optype = optype; /* A store, or a deep clone */
1286 cxt->entry = 1; /* No recursion yet */
1289 * The `hseen' table is used to keep track of each SV stored and their
1290 * associated tag numbers is special. It is "abused" because the
1291 * values stored are not real SV, just integers cast to (SV *),
1292 * which explains the freeing below.
1294 * It is also one possible bottlneck to achieve good storing speed,
1295 * so the "shared keys" optimization is turned off (unlikely to be
1296 * of any use here), and the hash table is "pre-extended". Together,
1297 * those optimizations increase the throughput by 12%.
1300 #ifdef USE_PTR_TABLE
1301 cxt->pseen = ptr_table_new();
1304 cxt->hseen = newHV(); /* Table where seen objects are stored */
1305 HvSHAREKEYS_off(cxt->hseen);
1308 * The following does not work well with perl5.004_04, and causes
1309 * a core dump later on, in a completely unrelated spot, which
1310 * makes me think there is a memory corruption going on.
1312 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1313 * it below does not make any difference. It seems to work fine
1314 * with perl5.004_68 but given the probable nature of the bug,
1315 * that does not prove anything.
1317 * It's a shame because increasing the amount of buckets raises
1318 * store() throughput by 5%, but until I figure this out, I can't
1319 * allow for this to go into production.
1321 * It is reported fixed in 5.005, hence the #if.
1323 #if PERL_VERSION >= 5
1324 #define HBUCKETS 4096 /* Buckets for %hseen */
1325 #ifndef USE_PTR_TABLE
1326 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1331 * The `hclass' hash uses the same settings as `hseen' above, but it is
1332 * used to assign sequential tags (numbers) to class names for blessed
1335 * We turn the shared key optimization on.
1338 cxt->hclass = newHV(); /* Where seen classnames are stored */
1340 #if PERL_VERSION >= 5
1341 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1345 * The `hook' hash table is used to keep track of the references on
1346 * the STORABLE_freeze hook routines, when found in some class name.
1348 * It is assumed that the inheritance tree will not be changed during
1349 * storing, and that no new method will be dynamically created by the
1353 cxt->hook = newHV(); /* Table where hooks are cached */
1356 * The `hook_seen' array keeps track of all the SVs returned by
1357 * STORABLE_freeze hooks for us to serialize, so that they are not
1358 * reclaimed until the end of the serialization process. Each SV is
1359 * only stored once, the first time it is seen.
1362 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1366 * clean_store_context
1368 * Clean store context by
1370 static void clean_store_context(pTHX_ stcxt_t *cxt)
1374 TRACEME(("clean_store_context"));
1376 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1379 * Insert real values into hashes where we stored faked pointers.
1382 #ifndef USE_PTR_TABLE
1384 hv_iterinit(cxt->hseen);
1385 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1386 HeVAL(he) = &PL_sv_undef;
1391 hv_iterinit(cxt->hclass);
1392 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1393 HeVAL(he) = &PL_sv_undef;
1397 * And now dispose of them...
1399 * The surrounding if() protection has been added because there might be
1400 * some cases where this routine is called more than once, during
1401 * exceptionnal events. This was reported by Marc Lehmann when Storable
1402 * is executed from mod_perl, and the fix was suggested by him.
1403 * -- RAM, 20/12/2000
1406 #ifdef USE_PTR_TABLE
1408 struct ptr_tbl *pseen = cxt->pseen;
1410 ptr_table_free(pseen);
1412 assert(!cxt->hseen);
1415 HV *hseen = cxt->hseen;
1418 sv_free((SV *) hseen);
1423 HV *hclass = cxt->hclass;
1426 sv_free((SV *) hclass);
1430 HV *hook = cxt->hook;
1433 sv_free((SV *) hook);
1436 if (cxt->hook_seen) {
1437 AV *hook_seen = cxt->hook_seen;
1439 av_undef(hook_seen);
1440 sv_free((SV *) hook_seen);
1443 cxt->forgive_me = -1; /* Fetched from perl if needed */
1444 cxt->deparse = -1; /* Idem */
1446 SvREFCNT_dec(cxt->eval);
1448 cxt->eval = NULL; /* Idem */
1449 cxt->canonical = -1; /* Idem */
1455 * init_retrieve_context
1457 * Initialize a new retrieve context for real recursion.
1459 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1461 TRACEME(("init_retrieve_context"));
1464 * The hook hash table is used to keep track of the references on
1465 * the STORABLE_thaw hook routines, when found in some class name.
1467 * It is assumed that the inheritance tree will not be changed during
1468 * storing, and that no new method will be dynamically created by the
1472 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1474 #ifdef USE_PTR_TABLE
1479 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1480 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1481 * the correspondance between the tags and the tag number used by the
1482 * new retrieve routines.
1485 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1488 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1489 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1490 cxt->aclass = newAV(); /* Where seen classnames are kept */
1491 cxt->tagnum = 0; /* Have to count objects... */
1492 cxt->classnum = 0; /* ...and class names as well */
1493 cxt->optype = optype;
1494 cxt->s_tainted = is_tainted;
1495 cxt->entry = 1; /* No recursion yet */
1496 #ifndef HAS_RESTRICTED_HASHES
1497 cxt->derestrict = -1; /* Fetched from perl if needed */
1499 #ifndef HAS_UTF8_ALL
1500 cxt->use_bytes = -1; /* Fetched from perl if needed */
1502 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1506 * clean_retrieve_context
1508 * Clean retrieve context by
1510 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1512 TRACEME(("clean_retrieve_context"));
1514 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1517 AV *aseen = cxt->aseen;
1520 sv_free((SV *) aseen);
1522 cxt->where_is_undef = -1;
1525 AV *aclass = cxt->aclass;
1528 sv_free((SV *) aclass);
1532 HV *hook = cxt->hook;
1535 sv_free((SV *) hook);
1539 HV *hseen = cxt->hseen;
1542 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1545 #ifndef HAS_RESTRICTED_HASHES
1546 cxt->derestrict = -1; /* Fetched from perl if needed */
1548 #ifndef HAS_UTF8_ALL
1549 cxt->use_bytes = -1; /* Fetched from perl if needed */
1551 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1559 * A workaround for the CROAK bug: cleanup the last context.
1561 static void clean_context(pTHX_ stcxt_t *cxt)
1563 TRACEME(("clean_context"));
1565 ASSERT(cxt->s_dirty, ("dirty context"));
1570 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1572 if (cxt->optype & ST_RETRIEVE)
1573 clean_retrieve_context(aTHX_ cxt);
1574 else if (cxt->optype & ST_STORE)
1575 clean_store_context(aTHX_ cxt);
1579 ASSERT(!cxt->s_dirty, ("context is clean"));
1580 ASSERT(cxt->entry == 0, ("context is reset"));
1586 * Allocate a new context and push it on top of the parent one.
1587 * This new context is made globally visible via SET_STCXT().
1589 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1593 TRACEME(("allocate_context"));
1595 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1597 NEW_STORABLE_CXT_OBJ(cxt);
1598 cxt->prev = parent_cxt->my_sv;
1601 ASSERT(!cxt->s_dirty, ("clean context"));
1609 * Free current context, which cannot be the "root" one.
1610 * Make the context underneath globally visible via SET_STCXT().
1612 static void free_context(pTHX_ stcxt_t *cxt)
1614 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1616 TRACEME(("free_context"));
1618 ASSERT(!cxt->s_dirty, ("clean context"));
1619 ASSERT(prev, ("not freeing root context"));
1621 SvREFCNT_dec(cxt->my_sv);
1624 ASSERT(cxt, ("context not void"));
1634 * Tells whether we're in the middle of a store operation.
1636 static int is_storing(pTHX)
1640 return cxt->entry && (cxt->optype & ST_STORE);
1646 * Tells whether we're in the middle of a retrieve operation.
1648 static int is_retrieving(pTHX)
1652 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1656 * last_op_in_netorder
1658 * Returns whether last operation was made using network order.
1660 * This is typically out-of-band information that might prove useful
1661 * to people wishing to convert native to network order data when used.
1663 static int last_op_in_netorder(pTHX)
1667 return cxt->netorder;
1671 *** Hook lookup and calling routines.
1677 * A wrapper on gv_fetchmethod_autoload() which caches results.
1679 * Returns the routine reference as an SV*, or null if neither the package
1680 * nor its ancestors know about the method.
1682 static SV *pkg_fetchmeth(
1690 const char *hvname = HvNAME_get(pkg);
1694 * The following code is the same as the one performed by UNIVERSAL::can
1698 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1699 if (gv && isGV(gv)) {
1700 sv = newRV((SV*) GvCV(gv));
1701 TRACEME(("%s->%s: 0x%"UVxf, hvname, method, PTR2UV(sv)));
1703 sv = newSVsv(&PL_sv_undef);
1704 TRACEME(("%s->%s: not found", hvname, method));
1708 * Cache the result, ignoring failure: if we can't store the value,
1709 * it just won't be cached.
1712 (void) hv_store(cache, hvname, strlen(hvname), sv, 0);
1714 return SvOK(sv) ? sv : (SV *) 0;
1720 * Force cached value to be undef: hook ignored even if present.
1722 static void pkg_hide(
1728 const char *hvname = HvNAME_get(pkg);
1729 (void) hv_store(cache,
1730 hvname, strlen(hvname), newSVsv(&PL_sv_undef), 0);
1736 * Discard cached value: a whole fetch loop will be retried at next lookup.
1738 static void pkg_uncache(
1744 const char *hvname = HvNAME_get(pkg);
1745 (void) hv_delete(cache, hvname, strlen(hvname), G_DISCARD);
1751 * Our own "UNIVERSAL::can", which caches results.
1753 * Returns the routine reference as an SV*, or null if the object does not
1754 * know about the method.
1764 const char *hvname = HvNAME_get(pkg);
1766 TRACEME(("pkg_can for %s->%s", hvname, method));
1769 * Look into the cache to see whether we already have determined
1770 * where the routine was, if any.
1772 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1773 * that only one hook (i.e. always the same) is cached in a given cache.
1776 svh = hv_fetch(cache, hvname, strlen(hvname), FALSE);
1780 TRACEME(("cached %s->%s: not found", hvname, method));
1783 TRACEME(("cached %s->%s: 0x%"UVxf,
1784 hvname, method, PTR2UV(sv)));
1789 TRACEME(("not cached yet"));
1790 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1796 * Call routine as obj->hook(av) in scalar context.
1797 * Propagates the single returned value if not called in void context.
1799 static SV *scalar_call(
1811 TRACEME(("scalar_call (cloning=%d)", cloning));
1818 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1820 SV **ary = AvARRAY(av);
1821 int cnt = AvFILLp(av) + 1;
1823 XPUSHs(ary[0]); /* Frozen string */
1824 for (i = 1; i < cnt; i++) {
1825 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1826 i, PTR2UV(ary[i])));
1827 XPUSHs(sv_2mortal(newRV(ary[i])));
1832 TRACEME(("calling..."));
1833 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1834 TRACEME(("count = %d", count));
1840 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1853 * Call routine obj->hook(cloning) in list context.
1854 * Returns the list of returned values in an array.
1856 static AV *array_call(
1867 TRACEME(("array_call (cloning=%d)", cloning));
1873 XPUSHs(obj); /* Target object */
1874 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1877 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1882 for (i = count - 1; i >= 0; i--) {
1884 av_store(av, i, SvREFCNT_inc(sv));
1897 * Lookup the class name in the `hclass' table and either assign it a new ID
1898 * or return the existing one, by filling in `classnum'.
1900 * Return true if the class was known, false if the ID was just generated.
1902 static int known_class(
1905 char *name, /* Class name */
1906 int len, /* Name length */
1910 HV *hclass = cxt->hclass;
1912 TRACEME(("known_class (%s)", name));
1915 * Recall that we don't store pointers in this hash table, but tags.
1916 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1919 svh = hv_fetch(hclass, name, len, FALSE);
1921 *classnum = LOW_32BITS(*svh);
1926 * Unknown classname, we need to record it.
1930 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1931 CROAK(("Unable to record new classname"));
1933 *classnum = cxt->classnum;
1938 *** Sepcific store routines.
1944 * Store a reference.
1945 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1947 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1950 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1953 * Follow reference, and check if target is overloaded.
1959 TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1964 HV *stash = (HV *) SvSTASH(sv);
1965 if (stash && Gv_AMG(stash)) {
1966 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1967 PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1969 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1971 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1973 return store(aTHX_ cxt, sv);
1981 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1982 * The <data> section is omitted if <length> is 0.
1984 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1985 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1987 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
1992 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1994 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1997 * For efficiency, break the SV encapsulation by peaking at the flags
1998 * directly without using the Perl macros to avoid dereferencing
1999 * sv->sv_flags each time we wish to check the flags.
2002 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
2003 if (sv == &PL_sv_undef) {
2004 TRACEME(("immortal undef"));
2005 PUTMARK(SX_SV_UNDEF);
2007 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
2014 * Always store the string representation of a scalar if it exists.
2015 * Gisle Aas provided me with this test case, better than a long speach:
2017 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
2018 * SV = PVNV(0x80c8520)
2020 * FLAGS = (NOK,POK,pNOK,pPOK)
2023 * PV = 0x80c83d0 "abc"\0
2027 * Write SX_SCALAR, length, followed by the actual data.
2029 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
2030 * appropriate, followed by the actual (binary) data. A double
2031 * is written as a string if network order, for portability.
2033 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
2034 * The reason is that when the scalar value is tainted, the SvNOK(sv)
2037 * The test for a read-only scalar with both POK and NOK set is meant
2038 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
2039 * address comparison for each scalar we store.
2042 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
2044 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
2045 if (sv == &PL_sv_yes) {
2046 TRACEME(("immortal yes"));
2048 } else if (sv == &PL_sv_no) {
2049 TRACEME(("immortal no"));
2052 pv = SvPV(sv, len); /* We know it's SvPOK */
2053 goto string; /* Share code below */
2055 } else if (flags & SVf_POK) {
2056 /* public string - go direct to string read. */
2057 goto string_readlen;
2059 #if (PATCHLEVEL <= 6)
2060 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
2061 direct if NV flag is off. */
2062 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
2064 /* 5.7 rules are that if IV public flag is set, IV value is as
2065 good, if not better, than NV value. */
2071 * Will come here from below with iv set if double is an integer.
2075 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2077 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
2078 * (for example) and that ends up in the optimised small integer
2081 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
2082 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
2083 goto string_readlen;
2087 * Optimize small integers into a single byte, otherwise store as
2088 * a real integer (converted into network order if they asked).
2091 if (iv >= -128 && iv <= 127) {
2092 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
2095 TRACEME(("small integer stored as %d", siv));
2096 } else if (cxt->netorder) {
2098 TRACEME(("no htonl, fall back to string for integer"));
2099 goto string_readlen;
2107 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2108 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
2110 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
2111 /* Bigger than 32 bits. */
2112 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2113 goto string_readlen;
2117 niv = (I32) htonl((I32) iv);
2118 TRACEME(("using network order"));
2123 PUTMARK(SX_INTEGER);
2124 WRITE(&iv, sizeof(iv));
2127 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2128 } else if (flags & SVf_NOK) {
2130 #if (PATCHLEVEL <= 6)
2133 * Watch for number being an integer in disguise.
2135 if (nv == (NV) (iv = I_V(nv))) {
2136 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2137 goto integer; /* Share code above */
2142 if (SvIOK_notUV(sv)) {
2144 goto integer; /* Share code above */
2149 if (cxt->netorder) {
2150 TRACEME(("double %"NVff" stored as string", nv));
2151 goto string_readlen; /* Share code below */
2155 WRITE(&nv, sizeof(nv));
2157 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2159 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2160 I32 wlen; /* For 64-bit machines */
2166 * Will come here from above if it was readonly, POK and NOK but
2167 * neither &PL_sv_yes nor &PL_sv_no.
2171 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2173 STORE_UTF8STR(pv, wlen);
2175 STORE_SCALAR(pv, wlen);
2176 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2177 PTR2UV(sv), SvPVX(sv), (IV)len));
2179 CROAK(("Can't determine type of %s(0x%"UVxf")",
2180 sv_reftype(sv, FALSE),
2182 return 0; /* Ok, no recursion on scalars */
2190 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2191 * Each item is stored as <object>.
2193 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2196 I32 len = av_len(av) + 1;
2200 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2203 * Signal array by emitting SX_ARRAY, followed by the array length.
2208 TRACEME(("size = %d", len));
2211 * Now store each item recursively.
2214 for (i = 0; i < len; i++) {
2215 sav = av_fetch(av, i, 0);
2217 TRACEME(("(#%d) undef item", i));
2221 TRACEME(("(#%d) item", i));
2222 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2226 TRACEME(("ok (array)"));
2232 #if (PATCHLEVEL <= 6)
2238 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2241 sortcmp(const void *a, const void *b)
2243 #if defined(USE_ITHREADS)
2245 #endif /* USE_ITHREADS */
2246 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2249 #endif /* PATCHLEVEL <= 6 */
2254 * Store a hash table.
2256 * For a "normal" hash (not restricted, no utf8 keys):
2258 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2259 * Values are stored as <object>.
2260 * Keys are stored as <length> <data>, the <data> section being omitted
2263 * For a "fancy" hash (restricted or utf8 keys):
2265 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2267 * Values are stored as <object>.
2268 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2270 * Currently the only hash flag is "restriced"
2271 * Key flags are as for hv.h
2273 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2277 #ifdef HAS_RESTRICTED_HASHES
2286 int flagged_hash = ((SvREADONLY(hv)
2287 #ifdef HAS_HASH_KEY_FLAGS
2291 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2294 /* needs int cast for C++ compilers, doesn't it? */
2295 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2298 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2302 * Signal hash by emitting SX_HASH, followed by the table length.
2306 PUTMARK(SX_FLAG_HASH);
2307 PUTMARK(hash_flags);
2312 TRACEME(("size = %d", len));
2315 * Save possible iteration state via each() on that table.
2318 riter = HvRITER_get(hv);
2319 eiter = HvEITER_get(hv);
2323 * Now store each item recursively.
2325 * If canonical is defined to some true value then store each
2326 * key/value pair in sorted order otherwise the order is random.
2327 * Canonical order is irrelevant when a deep clone operation is performed.
2329 * Fetch the value from perl only once per store() operation, and only
2334 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2335 (cxt->canonical < 0 && (cxt->canonical =
2336 (SvTRUE(perl_get_sv("Storable::canonical", GV_ADD)) ? 1 : 0))))
2339 * Storing in order, sorted by key.
2340 * Run through the hash, building up an array of keys in a
2341 * mortal array, sort the array and then run through the
2347 /*av_extend (av, len);*/
2349 TRACEME(("using canonical order"));
2351 for (i = 0; i < len; i++) {
2352 #ifdef HAS_RESTRICTED_HASHES
2353 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2355 HE *he = hv_iternext(hv);
2360 CROAK(("Hash %p inconsistent - expected %d keys, %dth is NULL", hv, len, i));
2361 key = hv_iterkeysv(he);
2362 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2367 for (i = 0; i < len; i++) {
2368 #ifdef HAS_RESTRICTED_HASHES
2369 int placeholders = (int)HvPLACEHOLDERS_get(hv);
2371 unsigned char flags = 0;
2375 SV *key = av_shift(av);
2376 /* This will fail if key is a placeholder.
2377 Track how many placeholders we have, and error if we
2379 HE *he = hv_fetch_ent(hv, key, 0, 0);
2383 if (!(val = HeVAL(he))) {
2384 /* Internal error, not I/O error */
2388 #ifdef HAS_RESTRICTED_HASHES
2389 /* Should be a placeholder. */
2390 if (placeholders-- < 0) {
2391 /* This should not happen - number of
2392 retrieves should be identical to
2393 number of placeholders. */
2396 /* Value is never needed, and PL_sv_undef is
2397 more space efficient to store. */
2400 ("Flags not 0 but %d", flags));
2401 flags = SHV_K_PLACEHOLDER;
2408 * Store value first.
2411 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2413 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2418 * Keys are written after values to make sure retrieval
2419 * can be optimal in terms of memory usage, where keys are
2420 * read into a fixed unique buffer called kbuf.
2421 * See retrieve_hash() for details.
2424 /* Implementation of restricted hashes isn't nicely
2426 if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
2427 flags |= SHV_K_LOCKED;
2430 keyval = SvPV(key, keylen_tmp);
2431 keylen = keylen_tmp;
2432 #ifdef HAS_UTF8_HASHES
2433 /* If you build without optimisation on pre 5.6
2434 then nothing spots that SvUTF8(key) is always 0,
2435 so the block isn't optimised away, at which point
2436 the linker dislikes the reference to
2439 const char *keysave = keyval;
2440 bool is_utf8 = TRUE;
2442 /* Just casting the &klen to (STRLEN) won't work
2443 well if STRLEN and I32 are of different widths.
2445 keyval = (char*)bytes_from_utf8((U8*)keyval,
2449 /* If we were able to downgrade here, then than
2450 means that we have a key which only had chars
2451 0-255, but was utf8 encoded. */
2453 if (keyval != keysave) {
2454 keylen = keylen_tmp;
2455 flags |= SHV_K_WASUTF8;
2457 /* keylen_tmp can't have changed, so no need
2458 to assign back to keylen. */
2459 flags |= SHV_K_UTF8;
2466 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2468 /* This is a workaround for a bug in 5.8.0
2469 that causes the HEK_WASUTF8 flag to be
2470 set on an HEK without the hash being
2471 marked as having key flags. We just
2472 cross our fingers and drop the flag.
2474 assert (flags == 0 || flags == SHV_K_WASUTF8);
2475 TRACEME(("(#%d) key '%s'", i, keyval));
2479 WRITE(keyval, keylen);
2480 if (flags & SHV_K_WASUTF8)
2485 * Free up the temporary array
2494 * Storing in "random" order (in the order the keys are stored
2495 * within the hash). This is the default and will be faster!
2498 for (i = 0; i < len; i++) {
2501 unsigned char flags;
2502 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2503 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2505 HE *he = hv_iternext(hv);
2507 SV *val = (he ? hv_iterval(hv, he) : 0);
2512 return 1; /* Internal error, not I/O error */
2514 /* Implementation of restricted hashes isn't nicely
2517 = (((hash_flags & SHV_RESTRICTED)
2519 ? SHV_K_LOCKED : 0);
2521 if (val == &PL_sv_placeholder) {
2522 flags |= SHV_K_PLACEHOLDER;
2527 * Store value first.
2530 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2532 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2536 hek = HeKEY_hek(he);
2538 if (len == HEf_SVKEY) {
2539 /* This is somewhat sick, but the internal APIs are
2540 * such that XS code could put one of these in in
2542 * Maybe we should be capable of storing one if
2545 key_sv = HeKEY_sv(he);
2546 flags |= SHV_K_ISSV;
2548 /* Regular string key. */
2549 #ifdef HAS_HASH_KEY_FLAGS
2551 flags |= SHV_K_UTF8;
2552 if (HEK_WASUTF8(hek))
2553 flags |= SHV_K_WASUTF8;
2559 * Keys are written after values to make sure retrieval
2560 * can be optimal in terms of memory usage, where keys are
2561 * read into a fixed unique buffer called kbuf.
2562 * See retrieve_hash() for details.
2567 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2569 /* This is a workaround for a bug in 5.8.0
2570 that causes the HEK_WASUTF8 flag to be
2571 set on an HEK without the hash being
2572 marked as having key flags. We just
2573 cross our fingers and drop the flag.
2575 assert (flags == 0 || flags == SHV_K_WASUTF8);
2576 TRACEME(("(#%d) key '%s'", i, key));
2578 if (flags & SHV_K_ISSV) {
2579 store(aTHX_ cxt, key_sv);
2588 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2591 HvRITER_set(hv, riter); /* Restore hash iterator state */
2592 HvEITER_set(hv, eiter);
2600 * Store a code reference.
2602 * Layout is SX_CODE <length> followed by a scalar containing the perl
2603 * source code of the code reference.
2605 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2607 #if PERL_VERSION < 6
2609 * retrieve_code does not work with perl 5.005 or less
2611 return store_other(aTHX_ cxt, (SV*)cv);
2616 SV *text, *bdeparse;
2618 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2621 cxt->deparse == 0 ||
2622 (cxt->deparse < 0 && !(cxt->deparse =
2623 SvTRUE(perl_get_sv("Storable::Deparse", GV_ADD)) ? 1 : 0))
2625 return store_other(aTHX_ cxt, (SV*)cv);
2629 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2630 * blessed code references.
2632 /* Ownership of both SVs is passed to load_module, which frees them. */
2633 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2640 * create the B::Deparse object
2644 XPUSHs(newSVpvs_flags("B::Deparse", SVs_TEMP));
2646 count = call_method("new", G_SCALAR);
2649 CROAK(("Unexpected return value from B::Deparse::new\n"));
2653 * call the coderef2text method
2657 XPUSHs(bdeparse); /* XXX is this already mortal? */
2658 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2660 count = call_method("coderef2text", G_SCALAR);
2663 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2667 reallen = strlen(SvPV_nolen(text));
2670 * Empty code references or XS functions are deparsed as
2671 * "(prototype) ;" or ";".
2674 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2675 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2679 * Signal code by emitting SX_CODE.
2683 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2684 TRACEME(("size = %d", len));
2685 TRACEME(("code = %s", SvPV_nolen(text)));
2688 * Now store the source code.
2691 STORE_SCALAR(SvPV_nolen(text), len);
2696 TRACEME(("ok (code)"));
2705 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2706 * a special mark, followed by the underlying tied object. For instance, when
2707 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2708 * <hash object> stands for the serialization of the tied hash.
2710 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2715 int svt = SvTYPE(sv);
2718 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2721 * We have a small run-time penalty here because we chose to factorise
2722 * all tieds objects into the same routine, and not have a store_tied_hash,
2723 * a store_tied_array, etc...
2725 * Don't use a switch() statement, as most compilers don't optimize that
2726 * well for 2/3 values. An if() else if() cascade is just fine. We put
2727 * tied hashes first, as they are the most likely beasts.
2730 if (svt == SVt_PVHV) {
2731 TRACEME(("tied hash"));
2732 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2733 } else if (svt == SVt_PVAV) {
2734 TRACEME(("tied array"));
2735 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2737 TRACEME(("tied scalar"));
2738 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2742 if (!(mg = mg_find(sv, mtype)))
2743 CROAK(("No magic '%c' found while storing tied %s", mtype,
2744 (svt == SVt_PVHV) ? "hash" :
2745 (svt == SVt_PVAV) ? "array" : "scalar"));
2748 * The mg->mg_obj found by mg_find() above actually points to the
2749 * underlying tied Perl object implementation. For instance, if the
2750 * original SV was that of a tied array, then mg->mg_obj is an AV.
2752 * Note that we store the Perl object as-is. We don't call its FETCH
2753 * method along the way. At retrieval time, we won't call its STORE
2754 * method either, but the tieing magic will be re-installed. In itself,
2755 * that ensures that the tieing semantics are preserved since futher
2756 * accesses on the retrieved object will indeed call the magic methods...
2759 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2760 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2761 if ((ret = store(aTHX_ cxt, obj)))
2764 TRACEME(("ok (tied)"));
2772 * Stores a reference to an item within a tied structure:
2774 * . \$h{key}, stores both the (tied %h) object and 'key'.
2775 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2777 * Layout is therefore either:
2778 * SX_TIED_KEY <object> <key>
2779 * SX_TIED_IDX <object> <index>
2781 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2786 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2788 if (!(mg = mg_find(sv, 'p')))
2789 CROAK(("No magic 'p' found while storing reference to tied item"));
2792 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2796 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2797 PUTMARK(SX_TIED_KEY);
2798 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2800 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2803 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2805 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2808 I32 idx = mg->mg_len;
2810 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2811 PUTMARK(SX_TIED_IDX);
2812 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2814 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2817 TRACEME(("store_tied_item: storing IDX %d", idx));
2822 TRACEME(("ok (tied item)"));
2828 * store_hook -- dispatched manually, not via sv_store[]
2830 * The blessed SV is serialized by a hook.
2834 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2836 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2837 * the trailing part [] is present, the type of object (scalar, array or hash).
2838 * There is also a bit which says how the classname is stored between:
2843 * and when the <index> form is used (classname already seen), the "large
2844 * classname" bit in <flags> indicates how large the <index> is.
2846 * The serialized string returned by the hook is of length <len2> and comes
2847 * next. It is an opaque string for us.
2849 * Those <len3> object IDs which are listed last represent the extra references
2850 * not directly serialized by the hook, but which are linked to the object.
2852 * When recursion is mandated to resolve object-IDs not yet seen, we have
2853 * instead, with <header> being flags with bits set to indicate the object type
2854 * and that recursion was indeed needed:
2856 * SX_HOOK <header> <object> <header> <object> <flags>
2858 * that same header being repeated between serialized objects obtained through
2859 * recursion, until we reach flags indicating no recursion, at which point
2860 * we know we've resynchronized with a single layout, after <flags>.
2862 * When storing a blessed ref to a tied variable, the following format is
2865 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2867 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2868 * real object type is held in the <extra> flag. At the very end of the
2869 * serialization stream, the underlying magic object is serialized, just like
2870 * any other tied variable.
2872 static int store_hook(
2886 int count; /* really len3 + 1 */
2887 unsigned char flags;
2890 int recursed = 0; /* counts recursion */
2891 int obj_type; /* object type, on 2 bits */
2894 int clone = cxt->optype & ST_CLONE;
2895 char mtype = '\0'; /* for blessed ref to tied structures */
2896 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2898 TRACEME(("store_hook, classname \"%s\", tagged #%d", HvNAME_get(pkg), cxt->tagnum));
2901 * Determine object type on 2 bits.
2906 obj_type = SHT_SCALAR;
2909 obj_type = SHT_ARRAY;
2912 obj_type = SHT_HASH;
2916 * Produced by a blessed ref to a tied data structure, $o in the
2917 * following Perl code.
2921 * my $o = bless \%h, 'BAR';
2923 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2924 * (since we have only 2 bits in <flags> to store the type), and an
2925 * <extra> byte flag will be emitted after the FIRST <flags> in the
2926 * stream, carrying what we put in `eflags'.
2928 obj_type = SHT_EXTRA;
2929 switch (SvTYPE(sv)) {
2931 eflags = (unsigned char) SHT_THASH;
2935 eflags = (unsigned char) SHT_TARRAY;
2939 eflags = (unsigned char) SHT_TSCALAR;
2945 CROAK(("Unexpected object type (%d) in store_hook()", type));
2947 flags = SHF_NEED_RECURSE | obj_type;
2949 classname = HvNAME_get(pkg);
2950 len = strlen(classname);
2953 * To call the hook, we need to fake a call like:
2955 * $object->STORABLE_freeze($cloning);
2957 * but we don't have the $object here. For instance, if $object is
2958 * a blessed array, what we have in `sv' is the array, and we can't
2959 * call a method on those.
2961 * Therefore, we need to create a temporary reference to the object and
2962 * make the call on that reference.
2965 TRACEME(("about to call STORABLE_freeze on class %s", classname));
2967 ref = newRV_noinc(sv); /* Temporary reference */
2968 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2969 SvRV_set(ref, NULL);
2970 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2972 count = AvFILLp(av) + 1;
2973 TRACEME(("store_hook, array holds %d items", count));
2976 * If they return an empty list, it means they wish to ignore the
2977 * hook for this class (and not just this instance -- that's for them
2978 * to handle if they so wish).
2980 * Simply disable the cached entry for the hook (it won't be recomputed
2981 * since it's present in the cache) and recurse to store_blessed().
2986 * They must not change their mind in the middle of a serialization.
2989 if (hv_fetch(cxt->hclass, classname, len, FALSE))
2990 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2991 (cxt->optype & ST_CLONE) ? "cloning" : "storing", classname));
2993 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
2995 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2996 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", classname));
2998 return store_blessed(aTHX_ cxt, sv, type, pkg);
3002 * Get frozen string.
3006 pv = SvPV(ary[0], len2);
3007 /* We can't use pkg_can here because it only caches one method per
3010 GV* gv = gv_fetchmethod_autoload(pkg, "STORABLE_attach", FALSE);
3011 if (gv && isGV(gv)) {
3013 CROAK(("Freeze cannot return references if %s class is using STORABLE_attach", classname));
3019 * If they returned more than one item, we need to serialize some
3020 * extra references if not already done.
3022 * Loop over the array, starting at position #1, and for each item,
3023 * ensure it is a reference, serialize it if not already done, and
3024 * replace the entry with the tag ID of the corresponding serialized
3027 * We CHEAT by not calling av_fetch() and read directly within the
3031 for (i = 1; i < count; i++) {
3032 #ifdef USE_PTR_TABLE
3040 AV *av_hook = cxt->hook_seen;
3043 CROAK(("Item #%d returned by STORABLE_freeze "
3044 "for %s is not a reference", i, classname));
3045 xsv = SvRV(rsv); /* Follow ref to know what to look for */
3048 * Look in hseen and see if we have a tag already.
3049 * Serialize entry if not done already, and get its tag.
3052 #ifdef USE_PTR_TABLE
3053 /* Fakery needed because ptr_table_fetch returns zero for a
3054 failure, whereas the existing code assumes that it can
3055 safely store a tag zero. So for ptr_tables we store tag+1
3057 if ((fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv)))
3058 goto sv_seen; /* Avoid moving code too far to the right */
3060 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
3061 goto sv_seen; /* Avoid moving code too far to the right */
3064 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
3067 * We need to recurse to store that object and get it to be known
3068 * so that we can resolve the list of object-IDs at retrieve time.
3070 * The first time we do this, we need to emit the proper header
3071 * indicating that we recursed, and what the type of object is (the
3072 * object we're storing via a user-hook). Indeed, during retrieval,
3073 * we'll have to create the object before recursing to retrieve the
3074 * others, in case those would point back at that object.
3077 /* [SX_HOOK] <flags> [<extra>] <object>*/
3081 if (obj_type == SHT_EXTRA)
3086 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
3089 #ifdef USE_PTR_TABLE
3090 fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv);
3092 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3094 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
3096 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3099 * It was the first time we serialized `xsv'.
3101 * Keep this SV alive until the end of the serialization: if we
3102 * disposed of it right now by decrementing its refcount, and it was
3103 * a temporary value, some next temporary value allocated during
3104 * another STORABLE_freeze might take its place, and we'd wrongly
3105 * assume that new SV was already serialized, based on its presence
3108 * Therefore, push it away in cxt->hook_seen.
3111 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
3115 * Dispose of the REF they returned. If we saved the `xsv' away
3116 * in the array of returned SVs, that will not cause the underlying
3117 * referenced SV to be reclaimed.
3120 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
3121 SvREFCNT_dec(rsv); /* Dispose of reference */
3124 * Replace entry with its tag (not a real SV, so no refcnt increment)
3127 #ifdef USE_PTR_TABLE
3128 tag = (SV *)--fake_tag;
3133 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
3134 i-1, PTR2UV(xsv), PTR2UV(tag)));
3138 * Allocate a class ID if not already done.
3140 * This needs to be done after the recursion above, since at retrieval
3141 * time, we'll see the inner objects first. Many thanks to
3142 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
3143 * proposed the right fix. -- RAM, 15/09/2000
3147 if (!known_class(aTHX_ cxt, classname, len, &classnum)) {
3148 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3149 classnum = -1; /* Mark: we must store classname */
3151 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3155 * Compute leading flags.
3159 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3160 flags |= SHF_LARGE_CLASSLEN;
3162 flags |= SHF_IDX_CLASSNAME;
3163 if (len2 > LG_SCALAR)
3164 flags |= SHF_LARGE_STRLEN;
3166 flags |= SHF_HAS_LIST;
3167 if (count > (LG_SCALAR + 1))
3168 flags |= SHF_LARGE_LISTLEN;
3171 * We're ready to emit either serialized form:
3173 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3174 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3176 * If we recursed, the SX_HOOK has already been emitted.
3179 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3180 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3181 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3183 /* SX_HOOK <flags> [<extra>] */
3187 if (obj_type == SHT_EXTRA)
3192 /* <len> <classname> or <index> */
3193 if (flags & SHF_IDX_CLASSNAME) {
3194 if (flags & SHF_LARGE_CLASSLEN)
3197 unsigned char cnum = (unsigned char) classnum;
3201 if (flags & SHF_LARGE_CLASSLEN)
3204 unsigned char clen = (unsigned char) len;
3207 WRITE(classname, len); /* Final \0 is omitted */
3210 /* <len2> <frozen-str> */
3211 if (flags & SHF_LARGE_STRLEN) {
3212 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3213 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3215 unsigned char clen = (unsigned char) len2;
3219 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3221 /* [<len3> <object-IDs>] */
3222 if (flags & SHF_HAS_LIST) {
3223 int len3 = count - 1;
3224 if (flags & SHF_LARGE_LISTLEN)
3227 unsigned char clen = (unsigned char) len3;
3232 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3233 * real pointer, rather a tag number, well under the 32-bit limit.
3236 for (i = 1; i < count; i++) {
3237 I32 tagval = htonl(LOW_32BITS(ary[i]));
3239 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3244 * Free the array. We need extra care for indices after 0, since they
3245 * don't hold real SVs but integers cast.
3249 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3254 * If object was tied, need to insert serialization of the magic object.
3257 if (obj_type == SHT_EXTRA) {
3260 if (!(mg = mg_find(sv, mtype))) {
3261 int svt = SvTYPE(sv);
3262 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3263 mtype, (svt == SVt_PVHV) ? "hash" :
3264 (svt == SVt_PVAV) ? "array" : "scalar"));
3267 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3268 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3274 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3282 * store_blessed -- dispatched manually, not via sv_store[]
3284 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3285 * of its ancestors. If there is, then redispatch to store_hook();
3287 * Otherwise, the blessed SV is stored using the following layout:
3289 * SX_BLESS <flag> <len> <classname> <object>
3291 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3292 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3293 * Otherwise, the low order bits give the length, thereby giving a compact
3294 * representation for class names less than 127 chars long.
3296 * Each <classname> seen is remembered and indexed, so that the next time
3297 * an object in the blessed in the same <classname> is stored, the following
3300 * SX_IX_BLESS <flag> <index> <object>
3302 * where <index> is the classname index, stored on 0 or 4 bytes depending
3303 * on the high-order bit in flag (same encoding as above for <len>).
3305 static int store_blessed(
3317 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME_get(pkg)));
3320 * Look for a hook for this blessed SV and redirect to store_hook()
3324 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3326 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3329 * This is a blessed SV without any serialization hook.
3332 classname = HvNAME_get(pkg);
3333 len = strlen(classname);
3335 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3336 PTR2UV(sv), classname, cxt->tagnum));
3339 * Determine whether it is the first time we see that class name (in which
3340 * case it will be stored in the SX_BLESS form), or whether we already
3341 * saw that class name before (in which case the SX_IX_BLESS form will be
3345 if (known_class(aTHX_ cxt, classname, len, &classnum)) {
3346 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3347 PUTMARK(SX_IX_BLESS);
3348 if (classnum <= LG_BLESS) {
3349 unsigned char cnum = (unsigned char) classnum;
3352 unsigned char flag = (unsigned char) 0x80;
3357 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3359 if (len <= LG_BLESS) {
3360 unsigned char clen = (unsigned char) len;
3363 unsigned char flag = (unsigned char) 0x80;
3365 WLEN(len); /* Don't BER-encode, this should be rare */
3367 WRITE(classname, len); /* Final \0 is omitted */
3371 * Now emit the <object> part.
3374 return SV_STORE(type)(aTHX_ cxt, sv);
3380 * We don't know how to store the item we reached, so return an error condition.
3381 * (it's probably a GLOB, some CODE reference, etc...)
3383 * If they defined the `forgive_me' variable at the Perl level to some
3384 * true value, then don't croak, just warn, and store a placeholder string
3387 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3392 TRACEME(("store_other"));
3395 * Fetch the value from perl only once per store() operation.
3399 cxt->forgive_me == 0 ||
3400 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3401 SvTRUE(perl_get_sv("Storable::forgive_me", GV_ADD)) ? 1 : 0))
3403 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3405 warn("Can't store item %s(0x%"UVxf")",
3406 sv_reftype(sv, FALSE), PTR2UV(sv));
3409 * Store placeholder string as a scalar instead...
3412 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3413 PTR2UV(sv), (char) 0);
3416 STORE_SCALAR(buf, len);
3417 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3423 *** Store driving routines
3429 * WARNING: partially duplicates Perl's sv_reftype for speed.
3431 * Returns the type of the SV, identified by an integer. That integer
3432 * may then be used to index the dynamic routine dispatch table.
3434 static int sv_type(pTHX_ SV *sv)
3436 switch (SvTYPE(sv)) {
3438 #if PERL_VERSION <= 10
3443 * No need to check for ROK, that can't be set here since there
3444 * is no field capable of hodling the xrv_rv reference.
3448 #if PERL_VERSION <= 10
3456 * Starting from SVt_PV, it is possible to have the ROK flag
3457 * set, the pointer to the other SV being either stored in
3458 * the xrv_rv (in the case of a pure SVt_RV), or as the
3459 * xpv_pv field of an SVt_PV and its heirs.
3461 * However, those SV cannot be magical or they would be an
3462 * SVt_PVMG at least.
3464 return SvROK(sv) ? svis_REF : svis_SCALAR;
3466 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3467 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3468 return svis_TIED_ITEM;
3470 #if PERL_VERSION < 9
3473 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3475 return SvROK(sv) ? svis_REF : svis_SCALAR;
3477 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3481 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3486 #if PERL_VERSION > 8
3487 /* case SVt_BIND: */
3499 * Recursively store objects pointed to by the sv to the specified file.
3501 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3502 * object (one for which storage has started -- it may not be over if we have
3503 * a self-referenced structure). This data set forms a stored <object>.
3505 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3510 #ifdef USE_PTR_TABLE
3511 struct ptr_tbl *pseen = cxt->pseen;
3513 HV *hseen = cxt->hseen;
3516 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3519 * If object has already been stored, do not duplicate data.
3520 * Simply emit the SX_OBJECT marker followed by its tag data.
3521 * The tag is always written in network order.
3523 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3524 * real pointer, rather a tag number (watch the insertion code below).
3525 * That means it probably safe to assume it is well under the 32-bit limit,
3526 * and makes the truncation safe.
3527 * -- RAM, 14/09/1999
3530 #ifdef USE_PTR_TABLE
3531 svh = (SV **)ptr_table_fetch(pseen, sv);
3533 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3538 if (sv == &PL_sv_undef) {
3539 /* We have seen PL_sv_undef before, but fake it as
3542 Not the simplest solution to making restricted
3543 hashes work on 5.8.0, but it does mean that
3544 repeated references to the one true undef will
3545 take up less space in the output file.
3547 /* Need to jump past the next hv_store, because on the
3548 second store of undef the old hash value will be
3549 SvREFCNT_dec()ed, and as Storable cheats horribly
3550 by storing non-SVs in the hash a SEGV will ensure.
3551 Need to increase the tag number so that the
3552 receiver has no idea what games we're up to. This
3553 special casing doesn't affect hooks that store
3554 undef, as the hook routine does its own lookup into
3555 hseen. Also this means that any references back
3556 to PL_sv_undef (from the pathological case of hooks
3557 storing references to it) will find the seen hash
3558 entry for the first time, as if we didn't have this
3559 hackery here. (That hseen lookup works even on 5.8.0
3560 because it's a key of &PL_sv_undef and a value
3561 which is a tag number, not a value which is
3565 goto undef_special_case;
3568 #ifdef USE_PTR_TABLE
3569 tagval = htonl(LOW_32BITS(((char *)svh)-1));
3571 tagval = htonl(LOW_32BITS(*svh));
3574 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3582 * Allocate a new tag and associate it with the address of the sv being
3583 * stored, before recursing...
3585 * In order to avoid creating new SvIVs to hold the tagnum we just
3586 * cast the tagnum to an SV pointer and store that in the hash. This
3587 * means that we must clean up the hash manually afterwards, but gives
3588 * us a 15% throughput increase.
3593 #ifdef USE_PTR_TABLE
3594 ptr_table_store(pseen, sv, INT2PTR(SV*, 1 + cxt->tagnum));
3596 if (!hv_store(hseen,
3597 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3602 * Store `sv' and everything beneath it, using appropriate routine.
3603 * Abort immediately if we get a non-zero status back.
3606 type = sv_type(aTHX_ sv);
3609 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3610 PTR2UV(sv), cxt->tagnum, type));
3613 HV *pkg = SvSTASH(sv);
3614 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3616 ret = SV_STORE(type)(aTHX_ cxt, sv);
3618 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3619 ret ? "FAILED" : "ok", PTR2UV(sv),
3620 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3628 * Write magic number and system information into the file.
3629 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3630 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3631 * All size and lenghts are written as single characters here.
3633 * Note that no byte ordering info is emitted when <network> is true, since
3634 * integers will be emitted in network order in that case.
3636 static int magic_write(pTHX_ stcxt_t *cxt)
3639 * Starting with 0.6, the "use_network_order" byte flag is also used to
3640 * indicate the version number of the binary image, encoded in the upper
3641 * bits. The bit 0 is always used to indicate network order.
3644 * Starting with 0.7, a full byte is dedicated to the minor version of
3645 * the binary format, which is incremented only when new markers are
3646 * introduced, for instance, but when backward compatibility is preserved.
3649 /* Make these at compile time. The WRITE() macro is sufficiently complex
3650 that it saves about 200 bytes doing it this way and only using it
3652 static const unsigned char network_file_header[] = {
3654 (STORABLE_BIN_MAJOR << 1) | 1,
3655 STORABLE_BIN_WRITE_MINOR
3657 static const unsigned char file_header[] = {
3659 (STORABLE_BIN_MAJOR << 1) | 0,
3660 STORABLE_BIN_WRITE_MINOR,
3661 /* sizeof the array includes the 0 byte at the end: */
3662 (char) sizeof (byteorderstr) - 1,
3664 (unsigned char) sizeof(int),
3665 (unsigned char) sizeof(long),
3666 (unsigned char) sizeof(char *),
3667 (unsigned char) sizeof(NV)
3669 #ifdef USE_56_INTERWORK_KLUDGE
3670 static const unsigned char file_header_56[] = {
3672 (STORABLE_BIN_MAJOR << 1) | 0,
3673 STORABLE_BIN_WRITE_MINOR,
3674 /* sizeof the array includes the 0 byte at the end: */
3675 (char) sizeof (byteorderstr_56) - 1,
3677 (unsigned char) sizeof(int),
3678 (unsigned char) sizeof(long),
3679 (unsigned char) sizeof(char *),
3680 (unsigned char) sizeof(NV)
3683 const unsigned char *header;
3686 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3688 if (cxt->netorder) {
3689 header = network_file_header;
3690 length = sizeof (network_file_header);
3692 #ifdef USE_56_INTERWORK_KLUDGE
3693 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", GV_ADD))) {
3694 header = file_header_56;
3695 length = sizeof (file_header_56);
3699 header = file_header;
3700 length = sizeof (file_header);
3705 /* sizeof the array includes the 0 byte at the end. */
3706 header += sizeof (magicstr) - 1;
3707 length -= sizeof (magicstr) - 1;
3710 WRITE( (unsigned char*) header, length);
3712 if (!cxt->netorder) {
3713 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3714 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3715 (int) sizeof(int), (int) sizeof(long),
3716 (int) sizeof(char *), (int) sizeof(NV)));
3724 * Common code for store operations.
3726 * When memory store is requested (f = NULL) and a non null SV* is given in
3727 * `res', it is filled with a new SV created out of the memory buffer.
3729 * It is required to provide a non-null `res' when the operation type is not
3730 * dclone() and store() is performed to memory.
3732 static int do_store(
3743 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3744 ("must supply result SV pointer for real recursion to memory"));
3746 TRACEME(("do_store (optype=%d, netorder=%d)",
3747 optype, network_order));
3752 * Workaround for CROAK leak: if they enter with a "dirty" context,
3753 * free up memory for them now.
3757 clean_context(aTHX_ cxt);
3760 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3761 * re-enter store() via the hooks. We need to stack contexts.
3765 cxt = allocate_context(aTHX_ cxt);
3769 ASSERT(cxt->entry == 1, ("starting new recursion"));
3770 ASSERT(!cxt->s_dirty, ("clean context"));
3773 * Ensure sv is actually a reference. From perl, we called something
3775 * pstore(aTHX_ FILE, \@array);
3776 * so we must get the scalar value behing that reference.
3780 CROAK(("Not a reference"));
3781 sv = SvRV(sv); /* So follow it to know what to store */
3784 * If we're going to store to memory, reset the buffer.
3791 * Prepare context and emit headers.
3794 init_store_context(aTHX_ cxt, f, optype, network_order);
3796 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3797 return 0; /* Error */
3800 * Recursively store object...
3803 ASSERT(is_storing(aTHX), ("within store operation"));
3805 status = store(aTHX_ cxt, sv); /* Just do it! */
3808 * If they asked for a memory store and they provided an SV pointer,
3809 * make an SV string out of the buffer and fill their pointer.
3811 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3812 * an SV, since context cleanup might free the buffer if we did recurse.
3813 * (unless caller is dclone(), which is aware of that).
3816 if (!cxt->fio && res)
3817 *res = mbuf2sv(aTHX);
3822 * The "root" context is never freed, since it is meant to be always
3823 * handy for the common case where no recursion occurs at all (i.e.
3824 * we enter store() outside of any Storable code and leave it, period).
3825 * We know it's the "root" context because there's nothing stacked
3830 * When deep cloning, we don't free the context: doing so would force
3831 * us to copy the data in the memory buffer. Sicne we know we're
3832 * about to enter do_retrieve...
3835 clean_store_context(aTHX_ cxt);
3836 if (cxt->prev && !(cxt->optype & ST_CLONE))
3837 free_context(aTHX_ cxt);
3839 TRACEME(("do_store returns %d", status));
3847 * Store the transitive data closure of given object to disk.
3848 * Returns 0 on error, a true value otherwise.
3850 static int pstore(pTHX_ PerlIO *f, SV *sv)
3852 TRACEME(("pstore"));
3853 return do_store(aTHX_ f, sv, 0, FALSE, (SV**) 0);
3860 * Same as pstore(), but network order is used for integers and doubles are
3861 * emitted as strings.
3863 static int net_pstore(pTHX_ PerlIO *f, SV *sv)
3865 TRACEME(("net_pstore"));
3866 return do_store(aTHX_ f, sv, 0, TRUE, (SV**) 0);
3876 * Build a new SV out of the content of the internal memory buffer.
3878 static SV *mbuf2sv(pTHX)
3882 return newSVpv(mbase, MBUF_SIZE());
3888 * Store the transitive data closure of given object to memory.
3889 * Returns undef on error, a scalar value containing the data otherwise.
3891 static SV *mstore(pTHX_ SV *sv)
3895 TRACEME(("mstore"));
3897 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, FALSE, &out))
3898 return &PL_sv_undef;
3906 * Same as mstore(), but network order is used for integers and doubles are
3907 * emitted as strings.
3909 static SV *net_mstore(pTHX_ SV *sv)
3913 TRACEME(("net_mstore"));
3915 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, TRUE, &out))
3916 return &PL_sv_undef;
3922 *** Specific retrieve callbacks.
3928 * Return an error via croak, since it is not possible that we get here
3929 * under normal conditions, when facing a file produced via pstore().
3931 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname)
3934 cxt->ver_major != STORABLE_BIN_MAJOR &&
3935 cxt->ver_minor != STORABLE_BIN_MINOR
3937 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3938 cxt->fio ? "file" : "string",
3939 cxt->ver_major, cxt->ver_minor,
3940 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3942 CROAK(("Corrupted storable %s (binary v%d.%d)",
3943 cxt->fio ? "file" : "string",
3944 cxt->ver_major, cxt->ver_minor));
3947 return (SV *) 0; /* Just in case */
3951 * retrieve_idx_blessed
3953 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3954 * <index> can be coded on either 1 or 5 bytes.
3956 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3959 const char *classname;
3963 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3964 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3966 GETMARK(idx); /* Index coded on a single char? */
3971 * Fetch classname in `aclass'
3974 sva = av_fetch(cxt->aclass, idx, FALSE);
3976 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3978 classname = SvPVX(*sva); /* We know it's a PV, by construction */
3980 TRACEME(("class ID %d => %s", idx, classname));
3983 * Retrieve object and bless it.
3986 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3994 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3995 * <len> can be coded on either 1 or 5 bytes.
3997 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname)
4001 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
4002 char *classname = buf;
4003 char *malloced_classname = NULL;
4005 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
4006 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
4009 * Decode class name length and read that name.
4011 * Short classnames have two advantages: their length is stored on one
4012 * single byte, and the string can be read on the stack.
4015 GETMARK(len); /* Length coded on a single char? */
4018 TRACEME(("** allocating %d bytes for class name", len+1));
4019 New(10003, classname, len+1, char);
4020 malloced_classname = classname;
4022 SAFEPVREAD(classname, len, malloced_classname);
4023 classname[len] = '\0'; /* Mark string end */
4026 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
4029 TRACEME(("new class name \"%s\" will bear ID = %d", classname, cxt->classnum));
4031 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len))) {
4032 Safefree(malloced_classname);
4037 * Retrieve object and bless it.
4040 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
4041 if (malloced_classname)
4042 Safefree(malloced_classname);
4050 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
4051 * with leading mark already read, as usual.
4053 * When recursion was involved during serialization of the object, there
4054 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
4055 * we reach a <flags> marker with the recursion bit cleared.
4057 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
4058 * is held in the <extra> byte, and if the object is tied, the serialized
4059 * magic object comes at the very end:
4061 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
4063 * This means the STORABLE_thaw hook will NOT get a tied variable during its
4064 * processing (since we won't have seen the magic object by the time the hook
4065 * is called). See comments below for why it was done that way.
4067 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname)
4070 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
4071 char *classname = buf;
4082 int clone = cxt->optype & ST_CLONE;
4084 unsigned int extra_type = 0;
4086 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
4087 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
4090 * Read flags, which tell us about the type, and whether we need to recurse.
4096 * Create the (empty) object, and mark it as seen.
4098 * This must be done now, because tags are incremented, and during
4099 * serialization, the object tag was affected before recursion could
4103 obj_type = flags & SHF_TYPE_MASK;
4109 sv = (SV *) newAV();
4112 sv = (SV *) newHV();
4116 * Read <extra> flag to know the type of the object.
4117 * Record associated magic type for later.
4119 GETMARK(extra_type);
4120 switch (extra_type) {
4126 sv = (SV *) newAV();
4130 sv = (SV *) newHV();
4134 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4138 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4140 SEEN(sv, 0, 0); /* Don't bless yet */
4143 * Whilst flags tell us to recurse, do so.
4145 * We don't need to remember the addresses returned by retrieval, because
4146 * all the references will be obtained through indirection via the object
4147 * tags in the object-ID list.
4149 * We need to decrement the reference count for these objects
4150 * because, if the user doesn't save a reference to them in the hook,
4151 * they must be freed when this context is cleaned.
4154 while (flags & SHF_NEED_RECURSE) {
4155 TRACEME(("retrieve_hook recursing..."));
4156 rv = retrieve(aTHX_ cxt, 0);
4160 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
4165 if (flags & SHF_IDX_CLASSNAME) {
4170 * Fetch index from `aclass'
4173 if (flags & SHF_LARGE_CLASSLEN)
4178 sva = av_fetch(cxt->aclass, idx, FALSE);
4180 CROAK(("Class name #%"IVdf" should have been seen already",
4183 classname = SvPVX(*sva); /* We know it's a PV, by construction */
4184 TRACEME(("class ID %d => %s", idx, classname));
4188 * Decode class name length and read that name.
4190 * NOTA BENE: even if the length is stored on one byte, we don't read
4191 * on the stack. Just like retrieve_blessed(), we limit the name to
4192 * LG_BLESS bytes. This is an arbitrary decision.
4194 char *malloced_classname = NULL;
4196 if (flags & SHF_LARGE_CLASSLEN)
4201 if (len > LG_BLESS) {
4202 TRACEME(("** allocating %d bytes for class name", len+1));
4203 New(10003, classname, len+1, char);
4204 malloced_classname = classname;
4207 SAFEPVREAD(classname, len, malloced_classname);
4208 classname[len] = '\0'; /* Mark string end */
4211 * Record new classname.
4214 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len))) {
4215 Safefree(malloced_classname);
4220 TRACEME(("class name: %s", classname));
4223 * Decode user-frozen string length and read it in an SV.
4225 * For efficiency reasons, we read data directly into the SV buffer.
4226 * To understand that code, read retrieve_scalar()
4229 if (flags & SHF_LARGE_STRLEN)
4234 frozen = NEWSV(10002, len2);
4236 SAFEREAD(SvPVX(frozen), len2, frozen);
4237 SvCUR_set(frozen, len2);
4238 *SvEND(frozen) = '\0';
4240 (void) SvPOK_only(frozen); /* Validates string pointer */
4241 if (cxt->s_tainted) /* Is input source tainted? */
4244 TRACEME(("frozen string: %d bytes", len2));
4247 * Decode object-ID list length, if present.
4250 if (flags & SHF_HAS_LIST) {
4251 if (flags & SHF_LARGE_LISTLEN)
4257 av_extend(av, len3 + 1); /* Leave room for [0] */
4258 AvFILLp(av) = len3; /* About to be filled anyway */
4262 TRACEME(("has %d object IDs to link", len3));
4265 * Read object-ID list into array.
4266 * Because we pre-extended it, we can cheat and fill it manually.
4268 * We read object tags and we can convert them into SV* on the fly
4269 * because we know all the references listed in there (as tags)
4270 * have been already serialized, hence we have a valid correspondance
4271 * between each of those tags and the recreated SV.
4275 SV **ary = AvARRAY(av);
4277 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
4284 svh = av_fetch(cxt->aseen, tag, FALSE);
4286 if (tag == cxt->where_is_undef) {
4287 /* av_fetch uses PL_sv_undef internally, hence this
4288 somewhat gruesome hack. */
4292 CROAK(("Object #%"IVdf" should have been retrieved already",
4297 ary[i] = SvREFCNT_inc(xsv);
4302 * Bless the object and look up the STORABLE_thaw hook.
4305 BLESS(sv, classname);
4307 /* Handle attach case; again can't use pkg_can because it only
4308 * caches one method */
4309 attach = gv_fetchmethod_autoload(SvSTASH(sv), "STORABLE_attach", FALSE);
4310 if (attach && isGV(attach)) {
4312 SV* attach_hook = newRV((SV*) GvCV(attach));
4315 CROAK(("STORABLE_attach called with unexpected references"));
4319 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4320 rv = newSVpv(classname, 0);
4321 attached = scalar_call(aTHX_ rv, attach_hook, clone, av, G_SCALAR);
4324 sv_derived_from(attached, classname))
4325 return SvRV(attached);
4326 CROAK(("STORABLE_attach did not return a %s object", classname));
4329 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4332 * Hook not found. Maybe they did not require the module where this
4333 * hook is defined yet?
4335 * If the load below succeeds, we'll be able to find the hook.
4336 * Still, it only works reliably when each class is defined in a
4340 TRACEME(("No STORABLE_thaw defined for objects of class %s", classname));
4341 TRACEME(("Going to load module '%s'", classname));
4342 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(classname, 0), Nullsv);
4345 * We cache results of pkg_can, so we need to uncache before attempting
4349 pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4350 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4353 CROAK(("No STORABLE_thaw defined for objects of class %s "
4354 "(even after a \"require %s;\")", classname, classname));
4358 * If we don't have an `av' yet, prepare one.
4359 * Then insert the frozen string as item [0].
4367 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4372 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4374 * where $object is our blessed (empty) object, $cloning is a boolean
4375 * telling whether we're running a deep clone, $frozen is the frozen
4376 * string the user gave us in his serializing hook, and @refs, which may
4377 * be empty, is the list of extra references he returned along for us
4380 * In effect, the hook is an alternate creation routine for the class,
4381 * the object itself being already created by the runtime.
4384 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4385 classname, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4388 (void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
4395 SvREFCNT_dec(frozen);
4398 if (!(flags & SHF_IDX_CLASSNAME) && classname != buf)
4399 Safefree(classname);
4402 * If we had an <extra> type, then the object was not as simple, and
4403 * we need to restore extra magic now.
4409 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4411 rv = retrieve(aTHX_ cxt, 0); /* Retrieve <magic object> */
4413 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4414 PTR2UV(rv), PTR2UV(sv)));
4416 switch (extra_type) {
4418 sv_upgrade(sv, SVt_PVMG);
4421 sv_upgrade(sv, SVt_PVAV);
4422 AvREAL_off((AV *)sv);
4425 sv_upgrade(sv, SVt_PVHV);
4428 CROAK(("Forgot to deal with extra type %d", extra_type));
4433 * Adding the magic only now, well after the STORABLE_thaw hook was called
4434 * means the hook cannot know it deals with an object whose variable is
4435 * tied. But this is happening when retrieving $o in the following case:
4439 * my $o = bless \%h, 'BAR';
4441 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4442 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4443 * hash but a tied one should not matter at all, and remain transparent.
4444 * This means the magic must be restored by Storable AFTER the hook is
4447 * That looks very reasonable to me, but then I've come up with this
4448 * after a bug report from David Nesting, who was trying to store such
4449 * an object and caused Storable to fail. And unfortunately, it was
4450 * also the easiest way to retrofit support for blessed ref to tied objects
4451 * into the existing design. -- RAM, 17/02/2001
4454 sv_magic(sv, rv, mtype, (char *)NULL, 0);
4455 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4463 * Retrieve reference to some other scalar.
4464 * Layout is SX_REF <object>, with SX_REF already read.
4466 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname)
4471 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4474 * We need to create the SV that holds the reference to the yet-to-retrieve
4475 * object now, so that we may record the address in the seen table.
4476 * Otherwise, if the object to retrieve references us, we won't be able
4477 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4478 * do the retrieve first and use rv = newRV(sv) since it will be too late
4479 * for SEEN() recording.
4482 rv = NEWSV(10002, 0);
4483 SEEN(rv, cname, 0); /* Will return if rv is null */
4484 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4486 return (SV *) 0; /* Failed */
4489 * WARNING: breaks RV encapsulation.
4491 * Now for the tricky part. We have to upgrade our existing SV, so that
4492 * it is now an RV on sv... Again, we cheat by duplicating the code
4493 * held in newSVrv(), since we already got our SV from retrieve().
4497 * SvRV(rv) = SvREFCNT_inc(sv);
4499 * here because the reference count we got from retrieve() above is
4500 * already correct: if the object was retrieved from the file, then
4501 * its reference count is one. Otherwise, if it was retrieved via
4502 * an SX_OBJECT indication, a ref count increment was done.
4506 /* No need to do anything, as rv will already be PVMG. */
4507 assert (SvTYPE(rv) == SVt_RV || SvTYPE(rv) >= SVt_PV);
4509 sv_upgrade(rv, SVt_RV);
4512 SvRV_set(rv, sv); /* $rv = \$sv */
4515 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4523 * Retrieve weak reference to some other scalar.
4524 * Layout is SX_WEAKREF <object>, with SX_WEAKREF already read.
4526 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname)
4530 TRACEME(("retrieve_weakref (#%d)", cxt->tagnum));
4532 sv = retrieve_ref(aTHX_ cxt, cname);
4544 * retrieve_overloaded
4546 * Retrieve reference to some other scalar with overloading.
4547 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4549 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname)
4555 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4558 * Same code as retrieve_ref(), duplicated to avoid extra call.
4561 rv = NEWSV(10002, 0);
4562 SEEN(rv, cname, 0); /* Will return if rv is null */
4563 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4565 return (SV *) 0; /* Failed */
4568 * WARNING: breaks RV encapsulation.
4571 SvUPGRADE(rv, SVt_RV);
4572 SvRV_set(rv, sv); /* $rv = \$sv */
4576 * Restore overloading magic.
4579 stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
4581 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4582 ") (package <unknown>)",
4583 sv_reftype(sv, FALSE),
4586 if (!Gv_AMG(stash)) {
4587 const char *package = HvNAME_get(stash);
4588 TRACEME(("No overloading defined for package %s", package));
4589 TRACEME(("Going to load module '%s'", package));
4590 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(package, 0), Nullsv);
4591 if (!Gv_AMG(stash)) {
4592 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4593 ") (package %s) (even after a \"require %s;\")",
4594 sv_reftype(sv, FALSE),
4602 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4608 * retrieve_weakoverloaded
4610 * Retrieve weak overloaded reference to some other scalar.
4611 * Layout is SX_WEAKOVERLOADED <object>, with SX_WEAKOVERLOADED already read.
4613 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname)
4617 TRACEME(("retrieve_weakoverloaded (#%d)", cxt->tagnum));
4619 sv = retrieve_overloaded(aTHX_ cxt, cname);
4631 * retrieve_tied_array
4633 * Retrieve tied array
4634 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4636 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname)
4641 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4643 tv = NEWSV(10002, 0);
4644 SEEN(tv, cname, 0); /* Will return if tv is null */
4645 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4647 return (SV *) 0; /* Failed */
4649 sv_upgrade(tv, SVt_PVAV);
4650 AvREAL_off((AV *)tv);
4651 sv_magic(tv, sv, 'P', (char *)NULL, 0);
4652 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4654 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4660 * retrieve_tied_hash
4662 * Retrieve tied hash
4663 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4665 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname)
4670 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4672 tv = NEWSV(10002, 0);
4673 SEEN(tv, cname, 0); /* Will return if tv is null */
4674 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4676 return (SV *) 0; /* Failed */
4678 sv_upgrade(tv, SVt_PVHV);
4679 sv_magic(tv, sv, 'P', (char *)NULL, 0);
4680 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4682 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4688 * retrieve_tied_scalar
4690 * Retrieve tied scalar
4691 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4693 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4696 SV *sv, *obj = NULL;
4698 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4700 tv = NEWSV(10002, 0);
4701 SEEN(tv, cname, 0); /* Will return if rv is null */
4702 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4704 return (SV *) 0; /* Failed */
4706 else if (SvTYPE(sv) != SVt_NULL) {
4710 sv_upgrade(tv, SVt_PVMG);
4711 sv_magic(tv, obj, 'q', (char *)NULL, 0);
4714 /* Undo refcnt inc from sv_magic() */
4718 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4726 * Retrieve reference to value in a tied hash.
4727 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4729 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname)
4735 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4737 tv = NEWSV(10002, 0);
4738 SEEN(tv, cname, 0); /* Will return if tv is null */
4739 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4741 return (SV *) 0; /* Failed */
4743 key = retrieve(aTHX_ cxt, 0); /* Retrieve <key> */
4745 return (SV *) 0; /* Failed */
4747 sv_upgrade(tv, SVt_PVMG);
4748 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4749 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4750 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4758 * Retrieve reference to value in a tied array.
4759 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4761 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname)
4767 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4769 tv = NEWSV(10002, 0);
4770 SEEN(tv, cname, 0); /* Will return if tv is null */
4771 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4773 return (SV *) 0; /* Failed */
4775 RLEN(idx); /* Retrieve <idx> */
4777 sv_upgrade(tv, SVt_PVMG);
4778 sv_magic(tv, sv, 'p', (char *)NULL, idx);
4779 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4788 * Retrieve defined long (string) scalar.
4790 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4791 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4792 * was not stored on a single byte.
4794 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname)
4800 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4803 * Allocate an empty scalar of the suitable length.
4806 sv = NEWSV(10002, len);
4807 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4810 sv_setpvn(sv, "", 0);
4815 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4817 * Now, for efficiency reasons, read data directly inside the SV buffer,
4818 * and perform the SV final settings directly by duplicating the final
4819 * work done by sv_setpv. Since we're going to allocate lots of scalars
4820 * this way, it's worth the hassle and risk.
4823 SAFEREAD(SvPVX(sv), len, sv);
4824 SvCUR_set(sv, len); /* Record C string length */
4825 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4826 (void) SvPOK_only(sv); /* Validate string pointer */
4827 if (cxt->s_tainted) /* Is input source tainted? */
4828 SvTAINT(sv); /* External data cannot be trusted */
4830 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4831 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4839 * Retrieve defined short (string) scalar.
4841 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4842 * The scalar is "short" so <length> is single byte. If it is 0, there
4843 * is no <data> section.
4845 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4851 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4854 * Allocate an empty scalar of the suitable length.
4857 sv = NEWSV(10002, len);
4858 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4861 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4866 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4867 * To make it defined with an empty length, upgrade it now...
4868 * Don't upgrade to a PV if the original type contains more
4869 * information than a scalar.
4871 if (SvTYPE(sv) <= SVt_PV) {
4872 sv_upgrade(sv, SVt_PV);
4875 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4876 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4879 * Now, for efficiency reasons, read data directly inside the SV buffer,
4880 * and perform the SV final settings directly by duplicating the final
4881 * work done by sv_setpv. Since we're going to allocate lots of scalars
4882 * this way, it's worth the hassle and risk.
4884 SAFEREAD(SvPVX(sv), len, sv);
4885 SvCUR_set(sv, len); /* Record C string length */
4886 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4887 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4890 (void) SvPOK_only(sv); /* Validate string pointer */
4891 if (cxt->s_tainted) /* Is input source tainted? */
4892 SvTAINT(sv); /* External data cannot be trusted */
4894 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4901 * Like retrieve_scalar(), but tag result as utf8.
4902 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4904 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname)
4908 TRACEME(("retrieve_utf8str"));
4910 sv = retrieve_scalar(aTHX_ cxt, cname);
4912 #ifdef HAS_UTF8_SCALARS
4915 if (cxt->use_bytes < 0)
4917 = (SvTRUE(perl_get_sv("Storable::drop_utf8", GV_ADD))
4919 if (cxt->use_bytes == 0)
4930 * Like retrieve_lscalar(), but tag result as utf8.
4931 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4933 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname)
4937 TRACEME(("retrieve_lutf8str"));
4939 sv = retrieve_lscalar(aTHX_ cxt, cname);
4941 #ifdef HAS_UTF8_SCALARS
4944 if (cxt->use_bytes < 0)
4946 = (SvTRUE(perl_get_sv("Storable::drop_utf8", GV_ADD))
4948 if (cxt->use_bytes == 0)
4958 * Retrieve defined integer.
4959 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4961 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname)
4966 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4968 READ(&iv, sizeof(iv));
4970 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4972 TRACEME(("integer %"IVdf, iv));
4973 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4981 * Retrieve defined integer in network order.
4982 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4984 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname)
4989 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4993 sv = newSViv((int) ntohl(iv));
4994 TRACEME(("network integer %d", (int) ntohl(iv)));
4997 TRACEME(("network integer (as-is) %d", iv));
4999 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5001 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
5009 * Retrieve defined double.
5010 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
5012 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname)
5017 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
5019 READ(&nv, sizeof(nv));
5021 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5023 TRACEME(("double %"NVff, nv));
5024 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
5032 * Retrieve defined byte (small integer within the [-128, +127] range).
5033 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
5035 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname)
5039 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
5041 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
5044 TRACEME(("small integer read as %d", (unsigned char) siv));
5045 tmp = (unsigned char) siv - 128;
5047 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5049 TRACEME(("byte %d", tmp));
5050 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
5058 * Return the undefined value.
5060 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname)
5064 TRACEME(("retrieve_undef"));
5075 * Return the immortal undefined value.
5077 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname)
5079 SV *sv = &PL_sv_undef;
5081 TRACEME(("retrieve_sv_undef"));
5083 /* Special case PL_sv_undef, as av_fetch uses it internally to mark
5084 deleted elements, and will return NULL (fetch failed) whenever it
5086 if (cxt->where_is_undef == -1) {
5087 cxt->where_is_undef = cxt->tagnum;
5096 * Return the immortal yes value.
5098 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname)
5100 SV *sv = &PL_sv_yes;
5102 TRACEME(("retrieve_sv_yes"));
5111 * Return the immortal no value.
5113 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname)
5117 TRACEME(("retrieve_sv_no"));
5126 * Retrieve a whole array.
5127 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5128 * Each item is stored as <object>.
5130 * When we come here, SX_ARRAY has been read already.
5132 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5139 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
5142 * Read length, and allocate array, then pre-extend it.
5146 TRACEME(("size = %d", len));
5148 SEEN(av, cname, 0); /* Will return if array not allocated nicely */
5152 return (SV *) av; /* No data follow if array is empty */
5155 * Now get each item in turn...
5158 for (i = 0; i < len; i++) {
5159 TRACEME(("(#%d) item", i));
5160 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5163 if (av_store(av, i, sv) == 0)
5167 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5175 * Retrieve a whole hash table.
5176 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5177 * Keys are stored as <length> <data>, the <data> section being omitted
5179 * Values are stored as <object>.
5181 * When we come here, SX_HASH has been read already.
5183 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5191 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
5194 * Read length, allocate table.
5198 TRACEME(("size = %d", len));
5200 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5202 return (SV *) hv; /* No data follow if table empty */
5203 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5206 * Now get each key/value pair in turn...
5209 for (i = 0; i < len; i++) {
5214 TRACEME(("(#%d) value", i));
5215 sv = retrieve(aTHX_ cxt, 0);
5221 * Since we're reading into kbuf, we must ensure we're not
5222 * recursing between the read and the hv_store() where it's used.
5223 * Hence the key comes after the value.
5226 RLEN(size); /* Get key size */
5227 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5230 kbuf[size] = '\0'; /* Mark string end, just in case */
5231 TRACEME(("(#%d) key '%s'", i, kbuf));
5234 * Enter key/value pair into hash table.
5237 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5241 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5249 * Retrieve a whole hash table.
5250 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5251 * Keys are stored as <length> <data>, the <data> section being omitted
5253 * Values are stored as <object>.
5255 * When we come here, SX_HASH has been read already.
5257 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname)
5267 GETMARK(hash_flags);
5268 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
5270 * Read length, allocate table.
5273 #ifndef HAS_RESTRICTED_HASHES
5274 if (hash_flags & SHV_RESTRICTED) {
5275 if (cxt->derestrict < 0)
5277 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", GV_ADD))
5279 if (cxt->derestrict == 0)
5280 RESTRICTED_HASH_CROAK();
5285 TRACEME(("size = %d, flags = %d", len, hash_flags));
5287 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5289 return (SV *) hv; /* No data follow if table empty */
5290 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5293 * Now get each key/value pair in turn...
5296 for (i = 0; i < len; i++) {
5298 int store_flags = 0;
5303 TRACEME(("(#%d) value", i));
5304 sv = retrieve(aTHX_ cxt, 0);
5309 #ifdef HAS_RESTRICTED_HASHES
5310 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
5314 if (flags & SHV_K_ISSV) {
5315 /* XXX you can't set a placeholder with an SV key.
5316 Then again, you can't get an SV key.
5317 Without messing around beyond what the API is supposed to do.
5320 TRACEME(("(#%d) keysv, flags=%d", i, flags));
5321 keysv = retrieve(aTHX_ cxt, 0);
5325 if (!hv_store_ent(hv, keysv, sv, 0))
5330 * Since we're reading into kbuf, we must ensure we're not
5331 * recursing between the read and the hv_store() where it's used.
5332 * Hence the key comes after the value.
5335 if (flags & SHV_K_PLACEHOLDER) {
5337 sv = &PL_sv_placeholder;
5338 store_flags |= HVhek_PLACEHOLD;
5340 if (flags & SHV_K_UTF8) {
5341 #ifdef HAS_UTF8_HASHES
5342 store_flags |= HVhek_UTF8;
5344 if (cxt->use_bytes < 0)
5346 = (SvTRUE(perl_get_sv("Storable::drop_utf8", GV_ADD))
5348 if (cxt->use_bytes == 0)
5352 #ifdef HAS_UTF8_HASHES
5353 if (flags & SHV_K_WASUTF8)
5354 store_flags |= HVhek_WASUTF8;
5357 RLEN(size); /* Get key size */
5358 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5361 kbuf[size] = '\0'; /* Mark string end, just in case */
5362 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5363 flags, store_flags));
5366 * Enter key/value pair into hash table.
5369 #ifdef HAS_RESTRICTED_HASHES
5370 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5373 if (!(store_flags & HVhek_PLACEHOLD))
5374 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5379 #ifdef HAS_RESTRICTED_HASHES
5380 if (hash_flags & SHV_RESTRICTED)
5384 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5392 * Return a code reference.
5394 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname)
5396 #if PERL_VERSION < 6
5397 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5400 int type, count, tagnum;
5402 SV *sv, *text, *sub;
5404 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5407 * Insert dummy SV in the aseen array so that we don't screw
5408 * up the tag numbers. We would just make the internal
5409 * scalar an untagged item in the stream, but
5410 * retrieve_scalar() calls SEEN(). So we just increase the
5413 tagnum = cxt->tagnum;
5418 * Retrieve the source of the code reference
5419 * as a small or large scalar
5425 text = retrieve_scalar(aTHX_ cxt, cname);
5428 text = retrieve_lscalar(aTHX_ cxt, cname);
5431 CROAK(("Unexpected type %d in retrieve_code\n", type));
5435 * prepend "sub " to the source
5438 sub = newSVpvn("sub ", 4);
5439 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5443 * evaluate the source to a code reference and use the CV value
5446 if (cxt->eval == NULL) {
5447 cxt->eval = perl_get_sv("Storable::Eval", GV_ADD);
5448 SvREFCNT_inc(cxt->eval);
5450 if (!SvTRUE(cxt->eval)) {
5452 cxt->forgive_me == 0 ||
5453 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5454 SvTRUE(perl_get_sv("Storable::forgive_me", GV_ADD)) ? 1 : 0))
5456 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5459 /* fix up the dummy entry... */
5460 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5468 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5469 SV* errsv = get_sv("@", GV_ADD);
5470 sv_setpvn(errsv, "", 0); /* clear $@ */
5472 XPUSHs(sv_2mortal(newSVsv(sub)));
5474 count = call_sv(cxt->eval, G_SCALAR);
5477 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5479 if (SvTRUE(errsv)) {
5480 CROAK(("code %s caused an error: %s",
5481 SvPV_nolen(sub), SvPV_nolen(errsv)));
5485 cv = eval_pv(SvPV_nolen(sub), TRUE);
5487 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5490 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5493 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5498 /* fix up the dummy entry... */
5499 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5506 * old_retrieve_array
5508 * Retrieve a whole array in pre-0.6 binary format.
5510 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5511 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5513 * When we come here, SX_ARRAY has been read already.
5515 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5523 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5526 * Read length, and allocate array, then pre-extend it.
5530 TRACEME(("size = %d", len));
5532 SEEN(av, 0, 0); /* Will return if array not allocated nicely */
5536 return (SV *) av; /* No data follow if array is empty */
5539 * Now get each item in turn...
5542 for (i = 0; i < len; i++) {
5544 if (c == SX_IT_UNDEF) {
5545 TRACEME(("(#%d) undef item", i));
5546 continue; /* av_extend() already filled us with undef */
5549 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5550 TRACEME(("(#%d) item", i));
5551 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5554 if (av_store(av, i, sv) == 0)
5558 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5566 * Retrieve a whole hash table in pre-0.6 binary format.
5568 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5569 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5571 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5573 * When we come here, SX_HASH has been read already.
5575 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5583 SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5585 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5588 * Read length, allocate table.
5592 TRACEME(("size = %d", len));
5594 SEEN(hv, 0, 0); /* Will return if table not allocated properly */
5596 return (SV *) hv; /* No data follow if table empty */
5597 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5600 * Now get each key/value pair in turn...
5603 for (i = 0; i < len; i++) {
5609 if (c == SX_VL_UNDEF) {
5610 TRACEME(("(#%d) undef value", i));
5612 * Due to a bug in hv_store(), it's not possible to pass
5613 * &PL_sv_undef to hv_store() as a value, otherwise the
5614 * associated key will not be creatable any more. -- RAM, 14/01/97
5617 sv_h_undef = newSVsv(&PL_sv_undef);
5618 sv = SvREFCNT_inc(sv_h_undef);
5619 } else if (c == SX_VALUE) {
5620 TRACEME(("(#%d) value", i));
5621 sv = retrieve(aTHX_ cxt, 0);
5625 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5629 * Since we're reading into kbuf, we must ensure we're not
5630 * recursing between the read and the hv_store() where it's used.
5631 * Hence the key comes after the value.
5636 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5637 RLEN(size); /* Get key size */
5638 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5641 kbuf[size] = '\0'; /* Mark string end, just in case */
5642 TRACEME(("(#%d) key '%s'", i, kbuf));
5645 * Enter key/value pair into hash table.
5648 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5652 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5658 *** Retrieval engine.
5664 * Make sure the stored data we're trying to retrieve has been produced
5665 * on an ILP compatible system with the same byteorder. It croaks out in
5666 * case an error is detected. [ILP = integer-long-pointer sizes]
5667 * Returns null if error is detected, &PL_sv_undef otherwise.
5669 * Note that there's no byte ordering info emitted when network order was
5670 * used at store time.
5672 static SV *magic_check(pTHX_ stcxt_t *cxt)
5674 /* The worst case for a malicious header would be old magic (which is
5675 longer), major, minor, byteorder length byte of 255, 255 bytes of
5676 garbage, sizeof int, long, pointer, NV.
5677 So the worse of that we can read is 255 bytes of garbage plus 4.
5678 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5679 compiling perl on a system with chars that are larger than 8 bits.
5680 (Even Crays aren't *that* perverse).
5682 unsigned char buf[4 + 255];
5683 unsigned char *current;
5686 int use_network_order;
5690 int version_minor = 0;
5692 TRACEME(("magic_check"));
5695 * The "magic number" is only for files, not when freezing in memory.
5699 /* This includes the '\0' at the end. I want to read the extra byte,
5700 which is usually going to be the major version number. */
5701 STRLEN len = sizeof(magicstr);
5704 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5706 /* Point at the byte after the byte we read. */
5707 current = buf + --len; /* Do the -- outside of macros. */
5709 if (memNE(buf, magicstr, len)) {
5711 * Try to read more bytes to check for the old magic number, which
5715 TRACEME(("trying for old magic number"));
5717 old_len = sizeof(old_magicstr) - 1;
5718 READ(current + 1, (SSize_t)(old_len - len));
5720 if (memNE(buf, old_magicstr, old_len))
5721 CROAK(("File is not a perl storable"));
5723 current = buf + old_len;
5725 use_network_order = *current;
5727 GETMARK(use_network_order);
5730 * Starting with 0.6, the "use_network_order" byte flag is also used to
5731 * indicate the version number of the binary, and therefore governs the
5732 * setting of sv_retrieve_vtbl. See magic_write().
5734 if (old_magic && use_network_order > 1) {
5735 /* 0.1 dump - use_network_order is really byte order length */
5739 version_major = use_network_order >> 1;
5741 cxt->retrieve_vtbl = (SV*(**)(pTHX_ stcxt_t *cxt, const char *cname)) (version_major > 0 ? sv_retrieve : sv_old_retrieve);
5743 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5747 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5748 * minor version of the protocol. See magic_write().
5751 if (version_major > 1)
5752 GETMARK(version_minor);
5754 cxt->ver_major = version_major;
5755 cxt->ver_minor = version_minor;
5757 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5760 * Inter-operability sanity check: we can't retrieve something stored
5761 * using a format more recent than ours, because we have no way to
5762 * know what has changed, and letting retrieval go would mean a probable
5763 * failure reporting a "corrupted" storable file.
5767 version_major > STORABLE_BIN_MAJOR ||
5768 (version_major == STORABLE_BIN_MAJOR &&
5769 version_minor > STORABLE_BIN_MINOR)
5772 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5773 STORABLE_BIN_MINOR));
5775 if (version_major == STORABLE_BIN_MAJOR) {
5776 TRACEME(("cxt->accept_future_minor is %d",
5777 cxt->accept_future_minor));
5778 if (cxt->accept_future_minor < 0)
5779 cxt->accept_future_minor
5780 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5783 if (cxt->accept_future_minor == 1)
5784 croak_now = 0; /* Don't croak yet. */
5787 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5788 version_major, version_minor,
5789 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5794 * If they stored using network order, there's no byte ordering
5795 * information to check.
5798 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5799 return &PL_sv_undef; /* No byte ordering info */
5801 /* In C truth is 1, falsehood is 0. Very convienient. */
5802 use_NV_size = version_major >= 2 && version_minor >= 2;
5804 if (version_major >= 0) {
5808 c = use_network_order;
5810 length = c + 3 + use_NV_size;
5811 READ(buf, length); /* Not null-terminated */
5813 TRACEME(("byte order '%.*s' %d", c, buf, c));
5815 #ifdef USE_56_INTERWORK_KLUDGE
5816 /* No point in caching this in the context as we only need it once per
5817 retrieve, and we need to recheck it each read. */
5818 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", GV_ADD))) {
5819 if ((c != (sizeof (byteorderstr_56) - 1))
5820 || memNE(buf, byteorderstr_56, c))
5821 CROAK(("Byte order is not compatible"));
5825 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5826 CROAK(("Byte order is not compatible"));
5832 if ((int) *current++ != sizeof(int))
5833 CROAK(("Integer size is not compatible"));
5836 if ((int) *current++ != sizeof(long))
5837 CROAK(("Long integer size is not compatible"));
5839 /* sizeof(char *) */
5840 if ((int) *current != sizeof(char *))
5841 CROAK(("Pointer size is not compatible"));
5845 if ((int) *++current != sizeof(NV))
5846 CROAK(("Double size is not compatible"));
5849 return &PL_sv_undef; /* OK */
5855 * Recursively retrieve objects from the specified file and return their
5856 * root SV (which may be an AV or an HV for what we care).
5857 * Returns null if there is a problem.
5859 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname)
5865 TRACEME(("retrieve"));
5868 * Grab address tag which identifies the object if we are retrieving
5869 * an older format. Since the new binary format counts objects and no
5870 * longer explicitely tags them, we must keep track of the correspondance
5873 * The following section will disappear one day when the old format is
5874 * no longer supported, hence the final "goto" in the "if" block.
5877 if (cxt->hseen) { /* Retrieving old binary */
5879 if (cxt->netorder) {
5881 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5882 tag = (stag_t) nettag;
5884 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5887 if (type == SX_OBJECT) {
5889 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5891 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5893 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5896 * The following code is common with the SX_OBJECT case below.
5899 svh = av_fetch(cxt->aseen, tagn, FALSE);
5901 CROAK(("Object #%"IVdf" should have been retrieved already",
5904 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5905 SvREFCNT_inc(sv); /* One more reference to this same sv */
5906 return sv; /* The SV pointer where object was retrieved */
5910 * Map new object, but don't increase tagnum. This will be done
5911 * by each of the retrieve_* functions when they call SEEN().
5913 * The mapping associates the "tag" initially present with a unique
5914 * tag number. See test for SX_OBJECT above to see how this is perused.
5917 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5918 newSViv(cxt->tagnum), 0))
5925 * Regular post-0.6 binary format.
5930 TRACEME(("retrieve type = %d", type));
5933 * Are we dealing with an object we should have already retrieved?
5936 if (type == SX_OBJECT) {
5940 svh = av_fetch(cxt->aseen, tag, FALSE);
5942 CROAK(("Object #%"IVdf" should have been retrieved already",
5945 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5946 SvREFCNT_inc(sv); /* One more reference to this same sv */
5947 return sv; /* The SV pointer where object was retrieved */
5948 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5949 if (cxt->accept_future_minor < 0)
5950 cxt->accept_future_minor
5951 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5954 if (cxt->accept_future_minor == 1) {
5955 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5956 "This Storable is v%d.%d and can only handle data types up to %d",
5957 cxt->ver_major, cxt->ver_minor, type,
5958 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5962 first_time: /* Will disappear when support for old format is dropped */
5965 * Okay, first time through for this one.
5968 sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
5970 return (SV *) 0; /* Failed */
5973 * Old binary formats (pre-0.7).
5975 * Final notifications, ended by SX_STORED may now follow.
5976 * Currently, the only pertinent notification to apply on the
5977 * freshly retrieved object is either:
5978 * SX_CLASS <char-len> <classname> for short classnames.
5979 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5980 * Class name is then read into the key buffer pool used by
5981 * hash table key retrieval.
5984 if (cxt->ver_major < 2) {
5985 while ((type = GETCHAR()) != SX_STORED) {
5989 GETMARK(len); /* Length coded on a single char */
5991 case SX_LG_CLASS: /* Length coded on a regular integer */
5996 return (SV *) 0; /* Failed */
5998 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
6001 kbuf[len] = '\0'; /* Mark string end */
6006 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
6007 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
6015 * Retrieve data held in file and return the root object.
6016 * Common routine for pretrieve and mretrieve.
6018 static SV *do_retrieve(
6026 int is_tainted; /* Is input source tainted? */
6027 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
6029 TRACEME(("do_retrieve (optype = 0x%x)", optype));
6031 optype |= ST_RETRIEVE;
6034 * Sanity assertions for retrieve dispatch tables.
6037 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
6038 ("old and new retrieve dispatch table have same size"));
6039 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
6040 ("SX_ERROR entry correctly initialized in old dispatch table"));
6041 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
6042 ("SX_ERROR entry correctly initialized in new dispatch table"));
6045 * Workaround for CROAK leak: if they enter with a "dirty" context,
6046 * free up memory for them now.
6050 clean_context(aTHX_ cxt);
6053 * Now that STORABLE_xxx hooks exist, it is possible that they try to
6054 * re-enter retrieve() via the hooks.
6058 cxt = allocate_context(aTHX_ cxt);
6062 ASSERT(cxt->entry == 1, ("starting new recursion"));
6063 ASSERT(!cxt->s_dirty, ("clean context"));
6068 * Data is loaded into the memory buffer when f is NULL, unless `in' is
6069 * also NULL, in which case we're expecting the data to already lie
6070 * in the buffer (dclone case).
6073 KBUFINIT(); /* Allocate hash key reading pool once */
6079 const char *orig = SvPV(in, length);
6081 /* This is quite deliberate. I want the UTF8 routines
6082 to encounter the '\0' which perl adds at the end
6083 of all scalars, so that any new string also has
6086 STRLEN klen_tmp = length + 1;
6087 bool is_utf8 = TRUE;
6089 /* Just casting the &klen to (STRLEN) won't work
6090 well if STRLEN and I32 are of different widths.
6092 asbytes = (char*)bytes_from_utf8((U8*)orig,
6096 CROAK(("Frozen string corrupt - contains characters outside 0-255"));
6098 if (asbytes != orig) {
6099 /* String has been converted.
6100 There is no need to keep any reference to
6102 in = sv_newmortal();
6103 /* We donate the SV the malloc()ed string
6104 bytes_from_utf8 returned us. */
6105 SvUPGRADE(in, SVt_PV);
6107 SvPV_set(in, asbytes);
6108 SvLEN_set(in, klen_tmp);
6109 SvCUR_set(in, klen_tmp - 1);
6113 MBUF_SAVE_AND_LOAD(in);
6117 * Magic number verifications.
6119 * This needs to be done before calling init_retrieve_context()
6120 * since the format indication in the file are necessary to conduct
6121 * some of the initializations.
6124 cxt->fio = f; /* Where I/O are performed */
6126 if (!magic_check(aTHX_ cxt))
6127 CROAK(("Magic number checking on storable %s failed",
6128 cxt->fio ? "file" : "string"));
6130 TRACEME(("data stored in %s format",
6131 cxt->netorder ? "net order" : "native"));
6134 * Check whether input source is tainted, so that we don't wrongly
6135 * taint perfectly good values...
6137 * We assume file input is always tainted. If both `f' and `in' are
6138 * NULL, then we come from dclone, and tainted is already filled in
6139 * the context. That's a kludge, but the whole dclone() thing is
6140 * already quite a kludge anyway! -- RAM, 15/09/2000.
6143 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
6144 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
6145 init_retrieve_context(aTHX_ cxt, optype, is_tainted);
6147 ASSERT(is_retrieving(aTHX), ("within retrieve operation"));
6149 sv = retrieve(aTHX_ cxt, 0); /* Recursively retrieve object, get root SV */
6158 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
6161 * The "root" context is never freed.
6164 clean_retrieve_context(aTHX_ cxt);
6165 if (cxt->prev) /* This context was stacked */
6166 free_context(aTHX_ cxt); /* It was not the "root" context */
6169 * Prepare returned value.
6173 TRACEME(("retrieve ERROR"));
6174 #if (PATCHLEVEL <= 4)
6175 /* perl 5.00405 seems to screw up at this point with an
6176 'attempt to modify a read only value' error reported in the
6177 eval { $self = pretrieve(*FILE) } in _retrieve.
6178 I can't see what the cause of this error is, but I suspect a
6179 bug in 5.004, as it seems to be capable of issuing spurious
6180 errors or core dumping with matches on $@. I'm not going to
6181 spend time on what could be a fruitless search for the cause,
6182 so here's a bodge. If you're running 5.004 and don't like
6183 this inefficiency, either upgrade to a newer perl, or you are
6184 welcome to find the problem and send in a patch.
6188 return &PL_sv_undef; /* Something went wrong, return undef */
6192 TRACEME(("retrieve got %s(0x%"UVxf")",
6193 sv_reftype(sv, FALSE), PTR2UV(sv)));
6196 * Backward compatibility with Storable-0.5@9 (which we know we
6197 * are retrieving if hseen is non-null): don't create an extra RV
6198 * for objects since we special-cased it at store time.
6200 * Build a reference to the SV returned by pretrieve even if it is
6201 * already one and not a scalar, for consistency reasons.
6204 if (pre_06_fmt) { /* Was not handling overloading by then */
6206 TRACEME(("fixing for old formats -- pre 0.6"));
6207 if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
6208 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
6214 * If reference is overloaded, restore behaviour.
6216 * NB: minor glitch here: normally, overloaded refs are stored specially
6217 * so that we can croak when behaviour cannot be re-installed, and also
6218 * avoid testing for overloading magic at each reference retrieval.
6220 * Unfortunately, the root reference is implicitely stored, so we must
6221 * check for possible overloading now. Furthermore, if we don't restore
6222 * overloading, we cannot croak as if the original ref was, because we
6223 * have no way to determine whether it was an overloaded ref or not in
6226 * It's a pity that overloading magic is attached to the rv, and not to
6227 * the underlying sv as blessing is.
6231 HV *stash = (HV *) SvSTASH(sv);
6232 SV *rv = newRV_noinc(sv);
6233 if (stash && Gv_AMG(stash)) {
6235 TRACEME(("restored overloading on root reference"));
6237 TRACEME(("ended do_retrieve() with an object"));
6241 TRACEME(("regular do_retrieve() end"));
6243 return newRV_noinc(sv);
6249 * Retrieve data held in file and return the root object, undef on error.
6251 static SV *pretrieve(pTHX_ PerlIO *f)
6253 TRACEME(("pretrieve"));
6254 return do_retrieve(aTHX_ f, Nullsv, 0);
6260 * Retrieve data held in scalar and return the root object, undef on error.
6262 static SV *mretrieve(pTHX_ SV *sv)
6264 TRACEME(("mretrieve"));
6265 return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
6275 * Deep clone: returns a fresh copy of the original referenced SV tree.
6277 * This is achieved by storing the object in memory and restoring from
6278 * there. Not that efficient, but it should be faster than doing it from
6281 static SV *dclone(pTHX_ SV *sv)
6285 stcxt_t *real_context;
6288 TRACEME(("dclone"));
6291 * Workaround for CROAK leak: if they enter with a "dirty" context,
6292 * free up memory for them now.
6296 clean_context(aTHX_ cxt);
6299 * Tied elements seem to need special handling.
6302 if ((SvTYPE(sv) == SVt_PVLV
6303 #if PERL_VERSION < 8
6304 || SvTYPE(sv) == SVt_PVMG
6306 ) && SvRMAGICAL(sv) && mg_find(sv, 'p')) {
6311 * do_store() optimizes for dclone by not freeing its context, should
6312 * we need to allocate one because we're deep cloning from a hook.
6315 if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
6316 return &PL_sv_undef; /* Error during store */
6319 * Because of the above optimization, we have to refresh the context,
6320 * since a new one could have been allocated and stacked by do_store().
6323 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
6324 cxt = real_context; /* And we need this temporary... */
6327 * Now, `cxt' may refer to a new context.
6330 ASSERT(!cxt->s_dirty, ("clean context"));
6331 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
6334 TRACEME(("dclone stored %d bytes", size));
6338 * Since we're passing do_retrieve() both a NULL file and sv, we need
6339 * to pre-compute the taintedness of the input by setting cxt->tainted
6340 * to whatever state our own input string was. -- RAM, 15/09/2000
6342 * do_retrieve() will free non-root context.
6345 cxt->s_tainted = SvTAINTED(sv);
6346 out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
6348 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
6358 * The Perl IO GV object distinguishes between input and output for sockets
6359 * but not for plain files. To allow Storable to transparently work on
6360 * plain files and sockets transparently, we have to ask xsubpp to fetch the
6361 * right object for us. Hence the OutputStream and InputStream declarations.
6363 * Before perl 5.004_05, those entries in the standard typemap are not
6364 * defined in perl include files, so we do that here.
6367 #ifndef OutputStream
6368 #define OutputStream PerlIO *
6369 #define InputStream PerlIO *
6370 #endif /* !OutputStream */
6372 MODULE = Storable PACKAGE = Storable::Cxt
6378 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
6382 if (!cxt->membuf_ro && mbase)
6384 if (cxt->membuf_ro && (cxt->msaved).arena)
6385 Safefree((cxt->msaved).arena);
6388 MODULE = Storable PACKAGE = Storable
6394 HV *stash = gv_stashpvn("Storable", 8, GV_ADD);
6395 newCONSTSUB(stash, "BIN_MAJOR", newSViv(STORABLE_BIN_MAJOR));
6396 newCONSTSUB(stash, "BIN_MINOR", newSViv(STORABLE_BIN_MINOR));
6397 newCONSTSUB(stash, "BIN_WRITE_MINOR", newSViv(STORABLE_BIN_WRITE_MINOR));
6399 init_perinterp(aTHX);
6400 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
6402 /* Only disable the used only once warning if we are in debugging mode. */
6403 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
6405 #ifdef USE_56_INTERWORK_KLUDGE
6406 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
6413 init_perinterp(aTHX);
6420 RETVAL = pstore(aTHX_ f, obj);
6429 RETVAL = net_pstore(aTHX_ f, obj);
6437 RETVAL = mstore(aTHX_ obj);
6445 RETVAL = net_mstore(aTHX_ obj);
6453 RETVAL = pretrieve(aTHX_ f);
6461 RETVAL = mretrieve(aTHX_ sv);
6469 RETVAL = dclone(aTHX_ sv);
6474 last_op_in_netorder()
6476 RETVAL = last_op_in_netorder(aTHX);
6483 RETVAL = is_storing(aTHX);
6490 RETVAL = is_retrieving(aTHX);