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 #define NEED_load_module
22 #define NEED_vload_module
23 #define NEED_newCONSTSUB
24 #include "ppport.h" /* handle old perls */
28 #define DEBUGME /* Debug mode, turns assertions on as well */
29 #define DASSERT /* Assertion mode */
33 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
34 * Provide them with the necessary defines so they can build with pre-5.004.
37 #ifndef PERLIO_IS_STDIO
39 #define PerlIO_getc(x) getc(x)
40 #define PerlIO_putc(f,x) putc(x,f)
41 #define PerlIO_read(x,y,z) fread(y,1,z,x)
42 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
43 #define PerlIO_stdoutf printf
44 #endif /* PERLIO_IS_STDIO */
45 #endif /* USE_PERLIO */
48 * Earlier versions of perl might be used, we can't assume they have the latest!
51 #ifndef PERL_VERSION /* For perls < 5.6 */
52 #define PERL_VERSION PATCHLEVEL
54 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
56 #if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
57 #define PL_sv_yes sv_yes
58 #define PL_sv_no sv_no
59 #define PL_sv_undef sv_undef
60 #if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
61 #define newSVpvn newSVpv
63 #endif /* PATCHLEVEL <= 4 */
64 #ifndef HvSHAREKEYS_off
65 #define HvSHAREKEYS_off(hv) /* Ignore */
67 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
68 #define AvFILLp AvFILL
70 typedef double NV; /* Older perls lack the NV type */
71 #define IVdf "ld" /* Various printf formats for Perl types */
75 #define INT2PTR(t,v) (t)(IV)(v)
76 #define PTR2UV(v) (unsigned long)(v)
77 #endif /* PERL_VERSION -- perls < 5.6 */
79 #ifndef NVef /* The following were not part of perl 5.6 */
80 #if defined(USE_LONG_DOUBLE) && \
81 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
82 #define NVef PERL_PRIeldbl
83 #define NVff PERL_PRIfldbl
84 #define NVgf PERL_PRIgldbl
93 #define SvRV_set(sv, val) \
95 assert(SvTYPE(sv) >= SVt_RV); \
96 (((XRV*)SvANY(sv))->xrv_rv = (val)); \
100 #ifndef PERL_UNUSED_DECL
102 # if (defined(__GNUC__) && defined(__cplusplus)) || defined(__INTEL_COMPILER)
103 # define PERL_UNUSED_DECL
105 # define PERL_UNUSED_DECL __attribute__((unused))
108 # define PERL_UNUSED_DECL
113 #define dNOOP extern int Perl___notused PERL_UNUSED_DECL
121 # define HvRITER_set(hv,r) (HvRITER(hv) = r)
124 # define HvEITER_set(hv,r) (HvEITER(hv) = r)
128 # define HvRITER_get HvRITER
131 # define HvEITER_get HvEITER
135 #define HvNAME_get HvNAME
138 #ifndef HvPLACEHOLDERS_get
139 # define HvPLACEHOLDERS_get HvPLACEHOLDERS
149 * TRACEME() will only output things when the $Storable::DEBUGME is true.
154 if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
155 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
162 #define ASSERT(x,y) \
165 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
166 __FILE__, __LINE__); \
167 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
178 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
180 #define SX_OBJECT C(0) /* Already stored object */
181 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
182 #define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
183 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
184 #define SX_REF C(4) /* Reference to object forthcoming */
185 #define SX_UNDEF C(5) /* Undefined scalar */
186 #define SX_INTEGER C(6) /* Integer forthcoming */
187 #define SX_DOUBLE C(7) /* Double forthcoming */
188 #define SX_BYTE C(8) /* (signed) byte forthcoming */
189 #define SX_NETINT C(9) /* Integer in network order forthcoming */
190 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
191 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
192 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
193 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
194 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
195 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
196 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
197 #define SX_BLESS C(17) /* Object is blessed */
198 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
199 #define SX_HOOK C(19) /* Stored via hook, user-defined */
200 #define SX_OVERLOAD C(20) /* Overloaded reference */
201 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
202 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
203 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
204 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
205 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
206 #define SX_CODE C(26) /* Code references as perl source code */
207 #define SX_WEAKREF C(27) /* Weak reference to object forthcoming */
208 #define SX_WEAKOVERLOAD C(28) /* Overloaded weak reference */
209 #define SX_ERROR C(29) /* Error */
212 * Those are only used to retrieve "old" pre-0.6 binary images.
214 #define SX_ITEM 'i' /* An array item introducer */
215 #define SX_IT_UNDEF 'I' /* Undefined array item */
216 #define SX_KEY 'k' /* A hash key introducer */
217 #define SX_VALUE 'v' /* A hash value introducer */
218 #define SX_VL_UNDEF 'V' /* Undefined hash value */
221 * Those are only used to retrieve "old" pre-0.7 binary images
224 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
225 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
226 #define SX_STORED 'X' /* End of object */
229 * Limits between short/long length representation.
232 #define LG_SCALAR 255 /* Large scalar length limit */
233 #define LG_BLESS 127 /* Large classname bless limit */
239 #define ST_STORE 0x1 /* Store operation */
240 #define ST_RETRIEVE 0x2 /* Retrieval operation */
241 #define ST_CLONE 0x4 /* Deep cloning operation */
244 * The following structure is used for hash table key retrieval. Since, when
245 * retrieving objects, we'll be facing blessed hash references, it's best
246 * to pre-allocate that buffer once and resize it as the need arises, never
247 * freeing it (keys will be saved away someplace else anyway, so even large
248 * keys are not enough a motivation to reclaim that space).
250 * This structure is also used for memory store/retrieve operations which
251 * happen in a fixed place before being malloc'ed elsewhere if persistency
252 * is required. Hence the aptr pointer.
255 char *arena; /* Will hold hash key strings, resized as needed */
256 STRLEN asiz; /* Size of aforementionned buffer */
257 char *aptr; /* Arena pointer, for in-place read/write ops */
258 char *aend; /* First invalid address */
263 * A hash table records the objects which have already been stored.
264 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
265 * an arbitrary sequence number) is used to identify them.
268 * An array table records the objects which have already been retrieved,
269 * as seen by the tag determind by counting the objects themselves. The
270 * reference to that retrieved object is kept in the table, and is returned
271 * when an SX_OBJECT is found bearing that same tag.
273 * The same processing is used to record "classname" for blessed objects:
274 * indexing by a hash at store time, and via an array at retrieve time.
277 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
280 * The following "thread-safe" related defines were contributed by
281 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
282 * only renamed things a little bit to ensure consistency with surrounding
283 * code. -- RAM, 14/09/1999
285 * The original patch suffered from the fact that the stcxt_t structure
286 * was global. Murray tried to minimize the impact on the code as much as
289 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
290 * on objects. Therefore, the notion of context needs to be generalized,
294 #define MY_VERSION "Storable(" XS_VERSION ")"
298 * Conditional UTF8 support.
302 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
303 #define HAS_UTF8_SCALARS
305 #define HAS_UTF8_HASHES
308 /* 5.6 perl has utf8 scalars but not hashes */
312 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
315 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
318 #define WEAKREF_CROAK() CROAK(("Cannot retrieve weak references in this perl"))
321 #ifdef HvPLACEHOLDERS
322 #define HAS_RESTRICTED_HASHES
324 #define HVhek_PLACEHOLD 0x200
325 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
329 #define HAS_HASH_KEY_FLAGS
333 #define USE_PTR_TABLE
337 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
338 * files remap tainted and dirty when threading is enabled. That's bad for
339 * perl to remap such common words. -- RAM, 29/09/00
343 typedef struct stcxt {
344 int entry; /* flags recursion */
345 int optype; /* type of traversal operation */
346 /* which objects have been seen, store time.
347 tags are numbers, which are cast to (SV *) and stored directly */
349 /* use pseen if we have ptr_tables. We have to store tag+1, because
350 tag numbers start at 0, and we can't store (SV *) 0 in a ptr_table
351 without it being confused for a fetch lookup failure. */
352 struct ptr_tbl *pseen;
353 /* Still need hseen for the 0.6 file format code. */
356 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
357 AV *aseen; /* which objects have been seen, retrieve time */
358 IV where_is_undef; /* index in aseen of PL_sv_undef */
359 HV *hclass; /* which classnames have been seen, store time */
360 AV *aclass; /* which classnames have been seen, retrieve time */
361 HV *hook; /* cache for hook methods per class name */
362 IV tagnum; /* incremented at store time for each seen object */
363 IV classnum; /* incremented at store time for each seen classname */
364 int netorder; /* true if network order used */
365 int s_tainted; /* true if input source is tainted, at retrieve time */
366 int forgive_me; /* whether to be forgiving... */
367 int deparse; /* whether to deparse code refs */
368 SV *eval; /* whether to eval source code */
369 int canonical; /* whether to store hashes sorted by key */
370 #ifndef HAS_RESTRICTED_HASHES
371 int derestrict; /* whether to downgrade restrcted hashes */
374 int use_bytes; /* whether to bytes-ify utf8 */
376 int accept_future_minor; /* croak immediately on future minor versions? */
377 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
378 int membuf_ro; /* true means membuf is read-only and msaved is rw */
379 struct extendable keybuf; /* for hash key retrieval */
380 struct extendable membuf; /* for memory store/retrieve operations */
381 struct extendable msaved; /* where potentially valid mbuf is saved */
382 PerlIO *fio; /* where I/O are performed, NULL for memory */
383 int ver_major; /* major of version for retrieved object */
384 int ver_minor; /* minor of version for retrieved object */
385 SV *(**retrieve_vtbl)(pTHX_ struct stcxt *, const char *); /* retrieve dispatch table */
386 SV *prev; /* contexts chained backwards in real recursion */
387 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
390 #define NEW_STORABLE_CXT_OBJ(cxt) \
392 SV *self = newSV(sizeof(stcxt_t) - 1); \
393 SV *my_sv = newRV_noinc(self); \
394 sv_bless(my_sv, gv_stashpv("Storable::Cxt", GV_ADD)); \
395 cxt = (stcxt_t *)SvPVX(self); \
396 Zero(cxt, 1, stcxt_t); \
397 cxt->my_sv = my_sv; \
400 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
402 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
404 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
405 #else /* >= perl5.004_68 */
407 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
408 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
409 #endif /* < perl5.004_68 */
411 #define dSTCXT_PTR(T,name) \
412 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
413 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
416 dSTCXT_PTR(stcxt_t *, cxt)
420 NEW_STORABLE_CXT_OBJ(cxt); \
421 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
423 #define SET_STCXT(x) \
426 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
429 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
431 static stcxt_t *Context_ptr = NULL;
432 #define dSTCXT stcxt_t *cxt = Context_ptr
433 #define SET_STCXT(x) Context_ptr = x
436 NEW_STORABLE_CXT_OBJ(cxt); \
440 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
444 * Croaking implies a memory leak, since we don't use setjmp/longjmp
445 * to catch the exit and free memory used during store or retrieve
446 * operations. This is not too difficult to fix, but I need to understand
447 * how Perl does it, and croaking is exceptional anyway, so I lack the
448 * motivation to do it.
450 * The current workaround is to mark the context as dirty when croaking,
451 * so that data structures can be freed whenever we renter Storable code
452 * (but only *then*: it's a workaround, not a fix).
454 * This is also imperfect, because we don't really know how far they trapped
455 * the croak(), and when we were recursing, we won't be able to clean anything
456 * but the topmost context stacked.
459 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
462 * End of "thread-safe" related definitions.
468 * Keep only the low 32 bits of a pointer (used for tags, which are not
473 #define LOW_32BITS(x) ((I32) (x))
475 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
481 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
482 * Used in the WLEN and RLEN macros.
486 #define oI(x) ((I32 *) ((char *) (x) + 4))
487 #define oS(x) ((x) - 4)
488 #define oC(x) (x = 0)
497 * key buffer handling
499 #define kbuf (cxt->keybuf).arena
500 #define ksiz (cxt->keybuf).asiz
504 TRACEME(("** allocating kbuf of 128 bytes")); \
505 New(10003, kbuf, 128, char); \
512 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
513 Renew(kbuf, x+1, char); \
519 * memory buffer handling
521 #define mbase (cxt->membuf).arena
522 #define msiz (cxt->membuf).asiz
523 #define mptr (cxt->membuf).aptr
524 #define mend (cxt->membuf).aend
526 #define MGROW (1 << 13)
527 #define MMASK (MGROW - 1)
529 #define round_mgrow(x) \
530 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
531 #define trunc_int(x) \
532 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
533 #define int_aligned(x) \
534 ((unsigned long) (x) == trunc_int(x))
536 #define MBUF_INIT(x) \
539 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
540 New(10003, mbase, MGROW, char); \
541 msiz = (STRLEN)MGROW; \
547 mend = mbase + msiz; \
550 #define MBUF_TRUNC(x) mptr = mbase + x
551 #define MBUF_SIZE() (mptr - mbase)
557 * Those macros are used in do_retrieve() to save the current memory
558 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
559 * data from a string.
561 #define MBUF_SAVE_AND_LOAD(in) \
563 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
564 cxt->membuf_ro = 1; \
565 TRACEME(("saving mbuf")); \
566 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
570 #define MBUF_RESTORE() \
572 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
573 cxt->membuf_ro = 0; \
574 TRACEME(("restoring mbuf")); \
575 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
579 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
580 * See store_scalar() for other usage of this workaround.
582 #define MBUF_LOAD(v) \
584 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
586 CROAK(("Not a scalar string")); \
587 mptr = mbase = SvPV(v, msiz); \
588 mend = mbase + msiz; \
591 #define MBUF_XTEND(x) \
593 int nsz = (int) round_mgrow((x)+msiz); \
594 int offset = mptr - mbase; \
595 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
596 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
598 Renew(mbase, nsz, char); \
600 mptr = mbase + offset; \
601 mend = mbase + nsz; \
604 #define MBUF_CHK(x) \
606 if ((mptr + (x)) > mend) \
610 #define MBUF_GETC(x) \
613 x = (int) (unsigned char) *mptr++; \
619 #define MBUF_GETINT(x) \
622 if ((mptr + 4) <= mend) { \
623 memcpy(oI(&x), mptr, 4); \
629 #define MBUF_GETINT(x) \
631 if ((mptr + sizeof(int)) <= mend) { \
632 if (int_aligned(mptr)) \
635 memcpy(&x, mptr, sizeof(int)); \
636 mptr += sizeof(int); \
642 #define MBUF_READ(x,s) \
644 if ((mptr + (s)) <= mend) { \
645 memcpy(x, mptr, s); \
651 #define MBUF_SAFEREAD(x,s,z) \
653 if ((mptr + (s)) <= mend) { \
654 memcpy(x, mptr, s); \
662 #define MBUF_SAFEPVREAD(x,s,z) \
664 if ((mptr + (s)) <= mend) { \
665 memcpy(x, mptr, s); \
673 #define MBUF_PUTC(c) \
676 *mptr++ = (char) c; \
679 *mptr++ = (char) c; \
684 #define MBUF_PUTINT(i) \
687 memcpy(mptr, oI(&i), 4); \
691 #define MBUF_PUTINT(i) \
693 MBUF_CHK(sizeof(int)); \
694 if (int_aligned(mptr)) \
697 memcpy(mptr, &i, sizeof(int)); \
698 mptr += sizeof(int); \
702 #define MBUF_WRITE(x,s) \
705 memcpy(mptr, x, s); \
710 * Possible return values for sv_type().
714 #define svis_SCALAR 1
718 #define svis_TIED_ITEM 5
726 #define SHF_TYPE_MASK 0x03
727 #define SHF_LARGE_CLASSLEN 0x04
728 #define SHF_LARGE_STRLEN 0x08
729 #define SHF_LARGE_LISTLEN 0x10
730 #define SHF_IDX_CLASSNAME 0x20
731 #define SHF_NEED_RECURSE 0x40
732 #define SHF_HAS_LIST 0x80
735 * Types for SX_HOOK (last 2 bits in flags).
741 #define SHT_EXTRA 3 /* Read extra byte for type */
744 * The following are held in the "extra byte"...
747 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
748 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
749 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
752 * per hash flags for flagged hashes
755 #define SHV_RESTRICTED 0x01
758 * per key flags for flagged hashes
761 #define SHV_K_UTF8 0x01
762 #define SHV_K_WASUTF8 0x02
763 #define SHV_K_LOCKED 0x04
764 #define SHV_K_ISSV 0x08
765 #define SHV_K_PLACEHOLDER 0x10
768 * Before 0.6, the magic string was "perl-store" (binary version number 0).
770 * Since 0.6 introduced many binary incompatibilities, the magic string has
771 * been changed to "pst0" to allow an old image to be properly retrieved by
772 * a newer Storable, but ensure a newer image cannot be retrieved with an
775 * At 0.7, objects are given the ability to serialize themselves, and the
776 * set of markers is extended, backward compatibility is not jeopardized,
777 * so the binary version number could have remained unchanged. To correctly
778 * spot errors if a file making use of 0.7-specific extensions is given to
779 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
780 * a "minor" version, to better track this kind of evolution from now on.
783 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
784 static const char magicstr[] = "pst0"; /* Used as a magic number */
786 #define MAGICSTR_BYTES 'p','s','t','0'
787 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
789 /* 5.6.x introduced the ability to have IVs as long long.
790 However, Configure still defined BYTEORDER based on the size of a long.
791 Storable uses the BYTEORDER value as part of the header, but doesn't
792 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
793 with IV as long long on a platform that uses Configure (ie most things
794 except VMS and Windows) headers are identical for the different IV sizes,
795 despite the files containing some fields based on sizeof(IV)
797 5.8 is consistent - the following redifinition kludge is only needed on
798 5.6.x, but the interwork is needed on 5.8 while data survives in files
803 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
804 #ifndef NO_56_INTERWORK_KLUDGE
805 #define USE_56_INTERWORK_KLUDGE
807 #if BYTEORDER == 0x1234
809 #define BYTEORDER 0x12345678
811 #if BYTEORDER == 0x4321
813 #define BYTEORDER 0x87654321
818 #if BYTEORDER == 0x1234
819 #define BYTEORDER_BYTES '1','2','3','4'
821 #if BYTEORDER == 0x12345678
822 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
823 #ifdef USE_56_INTERWORK_KLUDGE
824 #define BYTEORDER_BYTES_56 '1','2','3','4'
827 #if BYTEORDER == 0x87654321
828 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
829 #ifdef USE_56_INTERWORK_KLUDGE
830 #define BYTEORDER_BYTES_56 '4','3','2','1'
833 #if BYTEORDER == 0x4321
834 #define BYTEORDER_BYTES '4','3','2','1'
836 #error Unknown byteorder. Please append your byteorder to Storable.xs
842 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
843 #ifdef USE_56_INTERWORK_KLUDGE
844 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
847 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
848 #define STORABLE_BIN_MINOR 7 /* Binary minor "version" */
850 #if (PATCHLEVEL <= 5)
851 #define STORABLE_BIN_WRITE_MINOR 4
854 * Perl 5.6.0 onwards can do weak references.
856 #define STORABLE_BIN_WRITE_MINOR 7
857 #endif /* (PATCHLEVEL <= 5) */
859 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
860 #define PL_sv_placeholder PL_sv_undef
864 * Useful store shortcuts...
868 * Note that if you put more than one mark for storing a particular
869 * type of thing, *and* in the retrieve_foo() function you mark both
870 * the thingy's you get off with SEEN(), you *must* increase the
871 * tagnum with cxt->tagnum++ along with this macro!
878 else if (PerlIO_putc(cxt->fio, x) == EOF) \
882 #define WRITE_I32(x) \
884 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
887 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
894 if (cxt->netorder) { \
895 int y = (int) htonl(x); \
898 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
903 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
908 #define WLEN(x) WRITE_I32(x)
915 else if (PerlIO_write(cxt->fio, x, y) != y) \
919 #define STORE_PV_LEN(pv, len, small, large) \
921 if (len <= LG_SCALAR) { \
922 unsigned char clen = (unsigned char) len; \
934 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
937 * Store &PL_sv_undef in arrays without recursing through store().
939 #define STORE_SV_UNDEF() \
942 PUTMARK(SX_SV_UNDEF); \
946 * Useful retrieve shortcuts...
950 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
956 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
960 #define READ_I32(x) \
962 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
966 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
976 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
979 x = (int) ntohl(x); \
982 #define RLEN(x) READ_I32(x)
989 else if (PerlIO_read(cxt->fio, x, y) != y) \
993 #define SAFEREAD(x,y,z) \
996 MBUF_SAFEREAD(x,y,z); \
997 else if (PerlIO_read(cxt->fio, x, y) != y) { \
1003 #define SAFEPVREAD(x,y,z) \
1006 MBUF_SAFEPVREAD(x,y,z); \
1007 else if (PerlIO_read(cxt->fio, x, y) != y) { \
1014 * This macro is used at retrieve time, to remember where object 'y', bearing a
1015 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
1016 * we'll therefore know where it has been retrieved and will be able to
1017 * share the same reference, as in the original stored memory image.
1019 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
1020 * on the objects given to STORABLE_thaw and expect that to be defined), and
1021 * also for overloaded objects (for which we might not find the stash if the
1022 * object is not blessed yet--this might occur for overloaded objects that
1023 * refer to themselves indirectly: if we blessed upon return from a sub
1024 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
1025 * restored on it because the underlying object would not be blessed yet!).
1027 * To achieve that, the class name of the last retrieved object is passed down
1028 * recursively, and the first SEEN() call for which the class name is not NULL
1029 * will bless the object.
1031 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
1033 #define SEEN(y,c,i) \
1037 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
1039 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
1040 PTR2UV(y), SvREFCNT(y)-1)); \
1042 BLESS((SV *) (y), c); \
1046 * Bless `s' in `p', via a temporary reference, required by sv_bless().
1048 #define BLESS(s,p) \
1052 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
1053 stash = gv_stashpv((p), GV_ADD); \
1054 ref = newRV_noinc(s); \
1055 (void) sv_bless(ref, stash); \
1056 SvRV_set(ref, NULL); \
1057 SvREFCNT_dec(ref); \
1060 * sort (used in store_hash) - conditionally use qsort when
1061 * sortsv is not available ( <= 5.6.1 ).
1064 #if (PATCHLEVEL <= 6)
1066 #if defined(USE_ITHREADS)
1068 #define STORE_HASH_SORT \
1070 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
1071 SAVESPTR(orig_perl); \
1072 PERL_SET_CONTEXT(aTHX); \
1073 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
1076 #else /* ! USE_ITHREADS */
1078 #define STORE_HASH_SORT \
1079 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1081 #endif /* USE_ITHREADS */
1083 #else /* PATCHLEVEL > 6 */
1085 #define STORE_HASH_SORT \
1086 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1088 #endif /* PATCHLEVEL <= 6 */
1090 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1091 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname);
1094 * Dynamic dispatching table for SV store.
1097 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1098 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1099 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1100 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1101 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1102 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1103 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1104 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1105 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1107 typedef int (*sv_store_t)(pTHX_ stcxt_t *cxt, SV *sv);
1109 static const sv_store_t sv_store[] = {
1110 (sv_store_t)store_ref, /* svis_REF */
1111 (sv_store_t)store_scalar, /* svis_SCALAR */
1112 (sv_store_t)store_array, /* svis_ARRAY */
1113 (sv_store_t)store_hash, /* svis_HASH */
1114 (sv_store_t)store_tied, /* svis_TIED */
1115 (sv_store_t)store_tied_item, /* svis_TIED_ITEM */
1116 (sv_store_t)store_code, /* svis_CODE */
1117 (sv_store_t)store_other, /* svis_OTHER */
1120 #define SV_STORE(x) (*sv_store[x])
1123 * Dynamic dispatching tables for SV retrieval.
1126 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname);
1127 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname);
1128 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1129 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1130 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname);
1131 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname);
1132 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname);
1133 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname);
1134 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname);
1135 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname);
1136 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1137 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname);
1138 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname);
1139 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname);
1140 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1141 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname);
1143 typedef SV* (*sv_retrieve_t)(pTHX_ stcxt_t *cxt, const char *name);
1145 static const sv_retrieve_t sv_old_retrieve[] = {
1146 0, /* SX_OBJECT -- entry unused dynamically */
1147 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1148 (sv_retrieve_t)old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1149 (sv_retrieve_t)old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1150 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1151 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1152 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1153 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1154 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1155 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1156 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1157 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1158 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1159 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1160 (sv_retrieve_t)retrieve_other, /* SX_SV_UNDEF not supported */
1161 (sv_retrieve_t)retrieve_other, /* SX_SV_YES not supported */
1162 (sv_retrieve_t)retrieve_other, /* SX_SV_NO not supported */
1163 (sv_retrieve_t)retrieve_other, /* SX_BLESS not supported */
1164 (sv_retrieve_t)retrieve_other, /* SX_IX_BLESS not supported */
1165 (sv_retrieve_t)retrieve_other, /* SX_HOOK not supported */
1166 (sv_retrieve_t)retrieve_other, /* SX_OVERLOADED not supported */
1167 (sv_retrieve_t)retrieve_other, /* SX_TIED_KEY not supported */
1168 (sv_retrieve_t)retrieve_other, /* SX_TIED_IDX not supported */
1169 (sv_retrieve_t)retrieve_other, /* SX_UTF8STR not supported */
1170 (sv_retrieve_t)retrieve_other, /* SX_LUTF8STR not supported */
1171 (sv_retrieve_t)retrieve_other, /* SX_FLAG_HASH not supported */
1172 (sv_retrieve_t)retrieve_other, /* SX_CODE not supported */
1173 (sv_retrieve_t)retrieve_other, /* SX_WEAKREF not supported */
1174 (sv_retrieve_t)retrieve_other, /* SX_WEAKOVERLOAD not supported */
1175 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1178 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1179 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1180 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname);
1181 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname);
1182 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname);
1183 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1184 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1185 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname);
1186 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname);
1187 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname);
1188 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname);
1189 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname);
1190 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname);
1191 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname);
1192 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname);
1194 static const sv_retrieve_t sv_retrieve[] = {
1195 0, /* SX_OBJECT -- entry unused dynamically */
1196 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1197 (sv_retrieve_t)retrieve_array, /* SX_ARRAY */
1198 (sv_retrieve_t)retrieve_hash, /* SX_HASH */
1199 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1200 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1201 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1202 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1203 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1204 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1205 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1206 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1207 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1208 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1209 (sv_retrieve_t)retrieve_sv_undef, /* SX_SV_UNDEF */
1210 (sv_retrieve_t)retrieve_sv_yes, /* SX_SV_YES */
1211 (sv_retrieve_t)retrieve_sv_no, /* SX_SV_NO */
1212 (sv_retrieve_t)retrieve_blessed, /* SX_BLESS */
1213 (sv_retrieve_t)retrieve_idx_blessed, /* SX_IX_BLESS */
1214 (sv_retrieve_t)retrieve_hook, /* SX_HOOK */
1215 (sv_retrieve_t)retrieve_overloaded, /* SX_OVERLOAD */
1216 (sv_retrieve_t)retrieve_tied_key, /* SX_TIED_KEY */
1217 (sv_retrieve_t)retrieve_tied_idx, /* SX_TIED_IDX */
1218 (sv_retrieve_t)retrieve_utf8str, /* SX_UTF8STR */
1219 (sv_retrieve_t)retrieve_lutf8str, /* SX_LUTF8STR */
1220 (sv_retrieve_t)retrieve_flag_hash, /* SX_HASH */
1221 (sv_retrieve_t)retrieve_code, /* SX_CODE */
1222 (sv_retrieve_t)retrieve_weakref, /* SX_WEAKREF */
1223 (sv_retrieve_t)retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
1224 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1227 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1229 static SV *mbuf2sv(pTHX);
1232 *** Context management.
1238 * Called once per "thread" (interpreter) to initialize some global context.
1240 static void init_perinterp(pTHX)
1244 cxt->netorder = 0; /* true if network order used */
1245 cxt->forgive_me = -1; /* whether to be forgiving... */
1246 cxt->accept_future_minor = -1; /* would otherwise occur too late */
1252 * Called at the end of every context cleaning, to perform common reset
1255 static void reset_context(stcxt_t *cxt)
1259 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1263 * init_store_context
1265 * Initialize a new store context for real recursion.
1267 static void init_store_context(
1274 TRACEME(("init_store_context"));
1276 cxt->netorder = network_order;
1277 cxt->forgive_me = -1; /* Fetched from perl if needed */
1278 cxt->deparse = -1; /* Idem */
1279 cxt->eval = NULL; /* Idem */
1280 cxt->canonical = -1; /* Idem */
1281 cxt->tagnum = -1; /* Reset tag numbers */
1282 cxt->classnum = -1; /* Reset class numbers */
1283 cxt->fio = f; /* Where I/O are performed */
1284 cxt->optype = optype; /* A store, or a deep clone */
1285 cxt->entry = 1; /* No recursion yet */
1288 * The `hseen' table is used to keep track of each SV stored and their
1289 * associated tag numbers is special. It is "abused" because the
1290 * values stored are not real SV, just integers cast to (SV *),
1291 * which explains the freeing below.
1293 * It is also one possible bottlneck to achieve good storing speed,
1294 * so the "shared keys" optimization is turned off (unlikely to be
1295 * of any use here), and the hash table is "pre-extended". Together,
1296 * those optimizations increase the throughput by 12%.
1299 #ifdef USE_PTR_TABLE
1300 cxt->pseen = ptr_table_new();
1303 cxt->hseen = newHV(); /* Table where seen objects are stored */
1304 HvSHAREKEYS_off(cxt->hseen);
1307 * The following does not work well with perl5.004_04, and causes
1308 * a core dump later on, in a completely unrelated spot, which
1309 * makes me think there is a memory corruption going on.
1311 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1312 * it below does not make any difference. It seems to work fine
1313 * with perl5.004_68 but given the probable nature of the bug,
1314 * that does not prove anything.
1316 * It's a shame because increasing the amount of buckets raises
1317 * store() throughput by 5%, but until I figure this out, I can't
1318 * allow for this to go into production.
1320 * It is reported fixed in 5.005, hence the #if.
1322 #if PERL_VERSION >= 5
1323 #define HBUCKETS 4096 /* Buckets for %hseen */
1324 #ifndef USE_PTR_TABLE
1325 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1330 * The `hclass' hash uses the same settings as `hseen' above, but it is
1331 * used to assign sequential tags (numbers) to class names for blessed
1334 * We turn the shared key optimization on.
1337 cxt->hclass = newHV(); /* Where seen classnames are stored */
1339 #if PERL_VERSION >= 5
1340 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1344 * The `hook' hash table is used to keep track of the references on
1345 * the STORABLE_freeze hook routines, when found in some class name.
1347 * It is assumed that the inheritance tree will not be changed during
1348 * storing, and that no new method will be dynamically created by the
1352 cxt->hook = newHV(); /* Table where hooks are cached */
1355 * The `hook_seen' array keeps track of all the SVs returned by
1356 * STORABLE_freeze hooks for us to serialize, so that they are not
1357 * reclaimed until the end of the serialization process. Each SV is
1358 * only stored once, the first time it is seen.
1361 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1365 * clean_store_context
1367 * Clean store context by
1369 static void clean_store_context(pTHX_ stcxt_t *cxt)
1373 TRACEME(("clean_store_context"));
1375 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1378 * Insert real values into hashes where we stored faked pointers.
1381 #ifndef USE_PTR_TABLE
1383 hv_iterinit(cxt->hseen);
1384 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1385 HeVAL(he) = &PL_sv_undef;
1390 hv_iterinit(cxt->hclass);
1391 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1392 HeVAL(he) = &PL_sv_undef;
1396 * And now dispose of them...
1398 * The surrounding if() protection has been added because there might be
1399 * some cases where this routine is called more than once, during
1400 * exceptionnal events. This was reported by Marc Lehmann when Storable
1401 * is executed from mod_perl, and the fix was suggested by him.
1402 * -- RAM, 20/12/2000
1405 #ifdef USE_PTR_TABLE
1407 struct ptr_tbl *pseen = cxt->pseen;
1409 ptr_table_free(pseen);
1411 assert(!cxt->hseen);
1414 HV *hseen = cxt->hseen;
1417 sv_free((SV *) hseen);
1422 HV *hclass = cxt->hclass;
1425 sv_free((SV *) hclass);
1429 HV *hook = cxt->hook;
1432 sv_free((SV *) hook);
1435 if (cxt->hook_seen) {
1436 AV *hook_seen = cxt->hook_seen;
1438 av_undef(hook_seen);
1439 sv_free((SV *) hook_seen);
1442 cxt->forgive_me = -1; /* Fetched from perl if needed */
1443 cxt->deparse = -1; /* Idem */
1445 SvREFCNT_dec(cxt->eval);
1447 cxt->eval = NULL; /* Idem */
1448 cxt->canonical = -1; /* Idem */
1454 * init_retrieve_context
1456 * Initialize a new retrieve context for real recursion.
1458 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1460 TRACEME(("init_retrieve_context"));
1463 * The hook hash table is used to keep track of the references on
1464 * the STORABLE_thaw hook routines, when found in some class name.
1466 * It is assumed that the inheritance tree will not be changed during
1467 * storing, and that no new method will be dynamically created by the
1471 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1473 #ifdef USE_PTR_TABLE
1478 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1479 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1480 * the correspondance between the tags and the tag number used by the
1481 * new retrieve routines.
1484 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1487 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1488 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1489 cxt->aclass = newAV(); /* Where seen classnames are kept */
1490 cxt->tagnum = 0; /* Have to count objects... */
1491 cxt->classnum = 0; /* ...and class names as well */
1492 cxt->optype = optype;
1493 cxt->s_tainted = is_tainted;
1494 cxt->entry = 1; /* No recursion yet */
1495 #ifndef HAS_RESTRICTED_HASHES
1496 cxt->derestrict = -1; /* Fetched from perl if needed */
1498 #ifndef HAS_UTF8_ALL
1499 cxt->use_bytes = -1; /* Fetched from perl if needed */
1501 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1505 * clean_retrieve_context
1507 * Clean retrieve context by
1509 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1511 TRACEME(("clean_retrieve_context"));
1513 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1516 AV *aseen = cxt->aseen;
1519 sv_free((SV *) aseen);
1521 cxt->where_is_undef = -1;
1524 AV *aclass = cxt->aclass;
1527 sv_free((SV *) aclass);
1531 HV *hook = cxt->hook;
1534 sv_free((SV *) hook);
1538 HV *hseen = cxt->hseen;
1541 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1544 #ifndef HAS_RESTRICTED_HASHES
1545 cxt->derestrict = -1; /* Fetched from perl if needed */
1547 #ifndef HAS_UTF8_ALL
1548 cxt->use_bytes = -1; /* Fetched from perl if needed */
1550 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1558 * A workaround for the CROAK bug: cleanup the last context.
1560 static void clean_context(pTHX_ stcxt_t *cxt)
1562 TRACEME(("clean_context"));
1564 ASSERT(cxt->s_dirty, ("dirty context"));
1569 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1571 if (cxt->optype & ST_RETRIEVE)
1572 clean_retrieve_context(aTHX_ cxt);
1573 else if (cxt->optype & ST_STORE)
1574 clean_store_context(aTHX_ cxt);
1578 ASSERT(!cxt->s_dirty, ("context is clean"));
1579 ASSERT(cxt->entry == 0, ("context is reset"));
1585 * Allocate a new context and push it on top of the parent one.
1586 * This new context is made globally visible via SET_STCXT().
1588 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1592 TRACEME(("allocate_context"));
1594 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1596 NEW_STORABLE_CXT_OBJ(cxt);
1597 cxt->prev = parent_cxt->my_sv;
1600 ASSERT(!cxt->s_dirty, ("clean context"));
1608 * Free current context, which cannot be the "root" one.
1609 * Make the context underneath globally visible via SET_STCXT().
1611 static void free_context(pTHX_ stcxt_t *cxt)
1613 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1615 TRACEME(("free_context"));
1617 ASSERT(!cxt->s_dirty, ("clean context"));
1618 ASSERT(prev, ("not freeing root context"));
1620 SvREFCNT_dec(cxt->my_sv);
1623 ASSERT(cxt, ("context not void"));
1633 * Tells whether we're in the middle of a store operation.
1635 static int is_storing(pTHX)
1639 return cxt->entry && (cxt->optype & ST_STORE);
1645 * Tells whether we're in the middle of a retrieve operation.
1647 static int is_retrieving(pTHX)
1651 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1655 * last_op_in_netorder
1657 * Returns whether last operation was made using network order.
1659 * This is typically out-of-band information that might prove useful
1660 * to people wishing to convert native to network order data when used.
1662 static int last_op_in_netorder(pTHX)
1666 return cxt->netorder;
1670 *** Hook lookup and calling routines.
1676 * A wrapper on gv_fetchmethod_autoload() which caches results.
1678 * Returns the routine reference as an SV*, or null if neither the package
1679 * nor its ancestors know about the method.
1681 static SV *pkg_fetchmeth(
1689 const char *hvname = HvNAME_get(pkg);
1693 * The following code is the same as the one performed by UNIVERSAL::can
1697 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1698 if (gv && isGV(gv)) {
1699 sv = newRV((SV*) GvCV(gv));
1700 TRACEME(("%s->%s: 0x%"UVxf, hvname, method, PTR2UV(sv)));
1702 sv = newSVsv(&PL_sv_undef);
1703 TRACEME(("%s->%s: not found", hvname, method));
1707 * Cache the result, ignoring failure: if we can't store the value,
1708 * it just won't be cached.
1711 (void) hv_store(cache, hvname, strlen(hvname), sv, 0);
1713 return SvOK(sv) ? sv : (SV *) 0;
1719 * Force cached value to be undef: hook ignored even if present.
1721 static void pkg_hide(
1727 const char *hvname = HvNAME_get(pkg);
1728 (void) hv_store(cache,
1729 hvname, strlen(hvname), newSVsv(&PL_sv_undef), 0);
1735 * Discard cached value: a whole fetch loop will be retried at next lookup.
1737 static void pkg_uncache(
1743 const char *hvname = HvNAME_get(pkg);
1744 (void) hv_delete(cache, hvname, strlen(hvname), G_DISCARD);
1750 * Our own "UNIVERSAL::can", which caches results.
1752 * Returns the routine reference as an SV*, or null if the object does not
1753 * know about the method.
1763 const char *hvname = HvNAME_get(pkg);
1765 TRACEME(("pkg_can for %s->%s", hvname, method));
1768 * Look into the cache to see whether we already have determined
1769 * where the routine was, if any.
1771 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1772 * that only one hook (i.e. always the same) is cached in a given cache.
1775 svh = hv_fetch(cache, hvname, strlen(hvname), FALSE);
1779 TRACEME(("cached %s->%s: not found", hvname, method));
1782 TRACEME(("cached %s->%s: 0x%"UVxf,
1783 hvname, method, PTR2UV(sv)));
1788 TRACEME(("not cached yet"));
1789 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1795 * Call routine as obj->hook(av) in scalar context.
1796 * Propagates the single returned value if not called in void context.
1798 static SV *scalar_call(
1810 TRACEME(("scalar_call (cloning=%d)", cloning));
1817 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1819 SV **ary = AvARRAY(av);
1820 int cnt = AvFILLp(av) + 1;
1822 XPUSHs(ary[0]); /* Frozen string */
1823 for (i = 1; i < cnt; i++) {
1824 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1825 i, PTR2UV(ary[i])));
1826 XPUSHs(sv_2mortal(newRV(ary[i])));
1831 TRACEME(("calling..."));
1832 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1833 TRACEME(("count = %d", count));
1839 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1852 * Call routine obj->hook(cloning) in list context.
1853 * Returns the list of returned values in an array.
1855 static AV *array_call(
1866 TRACEME(("array_call (cloning=%d)", cloning));
1872 XPUSHs(obj); /* Target object */
1873 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1876 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1881 for (i = count - 1; i >= 0; i--) {
1883 av_store(av, i, SvREFCNT_inc(sv));
1896 * Lookup the class name in the `hclass' table and either assign it a new ID
1897 * or return the existing one, by filling in `classnum'.
1899 * Return true if the class was known, false if the ID was just generated.
1901 static int known_class(
1904 char *name, /* Class name */
1905 int len, /* Name length */
1909 HV *hclass = cxt->hclass;
1911 TRACEME(("known_class (%s)", name));
1914 * Recall that we don't store pointers in this hash table, but tags.
1915 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1918 svh = hv_fetch(hclass, name, len, FALSE);
1920 *classnum = LOW_32BITS(*svh);
1925 * Unknown classname, we need to record it.
1929 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1930 CROAK(("Unable to record new classname"));
1932 *classnum = cxt->classnum;
1937 *** Sepcific store routines.
1943 * Store a reference.
1944 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1946 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1949 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1952 * Follow reference, and check if target is overloaded.
1958 TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1963 HV *stash = (HV *) SvSTASH(sv);
1964 if (stash && Gv_AMG(stash)) {
1965 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1966 PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1968 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1970 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1972 return store(aTHX_ cxt, sv);
1980 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1981 * The <data> section is omitted if <length> is 0.
1983 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1984 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1986 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
1991 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1993 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1996 * For efficiency, break the SV encapsulation by peaking at the flags
1997 * directly without using the Perl macros to avoid dereferencing
1998 * sv->sv_flags each time we wish to check the flags.
2001 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
2002 if (sv == &PL_sv_undef) {
2003 TRACEME(("immortal undef"));
2004 PUTMARK(SX_SV_UNDEF);
2006 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
2013 * Always store the string representation of a scalar if it exists.
2014 * Gisle Aas provided me with this test case, better than a long speach:
2016 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
2017 * SV = PVNV(0x80c8520)
2019 * FLAGS = (NOK,POK,pNOK,pPOK)
2022 * PV = 0x80c83d0 "abc"\0
2026 * Write SX_SCALAR, length, followed by the actual data.
2028 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
2029 * appropriate, followed by the actual (binary) data. A double
2030 * is written as a string if network order, for portability.
2032 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
2033 * The reason is that when the scalar value is tainted, the SvNOK(sv)
2036 * The test for a read-only scalar with both POK and NOK set is meant
2037 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
2038 * address comparison for each scalar we store.
2041 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
2043 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
2044 if (sv == &PL_sv_yes) {
2045 TRACEME(("immortal yes"));
2047 } else if (sv == &PL_sv_no) {
2048 TRACEME(("immortal no"));
2051 pv = SvPV(sv, len); /* We know it's SvPOK */
2052 goto string; /* Share code below */
2054 } else if (flags & SVf_POK) {
2055 /* public string - go direct to string read. */
2056 goto string_readlen;
2058 #if (PATCHLEVEL <= 6)
2059 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
2060 direct if NV flag is off. */
2061 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
2063 /* 5.7 rules are that if IV public flag is set, IV value is as
2064 good, if not better, than NV value. */
2070 * Will come here from below with iv set if double is an integer.
2074 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2076 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
2077 * (for example) and that ends up in the optimised small integer
2080 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
2081 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
2082 goto string_readlen;
2086 * Optimize small integers into a single byte, otherwise store as
2087 * a real integer (converted into network order if they asked).
2090 if (iv >= -128 && iv <= 127) {
2091 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
2094 TRACEME(("small integer stored as %d", siv));
2095 } else if (cxt->netorder) {
2097 TRACEME(("no htonl, fall back to string for integer"));
2098 goto string_readlen;
2106 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2107 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
2109 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
2110 /* Bigger than 32 bits. */
2111 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2112 goto string_readlen;
2116 niv = (I32) htonl((I32) iv);
2117 TRACEME(("using network order"));
2122 PUTMARK(SX_INTEGER);
2123 WRITE(&iv, sizeof(iv));
2126 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2127 } else if (flags & SVf_NOK) {
2129 #if (PATCHLEVEL <= 6)
2132 * Watch for number being an integer in disguise.
2134 if (nv == (NV) (iv = I_V(nv))) {
2135 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2136 goto integer; /* Share code above */
2141 if (SvIOK_notUV(sv)) {
2143 goto integer; /* Share code above */
2148 if (cxt->netorder) {
2149 TRACEME(("double %"NVff" stored as string", nv));
2150 goto string_readlen; /* Share code below */
2154 WRITE(&nv, sizeof(nv));
2156 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2158 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2159 I32 wlen; /* For 64-bit machines */
2165 * Will come here from above if it was readonly, POK and NOK but
2166 * neither &PL_sv_yes nor &PL_sv_no.
2170 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2172 STORE_UTF8STR(pv, wlen);
2174 STORE_SCALAR(pv, wlen);
2175 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2176 PTR2UV(sv), SvPVX(sv), (IV)len));
2178 CROAK(("Can't determine type of %s(0x%"UVxf")",
2179 sv_reftype(sv, FALSE),
2181 return 0; /* Ok, no recursion on scalars */
2189 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2190 * Each item is stored as <object>.
2192 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2195 I32 len = av_len(av) + 1;
2199 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2202 * Signal array by emitting SX_ARRAY, followed by the array length.
2207 TRACEME(("size = %d", len));
2210 * Now store each item recursively.
2213 for (i = 0; i < len; i++) {
2214 sav = av_fetch(av, i, 0);
2216 TRACEME(("(#%d) undef item", i));
2220 TRACEME(("(#%d) item", i));
2221 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2225 TRACEME(("ok (array)"));
2231 #if (PATCHLEVEL <= 6)
2237 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2240 sortcmp(const void *a, const void *b)
2242 #if defined(USE_ITHREADS)
2244 #endif /* USE_ITHREADS */
2245 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2248 #endif /* PATCHLEVEL <= 6 */
2253 * Store a hash table.
2255 * For a "normal" hash (not restricted, no utf8 keys):
2257 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2258 * Values are stored as <object>.
2259 * Keys are stored as <length> <data>, the <data> section being omitted
2262 * For a "fancy" hash (restricted or utf8 keys):
2264 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2266 * Values are stored as <object>.
2267 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2269 * Currently the only hash flag is "restriced"
2270 * Key flags are as for hv.h
2272 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2276 #ifdef HAS_RESTRICTED_HASHES
2285 int flagged_hash = ((SvREADONLY(hv)
2286 #ifdef HAS_HASH_KEY_FLAGS
2290 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2293 /* needs int cast for C++ compilers, doesn't it? */
2294 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2297 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2301 * Signal hash by emitting SX_HASH, followed by the table length.
2305 PUTMARK(SX_FLAG_HASH);
2306 PUTMARK(hash_flags);
2311 TRACEME(("size = %d", len));
2314 * Save possible iteration state via each() on that table.
2317 riter = HvRITER_get(hv);
2318 eiter = HvEITER_get(hv);
2322 * Now store each item recursively.
2324 * If canonical is defined to some true value then store each
2325 * key/value pair in sorted order otherwise the order is random.
2326 * Canonical order is irrelevant when a deep clone operation is performed.
2328 * Fetch the value from perl only once per store() operation, and only
2333 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2334 (cxt->canonical < 0 && (cxt->canonical =
2335 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2338 * Storing in order, sorted by key.
2339 * Run through the hash, building up an array of keys in a
2340 * mortal array, sort the array and then run through the
2346 /*av_extend (av, len);*/
2348 TRACEME(("using canonical order"));
2350 for (i = 0; i < len; i++) {
2351 #ifdef HAS_RESTRICTED_HASHES
2352 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2354 HE *he = hv_iternext(hv);
2359 CROAK(("Hash %p inconsistent - expected %d keys, %dth is NULL", hv, len, i));
2360 key = hv_iterkeysv(he);
2361 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2366 for (i = 0; i < len; i++) {
2367 #ifdef HAS_RESTRICTED_HASHES
2368 int placeholders = (int)HvPLACEHOLDERS_get(hv);
2370 unsigned char flags = 0;
2374 SV *key = av_shift(av);
2375 /* This will fail if key is a placeholder.
2376 Track how many placeholders we have, and error if we
2378 HE *he = hv_fetch_ent(hv, key, 0, 0);
2382 if (!(val = HeVAL(he))) {
2383 /* Internal error, not I/O error */
2387 #ifdef HAS_RESTRICTED_HASHES
2388 /* Should be a placeholder. */
2389 if (placeholders-- < 0) {
2390 /* This should not happen - number of
2391 retrieves should be identical to
2392 number of placeholders. */
2395 /* Value is never needed, and PL_sv_undef is
2396 more space efficient to store. */
2399 ("Flags not 0 but %d", flags));
2400 flags = SHV_K_PLACEHOLDER;
2407 * Store value first.
2410 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2412 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2417 * Keys are written after values to make sure retrieval
2418 * can be optimal in terms of memory usage, where keys are
2419 * read into a fixed unique buffer called kbuf.
2420 * See retrieve_hash() for details.
2423 /* Implementation of restricted hashes isn't nicely
2425 if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
2426 flags |= SHV_K_LOCKED;
2429 keyval = SvPV(key, keylen_tmp);
2430 keylen = keylen_tmp;
2431 #ifdef HAS_UTF8_HASHES
2432 /* If you build without optimisation on pre 5.6
2433 then nothing spots that SvUTF8(key) is always 0,
2434 so the block isn't optimised away, at which point
2435 the linker dislikes the reference to
2438 const char *keysave = keyval;
2439 bool is_utf8 = TRUE;
2441 /* Just casting the &klen to (STRLEN) won't work
2442 well if STRLEN and I32 are of different widths.
2444 keyval = (char*)bytes_from_utf8((U8*)keyval,
2448 /* If we were able to downgrade here, then than
2449 means that we have a key which only had chars
2450 0-255, but was utf8 encoded. */
2452 if (keyval != keysave) {
2453 keylen = keylen_tmp;
2454 flags |= SHV_K_WASUTF8;
2456 /* keylen_tmp can't have changed, so no need
2457 to assign back to keylen. */
2458 flags |= SHV_K_UTF8;
2465 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2467 /* This is a workaround for a bug in 5.8.0
2468 that causes the HEK_WASUTF8 flag to be
2469 set on an HEK without the hash being
2470 marked as having key flags. We just
2471 cross our fingers and drop the flag.
2473 assert (flags == 0 || flags == SHV_K_WASUTF8);
2474 TRACEME(("(#%d) key '%s'", i, keyval));
2478 WRITE(keyval, keylen);
2479 if (flags & SHV_K_WASUTF8)
2484 * Free up the temporary array
2493 * Storing in "random" order (in the order the keys are stored
2494 * within the hash). This is the default and will be faster!
2497 for (i = 0; i < len; i++) {
2500 unsigned char flags;
2501 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2502 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2504 HE *he = hv_iternext(hv);
2506 SV *val = (he ? hv_iterval(hv, he) : 0);
2511 return 1; /* Internal error, not I/O error */
2513 /* Implementation of restricted hashes isn't nicely
2516 = (((hash_flags & SHV_RESTRICTED)
2518 ? SHV_K_LOCKED : 0);
2520 if (val == &PL_sv_placeholder) {
2521 flags |= SHV_K_PLACEHOLDER;
2526 * Store value first.
2529 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2531 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2535 hek = HeKEY_hek(he);
2537 if (len == HEf_SVKEY) {
2538 /* This is somewhat sick, but the internal APIs are
2539 * such that XS code could put one of these in in
2541 * Maybe we should be capable of storing one if
2544 key_sv = HeKEY_sv(he);
2545 flags |= SHV_K_ISSV;
2547 /* Regular string key. */
2548 #ifdef HAS_HASH_KEY_FLAGS
2550 flags |= SHV_K_UTF8;
2551 if (HEK_WASUTF8(hek))
2552 flags |= SHV_K_WASUTF8;
2558 * Keys are written after values to make sure retrieval
2559 * can be optimal in terms of memory usage, where keys are
2560 * read into a fixed unique buffer called kbuf.
2561 * See retrieve_hash() for details.
2566 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2568 /* This is a workaround for a bug in 5.8.0
2569 that causes the HEK_WASUTF8 flag to be
2570 set on an HEK without the hash being
2571 marked as having key flags. We just
2572 cross our fingers and drop the flag.
2574 assert (flags == 0 || flags == SHV_K_WASUTF8);
2575 TRACEME(("(#%d) key '%s'", i, key));
2577 if (flags & SHV_K_ISSV) {
2578 store(aTHX_ cxt, key_sv);
2587 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2590 HvRITER_set(hv, riter); /* Restore hash iterator state */
2591 HvEITER_set(hv, eiter);
2599 * Store a code reference.
2601 * Layout is SX_CODE <length> followed by a scalar containing the perl
2602 * source code of the code reference.
2604 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2606 #if PERL_VERSION < 6
2608 * retrieve_code does not work with perl 5.005 or less
2610 return store_other(aTHX_ cxt, (SV*)cv);
2615 SV *text, *bdeparse;
2617 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2620 cxt->deparse == 0 ||
2621 (cxt->deparse < 0 && !(cxt->deparse =
2622 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2624 return store_other(aTHX_ cxt, (SV*)cv);
2628 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2629 * blessed code references.
2631 /* Ownership of both SVs is passed to load_module, which frees them. */
2632 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2639 * create the B::Deparse object
2643 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2645 count = call_method("new", G_SCALAR);
2648 CROAK(("Unexpected return value from B::Deparse::new\n"));
2652 * call the coderef2text method
2656 XPUSHs(bdeparse); /* XXX is this already mortal? */
2657 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2659 count = call_method("coderef2text", G_SCALAR);
2662 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2666 reallen = strlen(SvPV_nolen(text));
2669 * Empty code references or XS functions are deparsed as
2670 * "(prototype) ;" or ";".
2673 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2674 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2678 * Signal code by emitting SX_CODE.
2682 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2683 TRACEME(("size = %d", len));
2684 TRACEME(("code = %s", SvPV_nolen(text)));
2687 * Now store the source code.
2690 STORE_SCALAR(SvPV_nolen(text), len);
2695 TRACEME(("ok (code)"));
2704 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2705 * a special mark, followed by the underlying tied object. For instance, when
2706 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2707 * <hash object> stands for the serialization of the tied hash.
2709 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2714 int svt = SvTYPE(sv);
2717 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2720 * We have a small run-time penalty here because we chose to factorise
2721 * all tieds objects into the same routine, and not have a store_tied_hash,
2722 * a store_tied_array, etc...
2724 * Don't use a switch() statement, as most compilers don't optimize that
2725 * well for 2/3 values. An if() else if() cascade is just fine. We put
2726 * tied hashes first, as they are the most likely beasts.
2729 if (svt == SVt_PVHV) {
2730 TRACEME(("tied hash"));
2731 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2732 } else if (svt == SVt_PVAV) {
2733 TRACEME(("tied array"));
2734 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2736 TRACEME(("tied scalar"));
2737 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2741 if (!(mg = mg_find(sv, mtype)))
2742 CROAK(("No magic '%c' found while storing tied %s", mtype,
2743 (svt == SVt_PVHV) ? "hash" :
2744 (svt == SVt_PVAV) ? "array" : "scalar"));
2747 * The mg->mg_obj found by mg_find() above actually points to the
2748 * underlying tied Perl object implementation. For instance, if the
2749 * original SV was that of a tied array, then mg->mg_obj is an AV.
2751 * Note that we store the Perl object as-is. We don't call its FETCH
2752 * method along the way. At retrieval time, we won't call its STORE
2753 * method either, but the tieing magic will be re-installed. In itself,
2754 * that ensures that the tieing semantics are preserved since futher
2755 * accesses on the retrieved object will indeed call the magic methods...
2758 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2759 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2760 if ((ret = store(aTHX_ cxt, obj)))
2763 TRACEME(("ok (tied)"));
2771 * Stores a reference to an item within a tied structure:
2773 * . \$h{key}, stores both the (tied %h) object and 'key'.
2774 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2776 * Layout is therefore either:
2777 * SX_TIED_KEY <object> <key>
2778 * SX_TIED_IDX <object> <index>
2780 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2785 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2787 if (!(mg = mg_find(sv, 'p')))
2788 CROAK(("No magic 'p' found while storing reference to tied item"));
2791 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2795 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2796 PUTMARK(SX_TIED_KEY);
2797 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2799 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2802 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2804 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2807 I32 idx = mg->mg_len;
2809 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2810 PUTMARK(SX_TIED_IDX);
2811 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2813 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2816 TRACEME(("store_tied_item: storing IDX %d", idx));
2821 TRACEME(("ok (tied item)"));
2827 * store_hook -- dispatched manually, not via sv_store[]
2829 * The blessed SV is serialized by a hook.
2833 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2835 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2836 * the trailing part [] is present, the type of object (scalar, array or hash).
2837 * There is also a bit which says how the classname is stored between:
2842 * and when the <index> form is used (classname already seen), the "large
2843 * classname" bit in <flags> indicates how large the <index> is.
2845 * The serialized string returned by the hook is of length <len2> and comes
2846 * next. It is an opaque string for us.
2848 * Those <len3> object IDs which are listed last represent the extra references
2849 * not directly serialized by the hook, but which are linked to the object.
2851 * When recursion is mandated to resolve object-IDs not yet seen, we have
2852 * instead, with <header> being flags with bits set to indicate the object type
2853 * and that recursion was indeed needed:
2855 * SX_HOOK <header> <object> <header> <object> <flags>
2857 * that same header being repeated between serialized objects obtained through
2858 * recursion, until we reach flags indicating no recursion, at which point
2859 * we know we've resynchronized with a single layout, after <flags>.
2861 * When storing a blessed ref to a tied variable, the following format is
2864 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2866 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2867 * real object type is held in the <extra> flag. At the very end of the
2868 * serialization stream, the underlying magic object is serialized, just like
2869 * any other tied variable.
2871 static int store_hook(
2885 int count; /* really len3 + 1 */
2886 unsigned char flags;
2889 int recursed = 0; /* counts recursion */
2890 int obj_type; /* object type, on 2 bits */
2893 int clone = cxt->optype & ST_CLONE;
2894 char mtype = '\0'; /* for blessed ref to tied structures */
2895 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2897 TRACEME(("store_hook, classname \"%s\", tagged #%d", HvNAME_get(pkg), cxt->tagnum));
2900 * Determine object type on 2 bits.
2905 obj_type = SHT_SCALAR;
2908 obj_type = SHT_ARRAY;
2911 obj_type = SHT_HASH;
2915 * Produced by a blessed ref to a tied data structure, $o in the
2916 * following Perl code.
2920 * my $o = bless \%h, 'BAR';
2922 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2923 * (since we have only 2 bits in <flags> to store the type), and an
2924 * <extra> byte flag will be emitted after the FIRST <flags> in the
2925 * stream, carrying what we put in `eflags'.
2927 obj_type = SHT_EXTRA;
2928 switch (SvTYPE(sv)) {
2930 eflags = (unsigned char) SHT_THASH;
2934 eflags = (unsigned char) SHT_TARRAY;
2938 eflags = (unsigned char) SHT_TSCALAR;
2944 CROAK(("Unexpected object type (%d) in store_hook()", type));
2946 flags = SHF_NEED_RECURSE | obj_type;
2948 classname = HvNAME_get(pkg);
2949 len = strlen(classname);
2952 * To call the hook, we need to fake a call like:
2954 * $object->STORABLE_freeze($cloning);
2956 * but we don't have the $object here. For instance, if $object is
2957 * a blessed array, what we have in `sv' is the array, and we can't
2958 * call a method on those.
2960 * Therefore, we need to create a temporary reference to the object and
2961 * make the call on that reference.
2964 TRACEME(("about to call STORABLE_freeze on class %s", classname));
2966 ref = newRV_noinc(sv); /* Temporary reference */
2967 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2968 SvRV_set(ref, NULL);
2969 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2971 count = AvFILLp(av) + 1;
2972 TRACEME(("store_hook, array holds %d items", count));
2975 * If they return an empty list, it means they wish to ignore the
2976 * hook for this class (and not just this instance -- that's for them
2977 * to handle if they so wish).
2979 * Simply disable the cached entry for the hook (it won't be recomputed
2980 * since it's present in the cache) and recurse to store_blessed().
2985 * They must not change their mind in the middle of a serialization.
2988 if (hv_fetch(cxt->hclass, classname, len, FALSE))
2989 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2990 (cxt->optype & ST_CLONE) ? "cloning" : "storing", classname));
2992 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
2994 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2995 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", classname));
2997 return store_blessed(aTHX_ cxt, sv, type, pkg);
3001 * Get frozen string.
3005 pv = SvPV(ary[0], len2);
3006 /* We can't use pkg_can here because it only caches one method per
3009 GV* gv = gv_fetchmethod_autoload(pkg, "STORABLE_attach", FALSE);
3010 if (gv && isGV(gv)) {
3012 CROAK(("Freeze cannot return references if %s class is using STORABLE_attach", classname));
3018 * If they returned more than one item, we need to serialize some
3019 * extra references if not already done.
3021 * Loop over the array, starting at position #1, and for each item,
3022 * ensure it is a reference, serialize it if not already done, and
3023 * replace the entry with the tag ID of the corresponding serialized
3026 * We CHEAT by not calling av_fetch() and read directly within the
3030 for (i = 1; i < count; i++) {
3031 #ifdef USE_PTR_TABLE
3039 AV *av_hook = cxt->hook_seen;
3042 CROAK(("Item #%d returned by STORABLE_freeze "
3043 "for %s is not a reference", i, classname));
3044 xsv = SvRV(rsv); /* Follow ref to know what to look for */
3047 * Look in hseen and see if we have a tag already.
3048 * Serialize entry if not done already, and get its tag.
3051 #ifdef USE_PTR_TABLE
3052 /* Fakery needed because ptr_table_fetch returns zero for a
3053 failure, whereas the existing code assumes that it can
3054 safely store a tag zero. So for ptr_tables we store tag+1
3056 if ((fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv)))
3057 goto sv_seen; /* Avoid moving code too far to the right */
3059 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
3060 goto sv_seen; /* Avoid moving code too far to the right */
3063 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
3066 * We need to recurse to store that object and get it to be known
3067 * so that we can resolve the list of object-IDs at retrieve time.
3069 * The first time we do this, we need to emit the proper header
3070 * indicating that we recursed, and what the type of object is (the
3071 * object we're storing via a user-hook). Indeed, during retrieval,
3072 * we'll have to create the object before recursing to retrieve the
3073 * others, in case those would point back at that object.
3076 /* [SX_HOOK] <flags> [<extra>] <object>*/
3080 if (obj_type == SHT_EXTRA)
3085 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
3088 #ifdef USE_PTR_TABLE
3089 fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv);
3091 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3093 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
3095 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3098 * It was the first time we serialized `xsv'.
3100 * Keep this SV alive until the end of the serialization: if we
3101 * disposed of it right now by decrementing its refcount, and it was
3102 * a temporary value, some next temporary value allocated during
3103 * another STORABLE_freeze might take its place, and we'd wrongly
3104 * assume that new SV was already serialized, based on its presence
3107 * Therefore, push it away in cxt->hook_seen.
3110 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
3114 * Dispose of the REF they returned. If we saved the `xsv' away
3115 * in the array of returned SVs, that will not cause the underlying
3116 * referenced SV to be reclaimed.
3119 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
3120 SvREFCNT_dec(rsv); /* Dispose of reference */
3123 * Replace entry with its tag (not a real SV, so no refcnt increment)
3126 #ifdef USE_PTR_TABLE
3127 tag = (SV *)--fake_tag;
3132 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
3133 i-1, PTR2UV(xsv), PTR2UV(tag)));
3137 * Allocate a class ID if not already done.
3139 * This needs to be done after the recursion above, since at retrieval
3140 * time, we'll see the inner objects first. Many thanks to
3141 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
3142 * proposed the right fix. -- RAM, 15/09/2000
3146 if (!known_class(aTHX_ cxt, classname, len, &classnum)) {
3147 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3148 classnum = -1; /* Mark: we must store classname */
3150 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3154 * Compute leading flags.
3158 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3159 flags |= SHF_LARGE_CLASSLEN;
3161 flags |= SHF_IDX_CLASSNAME;
3162 if (len2 > LG_SCALAR)
3163 flags |= SHF_LARGE_STRLEN;
3165 flags |= SHF_HAS_LIST;
3166 if (count > (LG_SCALAR + 1))
3167 flags |= SHF_LARGE_LISTLEN;
3170 * We're ready to emit either serialized form:
3172 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3173 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3175 * If we recursed, the SX_HOOK has already been emitted.
3178 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3179 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3180 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3182 /* SX_HOOK <flags> [<extra>] */
3186 if (obj_type == SHT_EXTRA)
3191 /* <len> <classname> or <index> */
3192 if (flags & SHF_IDX_CLASSNAME) {
3193 if (flags & SHF_LARGE_CLASSLEN)
3196 unsigned char cnum = (unsigned char) classnum;
3200 if (flags & SHF_LARGE_CLASSLEN)
3203 unsigned char clen = (unsigned char) len;
3206 WRITE(classname, len); /* Final \0 is omitted */
3209 /* <len2> <frozen-str> */
3210 if (flags & SHF_LARGE_STRLEN) {
3211 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3212 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3214 unsigned char clen = (unsigned char) len2;
3218 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3220 /* [<len3> <object-IDs>] */
3221 if (flags & SHF_HAS_LIST) {
3222 int len3 = count - 1;
3223 if (flags & SHF_LARGE_LISTLEN)
3226 unsigned char clen = (unsigned char) len3;
3231 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3232 * real pointer, rather a tag number, well under the 32-bit limit.
3235 for (i = 1; i < count; i++) {
3236 I32 tagval = htonl(LOW_32BITS(ary[i]));
3238 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3243 * Free the array. We need extra care for indices after 0, since they
3244 * don't hold real SVs but integers cast.
3248 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3253 * If object was tied, need to insert serialization of the magic object.
3256 if (obj_type == SHT_EXTRA) {
3259 if (!(mg = mg_find(sv, mtype))) {
3260 int svt = SvTYPE(sv);
3261 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3262 mtype, (svt == SVt_PVHV) ? "hash" :
3263 (svt == SVt_PVAV) ? "array" : "scalar"));
3266 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3267 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3273 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3281 * store_blessed -- dispatched manually, not via sv_store[]
3283 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3284 * of its ancestors. If there is, then redispatch to store_hook();
3286 * Otherwise, the blessed SV is stored using the following layout:
3288 * SX_BLESS <flag> <len> <classname> <object>
3290 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3291 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3292 * Otherwise, the low order bits give the length, thereby giving a compact
3293 * representation for class names less than 127 chars long.
3295 * Each <classname> seen is remembered and indexed, so that the next time
3296 * an object in the blessed in the same <classname> is stored, the following
3299 * SX_IX_BLESS <flag> <index> <object>
3301 * where <index> is the classname index, stored on 0 or 4 bytes depending
3302 * on the high-order bit in flag (same encoding as above for <len>).
3304 static int store_blessed(
3316 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME_get(pkg)));
3319 * Look for a hook for this blessed SV and redirect to store_hook()
3323 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3325 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3328 * This is a blessed SV without any serialization hook.
3331 classname = HvNAME_get(pkg);
3332 len = strlen(classname);
3334 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3335 PTR2UV(sv), classname, cxt->tagnum));
3338 * Determine whether it is the first time we see that class name (in which
3339 * case it will be stored in the SX_BLESS form), or whether we already
3340 * saw that class name before (in which case the SX_IX_BLESS form will be
3344 if (known_class(aTHX_ cxt, classname, len, &classnum)) {
3345 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3346 PUTMARK(SX_IX_BLESS);
3347 if (classnum <= LG_BLESS) {
3348 unsigned char cnum = (unsigned char) classnum;
3351 unsigned char flag = (unsigned char) 0x80;
3356 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3358 if (len <= LG_BLESS) {
3359 unsigned char clen = (unsigned char) len;
3362 unsigned char flag = (unsigned char) 0x80;
3364 WLEN(len); /* Don't BER-encode, this should be rare */
3366 WRITE(classname, len); /* Final \0 is omitted */
3370 * Now emit the <object> part.
3373 return SV_STORE(type)(aTHX_ cxt, sv);
3379 * We don't know how to store the item we reached, so return an error condition.
3380 * (it's probably a GLOB, some CODE reference, etc...)
3382 * If they defined the `forgive_me' variable at the Perl level to some
3383 * true value, then don't croak, just warn, and store a placeholder string
3386 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3391 TRACEME(("store_other"));
3394 * Fetch the value from perl only once per store() operation.
3398 cxt->forgive_me == 0 ||
3399 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3400 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3402 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3404 warn("Can't store item %s(0x%"UVxf")",
3405 sv_reftype(sv, FALSE), PTR2UV(sv));
3408 * Store placeholder string as a scalar instead...
3411 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3412 PTR2UV(sv), (char) 0);
3415 STORE_SCALAR(buf, len);
3416 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3422 *** Store driving routines
3428 * WARNING: partially duplicates Perl's sv_reftype for speed.
3430 * Returns the type of the SV, identified by an integer. That integer
3431 * may then be used to index the dynamic routine dispatch table.
3433 static int sv_type(pTHX_ SV *sv)
3435 switch (SvTYPE(sv)) {
3440 * No need to check for ROK, that can't be set here since there
3441 * is no field capable of hodling the xrv_rv reference.
3449 * Starting from SVt_PV, it is possible to have the ROK flag
3450 * set, the pointer to the other SV being either stored in
3451 * the xrv_rv (in the case of a pure SVt_RV), or as the
3452 * xpv_pv field of an SVt_PV and its heirs.
3454 * However, those SV cannot be magical or they would be an
3455 * SVt_PVMG at least.
3457 return SvROK(sv) ? svis_REF : svis_SCALAR;
3459 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3460 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3461 return svis_TIED_ITEM;
3463 #if PERL_VERSION < 9
3466 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3468 return SvROK(sv) ? svis_REF : svis_SCALAR;
3470 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3474 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3479 #if PERL_VERSION > 8
3480 /* case SVt_BIND: */
3492 * Recursively store objects pointed to by the sv to the specified file.
3494 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3495 * object (one for which storage has started -- it may not be over if we have
3496 * a self-referenced structure). This data set forms a stored <object>.
3498 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3503 #ifdef USE_PTR_TABLE
3504 struct ptr_tbl *pseen = cxt->pseen;
3506 HV *hseen = cxt->hseen;
3509 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3512 * If object has already been stored, do not duplicate data.
3513 * Simply emit the SX_OBJECT marker followed by its tag data.
3514 * The tag is always written in network order.
3516 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3517 * real pointer, rather a tag number (watch the insertion code below).
3518 * That means it probably safe to assume it is well under the 32-bit limit,
3519 * and makes the truncation safe.
3520 * -- RAM, 14/09/1999
3523 #ifdef USE_PTR_TABLE
3524 svh = (SV **)ptr_table_fetch(pseen, sv);
3526 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3531 if (sv == &PL_sv_undef) {
3532 /* We have seen PL_sv_undef before, but fake it as
3535 Not the simplest solution to making restricted
3536 hashes work on 5.8.0, but it does mean that
3537 repeated references to the one true undef will
3538 take up less space in the output file.
3540 /* Need to jump past the next hv_store, because on the
3541 second store of undef the old hash value will be
3542 SvREFCNT_dec()ed, and as Storable cheats horribly
3543 by storing non-SVs in the hash a SEGV will ensure.
3544 Need to increase the tag number so that the
3545 receiver has no idea what games we're up to. This
3546 special casing doesn't affect hooks that store
3547 undef, as the hook routine does its own lookup into
3548 hseen. Also this means that any references back
3549 to PL_sv_undef (from the pathological case of hooks
3550 storing references to it) will find the seen hash
3551 entry for the first time, as if we didn't have this
3552 hackery here. (That hseen lookup works even on 5.8.0
3553 because it's a key of &PL_sv_undef and a value
3554 which is a tag number, not a value which is
3558 goto undef_special_case;
3561 #ifdef USE_PTR_TABLE
3562 tagval = htonl(LOW_32BITS(((char *)svh)-1));
3564 tagval = htonl(LOW_32BITS(*svh));
3567 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3575 * Allocate a new tag and associate it with the address of the sv being
3576 * stored, before recursing...
3578 * In order to avoid creating new SvIVs to hold the tagnum we just
3579 * cast the tagnum to an SV pointer and store that in the hash. This
3580 * means that we must clean up the hash manually afterwards, but gives
3581 * us a 15% throughput increase.
3586 #ifdef USE_PTR_TABLE
3587 ptr_table_store(pseen, sv, INT2PTR(SV*, 1 + cxt->tagnum));
3589 if (!hv_store(hseen,
3590 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3595 * Store `sv' and everything beneath it, using appropriate routine.
3596 * Abort immediately if we get a non-zero status back.
3599 type = sv_type(aTHX_ sv);
3602 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3603 PTR2UV(sv), cxt->tagnum, type));
3606 HV *pkg = SvSTASH(sv);
3607 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3609 ret = SV_STORE(type)(aTHX_ cxt, sv);
3611 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3612 ret ? "FAILED" : "ok", PTR2UV(sv),
3613 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3621 * Write magic number and system information into the file.
3622 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3623 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3624 * All size and lenghts are written as single characters here.
3626 * Note that no byte ordering info is emitted when <network> is true, since
3627 * integers will be emitted in network order in that case.
3629 static int magic_write(pTHX_ stcxt_t *cxt)
3632 * Starting with 0.6, the "use_network_order" byte flag is also used to
3633 * indicate the version number of the binary image, encoded in the upper
3634 * bits. The bit 0 is always used to indicate network order.
3637 * Starting with 0.7, a full byte is dedicated to the minor version of
3638 * the binary format, which is incremented only when new markers are
3639 * introduced, for instance, but when backward compatibility is preserved.
3642 /* Make these at compile time. The WRITE() macro is sufficiently complex
3643 that it saves about 200 bytes doing it this way and only using it
3645 static const unsigned char network_file_header[] = {
3647 (STORABLE_BIN_MAJOR << 1) | 1,
3648 STORABLE_BIN_WRITE_MINOR
3650 static const unsigned char file_header[] = {
3652 (STORABLE_BIN_MAJOR << 1) | 0,
3653 STORABLE_BIN_WRITE_MINOR,
3654 /* sizeof the array includes the 0 byte at the end: */
3655 (char) sizeof (byteorderstr) - 1,
3657 (unsigned char) sizeof(int),
3658 (unsigned char) sizeof(long),
3659 (unsigned char) sizeof(char *),
3660 (unsigned char) sizeof(NV)
3662 #ifdef USE_56_INTERWORK_KLUDGE
3663 static const unsigned char file_header_56[] = {
3665 (STORABLE_BIN_MAJOR << 1) | 0,
3666 STORABLE_BIN_WRITE_MINOR,
3667 /* sizeof the array includes the 0 byte at the end: */
3668 (char) sizeof (byteorderstr_56) - 1,
3670 (unsigned char) sizeof(int),
3671 (unsigned char) sizeof(long),
3672 (unsigned char) sizeof(char *),
3673 (unsigned char) sizeof(NV)
3676 const unsigned char *header;
3679 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3681 if (cxt->netorder) {
3682 header = network_file_header;
3683 length = sizeof (network_file_header);
3685 #ifdef USE_56_INTERWORK_KLUDGE
3686 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3687 header = file_header_56;
3688 length = sizeof (file_header_56);
3692 header = file_header;
3693 length = sizeof (file_header);
3698 /* sizeof the array includes the 0 byte at the end. */
3699 header += sizeof (magicstr) - 1;
3700 length -= sizeof (magicstr) - 1;
3703 WRITE( (unsigned char*) header, length);
3705 if (!cxt->netorder) {
3706 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3707 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3708 (int) sizeof(int), (int) sizeof(long),
3709 (int) sizeof(char *), (int) sizeof(NV)));
3717 * Common code for store operations.
3719 * When memory store is requested (f = NULL) and a non null SV* is given in
3720 * `res', it is filled with a new SV created out of the memory buffer.
3722 * It is required to provide a non-null `res' when the operation type is not
3723 * dclone() and store() is performed to memory.
3725 static int do_store(
3736 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3737 ("must supply result SV pointer for real recursion to memory"));
3739 TRACEME(("do_store (optype=%d, netorder=%d)",
3740 optype, network_order));
3745 * Workaround for CROAK leak: if they enter with a "dirty" context,
3746 * free up memory for them now.
3750 clean_context(aTHX_ cxt);
3753 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3754 * re-enter store() via the hooks. We need to stack contexts.
3758 cxt = allocate_context(aTHX_ cxt);
3762 ASSERT(cxt->entry == 1, ("starting new recursion"));
3763 ASSERT(!cxt->s_dirty, ("clean context"));
3766 * Ensure sv is actually a reference. From perl, we called something
3768 * pstore(aTHX_ FILE, \@array);
3769 * so we must get the scalar value behing that reference.
3773 CROAK(("Not a reference"));
3774 sv = SvRV(sv); /* So follow it to know what to store */
3777 * If we're going to store to memory, reset the buffer.
3784 * Prepare context and emit headers.
3787 init_store_context(aTHX_ cxt, f, optype, network_order);
3789 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3790 return 0; /* Error */
3793 * Recursively store object...
3796 ASSERT(is_storing(aTHX), ("within store operation"));
3798 status = store(aTHX_ cxt, sv); /* Just do it! */
3801 * If they asked for a memory store and they provided an SV pointer,
3802 * make an SV string out of the buffer and fill their pointer.
3804 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3805 * an SV, since context cleanup might free the buffer if we did recurse.
3806 * (unless caller is dclone(), which is aware of that).
3809 if (!cxt->fio && res)
3810 *res = mbuf2sv(aTHX);
3815 * The "root" context is never freed, since it is meant to be always
3816 * handy for the common case where no recursion occurs at all (i.e.
3817 * we enter store() outside of any Storable code and leave it, period).
3818 * We know it's the "root" context because there's nothing stacked
3823 * When deep cloning, we don't free the context: doing so would force
3824 * us to copy the data in the memory buffer. Sicne we know we're
3825 * about to enter do_retrieve...
3828 clean_store_context(aTHX_ cxt);
3829 if (cxt->prev && !(cxt->optype & ST_CLONE))
3830 free_context(aTHX_ cxt);
3832 TRACEME(("do_store returns %d", status));
3840 * Store the transitive data closure of given object to disk.
3841 * Returns 0 on error, a true value otherwise.
3843 static int pstore(pTHX_ PerlIO *f, SV *sv)
3845 TRACEME(("pstore"));
3846 return do_store(aTHX_ f, sv, 0, FALSE, (SV**) 0);
3853 * Same as pstore(), but network order is used for integers and doubles are
3854 * emitted as strings.
3856 static int net_pstore(pTHX_ PerlIO *f, SV *sv)
3858 TRACEME(("net_pstore"));
3859 return do_store(aTHX_ f, sv, 0, TRUE, (SV**) 0);
3869 * Build a new SV out of the content of the internal memory buffer.
3871 static SV *mbuf2sv(pTHX)
3875 return newSVpv(mbase, MBUF_SIZE());
3881 * Store the transitive data closure of given object to memory.
3882 * Returns undef on error, a scalar value containing the data otherwise.
3884 static SV *mstore(pTHX_ SV *sv)
3888 TRACEME(("mstore"));
3890 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, FALSE, &out))
3891 return &PL_sv_undef;
3899 * Same as mstore(), but network order is used for integers and doubles are
3900 * emitted as strings.
3902 static SV *net_mstore(pTHX_ SV *sv)
3906 TRACEME(("net_mstore"));
3908 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, TRUE, &out))
3909 return &PL_sv_undef;
3915 *** Specific retrieve callbacks.
3921 * Return an error via croak, since it is not possible that we get here
3922 * under normal conditions, when facing a file produced via pstore().
3924 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname)
3927 cxt->ver_major != STORABLE_BIN_MAJOR &&
3928 cxt->ver_minor != STORABLE_BIN_MINOR
3930 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3931 cxt->fio ? "file" : "string",
3932 cxt->ver_major, cxt->ver_minor,
3933 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3935 CROAK(("Corrupted storable %s (binary v%d.%d)",
3936 cxt->fio ? "file" : "string",
3937 cxt->ver_major, cxt->ver_minor));
3940 return (SV *) 0; /* Just in case */
3944 * retrieve_idx_blessed
3946 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3947 * <index> can be coded on either 1 or 5 bytes.
3949 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3952 const char *classname;
3956 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3957 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3959 GETMARK(idx); /* Index coded on a single char? */
3964 * Fetch classname in `aclass'
3967 sva = av_fetch(cxt->aclass, idx, FALSE);
3969 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3971 classname = SvPVX(*sva); /* We know it's a PV, by construction */
3973 TRACEME(("class ID %d => %s", idx, classname));
3976 * Retrieve object and bless it.
3979 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3987 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3988 * <len> can be coded on either 1 or 5 bytes.
3990 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3994 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3995 char *classname = buf;
3996 char *malloced_classname = NULL;
3998 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3999 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
4002 * Decode class name length and read that name.
4004 * Short classnames have two advantages: their length is stored on one
4005 * single byte, and the string can be read on the stack.
4008 GETMARK(len); /* Length coded on a single char? */
4011 TRACEME(("** allocating %d bytes for class name", len+1));
4012 New(10003, classname, len+1, char);
4013 malloced_classname = classname;
4015 SAFEPVREAD(classname, len, malloced_classname);
4016 classname[len] = '\0'; /* Mark string end */
4019 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
4022 TRACEME(("new class name \"%s\" will bear ID = %d", classname, cxt->classnum));
4024 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len))) {
4025 Safefree(malloced_classname);
4030 * Retrieve object and bless it.
4033 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
4034 if (malloced_classname)
4035 Safefree(malloced_classname);
4043 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
4044 * with leading mark already read, as usual.
4046 * When recursion was involved during serialization of the object, there
4047 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
4048 * we reach a <flags> marker with the recursion bit cleared.
4050 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
4051 * is held in the <extra> byte, and if the object is tied, the serialized
4052 * magic object comes at the very end:
4054 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
4056 * This means the STORABLE_thaw hook will NOT get a tied variable during its
4057 * processing (since we won't have seen the magic object by the time the hook
4058 * is called). See comments below for why it was done that way.
4060 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname)
4063 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
4064 char *classname = buf;
4075 int clone = cxt->optype & ST_CLONE;
4077 unsigned int extra_type = 0;
4079 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
4080 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
4083 * Read flags, which tell us about the type, and whether we need to recurse.
4089 * Create the (empty) object, and mark it as seen.
4091 * This must be done now, because tags are incremented, and during
4092 * serialization, the object tag was affected before recursion could
4096 obj_type = flags & SHF_TYPE_MASK;
4102 sv = (SV *) newAV();
4105 sv = (SV *) newHV();
4109 * Read <extra> flag to know the type of the object.
4110 * Record associated magic type for later.
4112 GETMARK(extra_type);
4113 switch (extra_type) {
4119 sv = (SV *) newAV();
4123 sv = (SV *) newHV();
4127 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4131 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4133 SEEN(sv, 0, 0); /* Don't bless yet */
4136 * Whilst flags tell us to recurse, do so.
4138 * We don't need to remember the addresses returned by retrieval, because
4139 * all the references will be obtained through indirection via the object
4140 * tags in the object-ID list.
4142 * We need to decrement the reference count for these objects
4143 * because, if the user doesn't save a reference to them in the hook,
4144 * they must be freed when this context is cleaned.
4147 while (flags & SHF_NEED_RECURSE) {
4148 TRACEME(("retrieve_hook recursing..."));
4149 rv = retrieve(aTHX_ cxt, 0);
4153 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
4158 if (flags & SHF_IDX_CLASSNAME) {
4163 * Fetch index from `aclass'
4166 if (flags & SHF_LARGE_CLASSLEN)
4171 sva = av_fetch(cxt->aclass, idx, FALSE);
4173 CROAK(("Class name #%"IVdf" should have been seen already",
4176 classname = SvPVX(*sva); /* We know it's a PV, by construction */
4177 TRACEME(("class ID %d => %s", idx, classname));
4181 * Decode class name length and read that name.
4183 * NOTA BENE: even if the length is stored on one byte, we don't read
4184 * on the stack. Just like retrieve_blessed(), we limit the name to
4185 * LG_BLESS bytes. This is an arbitrary decision.
4187 char *malloced_classname = NULL;
4189 if (flags & SHF_LARGE_CLASSLEN)
4194 if (len > LG_BLESS) {
4195 TRACEME(("** allocating %d bytes for class name", len+1));
4196 New(10003, classname, len+1, char);
4197 malloced_classname = classname;
4200 SAFEPVREAD(classname, len, malloced_classname);
4201 classname[len] = '\0'; /* Mark string end */
4204 * Record new classname.
4207 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len))) {
4208 Safefree(malloced_classname);
4213 TRACEME(("class name: %s", classname));
4216 * Decode user-frozen string length and read it in an SV.
4218 * For efficiency reasons, we read data directly into the SV buffer.
4219 * To understand that code, read retrieve_scalar()
4222 if (flags & SHF_LARGE_STRLEN)
4227 frozen = NEWSV(10002, len2);
4229 SAFEREAD(SvPVX(frozen), len2, frozen);
4230 SvCUR_set(frozen, len2);
4231 *SvEND(frozen) = '\0';
4233 (void) SvPOK_only(frozen); /* Validates string pointer */
4234 if (cxt->s_tainted) /* Is input source tainted? */
4237 TRACEME(("frozen string: %d bytes", len2));
4240 * Decode object-ID list length, if present.
4243 if (flags & SHF_HAS_LIST) {
4244 if (flags & SHF_LARGE_LISTLEN)
4250 av_extend(av, len3 + 1); /* Leave room for [0] */
4251 AvFILLp(av) = len3; /* About to be filled anyway */
4255 TRACEME(("has %d object IDs to link", len3));
4258 * Read object-ID list into array.
4259 * Because we pre-extended it, we can cheat and fill it manually.
4261 * We read object tags and we can convert them into SV* on the fly
4262 * because we know all the references listed in there (as tags)
4263 * have been already serialized, hence we have a valid correspondance
4264 * between each of those tags and the recreated SV.
4268 SV **ary = AvARRAY(av);
4270 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
4277 svh = av_fetch(cxt->aseen, tag, FALSE);
4279 if (tag == cxt->where_is_undef) {
4280 /* av_fetch uses PL_sv_undef internally, hence this
4281 somewhat gruesome hack. */
4285 CROAK(("Object #%"IVdf" should have been retrieved already",
4290 ary[i] = SvREFCNT_inc(xsv);
4295 * Bless the object and look up the STORABLE_thaw hook.
4298 BLESS(sv, classname);
4300 /* Handle attach case; again can't use pkg_can because it only
4301 * caches one method */
4302 attach = gv_fetchmethod_autoload(SvSTASH(sv), "STORABLE_attach", FALSE);
4303 if (attach && isGV(attach)) {
4305 SV* attach_hook = newRV((SV*) GvCV(attach));
4308 CROAK(("STORABLE_attach called with unexpected references"));
4312 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4313 rv = newSVpv(classname, 0);
4314 attached = scalar_call(aTHX_ rv, attach_hook, clone, av, G_SCALAR);
4317 sv_derived_from(attached, classname))
4318 return SvRV(attached);
4319 CROAK(("STORABLE_attach did not return a %s object", classname));
4322 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4325 * Hook not found. Maybe they did not require the module where this
4326 * hook is defined yet?
4328 * If the load below succeeds, we'll be able to find the hook.
4329 * Still, it only works reliably when each class is defined in a
4333 TRACEME(("No STORABLE_thaw defined for objects of class %s", classname));
4334 TRACEME(("Going to load module '%s'", classname));
4335 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(classname, 0), Nullsv);
4338 * We cache results of pkg_can, so we need to uncache before attempting
4342 pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4343 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4346 CROAK(("No STORABLE_thaw defined for objects of class %s "
4347 "(even after a \"require %s;\")", classname, classname));
4351 * If we don't have an `av' yet, prepare one.
4352 * Then insert the frozen string as item [0].
4360 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4365 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4367 * where $object is our blessed (empty) object, $cloning is a boolean
4368 * telling whether we're running a deep clone, $frozen is the frozen
4369 * string the user gave us in his serializing hook, and @refs, which may
4370 * be empty, is the list of extra references he returned along for us
4373 * In effect, the hook is an alternate creation routine for the class,
4374 * the object itself being already created by the runtime.
4377 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4378 classname, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4381 (void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
4388 SvREFCNT_dec(frozen);
4391 if (!(flags & SHF_IDX_CLASSNAME) && classname != buf)
4392 Safefree(classname);
4395 * If we had an <extra> type, then the object was not as simple, and
4396 * we need to restore extra magic now.
4402 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4404 rv = retrieve(aTHX_ cxt, 0); /* Retrieve <magic object> */
4406 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4407 PTR2UV(rv), PTR2UV(sv)));
4409 switch (extra_type) {
4411 sv_upgrade(sv, SVt_PVMG);
4414 sv_upgrade(sv, SVt_PVAV);
4415 AvREAL_off((AV *)sv);
4418 sv_upgrade(sv, SVt_PVHV);
4421 CROAK(("Forgot to deal with extra type %d", extra_type));
4426 * Adding the magic only now, well after the STORABLE_thaw hook was called
4427 * means the hook cannot know it deals with an object whose variable is
4428 * tied. But this is happening when retrieving $o in the following case:
4432 * my $o = bless \%h, 'BAR';
4434 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4435 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4436 * hash but a tied one should not matter at all, and remain transparent.
4437 * This means the magic must be restored by Storable AFTER the hook is
4440 * That looks very reasonable to me, but then I've come up with this
4441 * after a bug report from David Nesting, who was trying to store such
4442 * an object and caused Storable to fail. And unfortunately, it was
4443 * also the easiest way to retrofit support for blessed ref to tied objects
4444 * into the existing design. -- RAM, 17/02/2001
4447 sv_magic(sv, rv, mtype, Nullch, 0);
4448 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4456 * Retrieve reference to some other scalar.
4457 * Layout is SX_REF <object>, with SX_REF already read.
4459 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname)
4464 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4467 * We need to create the SV that holds the reference to the yet-to-retrieve
4468 * object now, so that we may record the address in the seen table.
4469 * Otherwise, if the object to retrieve references us, we won't be able
4470 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4471 * do the retrieve first and use rv = newRV(sv) since it will be too late
4472 * for SEEN() recording.
4475 rv = NEWSV(10002, 0);
4476 SEEN(rv, cname, 0); /* Will return if rv is null */
4477 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4479 return (SV *) 0; /* Failed */
4482 * WARNING: breaks RV encapsulation.
4484 * Now for the tricky part. We have to upgrade our existing SV, so that
4485 * it is now an RV on sv... Again, we cheat by duplicating the code
4486 * held in newSVrv(), since we already got our SV from retrieve().
4490 * SvRV(rv) = SvREFCNT_inc(sv);
4492 * here because the reference count we got from retrieve() above is
4493 * already correct: if the object was retrieved from the file, then
4494 * its reference count is one. Otherwise, if it was retrieved via
4495 * an SX_OBJECT indication, a ref count increment was done.
4499 /* No need to do anything, as rv will already be PVMG. */
4500 assert (SvTYPE(rv) == SVt_RV || SvTYPE(rv) >= SVt_PV);
4502 sv_upgrade(rv, SVt_RV);
4505 SvRV_set(rv, sv); /* $rv = \$sv */
4508 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4516 * Retrieve weak reference to some other scalar.
4517 * Layout is SX_WEAKREF <object>, with SX_WEAKREF already read.
4519 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname)
4523 TRACEME(("retrieve_weakref (#%d)", cxt->tagnum));
4525 sv = retrieve_ref(aTHX_ cxt, cname);
4537 * retrieve_overloaded
4539 * Retrieve reference to some other scalar with overloading.
4540 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4542 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname)
4548 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4551 * Same code as retrieve_ref(), duplicated to avoid extra call.
4554 rv = NEWSV(10002, 0);
4555 SEEN(rv, cname, 0); /* Will return if rv is null */
4556 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4558 return (SV *) 0; /* Failed */
4561 * WARNING: breaks RV encapsulation.
4564 sv_upgrade(rv, SVt_RV);
4565 SvRV_set(rv, sv); /* $rv = \$sv */
4569 * Restore overloading magic.
4572 stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
4574 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4575 ") (package <unknown>)",
4576 sv_reftype(sv, FALSE),
4579 if (!Gv_AMG(stash)) {
4580 const char *package = HvNAME_get(stash);
4581 TRACEME(("No overloading defined for package %s", package));
4582 TRACEME(("Going to load module '%s'", package));
4583 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(package, 0), Nullsv);
4584 if (!Gv_AMG(stash)) {
4585 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4586 ") (package %s) (even after a \"require %s;\")",
4587 sv_reftype(sv, FALSE),
4595 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4601 * retrieve_weakoverloaded
4603 * Retrieve weak overloaded reference to some other scalar.
4604 * Layout is SX_WEAKOVERLOADED <object>, with SX_WEAKOVERLOADED already read.
4606 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname)
4610 TRACEME(("retrieve_weakoverloaded (#%d)", cxt->tagnum));
4612 sv = retrieve_overloaded(aTHX_ cxt, cname);
4624 * retrieve_tied_array
4626 * Retrieve tied array
4627 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4629 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname)
4634 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4636 tv = NEWSV(10002, 0);
4637 SEEN(tv, cname, 0); /* Will return if tv is null */
4638 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4640 return (SV *) 0; /* Failed */
4642 sv_upgrade(tv, SVt_PVAV);
4643 AvREAL_off((AV *)tv);
4644 sv_magic(tv, sv, 'P', Nullch, 0);
4645 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4647 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4653 * retrieve_tied_hash
4655 * Retrieve tied hash
4656 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4658 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname)
4663 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4665 tv = NEWSV(10002, 0);
4666 SEEN(tv, cname, 0); /* Will return if tv is null */
4667 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4669 return (SV *) 0; /* Failed */
4671 sv_upgrade(tv, SVt_PVHV);
4672 sv_magic(tv, sv, 'P', Nullch, 0);
4673 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4675 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4681 * retrieve_tied_scalar
4683 * Retrieve tied scalar
4684 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4686 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4689 SV *sv, *obj = NULL;
4691 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4693 tv = NEWSV(10002, 0);
4694 SEEN(tv, cname, 0); /* Will return if rv is null */
4695 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4697 return (SV *) 0; /* Failed */
4699 else if (SvTYPE(sv) != SVt_NULL) {
4703 sv_upgrade(tv, SVt_PVMG);
4704 sv_magic(tv, obj, 'q', Nullch, 0);
4707 /* Undo refcnt inc from sv_magic() */
4711 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4719 * Retrieve reference to value in a tied hash.
4720 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4722 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname)
4728 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4730 tv = NEWSV(10002, 0);
4731 SEEN(tv, cname, 0); /* Will return if tv is null */
4732 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4734 return (SV *) 0; /* Failed */
4736 key = retrieve(aTHX_ cxt, 0); /* Retrieve <key> */
4738 return (SV *) 0; /* Failed */
4740 sv_upgrade(tv, SVt_PVMG);
4741 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4742 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4743 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4751 * Retrieve reference to value in a tied array.
4752 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4754 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname)
4760 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4762 tv = NEWSV(10002, 0);
4763 SEEN(tv, cname, 0); /* Will return if tv is null */
4764 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4766 return (SV *) 0; /* Failed */
4768 RLEN(idx); /* Retrieve <idx> */
4770 sv_upgrade(tv, SVt_PVMG);
4771 sv_magic(tv, sv, 'p', Nullch, idx);
4772 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4781 * Retrieve defined long (string) scalar.
4783 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4784 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4785 * was not stored on a single byte.
4787 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname)
4793 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4796 * Allocate an empty scalar of the suitable length.
4799 sv = NEWSV(10002, len);
4800 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4803 sv_setpvn(sv, "", 0);
4808 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4810 * Now, for efficiency reasons, read data directly inside the SV buffer,
4811 * and perform the SV final settings directly by duplicating the final
4812 * work done by sv_setpv. Since we're going to allocate lots of scalars
4813 * this way, it's worth the hassle and risk.
4816 SAFEREAD(SvPVX(sv), len, sv);
4817 SvCUR_set(sv, len); /* Record C string length */
4818 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4819 (void) SvPOK_only(sv); /* Validate string pointer */
4820 if (cxt->s_tainted) /* Is input source tainted? */
4821 SvTAINT(sv); /* External data cannot be trusted */
4823 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4824 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4832 * Retrieve defined short (string) scalar.
4834 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4835 * The scalar is "short" so <length> is single byte. If it is 0, there
4836 * is no <data> section.
4838 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4844 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4847 * Allocate an empty scalar of the suitable length.
4850 sv = NEWSV(10002, len);
4851 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4854 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4859 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4860 * To make it defined with an empty length, upgrade it now...
4861 * Don't upgrade to a PV if the original type contains more
4862 * information than a scalar.
4864 if (SvTYPE(sv) <= SVt_PV) {
4865 sv_upgrade(sv, SVt_PV);
4868 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4869 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4872 * Now, for efficiency reasons, read data directly inside the SV buffer,
4873 * and perform the SV final settings directly by duplicating the final
4874 * work done by sv_setpv. Since we're going to allocate lots of scalars
4875 * this way, it's worth the hassle and risk.
4877 SAFEREAD(SvPVX(sv), len, sv);
4878 SvCUR_set(sv, len); /* Record C string length */
4879 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4880 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4883 (void) SvPOK_only(sv); /* Validate string pointer */
4884 if (cxt->s_tainted) /* Is input source tainted? */
4885 SvTAINT(sv); /* External data cannot be trusted */
4887 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4894 * Like retrieve_scalar(), but tag result as utf8.
4895 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4897 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname)
4901 TRACEME(("retrieve_utf8str"));
4903 sv = retrieve_scalar(aTHX_ cxt, cname);
4905 #ifdef HAS_UTF8_SCALARS
4908 if (cxt->use_bytes < 0)
4910 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4912 if (cxt->use_bytes == 0)
4923 * Like retrieve_lscalar(), but tag result as utf8.
4924 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4926 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname)
4930 TRACEME(("retrieve_lutf8str"));
4932 sv = retrieve_lscalar(aTHX_ cxt, cname);
4934 #ifdef HAS_UTF8_SCALARS
4937 if (cxt->use_bytes < 0)
4939 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4941 if (cxt->use_bytes == 0)
4951 * Retrieve defined integer.
4952 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4954 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname)
4959 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4961 READ(&iv, sizeof(iv));
4963 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4965 TRACEME(("integer %"IVdf, iv));
4966 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4974 * Retrieve defined integer in network order.
4975 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4977 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname)
4982 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4986 sv = newSViv((int) ntohl(iv));
4987 TRACEME(("network integer %d", (int) ntohl(iv)));
4990 TRACEME(("network integer (as-is) %d", iv));
4992 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4994 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
5002 * Retrieve defined double.
5003 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
5005 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname)
5010 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
5012 READ(&nv, sizeof(nv));
5014 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5016 TRACEME(("double %"NVff, nv));
5017 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
5025 * Retrieve defined byte (small integer within the [-128, +127] range).
5026 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
5028 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname)
5032 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
5034 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
5037 TRACEME(("small integer read as %d", (unsigned char) siv));
5038 tmp = (unsigned char) siv - 128;
5040 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5042 TRACEME(("byte %d", tmp));
5043 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
5051 * Return the undefined value.
5053 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname)
5057 TRACEME(("retrieve_undef"));
5068 * Return the immortal undefined value.
5070 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname)
5072 SV *sv = &PL_sv_undef;
5074 TRACEME(("retrieve_sv_undef"));
5076 /* Special case PL_sv_undef, as av_fetch uses it internally to mark
5077 deleted elements, and will return NULL (fetch failed) whenever it
5079 if (cxt->where_is_undef == -1) {
5080 cxt->where_is_undef = cxt->tagnum;
5089 * Return the immortal yes value.
5091 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname)
5093 SV *sv = &PL_sv_yes;
5095 TRACEME(("retrieve_sv_yes"));
5104 * Return the immortal no value.
5106 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname)
5110 TRACEME(("retrieve_sv_no"));
5119 * Retrieve a whole array.
5120 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5121 * Each item is stored as <object>.
5123 * When we come here, SX_ARRAY has been read already.
5125 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5132 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
5135 * Read length, and allocate array, then pre-extend it.
5139 TRACEME(("size = %d", len));
5141 SEEN(av, cname, 0); /* Will return if array not allocated nicely */
5145 return (SV *) av; /* No data follow if array is empty */
5148 * Now get each item in turn...
5151 for (i = 0; i < len; i++) {
5152 TRACEME(("(#%d) item", i));
5153 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5156 if (av_store(av, i, sv) == 0)
5160 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5168 * Retrieve a whole hash table.
5169 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5170 * Keys are stored as <length> <data>, the <data> section being omitted
5172 * Values are stored as <object>.
5174 * When we come here, SX_HASH has been read already.
5176 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5184 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
5187 * Read length, allocate table.
5191 TRACEME(("size = %d", len));
5193 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5195 return (SV *) hv; /* No data follow if table empty */
5196 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5199 * Now get each key/value pair in turn...
5202 for (i = 0; i < len; i++) {
5207 TRACEME(("(#%d) value", i));
5208 sv = retrieve(aTHX_ cxt, 0);
5214 * Since we're reading into kbuf, we must ensure we're not
5215 * recursing between the read and the hv_store() where it's used.
5216 * Hence the key comes after the value.
5219 RLEN(size); /* Get key size */
5220 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5223 kbuf[size] = '\0'; /* Mark string end, just in case */
5224 TRACEME(("(#%d) key '%s'", i, kbuf));
5227 * Enter key/value pair into hash table.
5230 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5234 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5242 * Retrieve a whole hash table.
5243 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5244 * Keys are stored as <length> <data>, the <data> section being omitted
5246 * Values are stored as <object>.
5248 * When we come here, SX_HASH has been read already.
5250 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname)
5260 GETMARK(hash_flags);
5261 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
5263 * Read length, allocate table.
5266 #ifndef HAS_RESTRICTED_HASHES
5267 if (hash_flags & SHV_RESTRICTED) {
5268 if (cxt->derestrict < 0)
5270 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
5272 if (cxt->derestrict == 0)
5273 RESTRICTED_HASH_CROAK();
5278 TRACEME(("size = %d, flags = %d", len, hash_flags));
5280 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5282 return (SV *) hv; /* No data follow if table empty */
5283 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5286 * Now get each key/value pair in turn...
5289 for (i = 0; i < len; i++) {
5291 int store_flags = 0;
5296 TRACEME(("(#%d) value", i));
5297 sv = retrieve(aTHX_ cxt, 0);
5302 #ifdef HAS_RESTRICTED_HASHES
5303 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
5307 if (flags & SHV_K_ISSV) {
5308 /* XXX you can't set a placeholder with an SV key.
5309 Then again, you can't get an SV key.
5310 Without messing around beyond what the API is supposed to do.
5313 TRACEME(("(#%d) keysv, flags=%d", i, flags));
5314 keysv = retrieve(aTHX_ cxt, 0);
5318 if (!hv_store_ent(hv, keysv, sv, 0))
5323 * Since we're reading into kbuf, we must ensure we're not
5324 * recursing between the read and the hv_store() where it's used.
5325 * Hence the key comes after the value.
5328 if (flags & SHV_K_PLACEHOLDER) {
5330 sv = &PL_sv_placeholder;
5331 store_flags |= HVhek_PLACEHOLD;
5333 if (flags & SHV_K_UTF8) {
5334 #ifdef HAS_UTF8_HASHES
5335 store_flags |= HVhek_UTF8;
5337 if (cxt->use_bytes < 0)
5339 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
5341 if (cxt->use_bytes == 0)
5345 #ifdef HAS_UTF8_HASHES
5346 if (flags & SHV_K_WASUTF8)
5347 store_flags |= HVhek_WASUTF8;
5350 RLEN(size); /* Get key size */
5351 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5354 kbuf[size] = '\0'; /* Mark string end, just in case */
5355 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5356 flags, store_flags));
5359 * Enter key/value pair into hash table.
5362 #ifdef HAS_RESTRICTED_HASHES
5363 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5366 if (!(store_flags & HVhek_PLACEHOLD))
5367 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5372 #ifdef HAS_RESTRICTED_HASHES
5373 if (hash_flags & SHV_RESTRICTED)
5377 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5385 * Return a code reference.
5387 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname)
5389 #if PERL_VERSION < 6
5390 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5393 int type, count, tagnum;
5395 SV *sv, *text, *sub;
5397 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5400 * Insert dummy SV in the aseen array so that we don't screw
5401 * up the tag numbers. We would just make the internal
5402 * scalar an untagged item in the stream, but
5403 * retrieve_scalar() calls SEEN(). So we just increase the
5406 tagnum = cxt->tagnum;
5411 * Retrieve the source of the code reference
5412 * as a small or large scalar
5418 text = retrieve_scalar(aTHX_ cxt, cname);
5421 text = retrieve_lscalar(aTHX_ cxt, cname);
5424 CROAK(("Unexpected type %d in retrieve_code\n", type));
5428 * prepend "sub " to the source
5431 sub = newSVpvn("sub ", 4);
5432 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5436 * evaluate the source to a code reference and use the CV value
5439 if (cxt->eval == NULL) {
5440 cxt->eval = perl_get_sv("Storable::Eval", TRUE);
5441 SvREFCNT_inc(cxt->eval);
5443 if (!SvTRUE(cxt->eval)) {
5445 cxt->forgive_me == 0 ||
5446 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5447 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
5449 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5452 /* fix up the dummy entry... */
5453 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5461 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5462 SV* errsv = get_sv("@", TRUE);
5463 sv_setpvn(errsv, "", 0); /* clear $@ */
5465 XPUSHs(sv_2mortal(newSVsv(sub)));
5467 count = call_sv(cxt->eval, G_SCALAR);
5470 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5472 if (SvTRUE(errsv)) {
5473 CROAK(("code %s caused an error: %s",
5474 SvPV_nolen(sub), SvPV_nolen(errsv)));
5478 cv = eval_pv(SvPV_nolen(sub), TRUE);
5480 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5483 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5486 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5491 /* fix up the dummy entry... */
5492 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5499 * old_retrieve_array
5501 * Retrieve a whole array in pre-0.6 binary format.
5503 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5504 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5506 * When we come here, SX_ARRAY has been read already.
5508 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5516 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5519 * Read length, and allocate array, then pre-extend it.
5523 TRACEME(("size = %d", len));
5525 SEEN(av, 0, 0); /* Will return if array not allocated nicely */
5529 return (SV *) av; /* No data follow if array is empty */
5532 * Now get each item in turn...
5535 for (i = 0; i < len; i++) {
5537 if (c == SX_IT_UNDEF) {
5538 TRACEME(("(#%d) undef item", i));
5539 continue; /* av_extend() already filled us with undef */
5542 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5543 TRACEME(("(#%d) item", i));
5544 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5547 if (av_store(av, i, sv) == 0)
5551 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5559 * Retrieve a whole hash table in pre-0.6 binary format.
5561 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5562 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5564 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5566 * When we come here, SX_HASH has been read already.
5568 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5576 SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5578 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5581 * Read length, allocate table.
5585 TRACEME(("size = %d", len));
5587 SEEN(hv, 0, 0); /* Will return if table not allocated properly */
5589 return (SV *) hv; /* No data follow if table empty */
5590 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5593 * Now get each key/value pair in turn...
5596 for (i = 0; i < len; i++) {
5602 if (c == SX_VL_UNDEF) {
5603 TRACEME(("(#%d) undef value", i));
5605 * Due to a bug in hv_store(), it's not possible to pass
5606 * &PL_sv_undef to hv_store() as a value, otherwise the
5607 * associated key will not be creatable any more. -- RAM, 14/01/97
5610 sv_h_undef = newSVsv(&PL_sv_undef);
5611 sv = SvREFCNT_inc(sv_h_undef);
5612 } else if (c == SX_VALUE) {
5613 TRACEME(("(#%d) value", i));
5614 sv = retrieve(aTHX_ cxt, 0);
5618 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5622 * Since we're reading into kbuf, we must ensure we're not
5623 * recursing between the read and the hv_store() where it's used.
5624 * Hence the key comes after the value.
5629 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5630 RLEN(size); /* Get key size */
5631 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5634 kbuf[size] = '\0'; /* Mark string end, just in case */
5635 TRACEME(("(#%d) key '%s'", i, kbuf));
5638 * Enter key/value pair into hash table.
5641 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5645 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5651 *** Retrieval engine.
5657 * Make sure the stored data we're trying to retrieve has been produced
5658 * on an ILP compatible system with the same byteorder. It croaks out in
5659 * case an error is detected. [ILP = integer-long-pointer sizes]
5660 * Returns null if error is detected, &PL_sv_undef otherwise.
5662 * Note that there's no byte ordering info emitted when network order was
5663 * used at store time.
5665 static SV *magic_check(pTHX_ stcxt_t *cxt)
5667 /* The worst case for a malicious header would be old magic (which is
5668 longer), major, minor, byteorder length byte of 255, 255 bytes of
5669 garbage, sizeof int, long, pointer, NV.
5670 So the worse of that we can read is 255 bytes of garbage plus 4.
5671 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5672 compiling perl on a system with chars that are larger than 8 bits.
5673 (Even Crays aren't *that* perverse).
5675 unsigned char buf[4 + 255];
5676 unsigned char *current;
5679 int use_network_order;
5683 int version_minor = 0;
5685 TRACEME(("magic_check"));
5688 * The "magic number" is only for files, not when freezing in memory.
5692 /* This includes the '\0' at the end. I want to read the extra byte,
5693 which is usually going to be the major version number. */
5694 STRLEN len = sizeof(magicstr);
5697 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5699 /* Point at the byte after the byte we read. */
5700 current = buf + --len; /* Do the -- outside of macros. */
5702 if (memNE(buf, magicstr, len)) {
5704 * Try to read more bytes to check for the old magic number, which
5708 TRACEME(("trying for old magic number"));
5710 old_len = sizeof(old_magicstr) - 1;
5711 READ(current + 1, (SSize_t)(old_len - len));
5713 if (memNE(buf, old_magicstr, old_len))
5714 CROAK(("File is not a perl storable"));
5716 current = buf + old_len;
5718 use_network_order = *current;
5720 GETMARK(use_network_order);
5723 * Starting with 0.6, the "use_network_order" byte flag is also used to
5724 * indicate the version number of the binary, and therefore governs the
5725 * setting of sv_retrieve_vtbl. See magic_write().
5727 if (old_magic && use_network_order > 1) {
5728 /* 0.1 dump - use_network_order is really byte order length */
5732 version_major = use_network_order >> 1;
5734 cxt->retrieve_vtbl = (SV*(**)(pTHX_ stcxt_t *cxt, const char *cname)) (version_major > 0 ? sv_retrieve : sv_old_retrieve);
5736 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5740 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5741 * minor version of the protocol. See magic_write().
5744 if (version_major > 1)
5745 GETMARK(version_minor);
5747 cxt->ver_major = version_major;
5748 cxt->ver_minor = version_minor;
5750 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5753 * Inter-operability sanity check: we can't retrieve something stored
5754 * using a format more recent than ours, because we have no way to
5755 * know what has changed, and letting retrieval go would mean a probable
5756 * failure reporting a "corrupted" storable file.
5760 version_major > STORABLE_BIN_MAJOR ||
5761 (version_major == STORABLE_BIN_MAJOR &&
5762 version_minor > STORABLE_BIN_MINOR)
5765 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5766 STORABLE_BIN_MINOR));
5768 if (version_major == STORABLE_BIN_MAJOR) {
5769 TRACEME(("cxt->accept_future_minor is %d",
5770 cxt->accept_future_minor));
5771 if (cxt->accept_future_minor < 0)
5772 cxt->accept_future_minor
5773 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5776 if (cxt->accept_future_minor == 1)
5777 croak_now = 0; /* Don't croak yet. */
5780 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5781 version_major, version_minor,
5782 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5787 * If they stored using network order, there's no byte ordering
5788 * information to check.
5791 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5792 return &PL_sv_undef; /* No byte ordering info */
5794 /* In C truth is 1, falsehood is 0. Very convienient. */
5795 use_NV_size = version_major >= 2 && version_minor >= 2;
5797 if (version_major >= 0) {
5801 c = use_network_order;
5803 length = c + 3 + use_NV_size;
5804 READ(buf, length); /* Not null-terminated */
5806 TRACEME(("byte order '%.*s' %d", c, buf, c));
5808 #ifdef USE_56_INTERWORK_KLUDGE
5809 /* No point in caching this in the context as we only need it once per
5810 retrieve, and we need to recheck it each read. */
5811 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5812 if ((c != (sizeof (byteorderstr_56) - 1))
5813 || memNE(buf, byteorderstr_56, c))
5814 CROAK(("Byte order is not compatible"));
5818 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5819 CROAK(("Byte order is not compatible"));
5825 if ((int) *current++ != sizeof(int))
5826 CROAK(("Integer size is not compatible"));
5829 if ((int) *current++ != sizeof(long))
5830 CROAK(("Long integer size is not compatible"));
5832 /* sizeof(char *) */
5833 if ((int) *current != sizeof(char *))
5834 CROAK(("Pointer size is not compatible"));
5838 if ((int) *++current != sizeof(NV))
5839 CROAK(("Double size is not compatible"));
5842 return &PL_sv_undef; /* OK */
5848 * Recursively retrieve objects from the specified file and return their
5849 * root SV (which may be an AV or an HV for what we care).
5850 * Returns null if there is a problem.
5852 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname)
5858 TRACEME(("retrieve"));
5861 * Grab address tag which identifies the object if we are retrieving
5862 * an older format. Since the new binary format counts objects and no
5863 * longer explicitely tags them, we must keep track of the correspondance
5866 * The following section will disappear one day when the old format is
5867 * no longer supported, hence the final "goto" in the "if" block.
5870 if (cxt->hseen) { /* Retrieving old binary */
5872 if (cxt->netorder) {
5874 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5875 tag = (stag_t) nettag;
5877 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5880 if (type == SX_OBJECT) {
5882 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5884 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5886 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5889 * The following code is common with the SX_OBJECT case below.
5892 svh = av_fetch(cxt->aseen, tagn, FALSE);
5894 CROAK(("Object #%"IVdf" should have been retrieved already",
5897 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5898 SvREFCNT_inc(sv); /* One more reference to this same sv */
5899 return sv; /* The SV pointer where object was retrieved */
5903 * Map new object, but don't increase tagnum. This will be done
5904 * by each of the retrieve_* functions when they call SEEN().
5906 * The mapping associates the "tag" initially present with a unique
5907 * tag number. See test for SX_OBJECT above to see how this is perused.
5910 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5911 newSViv(cxt->tagnum), 0))
5918 * Regular post-0.6 binary format.
5923 TRACEME(("retrieve type = %d", type));
5926 * Are we dealing with an object we should have already retrieved?
5929 if (type == SX_OBJECT) {
5933 svh = av_fetch(cxt->aseen, tag, FALSE);
5935 CROAK(("Object #%"IVdf" should have been retrieved already",
5938 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5939 SvREFCNT_inc(sv); /* One more reference to this same sv */
5940 return sv; /* The SV pointer where object was retrieved */
5941 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5942 if (cxt->accept_future_minor < 0)
5943 cxt->accept_future_minor
5944 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5947 if (cxt->accept_future_minor == 1) {
5948 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5949 "This Storable is v%d.%d and can only handle data types up to %d",
5950 cxt->ver_major, cxt->ver_minor, type,
5951 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5955 first_time: /* Will disappear when support for old format is dropped */
5958 * Okay, first time through for this one.
5961 sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
5963 return (SV *) 0; /* Failed */
5966 * Old binary formats (pre-0.7).
5968 * Final notifications, ended by SX_STORED may now follow.
5969 * Currently, the only pertinent notification to apply on the
5970 * freshly retrieved object is either:
5971 * SX_CLASS <char-len> <classname> for short classnames.
5972 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5973 * Class name is then read into the key buffer pool used by
5974 * hash table key retrieval.
5977 if (cxt->ver_major < 2) {
5978 while ((type = GETCHAR()) != SX_STORED) {
5982 GETMARK(len); /* Length coded on a single char */
5984 case SX_LG_CLASS: /* Length coded on a regular integer */
5989 return (SV *) 0; /* Failed */
5991 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5994 kbuf[len] = '\0'; /* Mark string end */
5999 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
6000 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
6008 * Retrieve data held in file and return the root object.
6009 * Common routine for pretrieve and mretrieve.
6011 static SV *do_retrieve(
6019 int is_tainted; /* Is input source tainted? */
6020 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
6022 TRACEME(("do_retrieve (optype = 0x%x)", optype));
6024 optype |= ST_RETRIEVE;
6027 * Sanity assertions for retrieve dispatch tables.
6030 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
6031 ("old and new retrieve dispatch table have same size"));
6032 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
6033 ("SX_ERROR entry correctly initialized in old dispatch table"));
6034 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
6035 ("SX_ERROR entry correctly initialized in new dispatch table"));
6038 * Workaround for CROAK leak: if they enter with a "dirty" context,
6039 * free up memory for them now.
6043 clean_context(aTHX_ cxt);
6046 * Now that STORABLE_xxx hooks exist, it is possible that they try to
6047 * re-enter retrieve() via the hooks.
6051 cxt = allocate_context(aTHX_ cxt);
6055 ASSERT(cxt->entry == 1, ("starting new recursion"));
6056 ASSERT(!cxt->s_dirty, ("clean context"));
6061 * Data is loaded into the memory buffer when f is NULL, unless `in' is
6062 * also NULL, in which case we're expecting the data to already lie
6063 * in the buffer (dclone case).
6066 KBUFINIT(); /* Allocate hash key reading pool once */
6072 const char *orig = SvPV(in, length);
6074 /* This is quite deliberate. I want the UTF8 routines
6075 to encounter the '\0' which perl adds at the end
6076 of all scalars, so that any new string also has
6079 STRLEN klen_tmp = length + 1;
6080 bool is_utf8 = TRUE;
6082 /* Just casting the &klen to (STRLEN) won't work
6083 well if STRLEN and I32 are of different widths.
6085 asbytes = (char*)bytes_from_utf8((U8*)orig,
6089 CROAK(("Frozen string corrupt - contains characters outside 0-255"));
6091 if (asbytes != orig) {
6092 /* String has been converted.
6093 There is no need to keep any reference to
6095 in = sv_newmortal();
6096 /* We donate the SV the malloc()ed string
6097 bytes_from_utf8 returned us. */
6098 SvUPGRADE(in, SVt_PV);
6100 SvPV_set(in, asbytes);
6101 SvLEN_set(in, klen_tmp);
6102 SvCUR_set(in, klen_tmp - 1);
6106 MBUF_SAVE_AND_LOAD(in);
6110 * Magic number verifications.
6112 * This needs to be done before calling init_retrieve_context()
6113 * since the format indication in the file are necessary to conduct
6114 * some of the initializations.
6117 cxt->fio = f; /* Where I/O are performed */
6119 if (!magic_check(aTHX_ cxt))
6120 CROAK(("Magic number checking on storable %s failed",
6121 cxt->fio ? "file" : "string"));
6123 TRACEME(("data stored in %s format",
6124 cxt->netorder ? "net order" : "native"));
6127 * Check whether input source is tainted, so that we don't wrongly
6128 * taint perfectly good values...
6130 * We assume file input is always tainted. If both `f' and `in' are
6131 * NULL, then we come from dclone, and tainted is already filled in
6132 * the context. That's a kludge, but the whole dclone() thing is
6133 * already quite a kludge anyway! -- RAM, 15/09/2000.
6136 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
6137 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
6138 init_retrieve_context(aTHX_ cxt, optype, is_tainted);
6140 ASSERT(is_retrieving(aTHX), ("within retrieve operation"));
6142 sv = retrieve(aTHX_ cxt, 0); /* Recursively retrieve object, get root SV */
6151 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
6154 * The "root" context is never freed.
6157 clean_retrieve_context(aTHX_ cxt);
6158 if (cxt->prev) /* This context was stacked */
6159 free_context(aTHX_ cxt); /* It was not the "root" context */
6162 * Prepare returned value.
6166 TRACEME(("retrieve ERROR"));
6167 #if (PATCHLEVEL <= 4)
6168 /* perl 5.00405 seems to screw up at this point with an
6169 'attempt to modify a read only value' error reported in the
6170 eval { $self = pretrieve(*FILE) } in _retrieve.
6171 I can't see what the cause of this error is, but I suspect a
6172 bug in 5.004, as it seems to be capable of issuing spurious
6173 errors or core dumping with matches on $@. I'm not going to
6174 spend time on what could be a fruitless search for the cause,
6175 so here's a bodge. If you're running 5.004 and don't like
6176 this inefficiency, either upgrade to a newer perl, or you are
6177 welcome to find the problem and send in a patch.
6181 return &PL_sv_undef; /* Something went wrong, return undef */
6185 TRACEME(("retrieve got %s(0x%"UVxf")",
6186 sv_reftype(sv, FALSE), PTR2UV(sv)));
6189 * Backward compatibility with Storable-0.5@9 (which we know we
6190 * are retrieving if hseen is non-null): don't create an extra RV
6191 * for objects since we special-cased it at store time.
6193 * Build a reference to the SV returned by pretrieve even if it is
6194 * already one and not a scalar, for consistency reasons.
6197 if (pre_06_fmt) { /* Was not handling overloading by then */
6199 TRACEME(("fixing for old formats -- pre 0.6"));
6200 if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
6201 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
6207 * If reference is overloaded, restore behaviour.
6209 * NB: minor glitch here: normally, overloaded refs are stored specially
6210 * so that we can croak when behaviour cannot be re-installed, and also
6211 * avoid testing for overloading magic at each reference retrieval.
6213 * Unfortunately, the root reference is implicitely stored, so we must
6214 * check for possible overloading now. Furthermore, if we don't restore
6215 * overloading, we cannot croak as if the original ref was, because we
6216 * have no way to determine whether it was an overloaded ref or not in
6219 * It's a pity that overloading magic is attached to the rv, and not to
6220 * the underlying sv as blessing is.
6224 HV *stash = (HV *) SvSTASH(sv);
6225 SV *rv = newRV_noinc(sv);
6226 if (stash && Gv_AMG(stash)) {
6228 TRACEME(("restored overloading on root reference"));
6230 TRACEME(("ended do_retrieve() with an object"));
6234 TRACEME(("regular do_retrieve() end"));
6236 return newRV_noinc(sv);
6242 * Retrieve data held in file and return the root object, undef on error.
6244 static SV *pretrieve(pTHX_ PerlIO *f)
6246 TRACEME(("pretrieve"));
6247 return do_retrieve(aTHX_ f, Nullsv, 0);
6253 * Retrieve data held in scalar and return the root object, undef on error.
6255 static SV *mretrieve(pTHX_ SV *sv)
6257 TRACEME(("mretrieve"));
6258 return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
6268 * Deep clone: returns a fresh copy of the original referenced SV tree.
6270 * This is achieved by storing the object in memory and restoring from
6271 * there. Not that efficient, but it should be faster than doing it from
6274 static SV *dclone(pTHX_ SV *sv)
6278 stcxt_t *real_context;
6281 TRACEME(("dclone"));
6284 * Workaround for CROAK leak: if they enter with a "dirty" context,
6285 * free up memory for them now.
6289 clean_context(aTHX_ cxt);
6292 * Tied elements seem to need special handling.
6295 if ((SvTYPE(sv) == SVt_PVLV
6296 #if PERL_VERSION < 8
6297 || SvTYPE(sv) == SVt_PVMG
6299 ) && SvRMAGICAL(sv) && mg_find(sv, 'p')) {
6304 * do_store() optimizes for dclone by not freeing its context, should
6305 * we need to allocate one because we're deep cloning from a hook.
6308 if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
6309 return &PL_sv_undef; /* Error during store */
6312 * Because of the above optimization, we have to refresh the context,
6313 * since a new one could have been allocated and stacked by do_store().
6316 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
6317 cxt = real_context; /* And we need this temporary... */
6320 * Now, `cxt' may refer to a new context.
6323 ASSERT(!cxt->s_dirty, ("clean context"));
6324 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
6327 TRACEME(("dclone stored %d bytes", size));
6331 * Since we're passing do_retrieve() both a NULL file and sv, we need
6332 * to pre-compute the taintedness of the input by setting cxt->tainted
6333 * to whatever state our own input string was. -- RAM, 15/09/2000
6335 * do_retrieve() will free non-root context.
6338 cxt->s_tainted = SvTAINTED(sv);
6339 out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
6341 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
6351 * The Perl IO GV object distinguishes between input and output for sockets
6352 * but not for plain files. To allow Storable to transparently work on
6353 * plain files and sockets transparently, we have to ask xsubpp to fetch the
6354 * right object for us. Hence the OutputStream and InputStream declarations.
6356 * Before perl 5.004_05, those entries in the standard typemap are not
6357 * defined in perl include files, so we do that here.
6360 #ifndef OutputStream
6361 #define OutputStream PerlIO *
6362 #define InputStream PerlIO *
6363 #endif /* !OutputStream */
6365 MODULE = Storable PACKAGE = Storable::Cxt
6371 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
6375 if (!cxt->membuf_ro && mbase)
6377 if (cxt->membuf_ro && (cxt->msaved).arena)
6378 Safefree((cxt->msaved).arena);
6381 MODULE = Storable PACKAGE = Storable
6387 HV *stash = gv_stashpvn("Storable", 8, GV_ADD);
6388 newCONSTSUB(stash, "BIN_MAJOR", newSViv(STORABLE_BIN_MAJOR));
6389 newCONSTSUB(stash, "BIN_MINOR", newSViv(STORABLE_BIN_MINOR));
6390 newCONSTSUB(stash, "BIN_WRITE_MINOR", newSViv(STORABLE_BIN_WRITE_MINOR));
6392 init_perinterp(aTHX);
6393 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
6395 /* Only disable the used only once warning if we are in debugging mode. */
6396 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
6398 #ifdef USE_56_INTERWORK_KLUDGE
6399 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
6406 init_perinterp(aTHX);
6413 RETVAL = pstore(aTHX_ f, obj);
6422 RETVAL = net_pstore(aTHX_ f, obj);
6430 RETVAL = mstore(aTHX_ obj);
6438 RETVAL = net_mstore(aTHX_ obj);
6446 RETVAL = pretrieve(aTHX_ f);
6454 RETVAL = mretrieve(aTHX_ sv);
6462 RETVAL = dclone(aTHX_ sv);
6467 last_op_in_netorder()
6469 RETVAL = last_op_in_netorder(aTHX);
6476 RETVAL = is_storing(aTHX);
6483 RETVAL = is_retrieving(aTHX);