2 * Store and retrieve mechanism.
4 * Copyright (c) 1995-2000, Raphael Manfredi
6 * You may redistribute only under the same terms as Perl 5, as specified
7 * in the README file that comes with the distribution.
11 #define PERL_NO_GET_CONTEXT /* we want efficiency */
17 #include <patchlevel.h> /* Perl's one, needed since 5.6 */
20 #if !defined(PERL_VERSION) || PERL_VERSION < 8
21 #include "ppport.h" /* handle old perls */
25 #define DEBUGME /* Debug mode, turns assertions on as well */
26 #define DASSERT /* Assertion mode */
30 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
31 * Provide them with the necessary defines so they can build with pre-5.004.
34 #ifndef PERLIO_IS_STDIO
36 #define PerlIO_getc(x) getc(x)
37 #define PerlIO_putc(f,x) putc(x,f)
38 #define PerlIO_read(x,y,z) fread(y,1,z,x)
39 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
40 #define PerlIO_stdoutf printf
41 #endif /* PERLIO_IS_STDIO */
42 #endif /* USE_PERLIO */
45 * Earlier versions of perl might be used, we can't assume they have the latest!
48 #ifndef PERL_VERSION /* For perls < 5.6 */
49 #define PERL_VERSION PATCHLEVEL
51 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
53 #if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
54 #define PL_sv_yes sv_yes
55 #define PL_sv_no sv_no
56 #define PL_sv_undef sv_undef
57 #if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
58 #define newSVpvn newSVpv
60 #endif /* PATCHLEVEL <= 4 */
61 #ifndef HvSHAREKEYS_off
62 #define HvSHAREKEYS_off(hv) /* Ignore */
64 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
65 #define AvFILLp AvFILL
67 typedef double NV; /* Older perls lack the NV type */
68 #define IVdf "ld" /* Various printf formats for Perl types */
72 #define INT2PTR(t,v) (t)(IV)(v)
73 #define PTR2UV(v) (unsigned long)(v)
74 #endif /* PERL_VERSION -- perls < 5.6 */
76 #ifndef NVef /* The following were not part of perl 5.6 */
77 #if defined(USE_LONG_DOUBLE) && \
78 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
79 #define NVef PERL_PRIeldbl
80 #define NVff PERL_PRIfldbl
81 #define NVgf PERL_PRIgldbl
90 #define SvRV_set(sv, val) \
92 assert(SvTYPE(sv) >= SVt_RV); \
93 (((XRV*)SvANY(sv))->xrv_rv = (val)); \
97 #ifndef PERL_UNUSED_DECL
99 # if (defined(__GNUC__) && defined(__cplusplus)) || defined(__INTEL_COMPILER)
100 # define PERL_UNUSED_DECL
102 # define PERL_UNUSED_DECL __attribute__((unused))
105 # define PERL_UNUSED_DECL
110 #define dNOOP extern int Perl___notused PERL_UNUSED_DECL
118 # define HvRITER_set(hv,r) (HvRITER(hv) = r)
121 # define HvEITER_set(hv,r) (HvEITER(hv) = r)
125 # define HvRITER_get HvRITER
128 # define HvEITER_get HvEITER
132 #define HvNAME_get HvNAME
135 #ifndef HvPLACEHOLDERS_get
136 # define HvPLACEHOLDERS_get HvPLACEHOLDERS
146 * TRACEME() will only output things when the $Storable::DEBUGME is true.
151 if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
152 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
159 #define ASSERT(x,y) \
162 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
163 __FILE__, __LINE__); \
164 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
175 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
177 #define SX_OBJECT C(0) /* Already stored object */
178 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
179 #define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
180 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
181 #define SX_REF C(4) /* Reference to object forthcoming */
182 #define SX_UNDEF C(5) /* Undefined scalar */
183 #define SX_INTEGER C(6) /* Integer forthcoming */
184 #define SX_DOUBLE C(7) /* Double forthcoming */
185 #define SX_BYTE C(8) /* (signed) byte forthcoming */
186 #define SX_NETINT C(9) /* Integer in network order forthcoming */
187 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
188 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
189 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
190 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
191 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
192 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
193 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
194 #define SX_BLESS C(17) /* Object is blessed */
195 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
196 #define SX_HOOK C(19) /* Stored via hook, user-defined */
197 #define SX_OVERLOAD C(20) /* Overloaded reference */
198 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
199 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
200 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
201 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
202 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
203 #define SX_CODE C(26) /* Code references as perl source code */
204 #define SX_WEAKREF C(27) /* Weak reference to object forthcoming */
205 #define SX_WEAKOVERLOAD C(28) /* Overloaded weak reference */
206 #define SX_ERROR C(29) /* Error */
209 * Those are only used to retrieve "old" pre-0.6 binary images.
211 #define SX_ITEM 'i' /* An array item introducer */
212 #define SX_IT_UNDEF 'I' /* Undefined array item */
213 #define SX_KEY 'k' /* A hash key introducer */
214 #define SX_VALUE 'v' /* A hash value introducer */
215 #define SX_VL_UNDEF 'V' /* Undefined hash value */
218 * Those are only used to retrieve "old" pre-0.7 binary images
221 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
222 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
223 #define SX_STORED 'X' /* End of object */
226 * Limits between short/long length representation.
229 #define LG_SCALAR 255 /* Large scalar length limit */
230 #define LG_BLESS 127 /* Large classname bless limit */
236 #define ST_STORE 0x1 /* Store operation */
237 #define ST_RETRIEVE 0x2 /* Retrieval operation */
238 #define ST_CLONE 0x4 /* Deep cloning operation */
241 * The following structure is used for hash table key retrieval. Since, when
242 * retrieving objects, we'll be facing blessed hash references, it's best
243 * to pre-allocate that buffer once and resize it as the need arises, never
244 * freeing it (keys will be saved away someplace else anyway, so even large
245 * keys are not enough a motivation to reclaim that space).
247 * This structure is also used for memory store/retrieve operations which
248 * happen in a fixed place before being malloc'ed elsewhere if persistency
249 * is required. Hence the aptr pointer.
252 char *arena; /* Will hold hash key strings, resized as needed */
253 STRLEN asiz; /* Size of aforementionned buffer */
254 char *aptr; /* Arena pointer, for in-place read/write ops */
255 char *aend; /* First invalid address */
260 * A hash table records the objects which have already been stored.
261 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
262 * an arbitrary sequence number) is used to identify them.
265 * An array table records the objects which have already been retrieved,
266 * as seen by the tag determind by counting the objects themselves. The
267 * reference to that retrieved object is kept in the table, and is returned
268 * when an SX_OBJECT is found bearing that same tag.
270 * The same processing is used to record "classname" for blessed objects:
271 * indexing by a hash at store time, and via an array at retrieve time.
274 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
277 * The following "thread-safe" related defines were contributed by
278 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
279 * only renamed things a little bit to ensure consistency with surrounding
280 * code. -- RAM, 14/09/1999
282 * The original patch suffered from the fact that the stcxt_t structure
283 * was global. Murray tried to minimize the impact on the code as much as
286 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
287 * on objects. Therefore, the notion of context needs to be generalized,
291 #define MY_VERSION "Storable(" XS_VERSION ")"
295 * Conditional UTF8 support.
299 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
300 #define HAS_UTF8_SCALARS
302 #define HAS_UTF8_HASHES
305 /* 5.6 perl has utf8 scalars but not hashes */
309 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
312 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
315 #define WEAKREF_CROAK() CROAK(("Cannot retrieve weak references in this perl"))
318 #ifdef HvPLACEHOLDERS
319 #define HAS_RESTRICTED_HASHES
321 #define HVhek_PLACEHOLD 0x200
322 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
326 #define HAS_HASH_KEY_FLAGS
330 #define USE_PTR_TABLE
334 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
335 * files remap tainted and dirty when threading is enabled. That's bad for
336 * perl to remap such common words. -- RAM, 29/09/00
340 typedef struct stcxt {
341 int entry; /* flags recursion */
342 int optype; /* type of traversal operation */
343 /* which objects have been seen, store time.
344 tags are numbers, which are cast to (SV *) and stored directly */
346 /* use pseen if we have ptr_tables. We have to store tag+1, because
347 tag numbers start at 0, and we can't store (SV *) 0 in a ptr_table
348 without it being confused for a fetch lookup failure. */
349 struct ptr_tbl *pseen;
350 /* Still need hseen for the 0.6 file format code. */
353 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
354 AV *aseen; /* which objects have been seen, retrieve time */
355 IV where_is_undef; /* index in aseen of PL_sv_undef */
356 HV *hclass; /* which classnames have been seen, store time */
357 AV *aclass; /* which classnames have been seen, retrieve time */
358 HV *hook; /* cache for hook methods per class name */
359 IV tagnum; /* incremented at store time for each seen object */
360 IV classnum; /* incremented at store time for each seen classname */
361 int netorder; /* true if network order used */
362 int s_tainted; /* true if input source is tainted, at retrieve time */
363 int forgive_me; /* whether to be forgiving... */
364 int deparse; /* whether to deparse code refs */
365 SV *eval; /* whether to eval source code */
366 int canonical; /* whether to store hashes sorted by key */
367 #ifndef HAS_RESTRICTED_HASHES
368 int derestrict; /* whether to downgrade restrcted hashes */
371 int use_bytes; /* whether to bytes-ify utf8 */
373 int accept_future_minor; /* croak immediately on future minor versions? */
374 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
375 int membuf_ro; /* true means membuf is read-only and msaved is rw */
376 struct extendable keybuf; /* for hash key retrieval */
377 struct extendable membuf; /* for memory store/retrieve operations */
378 struct extendable msaved; /* where potentially valid mbuf is saved */
379 PerlIO *fio; /* where I/O are performed, NULL for memory */
380 int ver_major; /* major of version for retrieved object */
381 int ver_minor; /* minor of version for retrieved object */
382 SV *(**retrieve_vtbl)(pTHX_ struct stcxt *, const char *); /* retrieve dispatch table */
383 SV *prev; /* contexts chained backwards in real recursion */
384 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
387 #define NEW_STORABLE_CXT_OBJ(cxt) \
389 SV *self = newSV(sizeof(stcxt_t) - 1); \
390 SV *my_sv = newRV_noinc(self); \
391 sv_bless(my_sv, gv_stashpv("Storable::Cxt", GV_ADD)); \
392 cxt = (stcxt_t *)SvPVX(self); \
393 Zero(cxt, 1, stcxt_t); \
394 cxt->my_sv = my_sv; \
397 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
399 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
401 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
402 #else /* >= perl5.004_68 */
404 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
405 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
406 #endif /* < perl5.004_68 */
408 #define dSTCXT_PTR(T,name) \
409 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
410 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
413 dSTCXT_PTR(stcxt_t *, cxt)
417 NEW_STORABLE_CXT_OBJ(cxt); \
418 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
420 #define SET_STCXT(x) \
423 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
426 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
428 static stcxt_t *Context_ptr = NULL;
429 #define dSTCXT stcxt_t *cxt = Context_ptr
430 #define SET_STCXT(x) Context_ptr = x
433 NEW_STORABLE_CXT_OBJ(cxt); \
437 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
441 * Croaking implies a memory leak, since we don't use setjmp/longjmp
442 * to catch the exit and free memory used during store or retrieve
443 * operations. This is not too difficult to fix, but I need to understand
444 * how Perl does it, and croaking is exceptional anyway, so I lack the
445 * motivation to do it.
447 * The current workaround is to mark the context as dirty when croaking,
448 * so that data structures can be freed whenever we renter Storable code
449 * (but only *then*: it's a workaround, not a fix).
451 * This is also imperfect, because we don't really know how far they trapped
452 * the croak(), and when we were recursing, we won't be able to clean anything
453 * but the topmost context stacked.
456 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
459 * End of "thread-safe" related definitions.
465 * Keep only the low 32 bits of a pointer (used for tags, which are not
470 #define LOW_32BITS(x) ((I32) (x))
472 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
478 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
479 * Used in the WLEN and RLEN macros.
483 #define oI(x) ((I32 *) ((char *) (x) + 4))
484 #define oS(x) ((x) - 4)
485 #define oC(x) (x = 0)
494 * key buffer handling
496 #define kbuf (cxt->keybuf).arena
497 #define ksiz (cxt->keybuf).asiz
501 TRACEME(("** allocating kbuf of 128 bytes")); \
502 New(10003, kbuf, 128, char); \
509 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
510 Renew(kbuf, x+1, char); \
516 * memory buffer handling
518 #define mbase (cxt->membuf).arena
519 #define msiz (cxt->membuf).asiz
520 #define mptr (cxt->membuf).aptr
521 #define mend (cxt->membuf).aend
523 #define MGROW (1 << 13)
524 #define MMASK (MGROW - 1)
526 #define round_mgrow(x) \
527 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
528 #define trunc_int(x) \
529 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
530 #define int_aligned(x) \
531 ((unsigned long) (x) == trunc_int(x))
533 #define MBUF_INIT(x) \
536 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
537 New(10003, mbase, MGROW, char); \
538 msiz = (STRLEN)MGROW; \
544 mend = mbase + msiz; \
547 #define MBUF_TRUNC(x) mptr = mbase + x
548 #define MBUF_SIZE() (mptr - mbase)
554 * Those macros are used in do_retrieve() to save the current memory
555 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
556 * data from a string.
558 #define MBUF_SAVE_AND_LOAD(in) \
560 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
561 cxt->membuf_ro = 1; \
562 TRACEME(("saving mbuf")); \
563 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
567 #define MBUF_RESTORE() \
569 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
570 cxt->membuf_ro = 0; \
571 TRACEME(("restoring mbuf")); \
572 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
576 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
577 * See store_scalar() for other usage of this workaround.
579 #define MBUF_LOAD(v) \
581 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
583 CROAK(("Not a scalar string")); \
584 mptr = mbase = SvPV(v, msiz); \
585 mend = mbase + msiz; \
588 #define MBUF_XTEND(x) \
590 int nsz = (int) round_mgrow((x)+msiz); \
591 int offset = mptr - mbase; \
592 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
593 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
595 Renew(mbase, nsz, char); \
597 mptr = mbase + offset; \
598 mend = mbase + nsz; \
601 #define MBUF_CHK(x) \
603 if ((mptr + (x)) > mend) \
607 #define MBUF_GETC(x) \
610 x = (int) (unsigned char) *mptr++; \
616 #define MBUF_GETINT(x) \
619 if ((mptr + 4) <= mend) { \
620 memcpy(oI(&x), mptr, 4); \
626 #define MBUF_GETINT(x) \
628 if ((mptr + sizeof(int)) <= mend) { \
629 if (int_aligned(mptr)) \
632 memcpy(&x, mptr, sizeof(int)); \
633 mptr += sizeof(int); \
639 #define MBUF_READ(x,s) \
641 if ((mptr + (s)) <= mend) { \
642 memcpy(x, mptr, s); \
648 #define MBUF_SAFEREAD(x,s,z) \
650 if ((mptr + (s)) <= mend) { \
651 memcpy(x, mptr, s); \
659 #define MBUF_SAFEPVREAD(x,s,z) \
661 if ((mptr + (s)) <= mend) { \
662 memcpy(x, mptr, s); \
670 #define MBUF_PUTC(c) \
673 *mptr++ = (char) c; \
676 *mptr++ = (char) c; \
681 #define MBUF_PUTINT(i) \
684 memcpy(mptr, oI(&i), 4); \
688 #define MBUF_PUTINT(i) \
690 MBUF_CHK(sizeof(int)); \
691 if (int_aligned(mptr)) \
694 memcpy(mptr, &i, sizeof(int)); \
695 mptr += sizeof(int); \
699 #define MBUF_WRITE(x,s) \
702 memcpy(mptr, x, s); \
707 * Possible return values for sv_type().
711 #define svis_SCALAR 1
715 #define svis_TIED_ITEM 5
723 #define SHF_TYPE_MASK 0x03
724 #define SHF_LARGE_CLASSLEN 0x04
725 #define SHF_LARGE_STRLEN 0x08
726 #define SHF_LARGE_LISTLEN 0x10
727 #define SHF_IDX_CLASSNAME 0x20
728 #define SHF_NEED_RECURSE 0x40
729 #define SHF_HAS_LIST 0x80
732 * Types for SX_HOOK (last 2 bits in flags).
738 #define SHT_EXTRA 3 /* Read extra byte for type */
741 * The following are held in the "extra byte"...
744 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
745 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
746 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
749 * per hash flags for flagged hashes
752 #define SHV_RESTRICTED 0x01
755 * per key flags for flagged hashes
758 #define SHV_K_UTF8 0x01
759 #define SHV_K_WASUTF8 0x02
760 #define SHV_K_LOCKED 0x04
761 #define SHV_K_ISSV 0x08
762 #define SHV_K_PLACEHOLDER 0x10
765 * Before 0.6, the magic string was "perl-store" (binary version number 0).
767 * Since 0.6 introduced many binary incompatibilities, the magic string has
768 * been changed to "pst0" to allow an old image to be properly retrieved by
769 * a newer Storable, but ensure a newer image cannot be retrieved with an
772 * At 0.7, objects are given the ability to serialize themselves, and the
773 * set of markers is extended, backward compatibility is not jeopardized,
774 * so the binary version number could have remained unchanged. To correctly
775 * spot errors if a file making use of 0.7-specific extensions is given to
776 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
777 * a "minor" version, to better track this kind of evolution from now on.
780 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
781 static const char magicstr[] = "pst0"; /* Used as a magic number */
783 #define MAGICSTR_BYTES 'p','s','t','0'
784 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
786 /* 5.6.x introduced the ability to have IVs as long long.
787 However, Configure still defined BYTEORDER based on the size of a long.
788 Storable uses the BYTEORDER value as part of the header, but doesn't
789 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
790 with IV as long long on a platform that uses Configure (ie most things
791 except VMS and Windows) headers are identical for the different IV sizes,
792 despite the files containing some fields based on sizeof(IV)
794 5.8 is consistent - the following redifinition kludge is only needed on
795 5.6.x, but the interwork is needed on 5.8 while data survives in files
800 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
801 #ifndef NO_56_INTERWORK_KLUDGE
802 #define USE_56_INTERWORK_KLUDGE
804 #if BYTEORDER == 0x1234
806 #define BYTEORDER 0x12345678
808 #if BYTEORDER == 0x4321
810 #define BYTEORDER 0x87654321
815 #if BYTEORDER == 0x1234
816 #define BYTEORDER_BYTES '1','2','3','4'
818 #if BYTEORDER == 0x12345678
819 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
820 #ifdef USE_56_INTERWORK_KLUDGE
821 #define BYTEORDER_BYTES_56 '1','2','3','4'
824 #if BYTEORDER == 0x87654321
825 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
826 #ifdef USE_56_INTERWORK_KLUDGE
827 #define BYTEORDER_BYTES_56 '4','3','2','1'
830 #if BYTEORDER == 0x4321
831 #define BYTEORDER_BYTES '4','3','2','1'
833 #error Unknown byteorder. Please append your byteorder to Storable.xs
839 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
840 #ifdef USE_56_INTERWORK_KLUDGE
841 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
844 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
845 #define STORABLE_BIN_MINOR 7 /* Binary minor "version" */
847 #if (PATCHLEVEL <= 5)
848 #define STORABLE_BIN_WRITE_MINOR 4
851 * Perl 5.6.0 onwards can do weak references.
853 #define STORABLE_BIN_WRITE_MINOR 7
854 #endif /* (PATCHLEVEL <= 5) */
856 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
857 #define PL_sv_placeholder PL_sv_undef
861 * Useful store shortcuts...
865 * Note that if you put more than one mark for storing a particular
866 * type of thing, *and* in the retrieve_foo() function you mark both
867 * the thingy's you get off with SEEN(), you *must* increase the
868 * tagnum with cxt->tagnum++ along with this macro!
875 else if (PerlIO_putc(cxt->fio, x) == EOF) \
879 #define WRITE_I32(x) \
881 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
884 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
891 if (cxt->netorder) { \
892 int y = (int) htonl(x); \
895 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
900 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
905 #define WLEN(x) WRITE_I32(x)
912 else if (PerlIO_write(cxt->fio, x, y) != y) \
916 #define STORE_PV_LEN(pv, len, small, large) \
918 if (len <= LG_SCALAR) { \
919 unsigned char clen = (unsigned char) len; \
931 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
934 * Store &PL_sv_undef in arrays without recursing through store().
936 #define STORE_SV_UNDEF() \
939 PUTMARK(SX_SV_UNDEF); \
943 * Useful retrieve shortcuts...
947 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
953 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
957 #define READ_I32(x) \
959 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
963 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
973 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
976 x = (int) ntohl(x); \
979 #define RLEN(x) READ_I32(x)
986 else if (PerlIO_read(cxt->fio, x, y) != y) \
990 #define SAFEREAD(x,y,z) \
993 MBUF_SAFEREAD(x,y,z); \
994 else if (PerlIO_read(cxt->fio, x, y) != y) { \
1000 #define SAFEPVREAD(x,y,z) \
1003 MBUF_SAFEPVREAD(x,y,z); \
1004 else if (PerlIO_read(cxt->fio, x, y) != y) { \
1011 * This macro is used at retrieve time, to remember where object 'y', bearing a
1012 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
1013 * we'll therefore know where it has been retrieved and will be able to
1014 * share the same reference, as in the original stored memory image.
1016 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
1017 * on the objects given to STORABLE_thaw and expect that to be defined), and
1018 * also for overloaded objects (for which we might not find the stash if the
1019 * object is not blessed yet--this might occur for overloaded objects that
1020 * refer to themselves indirectly: if we blessed upon return from a sub
1021 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
1022 * restored on it because the underlying object would not be blessed yet!).
1024 * To achieve that, the class name of the last retrieved object is passed down
1025 * recursively, and the first SEEN() call for which the class name is not NULL
1026 * will bless the object.
1028 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
1030 #define SEEN(y,c,i) \
1034 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
1036 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
1037 PTR2UV(y), SvREFCNT(y)-1)); \
1039 BLESS((SV *) (y), c); \
1043 * Bless `s' in `p', via a temporary reference, required by sv_bless().
1045 #define BLESS(s,p) \
1049 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
1050 stash = gv_stashpv((p), GV_ADD); \
1051 ref = newRV_noinc(s); \
1052 (void) sv_bless(ref, stash); \
1053 SvRV_set(ref, NULL); \
1054 SvREFCNT_dec(ref); \
1057 * sort (used in store_hash) - conditionally use qsort when
1058 * sortsv is not available ( <= 5.6.1 ).
1061 #if (PATCHLEVEL <= 6)
1063 #if defined(USE_ITHREADS)
1065 #define STORE_HASH_SORT \
1067 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
1068 SAVESPTR(orig_perl); \
1069 PERL_SET_CONTEXT(aTHX); \
1070 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
1073 #else /* ! USE_ITHREADS */
1075 #define STORE_HASH_SORT \
1076 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1078 #endif /* USE_ITHREADS */
1080 #else /* PATCHLEVEL > 6 */
1082 #define STORE_HASH_SORT \
1083 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1085 #endif /* PATCHLEVEL <= 6 */
1087 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1088 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname);
1091 * Dynamic dispatching table for SV store.
1094 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1095 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1096 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1097 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1098 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1099 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1100 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1101 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1102 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1104 typedef int (*sv_store_t)(pTHX_ stcxt_t *cxt, SV *sv);
1106 static const sv_store_t sv_store[] = {
1107 (sv_store_t)store_ref, /* svis_REF */
1108 (sv_store_t)store_scalar, /* svis_SCALAR */
1109 (sv_store_t)store_array, /* svis_ARRAY */
1110 (sv_store_t)store_hash, /* svis_HASH */
1111 (sv_store_t)store_tied, /* svis_TIED */
1112 (sv_store_t)store_tied_item, /* svis_TIED_ITEM */
1113 (sv_store_t)store_code, /* svis_CODE */
1114 (sv_store_t)store_other, /* svis_OTHER */
1117 #define SV_STORE(x) (*sv_store[x])
1120 * Dynamic dispatching tables for SV retrieval.
1123 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname);
1124 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname);
1125 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1126 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1127 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname);
1128 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname);
1129 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname);
1130 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname);
1131 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname);
1132 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname);
1133 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1134 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname);
1135 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname);
1136 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname);
1137 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1138 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname);
1140 typedef SV* (*sv_retrieve_t)(pTHX_ stcxt_t *cxt, const char *name);
1142 static const sv_retrieve_t sv_old_retrieve[] = {
1143 0, /* SX_OBJECT -- entry unused dynamically */
1144 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1145 (sv_retrieve_t)old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1146 (sv_retrieve_t)old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1147 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1148 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1149 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1150 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1151 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1152 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1153 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1154 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1155 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1156 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1157 (sv_retrieve_t)retrieve_other, /* SX_SV_UNDEF not supported */
1158 (sv_retrieve_t)retrieve_other, /* SX_SV_YES not supported */
1159 (sv_retrieve_t)retrieve_other, /* SX_SV_NO not supported */
1160 (sv_retrieve_t)retrieve_other, /* SX_BLESS not supported */
1161 (sv_retrieve_t)retrieve_other, /* SX_IX_BLESS not supported */
1162 (sv_retrieve_t)retrieve_other, /* SX_HOOK not supported */
1163 (sv_retrieve_t)retrieve_other, /* SX_OVERLOADED not supported */
1164 (sv_retrieve_t)retrieve_other, /* SX_TIED_KEY not supported */
1165 (sv_retrieve_t)retrieve_other, /* SX_TIED_IDX not supported */
1166 (sv_retrieve_t)retrieve_other, /* SX_UTF8STR not supported */
1167 (sv_retrieve_t)retrieve_other, /* SX_LUTF8STR not supported */
1168 (sv_retrieve_t)retrieve_other, /* SX_FLAG_HASH not supported */
1169 (sv_retrieve_t)retrieve_other, /* SX_CODE not supported */
1170 (sv_retrieve_t)retrieve_other, /* SX_WEAKREF not supported */
1171 (sv_retrieve_t)retrieve_other, /* SX_WEAKOVERLOAD not supported */
1172 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1175 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1176 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1177 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname);
1178 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname);
1179 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname);
1180 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1181 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1182 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname);
1183 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname);
1184 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname);
1185 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname);
1186 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname);
1187 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname);
1188 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname);
1189 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname);
1191 static const sv_retrieve_t sv_retrieve[] = {
1192 0, /* SX_OBJECT -- entry unused dynamically */
1193 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1194 (sv_retrieve_t)retrieve_array, /* SX_ARRAY */
1195 (sv_retrieve_t)retrieve_hash, /* SX_HASH */
1196 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1197 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1198 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1199 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1200 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1201 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1202 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1203 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1204 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1205 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1206 (sv_retrieve_t)retrieve_sv_undef, /* SX_SV_UNDEF */
1207 (sv_retrieve_t)retrieve_sv_yes, /* SX_SV_YES */
1208 (sv_retrieve_t)retrieve_sv_no, /* SX_SV_NO */
1209 (sv_retrieve_t)retrieve_blessed, /* SX_BLESS */
1210 (sv_retrieve_t)retrieve_idx_blessed, /* SX_IX_BLESS */
1211 (sv_retrieve_t)retrieve_hook, /* SX_HOOK */
1212 (sv_retrieve_t)retrieve_overloaded, /* SX_OVERLOAD */
1213 (sv_retrieve_t)retrieve_tied_key, /* SX_TIED_KEY */
1214 (sv_retrieve_t)retrieve_tied_idx, /* SX_TIED_IDX */
1215 (sv_retrieve_t)retrieve_utf8str, /* SX_UTF8STR */
1216 (sv_retrieve_t)retrieve_lutf8str, /* SX_LUTF8STR */
1217 (sv_retrieve_t)retrieve_flag_hash, /* SX_HASH */
1218 (sv_retrieve_t)retrieve_code, /* SX_CODE */
1219 (sv_retrieve_t)retrieve_weakref, /* SX_WEAKREF */
1220 (sv_retrieve_t)retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
1221 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1224 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1226 static SV *mbuf2sv(pTHX);
1229 *** Context management.
1235 * Called once per "thread" (interpreter) to initialize some global context.
1237 static void init_perinterp(pTHX)
1241 cxt->netorder = 0; /* true if network order used */
1242 cxt->forgive_me = -1; /* whether to be forgiving... */
1243 cxt->accept_future_minor = -1; /* would otherwise occur too late */
1249 * Called at the end of every context cleaning, to perform common reset
1252 static void reset_context(stcxt_t *cxt)
1256 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1260 * init_store_context
1262 * Initialize a new store context for real recursion.
1264 static void init_store_context(
1271 TRACEME(("init_store_context"));
1273 cxt->netorder = network_order;
1274 cxt->forgive_me = -1; /* Fetched from perl if needed */
1275 cxt->deparse = -1; /* Idem */
1276 cxt->eval = NULL; /* Idem */
1277 cxt->canonical = -1; /* Idem */
1278 cxt->tagnum = -1; /* Reset tag numbers */
1279 cxt->classnum = -1; /* Reset class numbers */
1280 cxt->fio = f; /* Where I/O are performed */
1281 cxt->optype = optype; /* A store, or a deep clone */
1282 cxt->entry = 1; /* No recursion yet */
1285 * The `hseen' table is used to keep track of each SV stored and their
1286 * associated tag numbers is special. It is "abused" because the
1287 * values stored are not real SV, just integers cast to (SV *),
1288 * which explains the freeing below.
1290 * It is also one possible bottlneck to achieve good storing speed,
1291 * so the "shared keys" optimization is turned off (unlikely to be
1292 * of any use here), and the hash table is "pre-extended". Together,
1293 * those optimizations increase the throughput by 12%.
1296 #ifdef USE_PTR_TABLE
1297 cxt->pseen = ptr_table_new();
1300 cxt->hseen = newHV(); /* Table where seen objects are stored */
1301 HvSHAREKEYS_off(cxt->hseen);
1304 * The following does not work well with perl5.004_04, and causes
1305 * a core dump later on, in a completely unrelated spot, which
1306 * makes me think there is a memory corruption going on.
1308 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1309 * it below does not make any difference. It seems to work fine
1310 * with perl5.004_68 but given the probable nature of the bug,
1311 * that does not prove anything.
1313 * It's a shame because increasing the amount of buckets raises
1314 * store() throughput by 5%, but until I figure this out, I can't
1315 * allow for this to go into production.
1317 * It is reported fixed in 5.005, hence the #if.
1319 #if PERL_VERSION >= 5
1320 #define HBUCKETS 4096 /* Buckets for %hseen */
1321 #ifndef USE_PTR_TABLE
1322 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1327 * The `hclass' hash uses the same settings as `hseen' above, but it is
1328 * used to assign sequential tags (numbers) to class names for blessed
1331 * We turn the shared key optimization on.
1334 cxt->hclass = newHV(); /* Where seen classnames are stored */
1336 #if PERL_VERSION >= 5
1337 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1341 * The `hook' hash table is used to keep track of the references on
1342 * the STORABLE_freeze hook routines, when found in some class name.
1344 * It is assumed that the inheritance tree will not be changed during
1345 * storing, and that no new method will be dynamically created by the
1349 cxt->hook = newHV(); /* Table where hooks are cached */
1352 * The `hook_seen' array keeps track of all the SVs returned by
1353 * STORABLE_freeze hooks for us to serialize, so that they are not
1354 * reclaimed until the end of the serialization process. Each SV is
1355 * only stored once, the first time it is seen.
1358 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1362 * clean_store_context
1364 * Clean store context by
1366 static void clean_store_context(pTHX_ stcxt_t *cxt)
1370 TRACEME(("clean_store_context"));
1372 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1375 * Insert real values into hashes where we stored faked pointers.
1378 #ifndef USE_PTR_TABLE
1380 hv_iterinit(cxt->hseen);
1381 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1382 HeVAL(he) = &PL_sv_undef;
1387 hv_iterinit(cxt->hclass);
1388 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1389 HeVAL(he) = &PL_sv_undef;
1393 * And now dispose of them...
1395 * The surrounding if() protection has been added because there might be
1396 * some cases where this routine is called more than once, during
1397 * exceptionnal events. This was reported by Marc Lehmann when Storable
1398 * is executed from mod_perl, and the fix was suggested by him.
1399 * -- RAM, 20/12/2000
1402 #ifdef USE_PTR_TABLE
1404 struct ptr_tbl *pseen = cxt->pseen;
1406 ptr_table_free(pseen);
1408 assert(!cxt->hseen);
1411 HV *hseen = cxt->hseen;
1414 sv_free((SV *) hseen);
1419 HV *hclass = cxt->hclass;
1422 sv_free((SV *) hclass);
1426 HV *hook = cxt->hook;
1429 sv_free((SV *) hook);
1432 if (cxt->hook_seen) {
1433 AV *hook_seen = cxt->hook_seen;
1435 av_undef(hook_seen);
1436 sv_free((SV *) hook_seen);
1439 cxt->forgive_me = -1; /* Fetched from perl if needed */
1440 cxt->deparse = -1; /* Idem */
1442 SvREFCNT_dec(cxt->eval);
1444 cxt->eval = NULL; /* Idem */
1445 cxt->canonical = -1; /* Idem */
1451 * init_retrieve_context
1453 * Initialize a new retrieve context for real recursion.
1455 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1457 TRACEME(("init_retrieve_context"));
1460 * The hook hash table is used to keep track of the references on
1461 * the STORABLE_thaw hook routines, when found in some class name.
1463 * It is assumed that the inheritance tree will not be changed during
1464 * storing, and that no new method will be dynamically created by the
1468 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1470 #ifdef USE_PTR_TABLE
1475 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1476 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1477 * the correspondance between the tags and the tag number used by the
1478 * new retrieve routines.
1481 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1484 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1485 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1486 cxt->aclass = newAV(); /* Where seen classnames are kept */
1487 cxt->tagnum = 0; /* Have to count objects... */
1488 cxt->classnum = 0; /* ...and class names as well */
1489 cxt->optype = optype;
1490 cxt->s_tainted = is_tainted;
1491 cxt->entry = 1; /* No recursion yet */
1492 #ifndef HAS_RESTRICTED_HASHES
1493 cxt->derestrict = -1; /* Fetched from perl if needed */
1495 #ifndef HAS_UTF8_ALL
1496 cxt->use_bytes = -1; /* Fetched from perl if needed */
1498 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1502 * clean_retrieve_context
1504 * Clean retrieve context by
1506 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1508 TRACEME(("clean_retrieve_context"));
1510 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1513 AV *aseen = cxt->aseen;
1516 sv_free((SV *) aseen);
1518 cxt->where_is_undef = -1;
1521 AV *aclass = cxt->aclass;
1524 sv_free((SV *) aclass);
1528 HV *hook = cxt->hook;
1531 sv_free((SV *) hook);
1535 HV *hseen = cxt->hseen;
1538 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1541 #ifndef HAS_RESTRICTED_HASHES
1542 cxt->derestrict = -1; /* Fetched from perl if needed */
1544 #ifndef HAS_UTF8_ALL
1545 cxt->use_bytes = -1; /* Fetched from perl if needed */
1547 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1555 * A workaround for the CROAK bug: cleanup the last context.
1557 static void clean_context(pTHX_ stcxt_t *cxt)
1559 TRACEME(("clean_context"));
1561 ASSERT(cxt->s_dirty, ("dirty context"));
1566 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1568 if (cxt->optype & ST_RETRIEVE)
1569 clean_retrieve_context(aTHX_ cxt);
1570 else if (cxt->optype & ST_STORE)
1571 clean_store_context(aTHX_ cxt);
1575 ASSERT(!cxt->s_dirty, ("context is clean"));
1576 ASSERT(cxt->entry == 0, ("context is reset"));
1582 * Allocate a new context and push it on top of the parent one.
1583 * This new context is made globally visible via SET_STCXT().
1585 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1589 TRACEME(("allocate_context"));
1591 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1593 NEW_STORABLE_CXT_OBJ(cxt);
1594 cxt->prev = parent_cxt->my_sv;
1597 ASSERT(!cxt->s_dirty, ("clean context"));
1605 * Free current context, which cannot be the "root" one.
1606 * Make the context underneath globally visible via SET_STCXT().
1608 static void free_context(pTHX_ stcxt_t *cxt)
1610 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1612 TRACEME(("free_context"));
1614 ASSERT(!cxt->s_dirty, ("clean context"));
1615 ASSERT(prev, ("not freeing root context"));
1617 SvREFCNT_dec(cxt->my_sv);
1620 ASSERT(cxt, ("context not void"));
1630 * Tells whether we're in the middle of a store operation.
1632 static int is_storing(pTHX)
1636 return cxt->entry && (cxt->optype & ST_STORE);
1642 * Tells whether we're in the middle of a retrieve operation.
1644 static int is_retrieving(pTHX)
1648 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1652 * last_op_in_netorder
1654 * Returns whether last operation was made using network order.
1656 * This is typically out-of-band information that might prove useful
1657 * to people wishing to convert native to network order data when used.
1659 static int last_op_in_netorder(pTHX)
1663 return cxt->netorder;
1667 *** Hook lookup and calling routines.
1673 * A wrapper on gv_fetchmethod_autoload() which caches results.
1675 * Returns the routine reference as an SV*, or null if neither the package
1676 * nor its ancestors know about the method.
1678 static SV *pkg_fetchmeth(
1686 const char *hvname = HvNAME_get(pkg);
1690 * The following code is the same as the one performed by UNIVERSAL::can
1694 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1695 if (gv && isGV(gv)) {
1696 sv = newRV((SV*) GvCV(gv));
1697 TRACEME(("%s->%s: 0x%"UVxf, hvname, method, PTR2UV(sv)));
1699 sv = newSVsv(&PL_sv_undef);
1700 TRACEME(("%s->%s: not found", hvname, method));
1704 * Cache the result, ignoring failure: if we can't store the value,
1705 * it just won't be cached.
1708 (void) hv_store(cache, hvname, strlen(hvname), sv, 0);
1710 return SvOK(sv) ? sv : (SV *) 0;
1716 * Force cached value to be undef: hook ignored even if present.
1718 static void pkg_hide(
1724 const char *hvname = HvNAME_get(pkg);
1725 (void) hv_store(cache,
1726 hvname, strlen(hvname), newSVsv(&PL_sv_undef), 0);
1732 * Discard cached value: a whole fetch loop will be retried at next lookup.
1734 static void pkg_uncache(
1740 const char *hvname = HvNAME_get(pkg);
1741 (void) hv_delete(cache, hvname, strlen(hvname), G_DISCARD);
1747 * Our own "UNIVERSAL::can", which caches results.
1749 * Returns the routine reference as an SV*, or null if the object does not
1750 * know about the method.
1760 const char *hvname = HvNAME_get(pkg);
1762 TRACEME(("pkg_can for %s->%s", hvname, method));
1765 * Look into the cache to see whether we already have determined
1766 * where the routine was, if any.
1768 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1769 * that only one hook (i.e. always the same) is cached in a given cache.
1772 svh = hv_fetch(cache, hvname, strlen(hvname), FALSE);
1776 TRACEME(("cached %s->%s: not found", hvname, method));
1779 TRACEME(("cached %s->%s: 0x%"UVxf,
1780 hvname, method, PTR2UV(sv)));
1785 TRACEME(("not cached yet"));
1786 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1792 * Call routine as obj->hook(av) in scalar context.
1793 * Propagates the single returned value if not called in void context.
1795 static SV *scalar_call(
1807 TRACEME(("scalar_call (cloning=%d)", cloning));
1814 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1816 SV **ary = AvARRAY(av);
1817 int cnt = AvFILLp(av) + 1;
1819 XPUSHs(ary[0]); /* Frozen string */
1820 for (i = 1; i < cnt; i++) {
1821 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1822 i, PTR2UV(ary[i])));
1823 XPUSHs(sv_2mortal(newRV(ary[i])));
1828 TRACEME(("calling..."));
1829 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1830 TRACEME(("count = %d", count));
1836 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1849 * Call routine obj->hook(cloning) in list context.
1850 * Returns the list of returned values in an array.
1852 static AV *array_call(
1863 TRACEME(("array_call (cloning=%d)", cloning));
1869 XPUSHs(obj); /* Target object */
1870 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1873 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1878 for (i = count - 1; i >= 0; i--) {
1880 av_store(av, i, SvREFCNT_inc(sv));
1893 * Lookup the class name in the `hclass' table and either assign it a new ID
1894 * or return the existing one, by filling in `classnum'.
1896 * Return true if the class was known, false if the ID was just generated.
1898 static int known_class(
1901 char *name, /* Class name */
1902 int len, /* Name length */
1906 HV *hclass = cxt->hclass;
1908 TRACEME(("known_class (%s)", name));
1911 * Recall that we don't store pointers in this hash table, but tags.
1912 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1915 svh = hv_fetch(hclass, name, len, FALSE);
1917 *classnum = LOW_32BITS(*svh);
1922 * Unknown classname, we need to record it.
1926 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1927 CROAK(("Unable to record new classname"));
1929 *classnum = cxt->classnum;
1934 *** Sepcific store routines.
1940 * Store a reference.
1941 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1943 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1946 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1949 * Follow reference, and check if target is overloaded.
1955 TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1960 HV *stash = (HV *) SvSTASH(sv);
1961 if (stash && Gv_AMG(stash)) {
1962 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1963 PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1965 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1967 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1969 return store(aTHX_ cxt, sv);
1977 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1978 * The <data> section is omitted if <length> is 0.
1980 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1981 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1983 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
1988 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1990 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1993 * For efficiency, break the SV encapsulation by peaking at the flags
1994 * directly without using the Perl macros to avoid dereferencing
1995 * sv->sv_flags each time we wish to check the flags.
1998 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1999 if (sv == &PL_sv_undef) {
2000 TRACEME(("immortal undef"));
2001 PUTMARK(SX_SV_UNDEF);
2003 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
2010 * Always store the string representation of a scalar if it exists.
2011 * Gisle Aas provided me with this test case, better than a long speach:
2013 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
2014 * SV = PVNV(0x80c8520)
2016 * FLAGS = (NOK,POK,pNOK,pPOK)
2019 * PV = 0x80c83d0 "abc"\0
2023 * Write SX_SCALAR, length, followed by the actual data.
2025 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
2026 * appropriate, followed by the actual (binary) data. A double
2027 * is written as a string if network order, for portability.
2029 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
2030 * The reason is that when the scalar value is tainted, the SvNOK(sv)
2033 * The test for a read-only scalar with both POK and NOK set is meant
2034 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
2035 * address comparison for each scalar we store.
2038 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
2040 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
2041 if (sv == &PL_sv_yes) {
2042 TRACEME(("immortal yes"));
2044 } else if (sv == &PL_sv_no) {
2045 TRACEME(("immortal no"));
2048 pv = SvPV(sv, len); /* We know it's SvPOK */
2049 goto string; /* Share code below */
2051 } else if (flags & SVf_POK) {
2052 /* public string - go direct to string read. */
2053 goto string_readlen;
2055 #if (PATCHLEVEL <= 6)
2056 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
2057 direct if NV flag is off. */
2058 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
2060 /* 5.7 rules are that if IV public flag is set, IV value is as
2061 good, if not better, than NV value. */
2067 * Will come here from below with iv set if double is an integer.
2071 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2073 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
2074 * (for example) and that ends up in the optimised small integer
2077 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
2078 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
2079 goto string_readlen;
2083 * Optimize small integers into a single byte, otherwise store as
2084 * a real integer (converted into network order if they asked).
2087 if (iv >= -128 && iv <= 127) {
2088 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
2091 TRACEME(("small integer stored as %d", siv));
2092 } else if (cxt->netorder) {
2094 TRACEME(("no htonl, fall back to string for integer"));
2095 goto string_readlen;
2103 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2104 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
2106 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
2107 /* Bigger than 32 bits. */
2108 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2109 goto string_readlen;
2113 niv = (I32) htonl((I32) iv);
2114 TRACEME(("using network order"));
2119 PUTMARK(SX_INTEGER);
2120 WRITE(&iv, sizeof(iv));
2123 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2124 } else if (flags & SVf_NOK) {
2126 #if (PATCHLEVEL <= 6)
2129 * Watch for number being an integer in disguise.
2131 if (nv == (NV) (iv = I_V(nv))) {
2132 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2133 goto integer; /* Share code above */
2138 if (SvIOK_notUV(sv)) {
2140 goto integer; /* Share code above */
2145 if (cxt->netorder) {
2146 TRACEME(("double %"NVff" stored as string", nv));
2147 goto string_readlen; /* Share code below */
2151 WRITE(&nv, sizeof(nv));
2153 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2155 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2156 I32 wlen; /* For 64-bit machines */
2162 * Will come here from above if it was readonly, POK and NOK but
2163 * neither &PL_sv_yes nor &PL_sv_no.
2167 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2169 STORE_UTF8STR(pv, wlen);
2171 STORE_SCALAR(pv, wlen);
2172 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2173 PTR2UV(sv), SvPVX(sv), (IV)len));
2175 CROAK(("Can't determine type of %s(0x%"UVxf")",
2176 sv_reftype(sv, FALSE),
2178 return 0; /* Ok, no recursion on scalars */
2186 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2187 * Each item is stored as <object>.
2189 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2192 I32 len = av_len(av) + 1;
2196 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2199 * Signal array by emitting SX_ARRAY, followed by the array length.
2204 TRACEME(("size = %d", len));
2207 * Now store each item recursively.
2210 for (i = 0; i < len; i++) {
2211 sav = av_fetch(av, i, 0);
2213 TRACEME(("(#%d) undef item", i));
2217 TRACEME(("(#%d) item", i));
2218 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2222 TRACEME(("ok (array)"));
2228 #if (PATCHLEVEL <= 6)
2234 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2237 sortcmp(const void *a, const void *b)
2239 #if defined(USE_ITHREADS)
2241 #endif /* USE_ITHREADS */
2242 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2245 #endif /* PATCHLEVEL <= 6 */
2250 * Store a hash table.
2252 * For a "normal" hash (not restricted, no utf8 keys):
2254 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2255 * Values are stored as <object>.
2256 * Keys are stored as <length> <data>, the <data> section being omitted
2259 * For a "fancy" hash (restricted or utf8 keys):
2261 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2263 * Values are stored as <object>.
2264 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2266 * Currently the only hash flag is "restriced"
2267 * Key flags are as for hv.h
2269 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2273 #ifdef HAS_RESTRICTED_HASHES
2282 int flagged_hash = ((SvREADONLY(hv)
2283 #ifdef HAS_HASH_KEY_FLAGS
2287 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2290 /* needs int cast for C++ compilers, doesn't it? */
2291 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2294 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2298 * Signal hash by emitting SX_HASH, followed by the table length.
2302 PUTMARK(SX_FLAG_HASH);
2303 PUTMARK(hash_flags);
2308 TRACEME(("size = %d", len));
2311 * Save possible iteration state via each() on that table.
2314 riter = HvRITER_get(hv);
2315 eiter = HvEITER_get(hv);
2319 * Now store each item recursively.
2321 * If canonical is defined to some true value then store each
2322 * key/value pair in sorted order otherwise the order is random.
2323 * Canonical order is irrelevant when a deep clone operation is performed.
2325 * Fetch the value from perl only once per store() operation, and only
2330 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2331 (cxt->canonical < 0 && (cxt->canonical =
2332 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2335 * Storing in order, sorted by key.
2336 * Run through the hash, building up an array of keys in a
2337 * mortal array, sort the array and then run through the
2343 /*av_extend (av, len);*/
2345 TRACEME(("using canonical order"));
2347 for (i = 0; i < len; i++) {
2348 #ifdef HAS_RESTRICTED_HASHES
2349 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2351 HE *he = hv_iternext(hv);
2356 CROAK(("Hash %p inconsistent - expected %d keys, %dth is NULL", hv, len, i));
2357 key = hv_iterkeysv(he);
2358 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2363 for (i = 0; i < len; i++) {
2364 #ifdef HAS_RESTRICTED_HASHES
2365 int placeholders = (int)HvPLACEHOLDERS_get(hv);
2367 unsigned char flags = 0;
2371 SV *key = av_shift(av);
2372 /* This will fail if key is a placeholder.
2373 Track how many placeholders we have, and error if we
2375 HE *he = hv_fetch_ent(hv, key, 0, 0);
2379 if (!(val = HeVAL(he))) {
2380 /* Internal error, not I/O error */
2384 #ifdef HAS_RESTRICTED_HASHES
2385 /* Should be a placeholder. */
2386 if (placeholders-- < 0) {
2387 /* This should not happen - number of
2388 retrieves should be identical to
2389 number of placeholders. */
2392 /* Value is never needed, and PL_sv_undef is
2393 more space efficient to store. */
2396 ("Flags not 0 but %d", flags));
2397 flags = SHV_K_PLACEHOLDER;
2404 * Store value first.
2407 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2409 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2414 * Keys are written after values to make sure retrieval
2415 * can be optimal in terms of memory usage, where keys are
2416 * read into a fixed unique buffer called kbuf.
2417 * See retrieve_hash() for details.
2420 /* Implementation of restricted hashes isn't nicely
2422 if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
2423 flags |= SHV_K_LOCKED;
2426 keyval = SvPV(key, keylen_tmp);
2427 keylen = keylen_tmp;
2428 #ifdef HAS_UTF8_HASHES
2429 /* If you build without optimisation on pre 5.6
2430 then nothing spots that SvUTF8(key) is always 0,
2431 so the block isn't optimised away, at which point
2432 the linker dislikes the reference to
2435 const char *keysave = keyval;
2436 bool is_utf8 = TRUE;
2438 /* Just casting the &klen to (STRLEN) won't work
2439 well if STRLEN and I32 are of different widths.
2441 keyval = (char*)bytes_from_utf8((U8*)keyval,
2445 /* If we were able to downgrade here, then than
2446 means that we have a key which only had chars
2447 0-255, but was utf8 encoded. */
2449 if (keyval != keysave) {
2450 keylen = keylen_tmp;
2451 flags |= SHV_K_WASUTF8;
2453 /* keylen_tmp can't have changed, so no need
2454 to assign back to keylen. */
2455 flags |= SHV_K_UTF8;
2462 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2464 /* This is a workaround for a bug in 5.8.0
2465 that causes the HEK_WASUTF8 flag to be
2466 set on an HEK without the hash being
2467 marked as having key flags. We just
2468 cross our fingers and drop the flag.
2470 assert (flags == 0 || flags == SHV_K_WASUTF8);
2471 TRACEME(("(#%d) key '%s'", i, keyval));
2475 WRITE(keyval, keylen);
2476 if (flags & SHV_K_WASUTF8)
2481 * Free up the temporary array
2490 * Storing in "random" order (in the order the keys are stored
2491 * within the hash). This is the default and will be faster!
2494 for (i = 0; i < len; i++) {
2497 unsigned char flags;
2498 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2499 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2501 HE *he = hv_iternext(hv);
2503 SV *val = (he ? hv_iterval(hv, he) : 0);
2508 return 1; /* Internal error, not I/O error */
2510 /* Implementation of restricted hashes isn't nicely
2513 = (((hash_flags & SHV_RESTRICTED)
2515 ? SHV_K_LOCKED : 0);
2517 if (val == &PL_sv_placeholder) {
2518 flags |= SHV_K_PLACEHOLDER;
2523 * Store value first.
2526 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2528 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2532 hek = HeKEY_hek(he);
2534 if (len == HEf_SVKEY) {
2535 /* This is somewhat sick, but the internal APIs are
2536 * such that XS code could put one of these in in
2538 * Maybe we should be capable of storing one if
2541 key_sv = HeKEY_sv(he);
2542 flags |= SHV_K_ISSV;
2544 /* Regular string key. */
2545 #ifdef HAS_HASH_KEY_FLAGS
2547 flags |= SHV_K_UTF8;
2548 if (HEK_WASUTF8(hek))
2549 flags |= SHV_K_WASUTF8;
2555 * Keys are written after values to make sure retrieval
2556 * can be optimal in terms of memory usage, where keys are
2557 * read into a fixed unique buffer called kbuf.
2558 * See retrieve_hash() for details.
2563 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2565 /* This is a workaround for a bug in 5.8.0
2566 that causes the HEK_WASUTF8 flag to be
2567 set on an HEK without the hash being
2568 marked as having key flags. We just
2569 cross our fingers and drop the flag.
2571 assert (flags == 0 || flags == SHV_K_WASUTF8);
2572 TRACEME(("(#%d) key '%s'", i, key));
2574 if (flags & SHV_K_ISSV) {
2575 store(aTHX_ cxt, key_sv);
2584 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2587 HvRITER_set(hv, riter); /* Restore hash iterator state */
2588 HvEITER_set(hv, eiter);
2596 * Store a code reference.
2598 * Layout is SX_CODE <length> followed by a scalar containing the perl
2599 * source code of the code reference.
2601 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2603 #if PERL_VERSION < 6
2605 * retrieve_code does not work with perl 5.005 or less
2607 return store_other(aTHX_ cxt, (SV*)cv);
2612 SV *text, *bdeparse;
2614 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2617 cxt->deparse == 0 ||
2618 (cxt->deparse < 0 && !(cxt->deparse =
2619 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2621 return store_other(aTHX_ cxt, (SV*)cv);
2625 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2626 * blessed code references.
2628 /* Ownership of both SVs is passed to load_module, which frees them. */
2629 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2636 * create the B::Deparse object
2640 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2642 count = call_method("new", G_SCALAR);
2645 CROAK(("Unexpected return value from B::Deparse::new\n"));
2649 * call the coderef2text method
2653 XPUSHs(bdeparse); /* XXX is this already mortal? */
2654 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2656 count = call_method("coderef2text", G_SCALAR);
2659 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2663 reallen = strlen(SvPV_nolen(text));
2666 * Empty code references or XS functions are deparsed as
2667 * "(prototype) ;" or ";".
2670 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2671 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2675 * Signal code by emitting SX_CODE.
2679 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2680 TRACEME(("size = %d", len));
2681 TRACEME(("code = %s", SvPV_nolen(text)));
2684 * Now store the source code.
2687 STORE_SCALAR(SvPV_nolen(text), len);
2692 TRACEME(("ok (code)"));
2701 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2702 * a special mark, followed by the underlying tied object. For instance, when
2703 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2704 * <hash object> stands for the serialization of the tied hash.
2706 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2711 int svt = SvTYPE(sv);
2714 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2717 * We have a small run-time penalty here because we chose to factorise
2718 * all tieds objects into the same routine, and not have a store_tied_hash,
2719 * a store_tied_array, etc...
2721 * Don't use a switch() statement, as most compilers don't optimize that
2722 * well for 2/3 values. An if() else if() cascade is just fine. We put
2723 * tied hashes first, as they are the most likely beasts.
2726 if (svt == SVt_PVHV) {
2727 TRACEME(("tied hash"));
2728 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2729 } else if (svt == SVt_PVAV) {
2730 TRACEME(("tied array"));
2731 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2733 TRACEME(("tied scalar"));
2734 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2738 if (!(mg = mg_find(sv, mtype)))
2739 CROAK(("No magic '%c' found while storing tied %s", mtype,
2740 (svt == SVt_PVHV) ? "hash" :
2741 (svt == SVt_PVAV) ? "array" : "scalar"));
2744 * The mg->mg_obj found by mg_find() above actually points to the
2745 * underlying tied Perl object implementation. For instance, if the
2746 * original SV was that of a tied array, then mg->mg_obj is an AV.
2748 * Note that we store the Perl object as-is. We don't call its FETCH
2749 * method along the way. At retrieval time, we won't call its STORE
2750 * method either, but the tieing magic will be re-installed. In itself,
2751 * that ensures that the tieing semantics are preserved since futher
2752 * accesses on the retrieved object will indeed call the magic methods...
2755 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2756 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2757 if ((ret = store(aTHX_ cxt, obj)))
2760 TRACEME(("ok (tied)"));
2768 * Stores a reference to an item within a tied structure:
2770 * . \$h{key}, stores both the (tied %h) object and 'key'.
2771 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2773 * Layout is therefore either:
2774 * SX_TIED_KEY <object> <key>
2775 * SX_TIED_IDX <object> <index>
2777 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2782 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2784 if (!(mg = mg_find(sv, 'p')))
2785 CROAK(("No magic 'p' found while storing reference to tied item"));
2788 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2792 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2793 PUTMARK(SX_TIED_KEY);
2794 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2796 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2799 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2801 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2804 I32 idx = mg->mg_len;
2806 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2807 PUTMARK(SX_TIED_IDX);
2808 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2810 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2813 TRACEME(("store_tied_item: storing IDX %d", idx));
2818 TRACEME(("ok (tied item)"));
2824 * store_hook -- dispatched manually, not via sv_store[]
2826 * The blessed SV is serialized by a hook.
2830 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2832 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2833 * the trailing part [] is present, the type of object (scalar, array or hash).
2834 * There is also a bit which says how the classname is stored between:
2839 * and when the <index> form is used (classname already seen), the "large
2840 * classname" bit in <flags> indicates how large the <index> is.
2842 * The serialized string returned by the hook is of length <len2> and comes
2843 * next. It is an opaque string for us.
2845 * Those <len3> object IDs which are listed last represent the extra references
2846 * not directly serialized by the hook, but which are linked to the object.
2848 * When recursion is mandated to resolve object-IDs not yet seen, we have
2849 * instead, with <header> being flags with bits set to indicate the object type
2850 * and that recursion was indeed needed:
2852 * SX_HOOK <header> <object> <header> <object> <flags>
2854 * that same header being repeated between serialized objects obtained through
2855 * recursion, until we reach flags indicating no recursion, at which point
2856 * we know we've resynchronized with a single layout, after <flags>.
2858 * When storing a blessed ref to a tied variable, the following format is
2861 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2863 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2864 * real object type is held in the <extra> flag. At the very end of the
2865 * serialization stream, the underlying magic object is serialized, just like
2866 * any other tied variable.
2868 static int store_hook(
2882 int count; /* really len3 + 1 */
2883 unsigned char flags;
2886 int recursed = 0; /* counts recursion */
2887 int obj_type; /* object type, on 2 bits */
2890 int clone = cxt->optype & ST_CLONE;
2891 char mtype = '\0'; /* for blessed ref to tied structures */
2892 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2894 TRACEME(("store_hook, classname \"%s\", tagged #%d", HvNAME_get(pkg), cxt->tagnum));
2897 * Determine object type on 2 bits.
2902 obj_type = SHT_SCALAR;
2905 obj_type = SHT_ARRAY;
2908 obj_type = SHT_HASH;
2912 * Produced by a blessed ref to a tied data structure, $o in the
2913 * following Perl code.
2917 * my $o = bless \%h, 'BAR';
2919 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2920 * (since we have only 2 bits in <flags> to store the type), and an
2921 * <extra> byte flag will be emitted after the FIRST <flags> in the
2922 * stream, carrying what we put in `eflags'.
2924 obj_type = SHT_EXTRA;
2925 switch (SvTYPE(sv)) {
2927 eflags = (unsigned char) SHT_THASH;
2931 eflags = (unsigned char) SHT_TARRAY;
2935 eflags = (unsigned char) SHT_TSCALAR;
2941 CROAK(("Unexpected object type (%d) in store_hook()", type));
2943 flags = SHF_NEED_RECURSE | obj_type;
2945 classname = HvNAME_get(pkg);
2946 len = strlen(classname);
2949 * To call the hook, we need to fake a call like:
2951 * $object->STORABLE_freeze($cloning);
2953 * but we don't have the $object here. For instance, if $object is
2954 * a blessed array, what we have in `sv' is the array, and we can't
2955 * call a method on those.
2957 * Therefore, we need to create a temporary reference to the object and
2958 * make the call on that reference.
2961 TRACEME(("about to call STORABLE_freeze on class %s", classname));
2963 ref = newRV_noinc(sv); /* Temporary reference */
2964 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2965 SvRV_set(ref, NULL);
2966 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2968 count = AvFILLp(av) + 1;
2969 TRACEME(("store_hook, array holds %d items", count));
2972 * If they return an empty list, it means they wish to ignore the
2973 * hook for this class (and not just this instance -- that's for them
2974 * to handle if they so wish).
2976 * Simply disable the cached entry for the hook (it won't be recomputed
2977 * since it's present in the cache) and recurse to store_blessed().
2982 * They must not change their mind in the middle of a serialization.
2985 if (hv_fetch(cxt->hclass, classname, len, FALSE))
2986 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2987 (cxt->optype & ST_CLONE) ? "cloning" : "storing", classname));
2989 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
2991 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2992 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", classname));
2994 return store_blessed(aTHX_ cxt, sv, type, pkg);
2998 * Get frozen string.
3002 pv = SvPV(ary[0], len2);
3003 /* We can't use pkg_can here because it only caches one method per
3006 GV* gv = gv_fetchmethod_autoload(pkg, "STORABLE_attach", FALSE);
3007 if (gv && isGV(gv)) {
3009 CROAK(("Freeze cannot return references if %s class is using STORABLE_attach", classname));
3015 * If they returned more than one item, we need to serialize some
3016 * extra references if not already done.
3018 * Loop over the array, starting at position #1, and for each item,
3019 * ensure it is a reference, serialize it if not already done, and
3020 * replace the entry with the tag ID of the corresponding serialized
3023 * We CHEAT by not calling av_fetch() and read directly within the
3027 for (i = 1; i < count; i++) {
3028 #ifdef USE_PTR_TABLE
3036 AV *av_hook = cxt->hook_seen;
3039 CROAK(("Item #%d returned by STORABLE_freeze "
3040 "for %s is not a reference", i, classname));
3041 xsv = SvRV(rsv); /* Follow ref to know what to look for */
3044 * Look in hseen and see if we have a tag already.
3045 * Serialize entry if not done already, and get its tag.
3048 #ifdef USE_PTR_TABLE
3049 /* Fakery needed because ptr_table_fetch returns zero for a
3050 failure, whereas the existing code assumes that it can
3051 safely store a tag zero. So for ptr_tables we store tag+1
3053 if ((fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv)))
3054 goto sv_seen; /* Avoid moving code too far to the right */
3056 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
3057 goto sv_seen; /* Avoid moving code too far to the right */
3060 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
3063 * We need to recurse to store that object and get it to be known
3064 * so that we can resolve the list of object-IDs at retrieve time.
3066 * The first time we do this, we need to emit the proper header
3067 * indicating that we recursed, and what the type of object is (the
3068 * object we're storing via a user-hook). Indeed, during retrieval,
3069 * we'll have to create the object before recursing to retrieve the
3070 * others, in case those would point back at that object.
3073 /* [SX_HOOK] <flags> [<extra>] <object>*/
3077 if (obj_type == SHT_EXTRA)
3082 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
3085 #ifdef USE_PTR_TABLE
3086 fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv);
3088 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3090 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
3092 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3095 * It was the first time we serialized `xsv'.
3097 * Keep this SV alive until the end of the serialization: if we
3098 * disposed of it right now by decrementing its refcount, and it was
3099 * a temporary value, some next temporary value allocated during
3100 * another STORABLE_freeze might take its place, and we'd wrongly
3101 * assume that new SV was already serialized, based on its presence
3104 * Therefore, push it away in cxt->hook_seen.
3107 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
3111 * Dispose of the REF they returned. If we saved the `xsv' away
3112 * in the array of returned SVs, that will not cause the underlying
3113 * referenced SV to be reclaimed.
3116 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
3117 SvREFCNT_dec(rsv); /* Dispose of reference */
3120 * Replace entry with its tag (not a real SV, so no refcnt increment)
3123 #ifdef USE_PTR_TABLE
3124 tag = (SV *)--fake_tag;
3129 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
3130 i-1, PTR2UV(xsv), PTR2UV(tag)));
3134 * Allocate a class ID if not already done.
3136 * This needs to be done after the recursion above, since at retrieval
3137 * time, we'll see the inner objects first. Many thanks to
3138 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
3139 * proposed the right fix. -- RAM, 15/09/2000
3143 if (!known_class(aTHX_ cxt, classname, len, &classnum)) {
3144 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3145 classnum = -1; /* Mark: we must store classname */
3147 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3151 * Compute leading flags.
3155 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3156 flags |= SHF_LARGE_CLASSLEN;
3158 flags |= SHF_IDX_CLASSNAME;
3159 if (len2 > LG_SCALAR)
3160 flags |= SHF_LARGE_STRLEN;
3162 flags |= SHF_HAS_LIST;
3163 if (count > (LG_SCALAR + 1))
3164 flags |= SHF_LARGE_LISTLEN;
3167 * We're ready to emit either serialized form:
3169 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3170 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3172 * If we recursed, the SX_HOOK has already been emitted.
3175 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3176 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3177 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3179 /* SX_HOOK <flags> [<extra>] */
3183 if (obj_type == SHT_EXTRA)
3188 /* <len> <classname> or <index> */
3189 if (flags & SHF_IDX_CLASSNAME) {
3190 if (flags & SHF_LARGE_CLASSLEN)
3193 unsigned char cnum = (unsigned char) classnum;
3197 if (flags & SHF_LARGE_CLASSLEN)
3200 unsigned char clen = (unsigned char) len;
3203 WRITE(classname, len); /* Final \0 is omitted */
3206 /* <len2> <frozen-str> */
3207 if (flags & SHF_LARGE_STRLEN) {
3208 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3209 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3211 unsigned char clen = (unsigned char) len2;
3215 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3217 /* [<len3> <object-IDs>] */
3218 if (flags & SHF_HAS_LIST) {
3219 int len3 = count - 1;
3220 if (flags & SHF_LARGE_LISTLEN)
3223 unsigned char clen = (unsigned char) len3;
3228 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3229 * real pointer, rather a tag number, well under the 32-bit limit.
3232 for (i = 1; i < count; i++) {
3233 I32 tagval = htonl(LOW_32BITS(ary[i]));
3235 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3240 * Free the array. We need extra care for indices after 0, since they
3241 * don't hold real SVs but integers cast.
3245 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3250 * If object was tied, need to insert serialization of the magic object.
3253 if (obj_type == SHT_EXTRA) {
3256 if (!(mg = mg_find(sv, mtype))) {
3257 int svt = SvTYPE(sv);
3258 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3259 mtype, (svt == SVt_PVHV) ? "hash" :
3260 (svt == SVt_PVAV) ? "array" : "scalar"));
3263 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3264 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3270 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3278 * store_blessed -- dispatched manually, not via sv_store[]
3280 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3281 * of its ancestors. If there is, then redispatch to store_hook();
3283 * Otherwise, the blessed SV is stored using the following layout:
3285 * SX_BLESS <flag> <len> <classname> <object>
3287 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3288 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3289 * Otherwise, the low order bits give the length, thereby giving a compact
3290 * representation for class names less than 127 chars long.
3292 * Each <classname> seen is remembered and indexed, so that the next time
3293 * an object in the blessed in the same <classname> is stored, the following
3296 * SX_IX_BLESS <flag> <index> <object>
3298 * where <index> is the classname index, stored on 0 or 4 bytes depending
3299 * on the high-order bit in flag (same encoding as above for <len>).
3301 static int store_blessed(
3313 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME_get(pkg)));
3316 * Look for a hook for this blessed SV and redirect to store_hook()
3320 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3322 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3325 * This is a blessed SV without any serialization hook.
3328 classname = HvNAME_get(pkg);
3329 len = strlen(classname);
3331 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3332 PTR2UV(sv), classname, cxt->tagnum));
3335 * Determine whether it is the first time we see that class name (in which
3336 * case it will be stored in the SX_BLESS form), or whether we already
3337 * saw that class name before (in which case the SX_IX_BLESS form will be
3341 if (known_class(aTHX_ cxt, classname, len, &classnum)) {
3342 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3343 PUTMARK(SX_IX_BLESS);
3344 if (classnum <= LG_BLESS) {
3345 unsigned char cnum = (unsigned char) classnum;
3348 unsigned char flag = (unsigned char) 0x80;
3353 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3355 if (len <= LG_BLESS) {
3356 unsigned char clen = (unsigned char) len;
3359 unsigned char flag = (unsigned char) 0x80;
3361 WLEN(len); /* Don't BER-encode, this should be rare */
3363 WRITE(classname, len); /* Final \0 is omitted */
3367 * Now emit the <object> part.
3370 return SV_STORE(type)(aTHX_ cxt, sv);
3376 * We don't know how to store the item we reached, so return an error condition.
3377 * (it's probably a GLOB, some CODE reference, etc...)
3379 * If they defined the `forgive_me' variable at the Perl level to some
3380 * true value, then don't croak, just warn, and store a placeholder string
3383 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3388 TRACEME(("store_other"));
3391 * Fetch the value from perl only once per store() operation.
3395 cxt->forgive_me == 0 ||
3396 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3397 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3399 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3401 warn("Can't store item %s(0x%"UVxf")",
3402 sv_reftype(sv, FALSE), PTR2UV(sv));
3405 * Store placeholder string as a scalar instead...
3408 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3409 PTR2UV(sv), (char) 0);
3412 STORE_SCALAR(buf, len);
3413 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3419 *** Store driving routines
3425 * WARNING: partially duplicates Perl's sv_reftype for speed.
3427 * Returns the type of the SV, identified by an integer. That integer
3428 * may then be used to index the dynamic routine dispatch table.
3430 static int sv_type(pTHX_ SV *sv)
3432 switch (SvTYPE(sv)) {
3437 * No need to check for ROK, that can't be set here since there
3438 * is no field capable of hodling the xrv_rv reference.
3446 * Starting from SVt_PV, it is possible to have the ROK flag
3447 * set, the pointer to the other SV being either stored in
3448 * the xrv_rv (in the case of a pure SVt_RV), or as the
3449 * xpv_pv field of an SVt_PV and its heirs.
3451 * However, those SV cannot be magical or they would be an
3452 * SVt_PVMG at least.
3454 return SvROK(sv) ? svis_REF : svis_SCALAR;
3456 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3457 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3458 return svis_TIED_ITEM;
3460 #if PERL_VERSION < 9
3463 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3465 return SvROK(sv) ? svis_REF : svis_SCALAR;
3467 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3471 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3476 #if PERL_VERSION > 8
3477 /* case SVt_BIND: */
3489 * Recursively store objects pointed to by the sv to the specified file.
3491 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3492 * object (one for which storage has started -- it may not be over if we have
3493 * a self-referenced structure). This data set forms a stored <object>.
3495 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3500 #ifdef USE_PTR_TABLE
3501 struct ptr_tbl *pseen = cxt->pseen;
3503 HV *hseen = cxt->hseen;
3506 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3509 * If object has already been stored, do not duplicate data.
3510 * Simply emit the SX_OBJECT marker followed by its tag data.
3511 * The tag is always written in network order.
3513 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3514 * real pointer, rather a tag number (watch the insertion code below).
3515 * That means it probably safe to assume it is well under the 32-bit limit,
3516 * and makes the truncation safe.
3517 * -- RAM, 14/09/1999
3520 #ifdef USE_PTR_TABLE
3521 svh = (SV **)ptr_table_fetch(pseen, sv);
3523 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3528 if (sv == &PL_sv_undef) {
3529 /* We have seen PL_sv_undef before, but fake it as
3532 Not the simplest solution to making restricted
3533 hashes work on 5.8.0, but it does mean that
3534 repeated references to the one true undef will
3535 take up less space in the output file.
3537 /* Need to jump past the next hv_store, because on the
3538 second store of undef the old hash value will be
3539 SvREFCNT_dec()ed, and as Storable cheats horribly
3540 by storing non-SVs in the hash a SEGV will ensure.
3541 Need to increase the tag number so that the
3542 receiver has no idea what games we're up to. This
3543 special casing doesn't affect hooks that store
3544 undef, as the hook routine does its own lookup into
3545 hseen. Also this means that any references back
3546 to PL_sv_undef (from the pathological case of hooks
3547 storing references to it) will find the seen hash
3548 entry for the first time, as if we didn't have this
3549 hackery here. (That hseen lookup works even on 5.8.0
3550 because it's a key of &PL_sv_undef and a value
3551 which is a tag number, not a value which is
3555 goto undef_special_case;
3558 #ifdef USE_PTR_TABLE
3559 tagval = htonl(LOW_32BITS(((char *)svh)-1));
3561 tagval = htonl(LOW_32BITS(*svh));
3564 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3572 * Allocate a new tag and associate it with the address of the sv being
3573 * stored, before recursing...
3575 * In order to avoid creating new SvIVs to hold the tagnum we just
3576 * cast the tagnum to an SV pointer and store that in the hash. This
3577 * means that we must clean up the hash manually afterwards, but gives
3578 * us a 15% throughput increase.
3583 #ifdef USE_PTR_TABLE
3584 ptr_table_store(pseen, sv, INT2PTR(SV*, 1 + cxt->tagnum));
3586 if (!hv_store(hseen,
3587 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3592 * Store `sv' and everything beneath it, using appropriate routine.
3593 * Abort immediately if we get a non-zero status back.
3596 type = sv_type(aTHX_ sv);
3599 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3600 PTR2UV(sv), cxt->tagnum, type));
3603 HV *pkg = SvSTASH(sv);
3604 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3606 ret = SV_STORE(type)(aTHX_ cxt, sv);
3608 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3609 ret ? "FAILED" : "ok", PTR2UV(sv),
3610 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3618 * Write magic number and system information into the file.
3619 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3620 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3621 * All size and lenghts are written as single characters here.
3623 * Note that no byte ordering info is emitted when <network> is true, since
3624 * integers will be emitted in network order in that case.
3626 static int magic_write(pTHX_ stcxt_t *cxt)
3629 * Starting with 0.6, the "use_network_order" byte flag is also used to
3630 * indicate the version number of the binary image, encoded in the upper
3631 * bits. The bit 0 is always used to indicate network order.
3634 * Starting with 0.7, a full byte is dedicated to the minor version of
3635 * the binary format, which is incremented only when new markers are
3636 * introduced, for instance, but when backward compatibility is preserved.
3639 /* Make these at compile time. The WRITE() macro is sufficiently complex
3640 that it saves about 200 bytes doing it this way and only using it
3642 static const unsigned char network_file_header[] = {
3644 (STORABLE_BIN_MAJOR << 1) | 1,
3645 STORABLE_BIN_WRITE_MINOR
3647 static const unsigned char file_header[] = {
3649 (STORABLE_BIN_MAJOR << 1) | 0,
3650 STORABLE_BIN_WRITE_MINOR,
3651 /* sizeof the array includes the 0 byte at the end: */
3652 (char) sizeof (byteorderstr) - 1,
3654 (unsigned char) sizeof(int),
3655 (unsigned char) sizeof(long),
3656 (unsigned char) sizeof(char *),
3657 (unsigned char) sizeof(NV)
3659 #ifdef USE_56_INTERWORK_KLUDGE
3660 static const unsigned char file_header_56[] = {
3662 (STORABLE_BIN_MAJOR << 1) | 0,
3663 STORABLE_BIN_WRITE_MINOR,
3664 /* sizeof the array includes the 0 byte at the end: */
3665 (char) sizeof (byteorderstr_56) - 1,
3667 (unsigned char) sizeof(int),
3668 (unsigned char) sizeof(long),
3669 (unsigned char) sizeof(char *),
3670 (unsigned char) sizeof(NV)
3673 const unsigned char *header;
3676 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3678 if (cxt->netorder) {
3679 header = network_file_header;
3680 length = sizeof (network_file_header);
3682 #ifdef USE_56_INTERWORK_KLUDGE
3683 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3684 header = file_header_56;
3685 length = sizeof (file_header_56);
3689 header = file_header;
3690 length = sizeof (file_header);
3695 /* sizeof the array includes the 0 byte at the end. */
3696 header += sizeof (magicstr) - 1;
3697 length -= sizeof (magicstr) - 1;
3700 WRITE( (unsigned char*) header, length);
3702 if (!cxt->netorder) {
3703 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3704 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3705 (int) sizeof(int), (int) sizeof(long),
3706 (int) sizeof(char *), (int) sizeof(NV)));
3714 * Common code for store operations.
3716 * When memory store is requested (f = NULL) and a non null SV* is given in
3717 * `res', it is filled with a new SV created out of the memory buffer.
3719 * It is required to provide a non-null `res' when the operation type is not
3720 * dclone() and store() is performed to memory.
3722 static int do_store(
3733 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3734 ("must supply result SV pointer for real recursion to memory"));
3736 TRACEME(("do_store (optype=%d, netorder=%d)",
3737 optype, network_order));
3742 * Workaround for CROAK leak: if they enter with a "dirty" context,
3743 * free up memory for them now.
3747 clean_context(aTHX_ cxt);
3750 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3751 * re-enter store() via the hooks. We need to stack contexts.
3755 cxt = allocate_context(aTHX_ cxt);
3759 ASSERT(cxt->entry == 1, ("starting new recursion"));
3760 ASSERT(!cxt->s_dirty, ("clean context"));
3763 * Ensure sv is actually a reference. From perl, we called something
3765 * pstore(aTHX_ FILE, \@array);
3766 * so we must get the scalar value behing that reference.
3770 CROAK(("Not a reference"));
3771 sv = SvRV(sv); /* So follow it to know what to store */
3774 * If we're going to store to memory, reset the buffer.
3781 * Prepare context and emit headers.
3784 init_store_context(aTHX_ cxt, f, optype, network_order);
3786 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3787 return 0; /* Error */
3790 * Recursively store object...
3793 ASSERT(is_storing(aTHX), ("within store operation"));
3795 status = store(aTHX_ cxt, sv); /* Just do it! */
3798 * If they asked for a memory store and they provided an SV pointer,
3799 * make an SV string out of the buffer and fill their pointer.
3801 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3802 * an SV, since context cleanup might free the buffer if we did recurse.
3803 * (unless caller is dclone(), which is aware of that).
3806 if (!cxt->fio && res)
3807 *res = mbuf2sv(aTHX);
3812 * The "root" context is never freed, since it is meant to be always
3813 * handy for the common case where no recursion occurs at all (i.e.
3814 * we enter store() outside of any Storable code and leave it, period).
3815 * We know it's the "root" context because there's nothing stacked
3820 * When deep cloning, we don't free the context: doing so would force
3821 * us to copy the data in the memory buffer. Sicne we know we're
3822 * about to enter do_retrieve...
3825 clean_store_context(aTHX_ cxt);
3826 if (cxt->prev && !(cxt->optype & ST_CLONE))
3827 free_context(aTHX_ cxt);
3829 TRACEME(("do_store returns %d", status));
3837 * Store the transitive data closure of given object to disk.
3838 * Returns 0 on error, a true value otherwise.
3840 static int pstore(pTHX_ PerlIO *f, SV *sv)
3842 TRACEME(("pstore"));
3843 return do_store(aTHX_ f, sv, 0, FALSE, (SV**) 0);
3850 * Same as pstore(), but network order is used for integers and doubles are
3851 * emitted as strings.
3853 static int net_pstore(pTHX_ PerlIO *f, SV *sv)
3855 TRACEME(("net_pstore"));
3856 return do_store(aTHX_ f, sv, 0, TRUE, (SV**) 0);
3866 * Build a new SV out of the content of the internal memory buffer.
3868 static SV *mbuf2sv(pTHX)
3872 return newSVpv(mbase, MBUF_SIZE());
3878 * Store the transitive data closure of given object to memory.
3879 * Returns undef on error, a scalar value containing the data otherwise.
3881 static SV *mstore(pTHX_ SV *sv)
3885 TRACEME(("mstore"));
3887 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, FALSE, &out))
3888 return &PL_sv_undef;
3896 * Same as mstore(), but network order is used for integers and doubles are
3897 * emitted as strings.
3899 static SV *net_mstore(pTHX_ SV *sv)
3903 TRACEME(("net_mstore"));
3905 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, TRUE, &out))
3906 return &PL_sv_undef;
3912 *** Specific retrieve callbacks.
3918 * Return an error via croak, since it is not possible that we get here
3919 * under normal conditions, when facing a file produced via pstore().
3921 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname)
3924 cxt->ver_major != STORABLE_BIN_MAJOR &&
3925 cxt->ver_minor != STORABLE_BIN_MINOR
3927 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3928 cxt->fio ? "file" : "string",
3929 cxt->ver_major, cxt->ver_minor,
3930 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3932 CROAK(("Corrupted storable %s (binary v%d.%d)",
3933 cxt->fio ? "file" : "string",
3934 cxt->ver_major, cxt->ver_minor));
3937 return (SV *) 0; /* Just in case */
3941 * retrieve_idx_blessed
3943 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3944 * <index> can be coded on either 1 or 5 bytes.
3946 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3949 const char *classname;
3953 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3954 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3956 GETMARK(idx); /* Index coded on a single char? */
3961 * Fetch classname in `aclass'
3964 sva = av_fetch(cxt->aclass, idx, FALSE);
3966 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3968 classname = SvPVX(*sva); /* We know it's a PV, by construction */
3970 TRACEME(("class ID %d => %s", idx, classname));
3973 * Retrieve object and bless it.
3976 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3984 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3985 * <len> can be coded on either 1 or 5 bytes.
3987 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3991 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3992 char *classname = buf;
3993 char *malloced_classname = NULL;
3995 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3996 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3999 * Decode class name length and read that name.
4001 * Short classnames have two advantages: their length is stored on one
4002 * single byte, and the string can be read on the stack.
4005 GETMARK(len); /* Length coded on a single char? */
4008 TRACEME(("** allocating %d bytes for class name", len+1));
4009 New(10003, classname, len+1, char);
4010 malloced_classname = classname;
4012 SAFEPVREAD(classname, len, malloced_classname);
4013 classname[len] = '\0'; /* Mark string end */
4016 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
4019 TRACEME(("new class name \"%s\" will bear ID = %d", classname, cxt->classnum));
4021 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len))) {
4022 Safefree(malloced_classname);
4027 * Retrieve object and bless it.
4030 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
4031 if (malloced_classname)
4032 Safefree(malloced_classname);
4040 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
4041 * with leading mark already read, as usual.
4043 * When recursion was involved during serialization of the object, there
4044 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
4045 * we reach a <flags> marker with the recursion bit cleared.
4047 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
4048 * is held in the <extra> byte, and if the object is tied, the serialized
4049 * magic object comes at the very end:
4051 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
4053 * This means the STORABLE_thaw hook will NOT get a tied variable during its
4054 * processing (since we won't have seen the magic object by the time the hook
4055 * is called). See comments below for why it was done that way.
4057 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname)
4060 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
4061 char *classname = buf;
4072 int clone = cxt->optype & ST_CLONE;
4074 unsigned int extra_type = 0;
4076 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
4077 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
4080 * Read flags, which tell us about the type, and whether we need to recurse.
4086 * Create the (empty) object, and mark it as seen.
4088 * This must be done now, because tags are incremented, and during
4089 * serialization, the object tag was affected before recursion could
4093 obj_type = flags & SHF_TYPE_MASK;
4099 sv = (SV *) newAV();
4102 sv = (SV *) newHV();
4106 * Read <extra> flag to know the type of the object.
4107 * Record associated magic type for later.
4109 GETMARK(extra_type);
4110 switch (extra_type) {
4116 sv = (SV *) newAV();
4120 sv = (SV *) newHV();
4124 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4128 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4130 SEEN(sv, 0, 0); /* Don't bless yet */
4133 * Whilst flags tell us to recurse, do so.
4135 * We don't need to remember the addresses returned by retrieval, because
4136 * all the references will be obtained through indirection via the object
4137 * tags in the object-ID list.
4139 * We need to decrement the reference count for these objects
4140 * because, if the user doesn't save a reference to them in the hook,
4141 * they must be freed when this context is cleaned.
4144 while (flags & SHF_NEED_RECURSE) {
4145 TRACEME(("retrieve_hook recursing..."));
4146 rv = retrieve(aTHX_ cxt, 0);
4150 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
4155 if (flags & SHF_IDX_CLASSNAME) {
4160 * Fetch index from `aclass'
4163 if (flags & SHF_LARGE_CLASSLEN)
4168 sva = av_fetch(cxt->aclass, idx, FALSE);
4170 CROAK(("Class name #%"IVdf" should have been seen already",
4173 classname = SvPVX(*sva); /* We know it's a PV, by construction */
4174 TRACEME(("class ID %d => %s", idx, classname));
4178 * Decode class name length and read that name.
4180 * NOTA BENE: even if the length is stored on one byte, we don't read
4181 * on the stack. Just like retrieve_blessed(), we limit the name to
4182 * LG_BLESS bytes. This is an arbitrary decision.
4184 char *malloced_classname = NULL;
4186 if (flags & SHF_LARGE_CLASSLEN)
4191 if (len > LG_BLESS) {
4192 TRACEME(("** allocating %d bytes for class name", len+1));
4193 New(10003, classname, len+1, char);
4194 malloced_classname = classname;
4197 SAFEPVREAD(classname, len, malloced_classname);
4198 classname[len] = '\0'; /* Mark string end */
4201 * Record new classname.
4204 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len))) {
4205 Safefree(malloced_classname);
4210 TRACEME(("class name: %s", classname));
4213 * Decode user-frozen string length and read it in an SV.
4215 * For efficiency reasons, we read data directly into the SV buffer.
4216 * To understand that code, read retrieve_scalar()
4219 if (flags & SHF_LARGE_STRLEN)
4224 frozen = NEWSV(10002, len2);
4226 SAFEREAD(SvPVX(frozen), len2, frozen);
4227 SvCUR_set(frozen, len2);
4228 *SvEND(frozen) = '\0';
4230 (void) SvPOK_only(frozen); /* Validates string pointer */
4231 if (cxt->s_tainted) /* Is input source tainted? */
4234 TRACEME(("frozen string: %d bytes", len2));
4237 * Decode object-ID list length, if present.
4240 if (flags & SHF_HAS_LIST) {
4241 if (flags & SHF_LARGE_LISTLEN)
4247 av_extend(av, len3 + 1); /* Leave room for [0] */
4248 AvFILLp(av) = len3; /* About to be filled anyway */
4252 TRACEME(("has %d object IDs to link", len3));
4255 * Read object-ID list into array.
4256 * Because we pre-extended it, we can cheat and fill it manually.
4258 * We read object tags and we can convert them into SV* on the fly
4259 * because we know all the references listed in there (as tags)
4260 * have been already serialized, hence we have a valid correspondance
4261 * between each of those tags and the recreated SV.
4265 SV **ary = AvARRAY(av);
4267 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
4274 svh = av_fetch(cxt->aseen, tag, FALSE);
4276 if (tag == cxt->where_is_undef) {
4277 /* av_fetch uses PL_sv_undef internally, hence this
4278 somewhat gruesome hack. */
4282 CROAK(("Object #%"IVdf" should have been retrieved already",
4287 ary[i] = SvREFCNT_inc(xsv);
4292 * Bless the object and look up the STORABLE_thaw hook.
4295 BLESS(sv, classname);
4297 /* Handle attach case; again can't use pkg_can because it only
4298 * caches one method */
4299 attach = gv_fetchmethod_autoload(SvSTASH(sv), "STORABLE_attach", FALSE);
4300 if (attach && isGV(attach)) {
4302 SV* attach_hook = newRV((SV*) GvCV(attach));
4305 CROAK(("STORABLE_attach called with unexpected references"));
4309 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4310 rv = newSVpv(classname, 0);
4311 attached = scalar_call(aTHX_ rv, attach_hook, clone, av, G_SCALAR);
4314 sv_derived_from(attached, classname))
4315 return SvRV(attached);
4316 CROAK(("STORABLE_attach did not return a %s object", classname));
4319 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4322 * Hook not found. Maybe they did not require the module where this
4323 * hook is defined yet?
4325 * If the load below succeeds, we'll be able to find the hook.
4326 * Still, it only works reliably when each class is defined in a
4330 TRACEME(("No STORABLE_thaw defined for objects of class %s", classname));
4331 TRACEME(("Going to load module '%s'", classname));
4332 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(classname, 0), Nullsv);
4335 * We cache results of pkg_can, so we need to uncache before attempting
4339 pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4340 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4343 CROAK(("No STORABLE_thaw defined for objects of class %s "
4344 "(even after a \"require %s;\")", classname, classname));
4348 * If we don't have an `av' yet, prepare one.
4349 * Then insert the frozen string as item [0].
4357 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4362 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4364 * where $object is our blessed (empty) object, $cloning is a boolean
4365 * telling whether we're running a deep clone, $frozen is the frozen
4366 * string the user gave us in his serializing hook, and @refs, which may
4367 * be empty, is the list of extra references he returned along for us
4370 * In effect, the hook is an alternate creation routine for the class,
4371 * the object itself being already created by the runtime.
4374 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4375 classname, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4378 (void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
4385 SvREFCNT_dec(frozen);
4388 if (!(flags & SHF_IDX_CLASSNAME) && classname != buf)
4389 Safefree(classname);
4392 * If we had an <extra> type, then the object was not as simple, and
4393 * we need to restore extra magic now.
4399 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4401 rv = retrieve(aTHX_ cxt, 0); /* Retrieve <magic object> */
4403 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4404 PTR2UV(rv), PTR2UV(sv)));
4406 switch (extra_type) {
4408 sv_upgrade(sv, SVt_PVMG);
4411 sv_upgrade(sv, SVt_PVAV);
4412 AvREAL_off((AV *)sv);
4415 sv_upgrade(sv, SVt_PVHV);
4418 CROAK(("Forgot to deal with extra type %d", extra_type));
4423 * Adding the magic only now, well after the STORABLE_thaw hook was called
4424 * means the hook cannot know it deals with an object whose variable is
4425 * tied. But this is happening when retrieving $o in the following case:
4429 * my $o = bless \%h, 'BAR';
4431 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4432 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4433 * hash but a tied one should not matter at all, and remain transparent.
4434 * This means the magic must be restored by Storable AFTER the hook is
4437 * That looks very reasonable to me, but then I've come up with this
4438 * after a bug report from David Nesting, who was trying to store such
4439 * an object and caused Storable to fail. And unfortunately, it was
4440 * also the easiest way to retrofit support for blessed ref to tied objects
4441 * into the existing design. -- RAM, 17/02/2001
4444 sv_magic(sv, rv, mtype, Nullch, 0);
4445 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4453 * Retrieve reference to some other scalar.
4454 * Layout is SX_REF <object>, with SX_REF already read.
4456 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname)
4461 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4464 * We need to create the SV that holds the reference to the yet-to-retrieve
4465 * object now, so that we may record the address in the seen table.
4466 * Otherwise, if the object to retrieve references us, we won't be able
4467 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4468 * do the retrieve first and use rv = newRV(sv) since it will be too late
4469 * for SEEN() recording.
4472 rv = NEWSV(10002, 0);
4473 SEEN(rv, cname, 0); /* Will return if rv is null */
4474 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4476 return (SV *) 0; /* Failed */
4479 * WARNING: breaks RV encapsulation.
4481 * Now for the tricky part. We have to upgrade our existing SV, so that
4482 * it is now an RV on sv... Again, we cheat by duplicating the code
4483 * held in newSVrv(), since we already got our SV from retrieve().
4487 * SvRV(rv) = SvREFCNT_inc(sv);
4489 * here because the reference count we got from retrieve() above is
4490 * already correct: if the object was retrieved from the file, then
4491 * its reference count is one. Otherwise, if it was retrieved via
4492 * an SX_OBJECT indication, a ref count increment was done.
4496 /* No need to do anything, as rv will already be PVMG. */
4497 assert (SvTYPE(rv) >= SVt_RV);
4499 sv_upgrade(rv, SVt_RV);
4502 SvRV_set(rv, sv); /* $rv = \$sv */
4505 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4513 * Retrieve weak reference to some other scalar.
4514 * Layout is SX_WEAKREF <object>, with SX_WEAKREF already read.
4516 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname)
4520 TRACEME(("retrieve_weakref (#%d)", cxt->tagnum));
4522 sv = retrieve_ref(aTHX_ cxt, cname);
4534 * retrieve_overloaded
4536 * Retrieve reference to some other scalar with overloading.
4537 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4539 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname)
4545 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4548 * Same code as retrieve_ref(), duplicated to avoid extra call.
4551 rv = NEWSV(10002, 0);
4552 SEEN(rv, cname, 0); /* Will return if rv is null */
4553 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4555 return (SV *) 0; /* Failed */
4558 * WARNING: breaks RV encapsulation.
4561 sv_upgrade(rv, SVt_RV);
4562 SvRV_set(rv, sv); /* $rv = \$sv */
4566 * Restore overloading magic.
4569 stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
4571 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4572 ") (package <unknown>)",
4573 sv_reftype(sv, FALSE),
4576 if (!Gv_AMG(stash)) {
4577 const char *package = HvNAME_get(stash);
4578 TRACEME(("No overloading defined for package %s", package));
4579 TRACEME(("Going to load module '%s'", package));
4580 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(package, 0), Nullsv);
4581 if (!Gv_AMG(stash)) {
4582 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4583 ") (package %s) (even after a \"require %s;\")",
4584 sv_reftype(sv, FALSE),
4592 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4598 * retrieve_weakoverloaded
4600 * Retrieve weak overloaded reference to some other scalar.
4601 * Layout is SX_WEAKOVERLOADED <object>, with SX_WEAKOVERLOADED already read.
4603 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname)
4607 TRACEME(("retrieve_weakoverloaded (#%d)", cxt->tagnum));
4609 sv = retrieve_overloaded(aTHX_ cxt, cname);
4621 * retrieve_tied_array
4623 * Retrieve tied array
4624 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4626 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname)
4631 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4633 tv = NEWSV(10002, 0);
4634 SEEN(tv, cname, 0); /* Will return if tv is null */
4635 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4637 return (SV *) 0; /* Failed */
4639 sv_upgrade(tv, SVt_PVAV);
4640 AvREAL_off((AV *)tv);
4641 sv_magic(tv, sv, 'P', Nullch, 0);
4642 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4644 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4650 * retrieve_tied_hash
4652 * Retrieve tied hash
4653 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4655 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname)
4660 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4662 tv = NEWSV(10002, 0);
4663 SEEN(tv, cname, 0); /* Will return if tv is null */
4664 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4666 return (SV *) 0; /* Failed */
4668 sv_upgrade(tv, SVt_PVHV);
4669 sv_magic(tv, sv, 'P', Nullch, 0);
4670 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4672 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4678 * retrieve_tied_scalar
4680 * Retrieve tied scalar
4681 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4683 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4686 SV *sv, *obj = NULL;
4688 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4690 tv = NEWSV(10002, 0);
4691 SEEN(tv, cname, 0); /* Will return if rv is null */
4692 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4694 return (SV *) 0; /* Failed */
4696 else if (SvTYPE(sv) != SVt_NULL) {
4700 sv_upgrade(tv, SVt_PVMG);
4701 sv_magic(tv, obj, 'q', Nullch, 0);
4704 /* Undo refcnt inc from sv_magic() */
4708 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4716 * Retrieve reference to value in a tied hash.
4717 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4719 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname)
4725 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4727 tv = NEWSV(10002, 0);
4728 SEEN(tv, cname, 0); /* Will return if tv is null */
4729 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4731 return (SV *) 0; /* Failed */
4733 key = retrieve(aTHX_ cxt, 0); /* Retrieve <key> */
4735 return (SV *) 0; /* Failed */
4737 sv_upgrade(tv, SVt_PVMG);
4738 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4739 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4740 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4748 * Retrieve reference to value in a tied array.
4749 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4751 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname)
4757 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4759 tv = NEWSV(10002, 0);
4760 SEEN(tv, cname, 0); /* Will return if tv is null */
4761 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4763 return (SV *) 0; /* Failed */
4765 RLEN(idx); /* Retrieve <idx> */
4767 sv_upgrade(tv, SVt_PVMG);
4768 sv_magic(tv, sv, 'p', Nullch, idx);
4769 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4778 * Retrieve defined long (string) scalar.
4780 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4781 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4782 * was not stored on a single byte.
4784 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname)
4790 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4793 * Allocate an empty scalar of the suitable length.
4796 sv = NEWSV(10002, len);
4797 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4800 sv_setpvn(sv, "", 0);
4805 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4807 * Now, for efficiency reasons, read data directly inside the SV buffer,
4808 * and perform the SV final settings directly by duplicating the final
4809 * work done by sv_setpv. Since we're going to allocate lots of scalars
4810 * this way, it's worth the hassle and risk.
4813 SAFEREAD(SvPVX(sv), len, sv);
4814 SvCUR_set(sv, len); /* Record C string length */
4815 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4816 (void) SvPOK_only(sv); /* Validate string pointer */
4817 if (cxt->s_tainted) /* Is input source tainted? */
4818 SvTAINT(sv); /* External data cannot be trusted */
4820 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4821 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4829 * Retrieve defined short (string) scalar.
4831 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4832 * The scalar is "short" so <length> is single byte. If it is 0, there
4833 * is no <data> section.
4835 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4841 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4844 * Allocate an empty scalar of the suitable length.
4847 sv = NEWSV(10002, len);
4848 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4851 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4856 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4857 * To make it defined with an empty length, upgrade it now...
4858 * Don't upgrade to a PV if the original type contains more
4859 * information than a scalar.
4861 if (SvTYPE(sv) <= SVt_PV) {
4862 sv_upgrade(sv, SVt_PV);
4865 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4866 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4869 * Now, for efficiency reasons, read data directly inside the SV buffer,
4870 * and perform the SV final settings directly by duplicating the final
4871 * work done by sv_setpv. Since we're going to allocate lots of scalars
4872 * this way, it's worth the hassle and risk.
4874 SAFEREAD(SvPVX(sv), len, sv);
4875 SvCUR_set(sv, len); /* Record C string length */
4876 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4877 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4880 (void) SvPOK_only(sv); /* Validate string pointer */
4881 if (cxt->s_tainted) /* Is input source tainted? */
4882 SvTAINT(sv); /* External data cannot be trusted */
4884 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4891 * Like retrieve_scalar(), but tag result as utf8.
4892 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4894 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname)
4898 TRACEME(("retrieve_utf8str"));
4900 sv = retrieve_scalar(aTHX_ cxt, cname);
4902 #ifdef HAS_UTF8_SCALARS
4905 if (cxt->use_bytes < 0)
4907 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4909 if (cxt->use_bytes == 0)
4920 * Like retrieve_lscalar(), but tag result as utf8.
4921 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4923 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname)
4927 TRACEME(("retrieve_lutf8str"));
4929 sv = retrieve_lscalar(aTHX_ cxt, cname);
4931 #ifdef HAS_UTF8_SCALARS
4934 if (cxt->use_bytes < 0)
4936 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4938 if (cxt->use_bytes == 0)
4948 * Retrieve defined integer.
4949 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4951 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname)
4956 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4958 READ(&iv, sizeof(iv));
4960 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4962 TRACEME(("integer %"IVdf, iv));
4963 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4971 * Retrieve defined integer in network order.
4972 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4974 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname)
4979 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4983 sv = newSViv((int) ntohl(iv));
4984 TRACEME(("network integer %d", (int) ntohl(iv)));
4987 TRACEME(("network integer (as-is) %d", iv));
4989 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4991 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
4999 * Retrieve defined double.
5000 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
5002 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname)
5007 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
5009 READ(&nv, sizeof(nv));
5011 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5013 TRACEME(("double %"NVff, nv));
5014 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
5022 * Retrieve defined byte (small integer within the [-128, +127] range).
5023 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
5025 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname)
5029 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
5031 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
5034 TRACEME(("small integer read as %d", (unsigned char) siv));
5035 tmp = (unsigned char) siv - 128;
5037 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5039 TRACEME(("byte %d", tmp));
5040 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
5048 * Return the undefined value.
5050 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname)
5054 TRACEME(("retrieve_undef"));
5065 * Return the immortal undefined value.
5067 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname)
5069 SV *sv = &PL_sv_undef;
5071 TRACEME(("retrieve_sv_undef"));
5073 /* Special case PL_sv_undef, as av_fetch uses it internally to mark
5074 deleted elements, and will return NULL (fetch failed) whenever it
5076 if (cxt->where_is_undef == -1) {
5077 cxt->where_is_undef = cxt->tagnum;
5086 * Return the immortal yes value.
5088 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname)
5090 SV *sv = &PL_sv_yes;
5092 TRACEME(("retrieve_sv_yes"));
5101 * Return the immortal no value.
5103 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname)
5107 TRACEME(("retrieve_sv_no"));
5116 * Retrieve a whole array.
5117 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5118 * Each item is stored as <object>.
5120 * When we come here, SX_ARRAY has been read already.
5122 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5129 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
5132 * Read length, and allocate array, then pre-extend it.
5136 TRACEME(("size = %d", len));
5138 SEEN(av, cname, 0); /* Will return if array not allocated nicely */
5142 return (SV *) av; /* No data follow if array is empty */
5145 * Now get each item in turn...
5148 for (i = 0; i < len; i++) {
5149 TRACEME(("(#%d) item", i));
5150 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5153 if (av_store(av, i, sv) == 0)
5157 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5165 * Retrieve a whole hash table.
5166 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5167 * Keys are stored as <length> <data>, the <data> section being omitted
5169 * Values are stored as <object>.
5171 * When we come here, SX_HASH has been read already.
5173 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5181 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
5184 * Read length, allocate table.
5188 TRACEME(("size = %d", len));
5190 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5192 return (SV *) hv; /* No data follow if table empty */
5193 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5196 * Now get each key/value pair in turn...
5199 for (i = 0; i < len; i++) {
5204 TRACEME(("(#%d) value", i));
5205 sv = retrieve(aTHX_ cxt, 0);
5211 * Since we're reading into kbuf, we must ensure we're not
5212 * recursing between the read and the hv_store() where it's used.
5213 * Hence the key comes after the value.
5216 RLEN(size); /* Get key size */
5217 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5220 kbuf[size] = '\0'; /* Mark string end, just in case */
5221 TRACEME(("(#%d) key '%s'", i, kbuf));
5224 * Enter key/value pair into hash table.
5227 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5231 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5239 * Retrieve a whole hash table.
5240 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5241 * Keys are stored as <length> <data>, the <data> section being omitted
5243 * Values are stored as <object>.
5245 * When we come here, SX_HASH has been read already.
5247 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname)
5257 GETMARK(hash_flags);
5258 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
5260 * Read length, allocate table.
5263 #ifndef HAS_RESTRICTED_HASHES
5264 if (hash_flags & SHV_RESTRICTED) {
5265 if (cxt->derestrict < 0)
5267 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
5269 if (cxt->derestrict == 0)
5270 RESTRICTED_HASH_CROAK();
5275 TRACEME(("size = %d, flags = %d", len, hash_flags));
5277 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5279 return (SV *) hv; /* No data follow if table empty */
5280 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5283 * Now get each key/value pair in turn...
5286 for (i = 0; i < len; i++) {
5288 int store_flags = 0;
5293 TRACEME(("(#%d) value", i));
5294 sv = retrieve(aTHX_ cxt, 0);
5299 #ifdef HAS_RESTRICTED_HASHES
5300 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
5304 if (flags & SHV_K_ISSV) {
5305 /* XXX you can't set a placeholder with an SV key.
5306 Then again, you can't get an SV key.
5307 Without messing around beyond what the API is supposed to do.
5310 TRACEME(("(#%d) keysv, flags=%d", i, flags));
5311 keysv = retrieve(aTHX_ cxt, 0);
5315 if (!hv_store_ent(hv, keysv, sv, 0))
5320 * Since we're reading into kbuf, we must ensure we're not
5321 * recursing between the read and the hv_store() where it's used.
5322 * Hence the key comes after the value.
5325 if (flags & SHV_K_PLACEHOLDER) {
5327 sv = &PL_sv_placeholder;
5328 store_flags |= HVhek_PLACEHOLD;
5330 if (flags & SHV_K_UTF8) {
5331 #ifdef HAS_UTF8_HASHES
5332 store_flags |= HVhek_UTF8;
5334 if (cxt->use_bytes < 0)
5336 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
5338 if (cxt->use_bytes == 0)
5342 #ifdef HAS_UTF8_HASHES
5343 if (flags & SHV_K_WASUTF8)
5344 store_flags |= HVhek_WASUTF8;
5347 RLEN(size); /* Get key size */
5348 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5351 kbuf[size] = '\0'; /* Mark string end, just in case */
5352 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5353 flags, store_flags));
5356 * Enter key/value pair into hash table.
5359 #ifdef HAS_RESTRICTED_HASHES
5360 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5363 if (!(store_flags & HVhek_PLACEHOLD))
5364 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5369 #ifdef HAS_RESTRICTED_HASHES
5370 if (hash_flags & SHV_RESTRICTED)
5374 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5382 * Return a code reference.
5384 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname)
5386 #if PERL_VERSION < 6
5387 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5390 int type, count, tagnum;
5392 SV *sv, *text, *sub;
5394 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5397 * Insert dummy SV in the aseen array so that we don't screw
5398 * up the tag numbers. We would just make the internal
5399 * scalar an untagged item in the stream, but
5400 * retrieve_scalar() calls SEEN(). So we just increase the
5403 tagnum = cxt->tagnum;
5408 * Retrieve the source of the code reference
5409 * as a small or large scalar
5415 text = retrieve_scalar(aTHX_ cxt, cname);
5418 text = retrieve_lscalar(aTHX_ cxt, cname);
5421 CROAK(("Unexpected type %d in retrieve_code\n", type));
5425 * prepend "sub " to the source
5428 sub = newSVpvn("sub ", 4);
5429 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5433 * evaluate the source to a code reference and use the CV value
5436 if (cxt->eval == NULL) {
5437 cxt->eval = perl_get_sv("Storable::Eval", TRUE);
5438 SvREFCNT_inc(cxt->eval);
5440 if (!SvTRUE(cxt->eval)) {
5442 cxt->forgive_me == 0 ||
5443 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5444 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
5446 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5449 /* fix up the dummy entry... */
5450 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5458 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5459 SV* errsv = get_sv("@", TRUE);
5460 sv_setpvn(errsv, "", 0); /* clear $@ */
5462 XPUSHs(sv_2mortal(newSVsv(sub)));
5464 count = call_sv(cxt->eval, G_SCALAR);
5467 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5469 if (SvTRUE(errsv)) {
5470 CROAK(("code %s caused an error: %s",
5471 SvPV_nolen(sub), SvPV_nolen(errsv)));
5475 cv = eval_pv(SvPV_nolen(sub), TRUE);
5477 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5480 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5483 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5488 /* fix up the dummy entry... */
5489 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5496 * old_retrieve_array
5498 * Retrieve a whole array in pre-0.6 binary format.
5500 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5501 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5503 * When we come here, SX_ARRAY has been read already.
5505 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5513 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5516 * Read length, and allocate array, then pre-extend it.
5520 TRACEME(("size = %d", len));
5522 SEEN(av, 0, 0); /* Will return if array not allocated nicely */
5526 return (SV *) av; /* No data follow if array is empty */
5529 * Now get each item in turn...
5532 for (i = 0; i < len; i++) {
5534 if (c == SX_IT_UNDEF) {
5535 TRACEME(("(#%d) undef item", i));
5536 continue; /* av_extend() already filled us with undef */
5539 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5540 TRACEME(("(#%d) item", i));
5541 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5544 if (av_store(av, i, sv) == 0)
5548 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5556 * Retrieve a whole hash table in pre-0.6 binary format.
5558 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5559 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5561 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5563 * When we come here, SX_HASH has been read already.
5565 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5573 SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5575 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5578 * Read length, allocate table.
5582 TRACEME(("size = %d", len));
5584 SEEN(hv, 0, 0); /* Will return if table not allocated properly */
5586 return (SV *) hv; /* No data follow if table empty */
5587 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5590 * Now get each key/value pair in turn...
5593 for (i = 0; i < len; i++) {
5599 if (c == SX_VL_UNDEF) {
5600 TRACEME(("(#%d) undef value", i));
5602 * Due to a bug in hv_store(), it's not possible to pass
5603 * &PL_sv_undef to hv_store() as a value, otherwise the
5604 * associated key will not be creatable any more. -- RAM, 14/01/97
5607 sv_h_undef = newSVsv(&PL_sv_undef);
5608 sv = SvREFCNT_inc(sv_h_undef);
5609 } else if (c == SX_VALUE) {
5610 TRACEME(("(#%d) value", i));
5611 sv = retrieve(aTHX_ cxt, 0);
5615 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5619 * Since we're reading into kbuf, we must ensure we're not
5620 * recursing between the read and the hv_store() where it's used.
5621 * Hence the key comes after the value.
5626 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5627 RLEN(size); /* Get key size */
5628 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5631 kbuf[size] = '\0'; /* Mark string end, just in case */
5632 TRACEME(("(#%d) key '%s'", i, kbuf));
5635 * Enter key/value pair into hash table.
5638 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5642 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5648 *** Retrieval engine.
5654 * Make sure the stored data we're trying to retrieve has been produced
5655 * on an ILP compatible system with the same byteorder. It croaks out in
5656 * case an error is detected. [ILP = integer-long-pointer sizes]
5657 * Returns null if error is detected, &PL_sv_undef otherwise.
5659 * Note that there's no byte ordering info emitted when network order was
5660 * used at store time.
5662 static SV *magic_check(pTHX_ stcxt_t *cxt)
5664 /* The worst case for a malicious header would be old magic (which is
5665 longer), major, minor, byteorder length byte of 255, 255 bytes of
5666 garbage, sizeof int, long, pointer, NV.
5667 So the worse of that we can read is 255 bytes of garbage plus 4.
5668 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5669 compiling perl on a system with chars that are larger than 8 bits.
5670 (Even Crays aren't *that* perverse).
5672 unsigned char buf[4 + 255];
5673 unsigned char *current;
5676 int use_network_order;
5680 int version_minor = 0;
5682 TRACEME(("magic_check"));
5685 * The "magic number" is only for files, not when freezing in memory.
5689 /* This includes the '\0' at the end. I want to read the extra byte,
5690 which is usually going to be the major version number. */
5691 STRLEN len = sizeof(magicstr);
5694 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5696 /* Point at the byte after the byte we read. */
5697 current = buf + --len; /* Do the -- outside of macros. */
5699 if (memNE(buf, magicstr, len)) {
5701 * Try to read more bytes to check for the old magic number, which
5705 TRACEME(("trying for old magic number"));
5707 old_len = sizeof(old_magicstr) - 1;
5708 READ(current + 1, (SSize_t)(old_len - len));
5710 if (memNE(buf, old_magicstr, old_len))
5711 CROAK(("File is not a perl storable"));
5713 current = buf + old_len;
5715 use_network_order = *current;
5717 GETMARK(use_network_order);
5720 * Starting with 0.6, the "use_network_order" byte flag is also used to
5721 * indicate the version number of the binary, and therefore governs the
5722 * setting of sv_retrieve_vtbl. See magic_write().
5724 if (old_magic && use_network_order > 1) {
5725 /* 0.1 dump - use_network_order is really byte order length */
5729 version_major = use_network_order >> 1;
5731 cxt->retrieve_vtbl = (SV*(**)(pTHX_ stcxt_t *cxt, const char *cname)) (version_major > 0 ? sv_retrieve : sv_old_retrieve);
5733 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5737 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5738 * minor version of the protocol. See magic_write().
5741 if (version_major > 1)
5742 GETMARK(version_minor);
5744 cxt->ver_major = version_major;
5745 cxt->ver_minor = version_minor;
5747 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5750 * Inter-operability sanity check: we can't retrieve something stored
5751 * using a format more recent than ours, because we have no way to
5752 * know what has changed, and letting retrieval go would mean a probable
5753 * failure reporting a "corrupted" storable file.
5757 version_major > STORABLE_BIN_MAJOR ||
5758 (version_major == STORABLE_BIN_MAJOR &&
5759 version_minor > STORABLE_BIN_MINOR)
5762 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5763 STORABLE_BIN_MINOR));
5765 if (version_major == STORABLE_BIN_MAJOR) {
5766 TRACEME(("cxt->accept_future_minor is %d",
5767 cxt->accept_future_minor));
5768 if (cxt->accept_future_minor < 0)
5769 cxt->accept_future_minor
5770 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5773 if (cxt->accept_future_minor == 1)
5774 croak_now = 0; /* Don't croak yet. */
5777 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5778 version_major, version_minor,
5779 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5784 * If they stored using network order, there's no byte ordering
5785 * information to check.
5788 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5789 return &PL_sv_undef; /* No byte ordering info */
5791 /* In C truth is 1, falsehood is 0. Very convienient. */
5792 use_NV_size = version_major >= 2 && version_minor >= 2;
5794 if (version_major >= 0) {
5798 c = use_network_order;
5800 length = c + 3 + use_NV_size;
5801 READ(buf, length); /* Not null-terminated */
5803 TRACEME(("byte order '%.*s' %d", c, buf, c));
5805 #ifdef USE_56_INTERWORK_KLUDGE
5806 /* No point in caching this in the context as we only need it once per
5807 retrieve, and we need to recheck it each read. */
5808 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5809 if ((c != (sizeof (byteorderstr_56) - 1))
5810 || memNE(buf, byteorderstr_56, c))
5811 CROAK(("Byte order is not compatible"));
5815 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5816 CROAK(("Byte order is not compatible"));
5822 if ((int) *current++ != sizeof(int))
5823 CROAK(("Integer size is not compatible"));
5826 if ((int) *current++ != sizeof(long))
5827 CROAK(("Long integer size is not compatible"));
5829 /* sizeof(char *) */
5830 if ((int) *current != sizeof(char *))
5831 CROAK(("Pointer size is not compatible"));
5835 if ((int) *++current != sizeof(NV))
5836 CROAK(("Double size is not compatible"));
5839 return &PL_sv_undef; /* OK */
5845 * Recursively retrieve objects from the specified file and return their
5846 * root SV (which may be an AV or an HV for what we care).
5847 * Returns null if there is a problem.
5849 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname)
5855 TRACEME(("retrieve"));
5858 * Grab address tag which identifies the object if we are retrieving
5859 * an older format. Since the new binary format counts objects and no
5860 * longer explicitely tags them, we must keep track of the correspondance
5863 * The following section will disappear one day when the old format is
5864 * no longer supported, hence the final "goto" in the "if" block.
5867 if (cxt->hseen) { /* Retrieving old binary */
5869 if (cxt->netorder) {
5871 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5872 tag = (stag_t) nettag;
5874 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5877 if (type == SX_OBJECT) {
5879 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5881 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5883 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5886 * The following code is common with the SX_OBJECT case below.
5889 svh = av_fetch(cxt->aseen, tagn, FALSE);
5891 CROAK(("Object #%"IVdf" should have been retrieved already",
5894 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5895 SvREFCNT_inc(sv); /* One more reference to this same sv */
5896 return sv; /* The SV pointer where object was retrieved */
5900 * Map new object, but don't increase tagnum. This will be done
5901 * by each of the retrieve_* functions when they call SEEN().
5903 * The mapping associates the "tag" initially present with a unique
5904 * tag number. See test for SX_OBJECT above to see how this is perused.
5907 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5908 newSViv(cxt->tagnum), 0))
5915 * Regular post-0.6 binary format.
5920 TRACEME(("retrieve type = %d", type));
5923 * Are we dealing with an object we should have already retrieved?
5926 if (type == SX_OBJECT) {
5930 svh = av_fetch(cxt->aseen, tag, FALSE);
5932 CROAK(("Object #%"IVdf" should have been retrieved already",
5935 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5936 SvREFCNT_inc(sv); /* One more reference to this same sv */
5937 return sv; /* The SV pointer where object was retrieved */
5938 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5939 if (cxt->accept_future_minor < 0)
5940 cxt->accept_future_minor
5941 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5944 if (cxt->accept_future_minor == 1) {
5945 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5946 "This Storable is v%d.%d and can only handle data types up to %d",
5947 cxt->ver_major, cxt->ver_minor, type,
5948 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5952 first_time: /* Will disappear when support for old format is dropped */
5955 * Okay, first time through for this one.
5958 sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
5960 return (SV *) 0; /* Failed */
5963 * Old binary formats (pre-0.7).
5965 * Final notifications, ended by SX_STORED may now follow.
5966 * Currently, the only pertinent notification to apply on the
5967 * freshly retrieved object is either:
5968 * SX_CLASS <char-len> <classname> for short classnames.
5969 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5970 * Class name is then read into the key buffer pool used by
5971 * hash table key retrieval.
5974 if (cxt->ver_major < 2) {
5975 while ((type = GETCHAR()) != SX_STORED) {
5979 GETMARK(len); /* Length coded on a single char */
5981 case SX_LG_CLASS: /* Length coded on a regular integer */
5986 return (SV *) 0; /* Failed */
5988 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5991 kbuf[len] = '\0'; /* Mark string end */
5996 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5997 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
6005 * Retrieve data held in file and return the root object.
6006 * Common routine for pretrieve and mretrieve.
6008 static SV *do_retrieve(
6016 int is_tainted; /* Is input source tainted? */
6017 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
6019 TRACEME(("do_retrieve (optype = 0x%x)", optype));
6021 optype |= ST_RETRIEVE;
6024 * Sanity assertions for retrieve dispatch tables.
6027 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
6028 ("old and new retrieve dispatch table have same size"));
6029 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
6030 ("SX_ERROR entry correctly initialized in old dispatch table"));
6031 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
6032 ("SX_ERROR entry correctly initialized in new dispatch table"));
6035 * Workaround for CROAK leak: if they enter with a "dirty" context,
6036 * free up memory for them now.
6040 clean_context(aTHX_ cxt);
6043 * Now that STORABLE_xxx hooks exist, it is possible that they try to
6044 * re-enter retrieve() via the hooks.
6048 cxt = allocate_context(aTHX_ cxt);
6052 ASSERT(cxt->entry == 1, ("starting new recursion"));
6053 ASSERT(!cxt->s_dirty, ("clean context"));
6058 * Data is loaded into the memory buffer when f is NULL, unless `in' is
6059 * also NULL, in which case we're expecting the data to already lie
6060 * in the buffer (dclone case).
6063 KBUFINIT(); /* Allocate hash key reading pool once */
6069 const char *orig = SvPV(in, length);
6071 /* This is quite deliberate. I want the UTF8 routines
6072 to encounter the '\0' which perl adds at the end
6073 of all scalars, so that any new string also has
6076 STRLEN klen_tmp = length + 1;
6077 bool is_utf8 = TRUE;
6079 /* Just casting the &klen to (STRLEN) won't work
6080 well if STRLEN and I32 are of different widths.
6082 asbytes = (char*)bytes_from_utf8((U8*)orig,
6086 CROAK(("Frozen string corrupt - contains characters outside 0-255"));
6088 if (asbytes != orig) {
6089 /* String has been converted.
6090 There is no need to keep any reference to
6092 in = sv_newmortal();
6093 /* We donate the SV the malloc()ed string
6094 bytes_from_utf8 returned us. */
6095 SvUPGRADE(in, SVt_PV);
6097 SvPV_set(in, asbytes);
6098 SvLEN_set(in, klen_tmp);
6099 SvCUR_set(in, klen_tmp - 1);
6103 MBUF_SAVE_AND_LOAD(in);
6107 * Magic number verifications.
6109 * This needs to be done before calling init_retrieve_context()
6110 * since the format indication in the file are necessary to conduct
6111 * some of the initializations.
6114 cxt->fio = f; /* Where I/O are performed */
6116 if (!magic_check(aTHX_ cxt))
6117 CROAK(("Magic number checking on storable %s failed",
6118 cxt->fio ? "file" : "string"));
6120 TRACEME(("data stored in %s format",
6121 cxt->netorder ? "net order" : "native"));
6124 * Check whether input source is tainted, so that we don't wrongly
6125 * taint perfectly good values...
6127 * We assume file input is always tainted. If both `f' and `in' are
6128 * NULL, then we come from dclone, and tainted is already filled in
6129 * the context. That's a kludge, but the whole dclone() thing is
6130 * already quite a kludge anyway! -- RAM, 15/09/2000.
6133 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
6134 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
6135 init_retrieve_context(aTHX_ cxt, optype, is_tainted);
6137 ASSERT(is_retrieving(aTHX), ("within retrieve operation"));
6139 sv = retrieve(aTHX_ cxt, 0); /* Recursively retrieve object, get root SV */
6148 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
6151 * The "root" context is never freed.
6154 clean_retrieve_context(aTHX_ cxt);
6155 if (cxt->prev) /* This context was stacked */
6156 free_context(aTHX_ cxt); /* It was not the "root" context */
6159 * Prepare returned value.
6163 TRACEME(("retrieve ERROR"));
6164 #if (PATCHLEVEL <= 4)
6165 /* perl 5.00405 seems to screw up at this point with an
6166 'attempt to modify a read only value' error reported in the
6167 eval { $self = pretrieve(*FILE) } in _retrieve.
6168 I can't see what the cause of this error is, but I suspect a
6169 bug in 5.004, as it seems to be capable of issuing spurious
6170 errors or core dumping with matches on $@. I'm not going to
6171 spend time on what could be a fruitless search for the cause,
6172 so here's a bodge. If you're running 5.004 and don't like
6173 this inefficiency, either upgrade to a newer perl, or you are
6174 welcome to find the problem and send in a patch.
6178 return &PL_sv_undef; /* Something went wrong, return undef */
6182 TRACEME(("retrieve got %s(0x%"UVxf")",
6183 sv_reftype(sv, FALSE), PTR2UV(sv)));
6186 * Backward compatibility with Storable-0.5@9 (which we know we
6187 * are retrieving if hseen is non-null): don't create an extra RV
6188 * for objects since we special-cased it at store time.
6190 * Build a reference to the SV returned by pretrieve even if it is
6191 * already one and not a scalar, for consistency reasons.
6194 if (pre_06_fmt) { /* Was not handling overloading by then */
6196 TRACEME(("fixing for old formats -- pre 0.6"));
6197 if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
6198 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
6204 * If reference is overloaded, restore behaviour.
6206 * NB: minor glitch here: normally, overloaded refs are stored specially
6207 * so that we can croak when behaviour cannot be re-installed, and also
6208 * avoid testing for overloading magic at each reference retrieval.
6210 * Unfortunately, the root reference is implicitely stored, so we must
6211 * check for possible overloading now. Furthermore, if we don't restore
6212 * overloading, we cannot croak as if the original ref was, because we
6213 * have no way to determine whether it was an overloaded ref or not in
6216 * It's a pity that overloading magic is attached to the rv, and not to
6217 * the underlying sv as blessing is.
6221 HV *stash = (HV *) SvSTASH(sv);
6222 SV *rv = newRV_noinc(sv);
6223 if (stash && Gv_AMG(stash)) {
6225 TRACEME(("restored overloading on root reference"));
6227 TRACEME(("ended do_retrieve() with an object"));
6231 TRACEME(("regular do_retrieve() end"));
6233 return newRV_noinc(sv);
6239 * Retrieve data held in file and return the root object, undef on error.
6241 static SV *pretrieve(pTHX_ PerlIO *f)
6243 TRACEME(("pretrieve"));
6244 return do_retrieve(aTHX_ f, Nullsv, 0);
6250 * Retrieve data held in scalar and return the root object, undef on error.
6252 static SV *mretrieve(pTHX_ SV *sv)
6254 TRACEME(("mretrieve"));
6255 return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
6265 * Deep clone: returns a fresh copy of the original referenced SV tree.
6267 * This is achieved by storing the object in memory and restoring from
6268 * there. Not that efficient, but it should be faster than doing it from
6271 static SV *dclone(pTHX_ SV *sv)
6275 stcxt_t *real_context;
6278 TRACEME(("dclone"));
6281 * Workaround for CROAK leak: if they enter with a "dirty" context,
6282 * free up memory for them now.
6286 clean_context(aTHX_ cxt);
6289 * Tied elements seem to need special handling.
6292 if (SvTYPE(sv) == SVt_PVLV && SvRMAGICAL(sv) && mg_find(sv, 'p')) {
6297 * do_store() optimizes for dclone by not freeing its context, should
6298 * we need to allocate one because we're deep cloning from a hook.
6301 if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
6302 return &PL_sv_undef; /* Error during store */
6305 * Because of the above optimization, we have to refresh the context,
6306 * since a new one could have been allocated and stacked by do_store().
6309 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
6310 cxt = real_context; /* And we need this temporary... */
6313 * Now, `cxt' may refer to a new context.
6316 ASSERT(!cxt->s_dirty, ("clean context"));
6317 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
6320 TRACEME(("dclone stored %d bytes", size));
6324 * Since we're passing do_retrieve() both a NULL file and sv, we need
6325 * to pre-compute the taintedness of the input by setting cxt->tainted
6326 * to whatever state our own input string was. -- RAM, 15/09/2000
6328 * do_retrieve() will free non-root context.
6331 cxt->s_tainted = SvTAINTED(sv);
6332 out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
6334 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
6344 * The Perl IO GV object distinguishes between input and output for sockets
6345 * but not for plain files. To allow Storable to transparently work on
6346 * plain files and sockets transparently, we have to ask xsubpp to fetch the
6347 * right object for us. Hence the OutputStream and InputStream declarations.
6349 * Before perl 5.004_05, those entries in the standard typemap are not
6350 * defined in perl include files, so we do that here.
6353 #ifndef OutputStream
6354 #define OutputStream PerlIO *
6355 #define InputStream PerlIO *
6356 #endif /* !OutputStream */
6358 MODULE = Storable PACKAGE = Storable::Cxt
6364 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
6368 if (!cxt->membuf_ro && mbase)
6370 if (cxt->membuf_ro && (cxt->msaved).arena)
6371 Safefree((cxt->msaved).arena);
6374 MODULE = Storable PACKAGE = Storable
6380 HV *stash = gv_stashpvn("Storable", 8, GV_ADD);
6381 newCONSTSUB(stash, "BIN_MAJOR", newSViv(STORABLE_BIN_MAJOR));
6382 newCONSTSUB(stash, "BIN_MINOR", newSViv(STORABLE_BIN_MINOR));
6383 newCONSTSUB(stash, "BIN_WRITE_MINOR", newSViv(STORABLE_BIN_WRITE_MINOR));
6385 init_perinterp(aTHX);
6386 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
6388 /* Only disable the used only once warning if we are in debugging mode. */
6389 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
6391 #ifdef USE_56_INTERWORK_KLUDGE
6392 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
6399 init_perinterp(aTHX);
6406 RETVAL = pstore(aTHX_ f, obj);
6415 RETVAL = net_pstore(aTHX_ f, obj);
6423 RETVAL = mstore(aTHX_ obj);
6431 RETVAL = net_mstore(aTHX_ obj);
6439 RETVAL = pretrieve(aTHX_ f);
6447 RETVAL = mretrieve(aTHX_ sv);
6455 RETVAL = dclone(aTHX_ sv);
6460 last_op_in_netorder()
6462 RETVAL = last_op_in_netorder(aTHX);
6469 RETVAL = is_storing(aTHX);
6476 RETVAL = is_retrieving(aTHX);
projects / p5sagit/p5-mst-13.2.git / blob