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 #include "ppport.h" /* handle old perls */
27 #define DEBUGME /* Debug mode, turns assertions on as well */
28 #define DASSERT /* Assertion mode */
32 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
33 * Provide them with the necessary defines so they can build with pre-5.004.
36 #ifndef PERLIO_IS_STDIO
38 #define PerlIO_getc(x) getc(x)
39 #define PerlIO_putc(f,x) putc(x,f)
40 #define PerlIO_read(x,y,z) fread(y,1,z,x)
41 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
42 #define PerlIO_stdoutf printf
43 #endif /* PERLIO_IS_STDIO */
44 #endif /* USE_PERLIO */
47 * Earlier versions of perl might be used, we can't assume they have the latest!
50 #ifndef PERL_VERSION /* For perls < 5.6 */
51 #define PERL_VERSION PATCHLEVEL
53 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
55 #if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
56 #define PL_sv_yes sv_yes
57 #define PL_sv_no sv_no
58 #define PL_sv_undef sv_undef
59 #if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
60 #define newSVpvn newSVpv
62 #endif /* PATCHLEVEL <= 4 */
63 #ifndef HvSHAREKEYS_off
64 #define HvSHAREKEYS_off(hv) /* Ignore */
66 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
67 #define AvFILLp AvFILL
69 typedef double NV; /* Older perls lack the NV type */
70 #define IVdf "ld" /* Various printf formats for Perl types */
74 #define INT2PTR(t,v) (t)(IV)(v)
75 #define PTR2UV(v) (unsigned long)(v)
76 #endif /* PERL_VERSION -- perls < 5.6 */
78 #ifndef NVef /* The following were not part of perl 5.6 */
79 #if defined(USE_LONG_DOUBLE) && \
80 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
81 #define NVef PERL_PRIeldbl
82 #define NVff PERL_PRIfldbl
83 #define NVgf PERL_PRIgldbl
92 #define SvRV_set(sv, val) \
94 assert(SvTYPE(sv) >= SVt_RV); \
95 (((XRV*)SvANY(sv))->xrv_rv = (val)); \
99 #ifndef PERL_UNUSED_DECL
101 # if (defined(__GNUC__) && defined(__cplusplus)) || defined(__INTEL_COMPILER)
102 # define PERL_UNUSED_DECL
104 # define PERL_UNUSED_DECL __attribute__((unused))
107 # define PERL_UNUSED_DECL
112 #define dNOOP extern int Perl___notused PERL_UNUSED_DECL
120 # define HvRITER_set(hv,r) (HvRITER(hv) = r)
123 # define HvEITER_set(hv,r) (HvEITER(hv) = r)
127 # define HvRITER_get HvRITER
130 # define HvEITER_get HvEITER
134 #define HvNAME_get HvNAME
137 #ifndef HvPLACEHOLDERS_get
138 # define HvPLACEHOLDERS_get HvPLACEHOLDERS
148 * TRACEME() will only output things when the $Storable::DEBUGME is true.
153 if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
154 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
161 #define ASSERT(x,y) \
164 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
165 __FILE__, __LINE__); \
166 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
177 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
179 #define SX_OBJECT C(0) /* Already stored object */
180 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
181 #define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
182 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
183 #define SX_REF C(4) /* Reference to object forthcoming */
184 #define SX_UNDEF C(5) /* Undefined scalar */
185 #define SX_INTEGER C(6) /* Integer forthcoming */
186 #define SX_DOUBLE C(7) /* Double forthcoming */
187 #define SX_BYTE C(8) /* (signed) byte forthcoming */
188 #define SX_NETINT C(9) /* Integer in network order forthcoming */
189 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
190 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
191 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
192 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
193 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
194 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
195 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
196 #define SX_BLESS C(17) /* Object is blessed */
197 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
198 #define SX_HOOK C(19) /* Stored via hook, user-defined */
199 #define SX_OVERLOAD C(20) /* Overloaded reference */
200 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
201 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
202 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
203 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
204 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
205 #define SX_CODE C(26) /* Code references as perl source code */
206 #define SX_WEAKREF C(27) /* Weak reference to object forthcoming */
207 #define SX_WEAKOVERLOAD C(28) /* Overloaded weak reference */
208 #define SX_ERROR C(29) /* Error */
211 * Those are only used to retrieve "old" pre-0.6 binary images.
213 #define SX_ITEM 'i' /* An array item introducer */
214 #define SX_IT_UNDEF 'I' /* Undefined array item */
215 #define SX_KEY 'k' /* A hash key introducer */
216 #define SX_VALUE 'v' /* A hash value introducer */
217 #define SX_VL_UNDEF 'V' /* Undefined hash value */
220 * Those are only used to retrieve "old" pre-0.7 binary images
223 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
224 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
225 #define SX_STORED 'X' /* End of object */
228 * Limits between short/long length representation.
231 #define LG_SCALAR 255 /* Large scalar length limit */
232 #define LG_BLESS 127 /* Large classname bless limit */
238 #define ST_STORE 0x1 /* Store operation */
239 #define ST_RETRIEVE 0x2 /* Retrieval operation */
240 #define ST_CLONE 0x4 /* Deep cloning operation */
243 * The following structure is used for hash table key retrieval. Since, when
244 * retrieving objects, we'll be facing blessed hash references, it's best
245 * to pre-allocate that buffer once and resize it as the need arises, never
246 * freeing it (keys will be saved away someplace else anyway, so even large
247 * keys are not enough a motivation to reclaim that space).
249 * This structure is also used for memory store/retrieve operations which
250 * happen in a fixed place before being malloc'ed elsewhere if persistency
251 * is required. Hence the aptr pointer.
254 char *arena; /* Will hold hash key strings, resized as needed */
255 STRLEN asiz; /* Size of aforementionned buffer */
256 char *aptr; /* Arena pointer, for in-place read/write ops */
257 char *aend; /* First invalid address */
262 * A hash table records the objects which have already been stored.
263 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
264 * an arbitrary sequence number) is used to identify them.
267 * An array table records the objects which have already been retrieved,
268 * as seen by the tag determind by counting the objects themselves. The
269 * reference to that retrieved object is kept in the table, and is returned
270 * when an SX_OBJECT is found bearing that same tag.
272 * The same processing is used to record "classname" for blessed objects:
273 * indexing by a hash at store time, and via an array at retrieve time.
276 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
279 * The following "thread-safe" related defines were contributed by
280 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
281 * only renamed things a little bit to ensure consistency with surrounding
282 * code. -- RAM, 14/09/1999
284 * The original patch suffered from the fact that the stcxt_t structure
285 * was global. Murray tried to minimize the impact on the code as much as
288 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
289 * on objects. Therefore, the notion of context needs to be generalized,
293 #define MY_VERSION "Storable(" XS_VERSION ")"
297 * Conditional UTF8 support.
301 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
302 #define HAS_UTF8_SCALARS
304 #define HAS_UTF8_HASHES
307 /* 5.6 perl has utf8 scalars but not hashes */
311 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
314 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
317 #define WEAKREF_CROAK() CROAK(("Cannot retrieve weak references in this perl"))
320 #ifdef HvPLACEHOLDERS
321 #define HAS_RESTRICTED_HASHES
323 #define HVhek_PLACEHOLD 0x200
324 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
328 #define HAS_HASH_KEY_FLAGS
332 #define USE_PTR_TABLE
336 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
337 * files remap tainted and dirty when threading is enabled. That's bad for
338 * perl to remap such common words. -- RAM, 29/09/00
342 typedef struct stcxt {
343 int entry; /* flags recursion */
344 int optype; /* type of traversal operation */
345 /* which objects have been seen, store time.
346 tags are numbers, which are cast to (SV *) and stored directly */
348 /* use pseen if we have ptr_tables. We have to store tag+1, because
349 tag numbers start at 0, and we can't store (SV *) 0 in a ptr_table
350 without it being confused for a fetch lookup failure. */
351 struct ptr_tbl *pseen;
352 /* Still need hseen for the 0.6 file format code. */
355 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
356 AV *aseen; /* which objects have been seen, retrieve time */
357 IV where_is_undef; /* index in aseen of PL_sv_undef */
358 HV *hclass; /* which classnames have been seen, store time */
359 AV *aclass; /* which classnames have been seen, retrieve time */
360 HV *hook; /* cache for hook methods per class name */
361 IV tagnum; /* incremented at store time for each seen object */
362 IV classnum; /* incremented at store time for each seen classname */
363 int netorder; /* true if network order used */
364 int s_tainted; /* true if input source is tainted, at retrieve time */
365 int forgive_me; /* whether to be forgiving... */
366 int deparse; /* whether to deparse code refs */
367 SV *eval; /* whether to eval source code */
368 int canonical; /* whether to store hashes sorted by key */
369 #ifndef HAS_RESTRICTED_HASHES
370 int derestrict; /* whether to downgrade restrcted hashes */
373 int use_bytes; /* whether to bytes-ify utf8 */
375 int accept_future_minor; /* croak immediately on future minor versions? */
376 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
377 int membuf_ro; /* true means membuf is read-only and msaved is rw */
378 struct extendable keybuf; /* for hash key retrieval */
379 struct extendable membuf; /* for memory store/retrieve operations */
380 struct extendable msaved; /* where potentially valid mbuf is saved */
381 PerlIO *fio; /* where I/O are performed, NULL for memory */
382 int ver_major; /* major of version for retrieved object */
383 int ver_minor; /* minor of version for retrieved object */
384 SV *(**retrieve_vtbl)(pTHX_ struct stcxt *, const char *); /* retrieve dispatch table */
385 SV *prev; /* contexts chained backwards in real recursion */
386 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
389 #define NEW_STORABLE_CXT_OBJ(cxt) \
391 SV *self = newSV(sizeof(stcxt_t) - 1); \
392 SV *my_sv = newRV_noinc(self); \
393 sv_bless(my_sv, gv_stashpv("Storable::Cxt", GV_ADD)); \
394 cxt = (stcxt_t *)SvPVX(self); \
395 Zero(cxt, 1, stcxt_t); \
396 cxt->my_sv = my_sv; \
399 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
401 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
403 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
404 #else /* >= perl5.004_68 */
406 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
407 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
408 #endif /* < perl5.004_68 */
410 #define dSTCXT_PTR(T,name) \
411 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
412 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
415 dSTCXT_PTR(stcxt_t *, cxt)
419 NEW_STORABLE_CXT_OBJ(cxt); \
420 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
422 #define SET_STCXT(x) \
425 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
428 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
430 static stcxt_t *Context_ptr = NULL;
431 #define dSTCXT stcxt_t *cxt = Context_ptr
432 #define SET_STCXT(x) Context_ptr = x
435 NEW_STORABLE_CXT_OBJ(cxt); \
439 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
443 * Croaking implies a memory leak, since we don't use setjmp/longjmp
444 * to catch the exit and free memory used during store or retrieve
445 * operations. This is not too difficult to fix, but I need to understand
446 * how Perl does it, and croaking is exceptional anyway, so I lack the
447 * motivation to do it.
449 * The current workaround is to mark the context as dirty when croaking,
450 * so that data structures can be freed whenever we renter Storable code
451 * (but only *then*: it's a workaround, not a fix).
453 * This is also imperfect, because we don't really know how far they trapped
454 * the croak(), and when we were recursing, we won't be able to clean anything
455 * but the topmost context stacked.
458 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
461 * End of "thread-safe" related definitions.
467 * Keep only the low 32 bits of a pointer (used for tags, which are not
472 #define LOW_32BITS(x) ((I32) (x))
474 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
480 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
481 * Used in the WLEN and RLEN macros.
485 #define oI(x) ((I32 *) ((char *) (x) + 4))
486 #define oS(x) ((x) - 4)
487 #define oC(x) (x = 0)
496 * key buffer handling
498 #define kbuf (cxt->keybuf).arena
499 #define ksiz (cxt->keybuf).asiz
503 TRACEME(("** allocating kbuf of 128 bytes")); \
504 New(10003, kbuf, 128, char); \
511 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
512 Renew(kbuf, x+1, char); \
518 * memory buffer handling
520 #define mbase (cxt->membuf).arena
521 #define msiz (cxt->membuf).asiz
522 #define mptr (cxt->membuf).aptr
523 #define mend (cxt->membuf).aend
525 #define MGROW (1 << 13)
526 #define MMASK (MGROW - 1)
528 #define round_mgrow(x) \
529 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
530 #define trunc_int(x) \
531 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
532 #define int_aligned(x) \
533 ((unsigned long) (x) == trunc_int(x))
535 #define MBUF_INIT(x) \
538 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
539 New(10003, mbase, MGROW, char); \
540 msiz = (STRLEN)MGROW; \
546 mend = mbase + msiz; \
549 #define MBUF_TRUNC(x) mptr = mbase + x
550 #define MBUF_SIZE() (mptr - mbase)
556 * Those macros are used in do_retrieve() to save the current memory
557 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
558 * data from a string.
560 #define MBUF_SAVE_AND_LOAD(in) \
562 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
563 cxt->membuf_ro = 1; \
564 TRACEME(("saving mbuf")); \
565 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
569 #define MBUF_RESTORE() \
571 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
572 cxt->membuf_ro = 0; \
573 TRACEME(("restoring mbuf")); \
574 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
578 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
579 * See store_scalar() for other usage of this workaround.
581 #define MBUF_LOAD(v) \
583 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
585 CROAK(("Not a scalar string")); \
586 mptr = mbase = SvPV(v, msiz); \
587 mend = mbase + msiz; \
590 #define MBUF_XTEND(x) \
592 int nsz = (int) round_mgrow((x)+msiz); \
593 int offset = mptr - mbase; \
594 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
595 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
597 Renew(mbase, nsz, char); \
599 mptr = mbase + offset; \
600 mend = mbase + nsz; \
603 #define MBUF_CHK(x) \
605 if ((mptr + (x)) > mend) \
609 #define MBUF_GETC(x) \
612 x = (int) (unsigned char) *mptr++; \
618 #define MBUF_GETINT(x) \
621 if ((mptr + 4) <= mend) { \
622 memcpy(oI(&x), mptr, 4); \
628 #define MBUF_GETINT(x) \
630 if ((mptr + sizeof(int)) <= mend) { \
631 if (int_aligned(mptr)) \
634 memcpy(&x, mptr, sizeof(int)); \
635 mptr += sizeof(int); \
641 #define MBUF_READ(x,s) \
643 if ((mptr + (s)) <= mend) { \
644 memcpy(x, mptr, s); \
650 #define MBUF_SAFEREAD(x,s,z) \
652 if ((mptr + (s)) <= mend) { \
653 memcpy(x, mptr, s); \
661 #define MBUF_SAFEPVREAD(x,s,z) \
663 if ((mptr + (s)) <= mend) { \
664 memcpy(x, mptr, s); \
672 #define MBUF_PUTC(c) \
675 *mptr++ = (char) c; \
678 *mptr++ = (char) c; \
683 #define MBUF_PUTINT(i) \
686 memcpy(mptr, oI(&i), 4); \
690 #define MBUF_PUTINT(i) \
692 MBUF_CHK(sizeof(int)); \
693 if (int_aligned(mptr)) \
696 memcpy(mptr, &i, sizeof(int)); \
697 mptr += sizeof(int); \
701 #define MBUF_WRITE(x,s) \
704 memcpy(mptr, x, s); \
709 * Possible return values for sv_type().
713 #define svis_SCALAR 1
717 #define svis_TIED_ITEM 5
725 #define SHF_TYPE_MASK 0x03
726 #define SHF_LARGE_CLASSLEN 0x04
727 #define SHF_LARGE_STRLEN 0x08
728 #define SHF_LARGE_LISTLEN 0x10
729 #define SHF_IDX_CLASSNAME 0x20
730 #define SHF_NEED_RECURSE 0x40
731 #define SHF_HAS_LIST 0x80
734 * Types for SX_HOOK (last 2 bits in flags).
740 #define SHT_EXTRA 3 /* Read extra byte for type */
743 * The following are held in the "extra byte"...
746 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
747 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
748 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
751 * per hash flags for flagged hashes
754 #define SHV_RESTRICTED 0x01
757 * per key flags for flagged hashes
760 #define SHV_K_UTF8 0x01
761 #define SHV_K_WASUTF8 0x02
762 #define SHV_K_LOCKED 0x04
763 #define SHV_K_ISSV 0x08
764 #define SHV_K_PLACEHOLDER 0x10
767 * Before 0.6, the magic string was "perl-store" (binary version number 0).
769 * Since 0.6 introduced many binary incompatibilities, the magic string has
770 * been changed to "pst0" to allow an old image to be properly retrieved by
771 * a newer Storable, but ensure a newer image cannot be retrieved with an
774 * At 0.7, objects are given the ability to serialize themselves, and the
775 * set of markers is extended, backward compatibility is not jeopardized,
776 * so the binary version number could have remained unchanged. To correctly
777 * spot errors if a file making use of 0.7-specific extensions is given to
778 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
779 * a "minor" version, to better track this kind of evolution from now on.
782 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
783 static const char magicstr[] = "pst0"; /* Used as a magic number */
785 #define MAGICSTR_BYTES 'p','s','t','0'
786 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
788 /* 5.6.x introduced the ability to have IVs as long long.
789 However, Configure still defined BYTEORDER based on the size of a long.
790 Storable uses the BYTEORDER value as part of the header, but doesn't
791 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
792 with IV as long long on a platform that uses Configure (ie most things
793 except VMS and Windows) headers are identical for the different IV sizes,
794 despite the files containing some fields based on sizeof(IV)
796 5.8 is consistent - the following redifinition kludge is only needed on
797 5.6.x, but the interwork is needed on 5.8 while data survives in files
802 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
803 #ifndef NO_56_INTERWORK_KLUDGE
804 #define USE_56_INTERWORK_KLUDGE
806 #if BYTEORDER == 0x1234
808 #define BYTEORDER 0x12345678
810 #if BYTEORDER == 0x4321
812 #define BYTEORDER 0x87654321
817 #if BYTEORDER == 0x1234
818 #define BYTEORDER_BYTES '1','2','3','4'
820 #if BYTEORDER == 0x12345678
821 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
822 #ifdef USE_56_INTERWORK_KLUDGE
823 #define BYTEORDER_BYTES_56 '1','2','3','4'
826 #if BYTEORDER == 0x87654321
827 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
828 #ifdef USE_56_INTERWORK_KLUDGE
829 #define BYTEORDER_BYTES_56 '4','3','2','1'
832 #if BYTEORDER == 0x4321
833 #define BYTEORDER_BYTES '4','3','2','1'
835 #error Unknown byteorder. Please append your byteorder to Storable.xs
841 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
842 #ifdef USE_56_INTERWORK_KLUDGE
843 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
846 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
847 #define STORABLE_BIN_MINOR 7 /* Binary minor "version" */
849 #if (PATCHLEVEL <= 5)
850 #define STORABLE_BIN_WRITE_MINOR 4
853 * Perl 5.6.0 onwards can do weak references.
855 #define STORABLE_BIN_WRITE_MINOR 7
856 #endif /* (PATCHLEVEL <= 5) */
858 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
859 #define PL_sv_placeholder PL_sv_undef
863 * Useful store shortcuts...
867 * Note that if you put more than one mark for storing a particular
868 * type of thing, *and* in the retrieve_foo() function you mark both
869 * the thingy's you get off with SEEN(), you *must* increase the
870 * tagnum with cxt->tagnum++ along with this macro!
877 else if (PerlIO_putc(cxt->fio, x) == EOF) \
881 #define WRITE_I32(x) \
883 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
886 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
893 if (cxt->netorder) { \
894 int y = (int) htonl(x); \
897 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
902 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
907 #define WLEN(x) WRITE_I32(x)
914 else if (PerlIO_write(cxt->fio, x, y) != y) \
918 #define STORE_PV_LEN(pv, len, small, large) \
920 if (len <= LG_SCALAR) { \
921 unsigned char clen = (unsigned char) len; \
933 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
936 * Store &PL_sv_undef in arrays without recursing through store().
938 #define STORE_SV_UNDEF() \
941 PUTMARK(SX_SV_UNDEF); \
945 * Useful retrieve shortcuts...
949 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
955 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
959 #define READ_I32(x) \
961 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
965 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
975 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
978 x = (int) ntohl(x); \
981 #define RLEN(x) READ_I32(x)
988 else if (PerlIO_read(cxt->fio, x, y) != y) \
992 #define SAFEREAD(x,y,z) \
995 MBUF_SAFEREAD(x,y,z); \
996 else if (PerlIO_read(cxt->fio, x, y) != y) { \
1002 #define SAFEPVREAD(x,y,z) \
1005 MBUF_SAFEPVREAD(x,y,z); \
1006 else if (PerlIO_read(cxt->fio, x, y) != y) { \
1013 * This macro is used at retrieve time, to remember where object 'y', bearing a
1014 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
1015 * we'll therefore know where it has been retrieved and will be able to
1016 * share the same reference, as in the original stored memory image.
1018 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
1019 * on the objects given to STORABLE_thaw and expect that to be defined), and
1020 * also for overloaded objects (for which we might not find the stash if the
1021 * object is not blessed yet--this might occur for overloaded objects that
1022 * refer to themselves indirectly: if we blessed upon return from a sub
1023 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
1024 * restored on it because the underlying object would not be blessed yet!).
1026 * To achieve that, the class name of the last retrieved object is passed down
1027 * recursively, and the first SEEN() call for which the class name is not NULL
1028 * will bless the object.
1030 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
1032 #define SEEN(y,c,i) \
1036 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
1038 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
1039 PTR2UV(y), SvREFCNT(y)-1)); \
1041 BLESS((SV *) (y), c); \
1045 * Bless `s' in `p', via a temporary reference, required by sv_bless().
1047 #define BLESS(s,p) \
1051 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
1052 stash = gv_stashpv((p), GV_ADD); \
1053 ref = newRV_noinc(s); \
1054 (void) sv_bless(ref, stash); \
1055 SvRV_set(ref, NULL); \
1056 SvREFCNT_dec(ref); \
1059 * sort (used in store_hash) - conditionally use qsort when
1060 * sortsv is not available ( <= 5.6.1 ).
1063 #if (PATCHLEVEL <= 6)
1065 #if defined(USE_ITHREADS)
1067 #define STORE_HASH_SORT \
1069 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
1070 SAVESPTR(orig_perl); \
1071 PERL_SET_CONTEXT(aTHX); \
1072 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
1075 #else /* ! USE_ITHREADS */
1077 #define STORE_HASH_SORT \
1078 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1080 #endif /* USE_ITHREADS */
1082 #else /* PATCHLEVEL > 6 */
1084 #define STORE_HASH_SORT \
1085 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1087 #endif /* PATCHLEVEL <= 6 */
1089 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1090 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname);
1093 * Dynamic dispatching table for SV store.
1096 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1097 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1098 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1099 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1100 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1101 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1102 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1103 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1104 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1106 typedef int (*sv_store_t)(pTHX_ stcxt_t *cxt, SV *sv);
1108 static const sv_store_t sv_store[] = {
1109 (sv_store_t)store_ref, /* svis_REF */
1110 (sv_store_t)store_scalar, /* svis_SCALAR */
1111 (sv_store_t)store_array, /* svis_ARRAY */
1112 (sv_store_t)store_hash, /* svis_HASH */
1113 (sv_store_t)store_tied, /* svis_TIED */
1114 (sv_store_t)store_tied_item, /* svis_TIED_ITEM */
1115 (sv_store_t)store_code, /* svis_CODE */
1116 (sv_store_t)store_other, /* svis_OTHER */
1119 #define SV_STORE(x) (*sv_store[x])
1122 * Dynamic dispatching tables for SV retrieval.
1125 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname);
1126 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname);
1127 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1128 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1129 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname);
1130 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname);
1131 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname);
1132 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname);
1133 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname);
1134 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname);
1135 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1136 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname);
1137 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname);
1138 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname);
1139 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1140 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname);
1142 typedef SV* (*sv_retrieve_t)(pTHX_ stcxt_t *cxt, const char *name);
1144 static const sv_retrieve_t sv_old_retrieve[] = {
1145 0, /* SX_OBJECT -- entry unused dynamically */
1146 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1147 (sv_retrieve_t)old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1148 (sv_retrieve_t)old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1149 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1150 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1151 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1152 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1153 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1154 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1155 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1156 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1157 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1158 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1159 (sv_retrieve_t)retrieve_other, /* SX_SV_UNDEF not supported */
1160 (sv_retrieve_t)retrieve_other, /* SX_SV_YES not supported */
1161 (sv_retrieve_t)retrieve_other, /* SX_SV_NO not supported */
1162 (sv_retrieve_t)retrieve_other, /* SX_BLESS not supported */
1163 (sv_retrieve_t)retrieve_other, /* SX_IX_BLESS not supported */
1164 (sv_retrieve_t)retrieve_other, /* SX_HOOK not supported */
1165 (sv_retrieve_t)retrieve_other, /* SX_OVERLOADED not supported */
1166 (sv_retrieve_t)retrieve_other, /* SX_TIED_KEY not supported */
1167 (sv_retrieve_t)retrieve_other, /* SX_TIED_IDX not supported */
1168 (sv_retrieve_t)retrieve_other, /* SX_UTF8STR not supported */
1169 (sv_retrieve_t)retrieve_other, /* SX_LUTF8STR not supported */
1170 (sv_retrieve_t)retrieve_other, /* SX_FLAG_HASH not supported */
1171 (sv_retrieve_t)retrieve_other, /* SX_CODE not supported */
1172 (sv_retrieve_t)retrieve_other, /* SX_WEAKREF not supported */
1173 (sv_retrieve_t)retrieve_other, /* SX_WEAKOVERLOAD not supported */
1174 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1177 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1178 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1179 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname);
1180 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname);
1181 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname);
1182 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1183 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1184 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname);
1185 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname);
1186 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname);
1187 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname);
1188 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname);
1189 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname);
1190 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname);
1191 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname);
1193 static const sv_retrieve_t sv_retrieve[] = {
1194 0, /* SX_OBJECT -- entry unused dynamically */
1195 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1196 (sv_retrieve_t)retrieve_array, /* SX_ARRAY */
1197 (sv_retrieve_t)retrieve_hash, /* SX_HASH */
1198 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1199 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1200 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1201 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1202 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1203 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1204 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1205 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1206 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1207 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1208 (sv_retrieve_t)retrieve_sv_undef, /* SX_SV_UNDEF */
1209 (sv_retrieve_t)retrieve_sv_yes, /* SX_SV_YES */
1210 (sv_retrieve_t)retrieve_sv_no, /* SX_SV_NO */
1211 (sv_retrieve_t)retrieve_blessed, /* SX_BLESS */
1212 (sv_retrieve_t)retrieve_idx_blessed, /* SX_IX_BLESS */
1213 (sv_retrieve_t)retrieve_hook, /* SX_HOOK */
1214 (sv_retrieve_t)retrieve_overloaded, /* SX_OVERLOAD */
1215 (sv_retrieve_t)retrieve_tied_key, /* SX_TIED_KEY */
1216 (sv_retrieve_t)retrieve_tied_idx, /* SX_TIED_IDX */
1217 (sv_retrieve_t)retrieve_utf8str, /* SX_UTF8STR */
1218 (sv_retrieve_t)retrieve_lutf8str, /* SX_LUTF8STR */
1219 (sv_retrieve_t)retrieve_flag_hash, /* SX_HASH */
1220 (sv_retrieve_t)retrieve_code, /* SX_CODE */
1221 (sv_retrieve_t)retrieve_weakref, /* SX_WEAKREF */
1222 (sv_retrieve_t)retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
1223 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1226 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1228 static SV *mbuf2sv(pTHX);
1231 *** Context management.
1237 * Called once per "thread" (interpreter) to initialize some global context.
1239 static void init_perinterp(pTHX)
1243 cxt->netorder = 0; /* true if network order used */
1244 cxt->forgive_me = -1; /* whether to be forgiving... */
1245 cxt->accept_future_minor = -1; /* would otherwise occur too late */
1251 * Called at the end of every context cleaning, to perform common reset
1254 static void reset_context(stcxt_t *cxt)
1258 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1262 * init_store_context
1264 * Initialize a new store context for real recursion.
1266 static void init_store_context(
1273 TRACEME(("init_store_context"));
1275 cxt->netorder = network_order;
1276 cxt->forgive_me = -1; /* Fetched from perl if needed */
1277 cxt->deparse = -1; /* Idem */
1278 cxt->eval = NULL; /* Idem */
1279 cxt->canonical = -1; /* Idem */
1280 cxt->tagnum = -1; /* Reset tag numbers */
1281 cxt->classnum = -1; /* Reset class numbers */
1282 cxt->fio = f; /* Where I/O are performed */
1283 cxt->optype = optype; /* A store, or a deep clone */
1284 cxt->entry = 1; /* No recursion yet */
1287 * The `hseen' table is used to keep track of each SV stored and their
1288 * associated tag numbers is special. It is "abused" because the
1289 * values stored are not real SV, just integers cast to (SV *),
1290 * which explains the freeing below.
1292 * It is also one possible bottlneck to achieve good storing speed,
1293 * so the "shared keys" optimization is turned off (unlikely to be
1294 * of any use here), and the hash table is "pre-extended". Together,
1295 * those optimizations increase the throughput by 12%.
1298 #ifdef USE_PTR_TABLE
1299 cxt->pseen = ptr_table_new();
1302 cxt->hseen = newHV(); /* Table where seen objects are stored */
1303 HvSHAREKEYS_off(cxt->hseen);
1306 * The following does not work well with perl5.004_04, and causes
1307 * a core dump later on, in a completely unrelated spot, which
1308 * makes me think there is a memory corruption going on.
1310 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1311 * it below does not make any difference. It seems to work fine
1312 * with perl5.004_68 but given the probable nature of the bug,
1313 * that does not prove anything.
1315 * It's a shame because increasing the amount of buckets raises
1316 * store() throughput by 5%, but until I figure this out, I can't
1317 * allow for this to go into production.
1319 * It is reported fixed in 5.005, hence the #if.
1321 #if PERL_VERSION >= 5
1322 #define HBUCKETS 4096 /* Buckets for %hseen */
1323 #ifndef USE_PTR_TABLE
1324 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1329 * The `hclass' hash uses the same settings as `hseen' above, but it is
1330 * used to assign sequential tags (numbers) to class names for blessed
1333 * We turn the shared key optimization on.
1336 cxt->hclass = newHV(); /* Where seen classnames are stored */
1338 #if PERL_VERSION >= 5
1339 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1343 * The `hook' hash table is used to keep track of the references on
1344 * the STORABLE_freeze hook routines, when found in some class name.
1346 * It is assumed that the inheritance tree will not be changed during
1347 * storing, and that no new method will be dynamically created by the
1351 cxt->hook = newHV(); /* Table where hooks are cached */
1354 * The `hook_seen' array keeps track of all the SVs returned by
1355 * STORABLE_freeze hooks for us to serialize, so that they are not
1356 * reclaimed until the end of the serialization process. Each SV is
1357 * only stored once, the first time it is seen.
1360 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1364 * clean_store_context
1366 * Clean store context by
1368 static void clean_store_context(pTHX_ stcxt_t *cxt)
1372 TRACEME(("clean_store_context"));
1374 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1377 * Insert real values into hashes where we stored faked pointers.
1380 #ifndef USE_PTR_TABLE
1382 hv_iterinit(cxt->hseen);
1383 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1384 HeVAL(he) = &PL_sv_undef;
1389 hv_iterinit(cxt->hclass);
1390 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1391 HeVAL(he) = &PL_sv_undef;
1395 * And now dispose of them...
1397 * The surrounding if() protection has been added because there might be
1398 * some cases where this routine is called more than once, during
1399 * exceptionnal events. This was reported by Marc Lehmann when Storable
1400 * is executed from mod_perl, and the fix was suggested by him.
1401 * -- RAM, 20/12/2000
1404 #ifdef USE_PTR_TABLE
1406 struct ptr_tbl *pseen = cxt->pseen;
1408 ptr_table_free(pseen);
1410 assert(!cxt->hseen);
1413 HV *hseen = cxt->hseen;
1416 sv_free((SV *) hseen);
1421 HV *hclass = cxt->hclass;
1424 sv_free((SV *) hclass);
1428 HV *hook = cxt->hook;
1431 sv_free((SV *) hook);
1434 if (cxt->hook_seen) {
1435 AV *hook_seen = cxt->hook_seen;
1437 av_undef(hook_seen);
1438 sv_free((SV *) hook_seen);
1441 cxt->forgive_me = -1; /* Fetched from perl if needed */
1442 cxt->deparse = -1; /* Idem */
1444 SvREFCNT_dec(cxt->eval);
1446 cxt->eval = NULL; /* Idem */
1447 cxt->canonical = -1; /* Idem */
1453 * init_retrieve_context
1455 * Initialize a new retrieve context for real recursion.
1457 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1459 TRACEME(("init_retrieve_context"));
1462 * The hook hash table is used to keep track of the references on
1463 * the STORABLE_thaw hook routines, when found in some class name.
1465 * It is assumed that the inheritance tree will not be changed during
1466 * storing, and that no new method will be dynamically created by the
1470 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1472 #ifdef USE_PTR_TABLE
1477 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1478 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1479 * the correspondance between the tags and the tag number used by the
1480 * new retrieve routines.
1483 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1486 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1487 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1488 cxt->aclass = newAV(); /* Where seen classnames are kept */
1489 cxt->tagnum = 0; /* Have to count objects... */
1490 cxt->classnum = 0; /* ...and class names as well */
1491 cxt->optype = optype;
1492 cxt->s_tainted = is_tainted;
1493 cxt->entry = 1; /* No recursion yet */
1494 #ifndef HAS_RESTRICTED_HASHES
1495 cxt->derestrict = -1; /* Fetched from perl if needed */
1497 #ifndef HAS_UTF8_ALL
1498 cxt->use_bytes = -1; /* Fetched from perl if needed */
1500 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1504 * clean_retrieve_context
1506 * Clean retrieve context by
1508 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1510 TRACEME(("clean_retrieve_context"));
1512 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1515 AV *aseen = cxt->aseen;
1518 sv_free((SV *) aseen);
1520 cxt->where_is_undef = -1;
1523 AV *aclass = cxt->aclass;
1526 sv_free((SV *) aclass);
1530 HV *hook = cxt->hook;
1533 sv_free((SV *) hook);
1537 HV *hseen = cxt->hseen;
1540 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1543 #ifndef HAS_RESTRICTED_HASHES
1544 cxt->derestrict = -1; /* Fetched from perl if needed */
1546 #ifndef HAS_UTF8_ALL
1547 cxt->use_bytes = -1; /* Fetched from perl if needed */
1549 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1557 * A workaround for the CROAK bug: cleanup the last context.
1559 static void clean_context(pTHX_ stcxt_t *cxt)
1561 TRACEME(("clean_context"));
1563 ASSERT(cxt->s_dirty, ("dirty context"));
1568 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1570 if (cxt->optype & ST_RETRIEVE)
1571 clean_retrieve_context(aTHX_ cxt);
1572 else if (cxt->optype & ST_STORE)
1573 clean_store_context(aTHX_ cxt);
1577 ASSERT(!cxt->s_dirty, ("context is clean"));
1578 ASSERT(cxt->entry == 0, ("context is reset"));
1584 * Allocate a new context and push it on top of the parent one.
1585 * This new context is made globally visible via SET_STCXT().
1587 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1591 TRACEME(("allocate_context"));
1593 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1595 NEW_STORABLE_CXT_OBJ(cxt);
1596 cxt->prev = parent_cxt->my_sv;
1599 ASSERT(!cxt->s_dirty, ("clean context"));
1607 * Free current context, which cannot be the "root" one.
1608 * Make the context underneath globally visible via SET_STCXT().
1610 static void free_context(pTHX_ stcxt_t *cxt)
1612 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1614 TRACEME(("free_context"));
1616 ASSERT(!cxt->s_dirty, ("clean context"));
1617 ASSERT(prev, ("not freeing root context"));
1619 SvREFCNT_dec(cxt->my_sv);
1622 ASSERT(cxt, ("context not void"));
1632 * Tells whether we're in the middle of a store operation.
1634 static int is_storing(pTHX)
1638 return cxt->entry && (cxt->optype & ST_STORE);
1644 * Tells whether we're in the middle of a retrieve operation.
1646 static int is_retrieving(pTHX)
1650 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1654 * last_op_in_netorder
1656 * Returns whether last operation was made using network order.
1658 * This is typically out-of-band information that might prove useful
1659 * to people wishing to convert native to network order data when used.
1661 static int last_op_in_netorder(pTHX)
1665 return cxt->netorder;
1669 *** Hook lookup and calling routines.
1675 * A wrapper on gv_fetchmethod_autoload() which caches results.
1677 * Returns the routine reference as an SV*, or null if neither the package
1678 * nor its ancestors know about the method.
1680 static SV *pkg_fetchmeth(
1688 const char *hvname = HvNAME_get(pkg);
1692 * The following code is the same as the one performed by UNIVERSAL::can
1696 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1697 if (gv && isGV(gv)) {
1698 sv = newRV((SV*) GvCV(gv));
1699 TRACEME(("%s->%s: 0x%"UVxf, hvname, method, PTR2UV(sv)));
1701 sv = newSVsv(&PL_sv_undef);
1702 TRACEME(("%s->%s: not found", hvname, method));
1706 * Cache the result, ignoring failure: if we can't store the value,
1707 * it just won't be cached.
1710 (void) hv_store(cache, hvname, strlen(hvname), sv, 0);
1712 return SvOK(sv) ? sv : (SV *) 0;
1718 * Force cached value to be undef: hook ignored even if present.
1720 static void pkg_hide(
1726 const char *hvname = HvNAME_get(pkg);
1727 (void) hv_store(cache,
1728 hvname, strlen(hvname), newSVsv(&PL_sv_undef), 0);
1734 * Discard cached value: a whole fetch loop will be retried at next lookup.
1736 static void pkg_uncache(
1742 const char *hvname = HvNAME_get(pkg);
1743 (void) hv_delete(cache, hvname, strlen(hvname), G_DISCARD);
1749 * Our own "UNIVERSAL::can", which caches results.
1751 * Returns the routine reference as an SV*, or null if the object does not
1752 * know about the method.
1762 const char *hvname = HvNAME_get(pkg);
1764 TRACEME(("pkg_can for %s->%s", hvname, method));
1767 * Look into the cache to see whether we already have determined
1768 * where the routine was, if any.
1770 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1771 * that only one hook (i.e. always the same) is cached in a given cache.
1774 svh = hv_fetch(cache, hvname, strlen(hvname), FALSE);
1778 TRACEME(("cached %s->%s: not found", hvname, method));
1781 TRACEME(("cached %s->%s: 0x%"UVxf,
1782 hvname, method, PTR2UV(sv)));
1787 TRACEME(("not cached yet"));
1788 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1794 * Call routine as obj->hook(av) in scalar context.
1795 * Propagates the single returned value if not called in void context.
1797 static SV *scalar_call(
1809 TRACEME(("scalar_call (cloning=%d)", cloning));
1816 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1818 SV **ary = AvARRAY(av);
1819 int cnt = AvFILLp(av) + 1;
1821 XPUSHs(ary[0]); /* Frozen string */
1822 for (i = 1; i < cnt; i++) {
1823 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1824 i, PTR2UV(ary[i])));
1825 XPUSHs(sv_2mortal(newRV(ary[i])));
1830 TRACEME(("calling..."));
1831 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1832 TRACEME(("count = %d", count));
1838 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1851 * Call routine obj->hook(cloning) in list context.
1852 * Returns the list of returned values in an array.
1854 static AV *array_call(
1865 TRACEME(("array_call (cloning=%d)", cloning));
1871 XPUSHs(obj); /* Target object */
1872 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1875 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1880 for (i = count - 1; i >= 0; i--) {
1882 av_store(av, i, SvREFCNT_inc(sv));
1895 * Lookup the class name in the `hclass' table and either assign it a new ID
1896 * or return the existing one, by filling in `classnum'.
1898 * Return true if the class was known, false if the ID was just generated.
1900 static int known_class(
1903 char *name, /* Class name */
1904 int len, /* Name length */
1908 HV *hclass = cxt->hclass;
1910 TRACEME(("known_class (%s)", name));
1913 * Recall that we don't store pointers in this hash table, but tags.
1914 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1917 svh = hv_fetch(hclass, name, len, FALSE);
1919 *classnum = LOW_32BITS(*svh);
1924 * Unknown classname, we need to record it.
1928 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1929 CROAK(("Unable to record new classname"));
1931 *classnum = cxt->classnum;
1936 *** Sepcific store routines.
1942 * Store a reference.
1943 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1945 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1948 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1951 * Follow reference, and check if target is overloaded.
1957 TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1962 HV *stash = (HV *) SvSTASH(sv);
1963 if (stash && Gv_AMG(stash)) {
1964 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1965 PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1967 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1969 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1971 return store(aTHX_ cxt, sv);
1979 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1980 * The <data> section is omitted if <length> is 0.
1982 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1983 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1985 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
1990 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1992 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1995 * For efficiency, break the SV encapsulation by peaking at the flags
1996 * directly without using the Perl macros to avoid dereferencing
1997 * sv->sv_flags each time we wish to check the flags.
2000 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
2001 if (sv == &PL_sv_undef) {
2002 TRACEME(("immortal undef"));
2003 PUTMARK(SX_SV_UNDEF);
2005 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
2012 * Always store the string representation of a scalar if it exists.
2013 * Gisle Aas provided me with this test case, better than a long speach:
2015 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
2016 * SV = PVNV(0x80c8520)
2018 * FLAGS = (NOK,POK,pNOK,pPOK)
2021 * PV = 0x80c83d0 "abc"\0
2025 * Write SX_SCALAR, length, followed by the actual data.
2027 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
2028 * appropriate, followed by the actual (binary) data. A double
2029 * is written as a string if network order, for portability.
2031 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
2032 * The reason is that when the scalar value is tainted, the SvNOK(sv)
2035 * The test for a read-only scalar with both POK and NOK set is meant
2036 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
2037 * address comparison for each scalar we store.
2040 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
2042 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
2043 if (sv == &PL_sv_yes) {
2044 TRACEME(("immortal yes"));
2046 } else if (sv == &PL_sv_no) {
2047 TRACEME(("immortal no"));
2050 pv = SvPV(sv, len); /* We know it's SvPOK */
2051 goto string; /* Share code below */
2053 } else if (flags & SVf_POK) {
2054 /* public string - go direct to string read. */
2055 goto string_readlen;
2057 #if (PATCHLEVEL <= 6)
2058 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
2059 direct if NV flag is off. */
2060 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
2062 /* 5.7 rules are that if IV public flag is set, IV value is as
2063 good, if not better, than NV value. */
2069 * Will come here from below with iv set if double is an integer.
2073 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2075 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
2076 * (for example) and that ends up in the optimised small integer
2079 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
2080 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
2081 goto string_readlen;
2085 * Optimize small integers into a single byte, otherwise store as
2086 * a real integer (converted into network order if they asked).
2089 if (iv >= -128 && iv <= 127) {
2090 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
2093 TRACEME(("small integer stored as %d", siv));
2094 } else if (cxt->netorder) {
2096 TRACEME(("no htonl, fall back to string for integer"));
2097 goto string_readlen;
2105 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2106 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
2108 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
2109 /* Bigger than 32 bits. */
2110 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2111 goto string_readlen;
2115 niv = (I32) htonl((I32) iv);
2116 TRACEME(("using network order"));
2121 PUTMARK(SX_INTEGER);
2122 WRITE(&iv, sizeof(iv));
2125 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2126 } else if (flags & SVf_NOK) {
2128 #if (PATCHLEVEL <= 6)
2131 * Watch for number being an integer in disguise.
2133 if (nv == (NV) (iv = I_V(nv))) {
2134 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2135 goto integer; /* Share code above */
2140 if (SvIOK_notUV(sv)) {
2142 goto integer; /* Share code above */
2147 if (cxt->netorder) {
2148 TRACEME(("double %"NVff" stored as string", nv));
2149 goto string_readlen; /* Share code below */
2153 WRITE(&nv, sizeof(nv));
2155 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2157 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2158 I32 wlen; /* For 64-bit machines */
2164 * Will come here from above if it was readonly, POK and NOK but
2165 * neither &PL_sv_yes nor &PL_sv_no.
2169 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2171 STORE_UTF8STR(pv, wlen);
2173 STORE_SCALAR(pv, wlen);
2174 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2175 PTR2UV(sv), SvPVX(sv), (IV)len));
2177 CROAK(("Can't determine type of %s(0x%"UVxf")",
2178 sv_reftype(sv, FALSE),
2180 return 0; /* Ok, no recursion on scalars */
2188 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2189 * Each item is stored as <object>.
2191 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2194 I32 len = av_len(av) + 1;
2198 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2201 * Signal array by emitting SX_ARRAY, followed by the array length.
2206 TRACEME(("size = %d", len));
2209 * Now store each item recursively.
2212 for (i = 0; i < len; i++) {
2213 sav = av_fetch(av, i, 0);
2215 TRACEME(("(#%d) undef item", i));
2219 TRACEME(("(#%d) item", i));
2220 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2224 TRACEME(("ok (array)"));
2230 #if (PATCHLEVEL <= 6)
2236 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2239 sortcmp(const void *a, const void *b)
2241 #if defined(USE_ITHREADS)
2243 #endif /* USE_ITHREADS */
2244 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2247 #endif /* PATCHLEVEL <= 6 */
2252 * Store a hash table.
2254 * For a "normal" hash (not restricted, no utf8 keys):
2256 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2257 * Values are stored as <object>.
2258 * Keys are stored as <length> <data>, the <data> section being omitted
2261 * For a "fancy" hash (restricted or utf8 keys):
2263 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2265 * Values are stored as <object>.
2266 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2268 * Currently the only hash flag is "restriced"
2269 * Key flags are as for hv.h
2271 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2275 #ifdef HAS_RESTRICTED_HASHES
2284 int flagged_hash = ((SvREADONLY(hv)
2285 #ifdef HAS_HASH_KEY_FLAGS
2289 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2292 /* needs int cast for C++ compilers, doesn't it? */
2293 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2296 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2300 * Signal hash by emitting SX_HASH, followed by the table length.
2304 PUTMARK(SX_FLAG_HASH);
2305 PUTMARK(hash_flags);
2310 TRACEME(("size = %d", len));
2313 * Save possible iteration state via each() on that table.
2316 riter = HvRITER_get(hv);
2317 eiter = HvEITER_get(hv);
2321 * Now store each item recursively.
2323 * If canonical is defined to some true value then store each
2324 * key/value pair in sorted order otherwise the order is random.
2325 * Canonical order is irrelevant when a deep clone operation is performed.
2327 * Fetch the value from perl only once per store() operation, and only
2332 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2333 (cxt->canonical < 0 && (cxt->canonical =
2334 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2337 * Storing in order, sorted by key.
2338 * Run through the hash, building up an array of keys in a
2339 * mortal array, sort the array and then run through the
2345 /*av_extend (av, len);*/
2347 TRACEME(("using canonical order"));
2349 for (i = 0; i < len; i++) {
2350 #ifdef HAS_RESTRICTED_HASHES
2351 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2353 HE *he = hv_iternext(hv);
2358 CROAK(("Hash %p inconsistent - expected %d keys, %dth is NULL", hv, len, i));
2359 key = hv_iterkeysv(he);
2360 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2365 for (i = 0; i < len; i++) {
2366 #ifdef HAS_RESTRICTED_HASHES
2367 int placeholders = (int)HvPLACEHOLDERS_get(hv);
2369 unsigned char flags = 0;
2373 SV *key = av_shift(av);
2374 /* This will fail if key is a placeholder.
2375 Track how many placeholders we have, and error if we
2377 HE *he = hv_fetch_ent(hv, key, 0, 0);
2381 if (!(val = HeVAL(he))) {
2382 /* Internal error, not I/O error */
2386 #ifdef HAS_RESTRICTED_HASHES
2387 /* Should be a placeholder. */
2388 if (placeholders-- < 0) {
2389 /* This should not happen - number of
2390 retrieves should be identical to
2391 number of placeholders. */
2394 /* Value is never needed, and PL_sv_undef is
2395 more space efficient to store. */
2398 ("Flags not 0 but %d", flags));
2399 flags = SHV_K_PLACEHOLDER;
2406 * Store value first.
2409 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2411 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2416 * Keys are written after values to make sure retrieval
2417 * can be optimal in terms of memory usage, where keys are
2418 * read into a fixed unique buffer called kbuf.
2419 * See retrieve_hash() for details.
2422 /* Implementation of restricted hashes isn't nicely
2424 if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
2425 flags |= SHV_K_LOCKED;
2428 keyval = SvPV(key, keylen_tmp);
2429 keylen = keylen_tmp;
2430 #ifdef HAS_UTF8_HASHES
2431 /* If you build without optimisation on pre 5.6
2432 then nothing spots that SvUTF8(key) is always 0,
2433 so the block isn't optimised away, at which point
2434 the linker dislikes the reference to
2437 const char *keysave = keyval;
2438 bool is_utf8 = TRUE;
2440 /* Just casting the &klen to (STRLEN) won't work
2441 well if STRLEN and I32 are of different widths.
2443 keyval = (char*)bytes_from_utf8((U8*)keyval,
2447 /* If we were able to downgrade here, then than
2448 means that we have a key which only had chars
2449 0-255, but was utf8 encoded. */
2451 if (keyval != keysave) {
2452 keylen = keylen_tmp;
2453 flags |= SHV_K_WASUTF8;
2455 /* keylen_tmp can't have changed, so no need
2456 to assign back to keylen. */
2457 flags |= SHV_K_UTF8;
2464 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2466 /* This is a workaround for a bug in 5.8.0
2467 that causes the HEK_WASUTF8 flag to be
2468 set on an HEK without the hash being
2469 marked as having key flags. We just
2470 cross our fingers and drop the flag.
2472 assert (flags == 0 || flags == SHV_K_WASUTF8);
2473 TRACEME(("(#%d) key '%s'", i, keyval));
2477 WRITE(keyval, keylen);
2478 if (flags & SHV_K_WASUTF8)
2483 * Free up the temporary array
2492 * Storing in "random" order (in the order the keys are stored
2493 * within the hash). This is the default and will be faster!
2496 for (i = 0; i < len; i++) {
2499 unsigned char flags;
2500 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2501 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2503 HE *he = hv_iternext(hv);
2505 SV *val = (he ? hv_iterval(hv, he) : 0);
2510 return 1; /* Internal error, not I/O error */
2512 /* Implementation of restricted hashes isn't nicely
2515 = (((hash_flags & SHV_RESTRICTED)
2517 ? SHV_K_LOCKED : 0);
2519 if (val == &PL_sv_placeholder) {
2520 flags |= SHV_K_PLACEHOLDER;
2525 * Store value first.
2528 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2530 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2534 hek = HeKEY_hek(he);
2536 if (len == HEf_SVKEY) {
2537 /* This is somewhat sick, but the internal APIs are
2538 * such that XS code could put one of these in in
2540 * Maybe we should be capable of storing one if
2543 key_sv = HeKEY_sv(he);
2544 flags |= SHV_K_ISSV;
2546 /* Regular string key. */
2547 #ifdef HAS_HASH_KEY_FLAGS
2549 flags |= SHV_K_UTF8;
2550 if (HEK_WASUTF8(hek))
2551 flags |= SHV_K_WASUTF8;
2557 * Keys are written after values to make sure retrieval
2558 * can be optimal in terms of memory usage, where keys are
2559 * read into a fixed unique buffer called kbuf.
2560 * See retrieve_hash() for details.
2565 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2567 /* This is a workaround for a bug in 5.8.0
2568 that causes the HEK_WASUTF8 flag to be
2569 set on an HEK without the hash being
2570 marked as having key flags. We just
2571 cross our fingers and drop the flag.
2573 assert (flags == 0 || flags == SHV_K_WASUTF8);
2574 TRACEME(("(#%d) key '%s'", i, key));
2576 if (flags & SHV_K_ISSV) {
2577 store(aTHX_ cxt, key_sv);
2586 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2589 HvRITER_set(hv, riter); /* Restore hash iterator state */
2590 HvEITER_set(hv, eiter);
2598 * Store a code reference.
2600 * Layout is SX_CODE <length> followed by a scalar containing the perl
2601 * source code of the code reference.
2603 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2605 #if PERL_VERSION < 6
2607 * retrieve_code does not work with perl 5.005 or less
2609 return store_other(aTHX_ cxt, (SV*)cv);
2614 SV *text, *bdeparse;
2616 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2619 cxt->deparse == 0 ||
2620 (cxt->deparse < 0 && !(cxt->deparse =
2621 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2623 return store_other(aTHX_ cxt, (SV*)cv);
2627 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2628 * blessed code references.
2630 /* Ownership of both SVs is passed to load_module, which frees them. */
2631 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2638 * create the B::Deparse object
2642 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2644 count = call_method("new", G_SCALAR);
2647 CROAK(("Unexpected return value from B::Deparse::new\n"));
2651 * call the coderef2text method
2655 XPUSHs(bdeparse); /* XXX is this already mortal? */
2656 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2658 count = call_method("coderef2text", G_SCALAR);
2661 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2665 reallen = strlen(SvPV_nolen(text));
2668 * Empty code references or XS functions are deparsed as
2669 * "(prototype) ;" or ";".
2672 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2673 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2677 * Signal code by emitting SX_CODE.
2681 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2682 TRACEME(("size = %d", len));
2683 TRACEME(("code = %s", SvPV_nolen(text)));
2686 * Now store the source code.
2689 STORE_SCALAR(SvPV_nolen(text), len);
2694 TRACEME(("ok (code)"));
2703 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2704 * a special mark, followed by the underlying tied object. For instance, when
2705 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2706 * <hash object> stands for the serialization of the tied hash.
2708 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2713 int svt = SvTYPE(sv);
2716 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2719 * We have a small run-time penalty here because we chose to factorise
2720 * all tieds objects into the same routine, and not have a store_tied_hash,
2721 * a store_tied_array, etc...
2723 * Don't use a switch() statement, as most compilers don't optimize that
2724 * well for 2/3 values. An if() else if() cascade is just fine. We put
2725 * tied hashes first, as they are the most likely beasts.
2728 if (svt == SVt_PVHV) {
2729 TRACEME(("tied hash"));
2730 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2731 } else if (svt == SVt_PVAV) {
2732 TRACEME(("tied array"));
2733 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2735 TRACEME(("tied scalar"));
2736 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2740 if (!(mg = mg_find(sv, mtype)))
2741 CROAK(("No magic '%c' found while storing tied %s", mtype,
2742 (svt == SVt_PVHV) ? "hash" :
2743 (svt == SVt_PVAV) ? "array" : "scalar"));
2746 * The mg->mg_obj found by mg_find() above actually points to the
2747 * underlying tied Perl object implementation. For instance, if the
2748 * original SV was that of a tied array, then mg->mg_obj is an AV.
2750 * Note that we store the Perl object as-is. We don't call its FETCH
2751 * method along the way. At retrieval time, we won't call its STORE
2752 * method either, but the tieing magic will be re-installed. In itself,
2753 * that ensures that the tieing semantics are preserved since futher
2754 * accesses on the retrieved object will indeed call the magic methods...
2757 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2758 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2759 if ((ret = store(aTHX_ cxt, obj)))
2762 TRACEME(("ok (tied)"));
2770 * Stores a reference to an item within a tied structure:
2772 * . \$h{key}, stores both the (tied %h) object and 'key'.
2773 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2775 * Layout is therefore either:
2776 * SX_TIED_KEY <object> <key>
2777 * SX_TIED_IDX <object> <index>
2779 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2784 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2786 if (!(mg = mg_find(sv, 'p')))
2787 CROAK(("No magic 'p' found while storing reference to tied item"));
2790 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2794 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2795 PUTMARK(SX_TIED_KEY);
2796 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2798 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2801 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2803 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2806 I32 idx = mg->mg_len;
2808 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2809 PUTMARK(SX_TIED_IDX);
2810 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2812 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2815 TRACEME(("store_tied_item: storing IDX %d", idx));
2820 TRACEME(("ok (tied item)"));
2826 * store_hook -- dispatched manually, not via sv_store[]
2828 * The blessed SV is serialized by a hook.
2832 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2834 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2835 * the trailing part [] is present, the type of object (scalar, array or hash).
2836 * There is also a bit which says how the classname is stored between:
2841 * and when the <index> form is used (classname already seen), the "large
2842 * classname" bit in <flags> indicates how large the <index> is.
2844 * The serialized string returned by the hook is of length <len2> and comes
2845 * next. It is an opaque string for us.
2847 * Those <len3> object IDs which are listed last represent the extra references
2848 * not directly serialized by the hook, but which are linked to the object.
2850 * When recursion is mandated to resolve object-IDs not yet seen, we have
2851 * instead, with <header> being flags with bits set to indicate the object type
2852 * and that recursion was indeed needed:
2854 * SX_HOOK <header> <object> <header> <object> <flags>
2856 * that same header being repeated between serialized objects obtained through
2857 * recursion, until we reach flags indicating no recursion, at which point
2858 * we know we've resynchronized with a single layout, after <flags>.
2860 * When storing a blessed ref to a tied variable, the following format is
2863 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2865 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2866 * real object type is held in the <extra> flag. At the very end of the
2867 * serialization stream, the underlying magic object is serialized, just like
2868 * any other tied variable.
2870 static int store_hook(
2884 int count; /* really len3 + 1 */
2885 unsigned char flags;
2888 int recursed = 0; /* counts recursion */
2889 int obj_type; /* object type, on 2 bits */
2892 int clone = cxt->optype & ST_CLONE;
2893 char mtype = '\0'; /* for blessed ref to tied structures */
2894 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2896 TRACEME(("store_hook, classname \"%s\", tagged #%d", HvNAME_get(pkg), cxt->tagnum));
2899 * Determine object type on 2 bits.
2904 obj_type = SHT_SCALAR;
2907 obj_type = SHT_ARRAY;
2910 obj_type = SHT_HASH;
2914 * Produced by a blessed ref to a tied data structure, $o in the
2915 * following Perl code.
2919 * my $o = bless \%h, 'BAR';
2921 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2922 * (since we have only 2 bits in <flags> to store the type), and an
2923 * <extra> byte flag will be emitted after the FIRST <flags> in the
2924 * stream, carrying what we put in `eflags'.
2926 obj_type = SHT_EXTRA;
2927 switch (SvTYPE(sv)) {
2929 eflags = (unsigned char) SHT_THASH;
2933 eflags = (unsigned char) SHT_TARRAY;
2937 eflags = (unsigned char) SHT_TSCALAR;
2943 CROAK(("Unexpected object type (%d) in store_hook()", type));
2945 flags = SHF_NEED_RECURSE | obj_type;
2947 classname = HvNAME_get(pkg);
2948 len = strlen(classname);
2951 * To call the hook, we need to fake a call like:
2953 * $object->STORABLE_freeze($cloning);
2955 * but we don't have the $object here. For instance, if $object is
2956 * a blessed array, what we have in `sv' is the array, and we can't
2957 * call a method on those.
2959 * Therefore, we need to create a temporary reference to the object and
2960 * make the call on that reference.
2963 TRACEME(("about to call STORABLE_freeze on class %s", classname));
2965 ref = newRV_noinc(sv); /* Temporary reference */
2966 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2967 SvRV_set(ref, NULL);
2968 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2970 count = AvFILLp(av) + 1;
2971 TRACEME(("store_hook, array holds %d items", count));
2974 * If they return an empty list, it means they wish to ignore the
2975 * hook for this class (and not just this instance -- that's for them
2976 * to handle if they so wish).
2978 * Simply disable the cached entry for the hook (it won't be recomputed
2979 * since it's present in the cache) and recurse to store_blessed().
2984 * They must not change their mind in the middle of a serialization.
2987 if (hv_fetch(cxt->hclass, classname, len, FALSE))
2988 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2989 (cxt->optype & ST_CLONE) ? "cloning" : "storing", classname));
2991 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
2993 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2994 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", classname));
2996 return store_blessed(aTHX_ cxt, sv, type, pkg);
3000 * Get frozen string.
3004 pv = SvPV(ary[0], len2);
3005 /* We can't use pkg_can here because it only caches one method per
3008 GV* gv = gv_fetchmethod_autoload(pkg, "STORABLE_attach", FALSE);
3009 if (gv && isGV(gv)) {
3011 CROAK(("Freeze cannot return references if %s class is using STORABLE_attach", classname));
3017 * If they returned more than one item, we need to serialize some
3018 * extra references if not already done.
3020 * Loop over the array, starting at position #1, and for each item,
3021 * ensure it is a reference, serialize it if not already done, and
3022 * replace the entry with the tag ID of the corresponding serialized
3025 * We CHEAT by not calling av_fetch() and read directly within the
3029 for (i = 1; i < count; i++) {
3030 #ifdef USE_PTR_TABLE
3038 AV *av_hook = cxt->hook_seen;
3041 CROAK(("Item #%d returned by STORABLE_freeze "
3042 "for %s is not a reference", i, classname));
3043 xsv = SvRV(rsv); /* Follow ref to know what to look for */
3046 * Look in hseen and see if we have a tag already.
3047 * Serialize entry if not done already, and get its tag.
3050 #ifdef USE_PTR_TABLE
3051 /* Fakery needed because ptr_table_fetch returns zero for a
3052 failure, whereas the existing code assumes that it can
3053 safely store a tag zero. So for ptr_tables we store tag+1
3055 if ((fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv)))
3056 goto sv_seen; /* Avoid moving code too far to the right */
3058 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
3059 goto sv_seen; /* Avoid moving code too far to the right */
3062 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
3065 * We need to recurse to store that object and get it to be known
3066 * so that we can resolve the list of object-IDs at retrieve time.
3068 * The first time we do this, we need to emit the proper header
3069 * indicating that we recursed, and what the type of object is (the
3070 * object we're storing via a user-hook). Indeed, during retrieval,
3071 * we'll have to create the object before recursing to retrieve the
3072 * others, in case those would point back at that object.
3075 /* [SX_HOOK] <flags> [<extra>] <object>*/
3079 if (obj_type == SHT_EXTRA)
3084 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
3087 #ifdef USE_PTR_TABLE
3088 fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv);
3090 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3092 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
3094 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3097 * It was the first time we serialized `xsv'.
3099 * Keep this SV alive until the end of the serialization: if we
3100 * disposed of it right now by decrementing its refcount, and it was
3101 * a temporary value, some next temporary value allocated during
3102 * another STORABLE_freeze might take its place, and we'd wrongly
3103 * assume that new SV was already serialized, based on its presence
3106 * Therefore, push it away in cxt->hook_seen.
3109 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
3113 * Dispose of the REF they returned. If we saved the `xsv' away
3114 * in the array of returned SVs, that will not cause the underlying
3115 * referenced SV to be reclaimed.
3118 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
3119 SvREFCNT_dec(rsv); /* Dispose of reference */
3122 * Replace entry with its tag (not a real SV, so no refcnt increment)
3125 #ifdef USE_PTR_TABLE
3126 tag = (SV *)--fake_tag;
3131 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
3132 i-1, PTR2UV(xsv), PTR2UV(tag)));
3136 * Allocate a class ID if not already done.
3138 * This needs to be done after the recursion above, since at retrieval
3139 * time, we'll see the inner objects first. Many thanks to
3140 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
3141 * proposed the right fix. -- RAM, 15/09/2000
3145 if (!known_class(aTHX_ cxt, classname, len, &classnum)) {
3146 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3147 classnum = -1; /* Mark: we must store classname */
3149 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3153 * Compute leading flags.
3157 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3158 flags |= SHF_LARGE_CLASSLEN;
3160 flags |= SHF_IDX_CLASSNAME;
3161 if (len2 > LG_SCALAR)
3162 flags |= SHF_LARGE_STRLEN;
3164 flags |= SHF_HAS_LIST;
3165 if (count > (LG_SCALAR + 1))
3166 flags |= SHF_LARGE_LISTLEN;
3169 * We're ready to emit either serialized form:
3171 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3172 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3174 * If we recursed, the SX_HOOK has already been emitted.
3177 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3178 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3179 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3181 /* SX_HOOK <flags> [<extra>] */
3185 if (obj_type == SHT_EXTRA)
3190 /* <len> <classname> or <index> */
3191 if (flags & SHF_IDX_CLASSNAME) {
3192 if (flags & SHF_LARGE_CLASSLEN)
3195 unsigned char cnum = (unsigned char) classnum;
3199 if (flags & SHF_LARGE_CLASSLEN)
3202 unsigned char clen = (unsigned char) len;
3205 WRITE(classname, len); /* Final \0 is omitted */
3208 /* <len2> <frozen-str> */
3209 if (flags & SHF_LARGE_STRLEN) {
3210 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3211 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3213 unsigned char clen = (unsigned char) len2;
3217 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3219 /* [<len3> <object-IDs>] */
3220 if (flags & SHF_HAS_LIST) {
3221 int len3 = count - 1;
3222 if (flags & SHF_LARGE_LISTLEN)
3225 unsigned char clen = (unsigned char) len3;
3230 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3231 * real pointer, rather a tag number, well under the 32-bit limit.
3234 for (i = 1; i < count; i++) {
3235 I32 tagval = htonl(LOW_32BITS(ary[i]));
3237 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3242 * Free the array. We need extra care for indices after 0, since they
3243 * don't hold real SVs but integers cast.
3247 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3252 * If object was tied, need to insert serialization of the magic object.
3255 if (obj_type == SHT_EXTRA) {
3258 if (!(mg = mg_find(sv, mtype))) {
3259 int svt = SvTYPE(sv);
3260 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3261 mtype, (svt == SVt_PVHV) ? "hash" :
3262 (svt == SVt_PVAV) ? "array" : "scalar"));
3265 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3266 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3272 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3280 * store_blessed -- dispatched manually, not via sv_store[]
3282 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3283 * of its ancestors. If there is, then redispatch to store_hook();
3285 * Otherwise, the blessed SV is stored using the following layout:
3287 * SX_BLESS <flag> <len> <classname> <object>
3289 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3290 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3291 * Otherwise, the low order bits give the length, thereby giving a compact
3292 * representation for class names less than 127 chars long.
3294 * Each <classname> seen is remembered and indexed, so that the next time
3295 * an object in the blessed in the same <classname> is stored, the following
3298 * SX_IX_BLESS <flag> <index> <object>
3300 * where <index> is the classname index, stored on 0 or 4 bytes depending
3301 * on the high-order bit in flag (same encoding as above for <len>).
3303 static int store_blessed(
3315 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME_get(pkg)));
3318 * Look for a hook for this blessed SV and redirect to store_hook()
3322 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3324 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3327 * This is a blessed SV without any serialization hook.
3330 classname = HvNAME_get(pkg);
3331 len = strlen(classname);
3333 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3334 PTR2UV(sv), classname, cxt->tagnum));
3337 * Determine whether it is the first time we see that class name (in which
3338 * case it will be stored in the SX_BLESS form), or whether we already
3339 * saw that class name before (in which case the SX_IX_BLESS form will be
3343 if (known_class(aTHX_ cxt, classname, len, &classnum)) {
3344 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3345 PUTMARK(SX_IX_BLESS);
3346 if (classnum <= LG_BLESS) {
3347 unsigned char cnum = (unsigned char) classnum;
3350 unsigned char flag = (unsigned char) 0x80;
3355 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3357 if (len <= LG_BLESS) {
3358 unsigned char clen = (unsigned char) len;
3361 unsigned char flag = (unsigned char) 0x80;
3363 WLEN(len); /* Don't BER-encode, this should be rare */
3365 WRITE(classname, len); /* Final \0 is omitted */
3369 * Now emit the <object> part.
3372 return SV_STORE(type)(aTHX_ cxt, sv);
3378 * We don't know how to store the item we reached, so return an error condition.
3379 * (it's probably a GLOB, some CODE reference, etc...)
3381 * If they defined the `forgive_me' variable at the Perl level to some
3382 * true value, then don't croak, just warn, and store a placeholder string
3385 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3390 TRACEME(("store_other"));
3393 * Fetch the value from perl only once per store() operation.
3397 cxt->forgive_me == 0 ||
3398 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3399 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3401 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3403 warn("Can't store item %s(0x%"UVxf")",
3404 sv_reftype(sv, FALSE), PTR2UV(sv));
3407 * Store placeholder string as a scalar instead...
3410 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3411 PTR2UV(sv), (char) 0);
3414 STORE_SCALAR(buf, len);
3415 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3421 *** Store driving routines
3427 * WARNING: partially duplicates Perl's sv_reftype for speed.
3429 * Returns the type of the SV, identified by an integer. That integer
3430 * may then be used to index the dynamic routine dispatch table.
3432 static int sv_type(pTHX_ SV *sv)
3434 switch (SvTYPE(sv)) {
3439 * No need to check for ROK, that can't be set here since there
3440 * is no field capable of hodling the xrv_rv reference.
3448 * Starting from SVt_PV, it is possible to have the ROK flag
3449 * set, the pointer to the other SV being either stored in
3450 * the xrv_rv (in the case of a pure SVt_RV), or as the
3451 * xpv_pv field of an SVt_PV and its heirs.
3453 * However, those SV cannot be magical or they would be an
3454 * SVt_PVMG at least.
3456 return SvROK(sv) ? svis_REF : svis_SCALAR;
3458 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3459 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3460 return svis_TIED_ITEM;
3462 #if PERL_VERSION < 9
3465 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3467 return SvROK(sv) ? svis_REF : svis_SCALAR;
3469 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3473 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3478 #if PERL_VERSION > 8
3479 /* case SVt_BIND: */
3491 * Recursively store objects pointed to by the sv to the specified file.
3493 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3494 * object (one for which storage has started -- it may not be over if we have
3495 * a self-referenced structure). This data set forms a stored <object>.
3497 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3502 #ifdef USE_PTR_TABLE
3503 struct ptr_tbl *pseen = cxt->pseen;
3505 HV *hseen = cxt->hseen;
3508 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3511 * If object has already been stored, do not duplicate data.
3512 * Simply emit the SX_OBJECT marker followed by its tag data.
3513 * The tag is always written in network order.
3515 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3516 * real pointer, rather a tag number (watch the insertion code below).
3517 * That means it probably safe to assume it is well under the 32-bit limit,
3518 * and makes the truncation safe.
3519 * -- RAM, 14/09/1999
3522 #ifdef USE_PTR_TABLE
3523 svh = (SV **)ptr_table_fetch(pseen, sv);
3525 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3530 if (sv == &PL_sv_undef) {
3531 /* We have seen PL_sv_undef before, but fake it as
3534 Not the simplest solution to making restricted
3535 hashes work on 5.8.0, but it does mean that
3536 repeated references to the one true undef will
3537 take up less space in the output file.
3539 /* Need to jump past the next hv_store, because on the
3540 second store of undef the old hash value will be
3541 SvREFCNT_dec()ed, and as Storable cheats horribly
3542 by storing non-SVs in the hash a SEGV will ensure.
3543 Need to increase the tag number so that the
3544 receiver has no idea what games we're up to. This
3545 special casing doesn't affect hooks that store
3546 undef, as the hook routine does its own lookup into
3547 hseen. Also this means that any references back
3548 to PL_sv_undef (from the pathological case of hooks
3549 storing references to it) will find the seen hash
3550 entry for the first time, as if we didn't have this
3551 hackery here. (That hseen lookup works even on 5.8.0
3552 because it's a key of &PL_sv_undef and a value
3553 which is a tag number, not a value which is
3557 goto undef_special_case;
3560 #ifdef USE_PTR_TABLE
3561 tagval = htonl(LOW_32BITS(((char *)svh)-1));
3563 tagval = htonl(LOW_32BITS(*svh));
3566 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3574 * Allocate a new tag and associate it with the address of the sv being
3575 * stored, before recursing...
3577 * In order to avoid creating new SvIVs to hold the tagnum we just
3578 * cast the tagnum to an SV pointer and store that in the hash. This
3579 * means that we must clean up the hash manually afterwards, but gives
3580 * us a 15% throughput increase.
3585 #ifdef USE_PTR_TABLE
3586 ptr_table_store(pseen, sv, INT2PTR(SV*, 1 + cxt->tagnum));
3588 if (!hv_store(hseen,
3589 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3594 * Store `sv' and everything beneath it, using appropriate routine.
3595 * Abort immediately if we get a non-zero status back.
3598 type = sv_type(aTHX_ sv);
3601 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3602 PTR2UV(sv), cxt->tagnum, type));
3605 HV *pkg = SvSTASH(sv);
3606 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3608 ret = SV_STORE(type)(aTHX_ cxt, sv);
3610 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3611 ret ? "FAILED" : "ok", PTR2UV(sv),
3612 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3620 * Write magic number and system information into the file.
3621 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3622 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3623 * All size and lenghts are written as single characters here.
3625 * Note that no byte ordering info is emitted when <network> is true, since
3626 * integers will be emitted in network order in that case.
3628 static int magic_write(pTHX_ stcxt_t *cxt)
3631 * Starting with 0.6, the "use_network_order" byte flag is also used to
3632 * indicate the version number of the binary image, encoded in the upper
3633 * bits. The bit 0 is always used to indicate network order.
3636 * Starting with 0.7, a full byte is dedicated to the minor version of
3637 * the binary format, which is incremented only when new markers are
3638 * introduced, for instance, but when backward compatibility is preserved.
3641 /* Make these at compile time. The WRITE() macro is sufficiently complex
3642 that it saves about 200 bytes doing it this way and only using it
3644 static const unsigned char network_file_header[] = {
3646 (STORABLE_BIN_MAJOR << 1) | 1,
3647 STORABLE_BIN_WRITE_MINOR
3649 static const unsigned char file_header[] = {
3651 (STORABLE_BIN_MAJOR << 1) | 0,
3652 STORABLE_BIN_WRITE_MINOR,
3653 /* sizeof the array includes the 0 byte at the end: */
3654 (char) sizeof (byteorderstr) - 1,
3656 (unsigned char) sizeof(int),
3657 (unsigned char) sizeof(long),
3658 (unsigned char) sizeof(char *),
3659 (unsigned char) sizeof(NV)
3661 #ifdef USE_56_INTERWORK_KLUDGE
3662 static const unsigned char file_header_56[] = {
3664 (STORABLE_BIN_MAJOR << 1) | 0,
3665 STORABLE_BIN_WRITE_MINOR,
3666 /* sizeof the array includes the 0 byte at the end: */
3667 (char) sizeof (byteorderstr_56) - 1,
3669 (unsigned char) sizeof(int),
3670 (unsigned char) sizeof(long),
3671 (unsigned char) sizeof(char *),
3672 (unsigned char) sizeof(NV)
3675 const unsigned char *header;
3678 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3680 if (cxt->netorder) {
3681 header = network_file_header;
3682 length = sizeof (network_file_header);
3684 #ifdef USE_56_INTERWORK_KLUDGE
3685 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3686 header = file_header_56;
3687 length = sizeof (file_header_56);
3691 header = file_header;
3692 length = sizeof (file_header);
3697 /* sizeof the array includes the 0 byte at the end. */
3698 header += sizeof (magicstr) - 1;
3699 length -= sizeof (magicstr) - 1;
3702 WRITE( (unsigned char*) header, length);
3704 if (!cxt->netorder) {
3705 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3706 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3707 (int) sizeof(int), (int) sizeof(long),
3708 (int) sizeof(char *), (int) sizeof(NV)));
3716 * Common code for store operations.
3718 * When memory store is requested (f = NULL) and a non null SV* is given in
3719 * `res', it is filled with a new SV created out of the memory buffer.
3721 * It is required to provide a non-null `res' when the operation type is not
3722 * dclone() and store() is performed to memory.
3724 static int do_store(
3735 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3736 ("must supply result SV pointer for real recursion to memory"));
3738 TRACEME(("do_store (optype=%d, netorder=%d)",
3739 optype, network_order));
3744 * Workaround for CROAK leak: if they enter with a "dirty" context,
3745 * free up memory for them now.
3749 clean_context(aTHX_ cxt);
3752 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3753 * re-enter store() via the hooks. We need to stack contexts.
3757 cxt = allocate_context(aTHX_ cxt);
3761 ASSERT(cxt->entry == 1, ("starting new recursion"));
3762 ASSERT(!cxt->s_dirty, ("clean context"));
3765 * Ensure sv is actually a reference. From perl, we called something
3767 * pstore(aTHX_ FILE, \@array);
3768 * so we must get the scalar value behing that reference.
3772 CROAK(("Not a reference"));
3773 sv = SvRV(sv); /* So follow it to know what to store */
3776 * If we're going to store to memory, reset the buffer.
3783 * Prepare context and emit headers.
3786 init_store_context(aTHX_ cxt, f, optype, network_order);
3788 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3789 return 0; /* Error */
3792 * Recursively store object...
3795 ASSERT(is_storing(aTHX), ("within store operation"));
3797 status = store(aTHX_ cxt, sv); /* Just do it! */
3800 * If they asked for a memory store and they provided an SV pointer,
3801 * make an SV string out of the buffer and fill their pointer.
3803 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3804 * an SV, since context cleanup might free the buffer if we did recurse.
3805 * (unless caller is dclone(), which is aware of that).
3808 if (!cxt->fio && res)
3809 *res = mbuf2sv(aTHX);
3814 * The "root" context is never freed, since it is meant to be always
3815 * handy for the common case where no recursion occurs at all (i.e.
3816 * we enter store() outside of any Storable code and leave it, period).
3817 * We know it's the "root" context because there's nothing stacked
3822 * When deep cloning, we don't free the context: doing so would force
3823 * us to copy the data in the memory buffer. Sicne we know we're
3824 * about to enter do_retrieve...
3827 clean_store_context(aTHX_ cxt);
3828 if (cxt->prev && !(cxt->optype & ST_CLONE))
3829 free_context(aTHX_ cxt);
3831 TRACEME(("do_store returns %d", status));
3839 * Store the transitive data closure of given object to disk.
3840 * Returns 0 on error, a true value otherwise.
3842 static int pstore(pTHX_ PerlIO *f, SV *sv)
3844 TRACEME(("pstore"));
3845 return do_store(aTHX_ f, sv, 0, FALSE, (SV**) 0);
3852 * Same as pstore(), but network order is used for integers and doubles are
3853 * emitted as strings.
3855 static int net_pstore(pTHX_ PerlIO *f, SV *sv)
3857 TRACEME(("net_pstore"));
3858 return do_store(aTHX_ f, sv, 0, TRUE, (SV**) 0);
3868 * Build a new SV out of the content of the internal memory buffer.
3870 static SV *mbuf2sv(pTHX)
3874 return newSVpv(mbase, MBUF_SIZE());
3880 * Store the transitive data closure of given object to memory.
3881 * Returns undef on error, a scalar value containing the data otherwise.
3883 static SV *mstore(pTHX_ SV *sv)
3887 TRACEME(("mstore"));
3889 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, FALSE, &out))
3890 return &PL_sv_undef;
3898 * Same as mstore(), but network order is used for integers and doubles are
3899 * emitted as strings.
3901 static SV *net_mstore(pTHX_ SV *sv)
3905 TRACEME(("net_mstore"));
3907 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, TRUE, &out))
3908 return &PL_sv_undef;
3914 *** Specific retrieve callbacks.
3920 * Return an error via croak, since it is not possible that we get here
3921 * under normal conditions, when facing a file produced via pstore().
3923 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname)
3926 cxt->ver_major != STORABLE_BIN_MAJOR &&
3927 cxt->ver_minor != STORABLE_BIN_MINOR
3929 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3930 cxt->fio ? "file" : "string",
3931 cxt->ver_major, cxt->ver_minor,
3932 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3934 CROAK(("Corrupted storable %s (binary v%d.%d)",
3935 cxt->fio ? "file" : "string",
3936 cxt->ver_major, cxt->ver_minor));
3939 return (SV *) 0; /* Just in case */
3943 * retrieve_idx_blessed
3945 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3946 * <index> can be coded on either 1 or 5 bytes.
3948 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3951 const char *classname;
3955 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3956 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3958 GETMARK(idx); /* Index coded on a single char? */
3963 * Fetch classname in `aclass'
3966 sva = av_fetch(cxt->aclass, idx, FALSE);
3968 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3970 classname = SvPVX(*sva); /* We know it's a PV, by construction */
3972 TRACEME(("class ID %d => %s", idx, classname));
3975 * Retrieve object and bless it.
3978 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3986 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3987 * <len> can be coded on either 1 or 5 bytes.
3989 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3993 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3994 char *classname = buf;
3995 char *malloced_classname = NULL;
3997 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3998 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
4001 * Decode class name length and read that name.
4003 * Short classnames have two advantages: their length is stored on one
4004 * single byte, and the string can be read on the stack.
4007 GETMARK(len); /* Length coded on a single char? */
4010 TRACEME(("** allocating %d bytes for class name", len+1));
4011 New(10003, classname, len+1, char);
4012 malloced_classname = classname;
4014 SAFEPVREAD(classname, len, malloced_classname);
4015 classname[len] = '\0'; /* Mark string end */
4018 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
4021 TRACEME(("new class name \"%s\" will bear ID = %d", classname, cxt->classnum));
4023 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len))) {
4024 Safefree(malloced_classname);
4029 * Retrieve object and bless it.
4032 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
4033 if (malloced_classname)
4034 Safefree(malloced_classname);
4042 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
4043 * with leading mark already read, as usual.
4045 * When recursion was involved during serialization of the object, there
4046 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
4047 * we reach a <flags> marker with the recursion bit cleared.
4049 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
4050 * is held in the <extra> byte, and if the object is tied, the serialized
4051 * magic object comes at the very end:
4053 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
4055 * This means the STORABLE_thaw hook will NOT get a tied variable during its
4056 * processing (since we won't have seen the magic object by the time the hook
4057 * is called). See comments below for why it was done that way.
4059 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname)
4062 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
4063 char *classname = buf;
4074 int clone = cxt->optype & ST_CLONE;
4076 unsigned int extra_type = 0;
4078 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
4079 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
4082 * Read flags, which tell us about the type, and whether we need to recurse.
4088 * Create the (empty) object, and mark it as seen.
4090 * This must be done now, because tags are incremented, and during
4091 * serialization, the object tag was affected before recursion could
4095 obj_type = flags & SHF_TYPE_MASK;
4101 sv = (SV *) newAV();
4104 sv = (SV *) newHV();
4108 * Read <extra> flag to know the type of the object.
4109 * Record associated magic type for later.
4111 GETMARK(extra_type);
4112 switch (extra_type) {
4118 sv = (SV *) newAV();
4122 sv = (SV *) newHV();
4126 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4130 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4132 SEEN(sv, 0, 0); /* Don't bless yet */
4135 * Whilst flags tell us to recurse, do so.
4137 * We don't need to remember the addresses returned by retrieval, because
4138 * all the references will be obtained through indirection via the object
4139 * tags in the object-ID list.
4141 * We need to decrement the reference count for these objects
4142 * because, if the user doesn't save a reference to them in the hook,
4143 * they must be freed when this context is cleaned.
4146 while (flags & SHF_NEED_RECURSE) {
4147 TRACEME(("retrieve_hook recursing..."));
4148 rv = retrieve(aTHX_ cxt, 0);
4152 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
4157 if (flags & SHF_IDX_CLASSNAME) {
4162 * Fetch index from `aclass'
4165 if (flags & SHF_LARGE_CLASSLEN)
4170 sva = av_fetch(cxt->aclass, idx, FALSE);
4172 CROAK(("Class name #%"IVdf" should have been seen already",
4175 classname = SvPVX(*sva); /* We know it's a PV, by construction */
4176 TRACEME(("class ID %d => %s", idx, classname));
4180 * Decode class name length and read that name.
4182 * NOTA BENE: even if the length is stored on one byte, we don't read
4183 * on the stack. Just like retrieve_blessed(), we limit the name to
4184 * LG_BLESS bytes. This is an arbitrary decision.
4186 char *malloced_classname = NULL;
4188 if (flags & SHF_LARGE_CLASSLEN)
4193 if (len > LG_BLESS) {
4194 TRACEME(("** allocating %d bytes for class name", len+1));
4195 New(10003, classname, len+1, char);
4196 malloced_classname = classname;
4199 SAFEPVREAD(classname, len, malloced_classname);
4200 classname[len] = '\0'; /* Mark string end */
4203 * Record new classname.
4206 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len))) {
4207 Safefree(malloced_classname);
4212 TRACEME(("class name: %s", classname));
4215 * Decode user-frozen string length and read it in an SV.
4217 * For efficiency reasons, we read data directly into the SV buffer.
4218 * To understand that code, read retrieve_scalar()
4221 if (flags & SHF_LARGE_STRLEN)
4226 frozen = NEWSV(10002, len2);
4228 SAFEREAD(SvPVX(frozen), len2, frozen);
4229 SvCUR_set(frozen, len2);
4230 *SvEND(frozen) = '\0';
4232 (void) SvPOK_only(frozen); /* Validates string pointer */
4233 if (cxt->s_tainted) /* Is input source tainted? */
4236 TRACEME(("frozen string: %d bytes", len2));
4239 * Decode object-ID list length, if present.
4242 if (flags & SHF_HAS_LIST) {
4243 if (flags & SHF_LARGE_LISTLEN)
4249 av_extend(av, len3 + 1); /* Leave room for [0] */
4250 AvFILLp(av) = len3; /* About to be filled anyway */
4254 TRACEME(("has %d object IDs to link", len3));
4257 * Read object-ID list into array.
4258 * Because we pre-extended it, we can cheat and fill it manually.
4260 * We read object tags and we can convert them into SV* on the fly
4261 * because we know all the references listed in there (as tags)
4262 * have been already serialized, hence we have a valid correspondance
4263 * between each of those tags and the recreated SV.
4267 SV **ary = AvARRAY(av);
4269 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
4276 svh = av_fetch(cxt->aseen, tag, FALSE);
4278 if (tag == cxt->where_is_undef) {
4279 /* av_fetch uses PL_sv_undef internally, hence this
4280 somewhat gruesome hack. */
4284 CROAK(("Object #%"IVdf" should have been retrieved already",
4289 ary[i] = SvREFCNT_inc(xsv);
4294 * Bless the object and look up the STORABLE_thaw hook.
4297 BLESS(sv, classname);
4299 /* Handle attach case; again can't use pkg_can because it only
4300 * caches one method */
4301 attach = gv_fetchmethod_autoload(SvSTASH(sv), "STORABLE_attach", FALSE);
4302 if (attach && isGV(attach)) {
4304 SV* attach_hook = newRV((SV*) GvCV(attach));
4307 CROAK(("STORABLE_attach called with unexpected references"));
4311 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4312 rv = newSVpv(classname, 0);
4313 attached = scalar_call(aTHX_ rv, attach_hook, clone, av, G_SCALAR);
4316 sv_derived_from(attached, classname))
4317 return SvRV(attached);
4318 CROAK(("STORABLE_attach did not return a %s object", classname));
4321 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4324 * Hook not found. Maybe they did not require the module where this
4325 * hook is defined yet?
4327 * If the load below succeeds, we'll be able to find the hook.
4328 * Still, it only works reliably when each class is defined in a
4332 TRACEME(("No STORABLE_thaw defined for objects of class %s", classname));
4333 TRACEME(("Going to load module '%s'", classname));
4334 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(classname, 0), Nullsv);
4337 * We cache results of pkg_can, so we need to uncache before attempting
4341 pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4342 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4345 CROAK(("No STORABLE_thaw defined for objects of class %s "
4346 "(even after a \"require %s;\")", classname, classname));
4350 * If we don't have an `av' yet, prepare one.
4351 * Then insert the frozen string as item [0].
4359 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4364 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4366 * where $object is our blessed (empty) object, $cloning is a boolean
4367 * telling whether we're running a deep clone, $frozen is the frozen
4368 * string the user gave us in his serializing hook, and @refs, which may
4369 * be empty, is the list of extra references he returned along for us
4372 * In effect, the hook is an alternate creation routine for the class,
4373 * the object itself being already created by the runtime.
4376 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4377 classname, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4380 (void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
4387 SvREFCNT_dec(frozen);
4390 if (!(flags & SHF_IDX_CLASSNAME) && classname != buf)
4391 Safefree(classname);
4394 * If we had an <extra> type, then the object was not as simple, and
4395 * we need to restore extra magic now.
4401 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4403 rv = retrieve(aTHX_ cxt, 0); /* Retrieve <magic object> */
4405 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4406 PTR2UV(rv), PTR2UV(sv)));
4408 switch (extra_type) {
4410 sv_upgrade(sv, SVt_PVMG);
4413 sv_upgrade(sv, SVt_PVAV);
4414 AvREAL_off((AV *)sv);
4417 sv_upgrade(sv, SVt_PVHV);
4420 CROAK(("Forgot to deal with extra type %d", extra_type));
4425 * Adding the magic only now, well after the STORABLE_thaw hook was called
4426 * means the hook cannot know it deals with an object whose variable is
4427 * tied. But this is happening when retrieving $o in the following case:
4431 * my $o = bless \%h, 'BAR';
4433 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4434 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4435 * hash but a tied one should not matter at all, and remain transparent.
4436 * This means the magic must be restored by Storable AFTER the hook is
4439 * That looks very reasonable to me, but then I've come up with this
4440 * after a bug report from David Nesting, who was trying to store such
4441 * an object and caused Storable to fail. And unfortunately, it was
4442 * also the easiest way to retrofit support for blessed ref to tied objects
4443 * into the existing design. -- RAM, 17/02/2001
4446 sv_magic(sv, rv, mtype, Nullch, 0);
4447 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4455 * Retrieve reference to some other scalar.
4456 * Layout is SX_REF <object>, with SX_REF already read.
4458 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname)
4463 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4466 * We need to create the SV that holds the reference to the yet-to-retrieve
4467 * object now, so that we may record the address in the seen table.
4468 * Otherwise, if the object to retrieve references us, we won't be able
4469 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4470 * do the retrieve first and use rv = newRV(sv) since it will be too late
4471 * for SEEN() recording.
4474 rv = NEWSV(10002, 0);
4475 SEEN(rv, cname, 0); /* Will return if rv is null */
4476 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4478 return (SV *) 0; /* Failed */
4481 * WARNING: breaks RV encapsulation.
4483 * Now for the tricky part. We have to upgrade our existing SV, so that
4484 * it is now an RV on sv... Again, we cheat by duplicating the code
4485 * held in newSVrv(), since we already got our SV from retrieve().
4489 * SvRV(rv) = SvREFCNT_inc(sv);
4491 * here because the reference count we got from retrieve() above is
4492 * already correct: if the object was retrieved from the file, then
4493 * its reference count is one. Otherwise, if it was retrieved via
4494 * an SX_OBJECT indication, a ref count increment was done.
4498 /* No need to do anything, as rv will already be PVMG. */
4499 assert (SvTYPE(rv) >= SVt_RV);
4501 sv_upgrade(rv, SVt_RV);
4504 SvRV_set(rv, sv); /* $rv = \$sv */
4507 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4515 * Retrieve weak reference to some other scalar.
4516 * Layout is SX_WEAKREF <object>, with SX_WEAKREF already read.
4518 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname)
4522 TRACEME(("retrieve_weakref (#%d)", cxt->tagnum));
4524 sv = retrieve_ref(aTHX_ cxt, cname);
4536 * retrieve_overloaded
4538 * Retrieve reference to some other scalar with overloading.
4539 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4541 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname)
4547 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4550 * Same code as retrieve_ref(), duplicated to avoid extra call.
4553 rv = NEWSV(10002, 0);
4554 SEEN(rv, cname, 0); /* Will return if rv is null */
4555 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4557 return (SV *) 0; /* Failed */
4560 * WARNING: breaks RV encapsulation.
4563 sv_upgrade(rv, SVt_RV);
4564 SvRV_set(rv, sv); /* $rv = \$sv */
4568 * Restore overloading magic.
4571 stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
4573 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4574 ") (package <unknown>)",
4575 sv_reftype(sv, FALSE),
4578 if (!Gv_AMG(stash)) {
4579 const char *package = HvNAME_get(stash);
4580 TRACEME(("No overloading defined for package %s", package));
4581 TRACEME(("Going to load module '%s'", package));
4582 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(package, 0), Nullsv);
4583 if (!Gv_AMG(stash)) {
4584 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4585 ") (package %s) (even after a \"require %s;\")",
4586 sv_reftype(sv, FALSE),
4594 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4600 * retrieve_weakoverloaded
4602 * Retrieve weak overloaded reference to some other scalar.
4603 * Layout is SX_WEAKOVERLOADED <object>, with SX_WEAKOVERLOADED already read.
4605 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname)
4609 TRACEME(("retrieve_weakoverloaded (#%d)", cxt->tagnum));
4611 sv = retrieve_overloaded(aTHX_ cxt, cname);
4623 * retrieve_tied_array
4625 * Retrieve tied array
4626 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4628 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname)
4633 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4635 tv = NEWSV(10002, 0);
4636 SEEN(tv, cname, 0); /* Will return if tv is null */
4637 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4639 return (SV *) 0; /* Failed */
4641 sv_upgrade(tv, SVt_PVAV);
4642 AvREAL_off((AV *)tv);
4643 sv_magic(tv, sv, 'P', Nullch, 0);
4644 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4646 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4652 * retrieve_tied_hash
4654 * Retrieve tied hash
4655 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4657 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname)
4662 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4664 tv = NEWSV(10002, 0);
4665 SEEN(tv, cname, 0); /* Will return if tv is null */
4666 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4668 return (SV *) 0; /* Failed */
4670 sv_upgrade(tv, SVt_PVHV);
4671 sv_magic(tv, sv, 'P', Nullch, 0);
4672 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4674 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4680 * retrieve_tied_scalar
4682 * Retrieve tied scalar
4683 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4685 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4688 SV *sv, *obj = NULL;
4690 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4692 tv = NEWSV(10002, 0);
4693 SEEN(tv, cname, 0); /* Will return if rv is null */
4694 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4696 return (SV *) 0; /* Failed */
4698 else if (SvTYPE(sv) != SVt_NULL) {
4702 sv_upgrade(tv, SVt_PVMG);
4703 sv_magic(tv, obj, 'q', Nullch, 0);
4706 /* Undo refcnt inc from sv_magic() */
4710 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4718 * Retrieve reference to value in a tied hash.
4719 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4721 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname)
4727 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4729 tv = NEWSV(10002, 0);
4730 SEEN(tv, cname, 0); /* Will return if tv is null */
4731 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4733 return (SV *) 0; /* Failed */
4735 key = retrieve(aTHX_ cxt, 0); /* Retrieve <key> */
4737 return (SV *) 0; /* Failed */
4739 sv_upgrade(tv, SVt_PVMG);
4740 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4741 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4742 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4750 * Retrieve reference to value in a tied array.
4751 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4753 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname)
4759 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4761 tv = NEWSV(10002, 0);
4762 SEEN(tv, cname, 0); /* Will return if tv is null */
4763 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4765 return (SV *) 0; /* Failed */
4767 RLEN(idx); /* Retrieve <idx> */
4769 sv_upgrade(tv, SVt_PVMG);
4770 sv_magic(tv, sv, 'p', Nullch, idx);
4771 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4780 * Retrieve defined long (string) scalar.
4782 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4783 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4784 * was not stored on a single byte.
4786 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname)
4792 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4795 * Allocate an empty scalar of the suitable length.
4798 sv = NEWSV(10002, len);
4799 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4802 sv_setpvn(sv, "", 0);
4807 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4809 * Now, for efficiency reasons, read data directly inside the SV buffer,
4810 * and perform the SV final settings directly by duplicating the final
4811 * work done by sv_setpv. Since we're going to allocate lots of scalars
4812 * this way, it's worth the hassle and risk.
4815 SAFEREAD(SvPVX(sv), len, sv);
4816 SvCUR_set(sv, len); /* Record C string length */
4817 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4818 (void) SvPOK_only(sv); /* Validate string pointer */
4819 if (cxt->s_tainted) /* Is input source tainted? */
4820 SvTAINT(sv); /* External data cannot be trusted */
4822 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4823 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4831 * Retrieve defined short (string) scalar.
4833 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4834 * The scalar is "short" so <length> is single byte. If it is 0, there
4835 * is no <data> section.
4837 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4843 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4846 * Allocate an empty scalar of the suitable length.
4849 sv = NEWSV(10002, len);
4850 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4853 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4858 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4859 * To make it defined with an empty length, upgrade it now...
4860 * Don't upgrade to a PV if the original type contains more
4861 * information than a scalar.
4863 if (SvTYPE(sv) <= SVt_PV) {
4864 sv_upgrade(sv, SVt_PV);
4867 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4868 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4871 * Now, for efficiency reasons, read data directly inside the SV buffer,
4872 * and perform the SV final settings directly by duplicating the final
4873 * work done by sv_setpv. Since we're going to allocate lots of scalars
4874 * this way, it's worth the hassle and risk.
4876 SAFEREAD(SvPVX(sv), len, sv);
4877 SvCUR_set(sv, len); /* Record C string length */
4878 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4879 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4882 (void) SvPOK_only(sv); /* Validate string pointer */
4883 if (cxt->s_tainted) /* Is input source tainted? */
4884 SvTAINT(sv); /* External data cannot be trusted */
4886 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4893 * Like retrieve_scalar(), but tag result as utf8.
4894 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4896 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname)
4900 TRACEME(("retrieve_utf8str"));
4902 sv = retrieve_scalar(aTHX_ cxt, cname);
4904 #ifdef HAS_UTF8_SCALARS
4907 if (cxt->use_bytes < 0)
4909 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4911 if (cxt->use_bytes == 0)
4922 * Like retrieve_lscalar(), but tag result as utf8.
4923 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4925 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname)
4929 TRACEME(("retrieve_lutf8str"));
4931 sv = retrieve_lscalar(aTHX_ cxt, cname);
4933 #ifdef HAS_UTF8_SCALARS
4936 if (cxt->use_bytes < 0)
4938 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4940 if (cxt->use_bytes == 0)
4950 * Retrieve defined integer.
4951 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4953 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname)
4958 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4960 READ(&iv, sizeof(iv));
4962 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4964 TRACEME(("integer %"IVdf, iv));
4965 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4973 * Retrieve defined integer in network order.
4974 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4976 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname)
4981 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4985 sv = newSViv((int) ntohl(iv));
4986 TRACEME(("network integer %d", (int) ntohl(iv)));
4989 TRACEME(("network integer (as-is) %d", iv));
4991 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4993 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
5001 * Retrieve defined double.
5002 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
5004 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname)
5009 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
5011 READ(&nv, sizeof(nv));
5013 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5015 TRACEME(("double %"NVff, nv));
5016 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
5024 * Retrieve defined byte (small integer within the [-128, +127] range).
5025 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
5027 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname)
5031 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
5033 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
5036 TRACEME(("small integer read as %d", (unsigned char) siv));
5037 tmp = (unsigned char) siv - 128;
5039 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5041 TRACEME(("byte %d", tmp));
5042 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
5050 * Return the undefined value.
5052 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname)
5056 TRACEME(("retrieve_undef"));
5067 * Return the immortal undefined value.
5069 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname)
5071 SV *sv = &PL_sv_undef;
5073 TRACEME(("retrieve_sv_undef"));
5075 /* Special case PL_sv_undef, as av_fetch uses it internally to mark
5076 deleted elements, and will return NULL (fetch failed) whenever it
5078 if (cxt->where_is_undef == -1) {
5079 cxt->where_is_undef = cxt->tagnum;
5088 * Return the immortal yes value.
5090 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname)
5092 SV *sv = &PL_sv_yes;
5094 TRACEME(("retrieve_sv_yes"));
5103 * Return the immortal no value.
5105 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname)
5109 TRACEME(("retrieve_sv_no"));
5118 * Retrieve a whole array.
5119 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5120 * Each item is stored as <object>.
5122 * When we come here, SX_ARRAY has been read already.
5124 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5131 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
5134 * Read length, and allocate array, then pre-extend it.
5138 TRACEME(("size = %d", len));
5140 SEEN(av, cname, 0); /* Will return if array not allocated nicely */
5144 return (SV *) av; /* No data follow if array is empty */
5147 * Now get each item in turn...
5150 for (i = 0; i < len; i++) {
5151 TRACEME(("(#%d) item", i));
5152 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5155 if (av_store(av, i, sv) == 0)
5159 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5167 * Retrieve a whole hash table.
5168 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5169 * Keys are stored as <length> <data>, the <data> section being omitted
5171 * Values are stored as <object>.
5173 * When we come here, SX_HASH has been read already.
5175 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5183 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
5186 * Read length, allocate table.
5190 TRACEME(("size = %d", len));
5192 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5194 return (SV *) hv; /* No data follow if table empty */
5195 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5198 * Now get each key/value pair in turn...
5201 for (i = 0; i < len; i++) {
5206 TRACEME(("(#%d) value", i));
5207 sv = retrieve(aTHX_ cxt, 0);
5213 * Since we're reading into kbuf, we must ensure we're not
5214 * recursing between the read and the hv_store() where it's used.
5215 * Hence the key comes after the value.
5218 RLEN(size); /* Get key size */
5219 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5222 kbuf[size] = '\0'; /* Mark string end, just in case */
5223 TRACEME(("(#%d) key '%s'", i, kbuf));
5226 * Enter key/value pair into hash table.
5229 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5233 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5241 * Retrieve a whole hash table.
5242 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5243 * Keys are stored as <length> <data>, the <data> section being omitted
5245 * Values are stored as <object>.
5247 * When we come here, SX_HASH has been read already.
5249 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname)
5259 GETMARK(hash_flags);
5260 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
5262 * Read length, allocate table.
5265 #ifndef HAS_RESTRICTED_HASHES
5266 if (hash_flags & SHV_RESTRICTED) {
5267 if (cxt->derestrict < 0)
5269 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
5271 if (cxt->derestrict == 0)
5272 RESTRICTED_HASH_CROAK();
5277 TRACEME(("size = %d, flags = %d", len, hash_flags));
5279 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5281 return (SV *) hv; /* No data follow if table empty */
5282 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5285 * Now get each key/value pair in turn...
5288 for (i = 0; i < len; i++) {
5290 int store_flags = 0;
5295 TRACEME(("(#%d) value", i));
5296 sv = retrieve(aTHX_ cxt, 0);
5301 #ifdef HAS_RESTRICTED_HASHES
5302 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
5306 if (flags & SHV_K_ISSV) {
5307 /* XXX you can't set a placeholder with an SV key.
5308 Then again, you can't get an SV key.
5309 Without messing around beyond what the API is supposed to do.
5312 TRACEME(("(#%d) keysv, flags=%d", i, flags));
5313 keysv = retrieve(aTHX_ cxt, 0);
5317 if (!hv_store_ent(hv, keysv, sv, 0))
5322 * Since we're reading into kbuf, we must ensure we're not
5323 * recursing between the read and the hv_store() where it's used.
5324 * Hence the key comes after the value.
5327 if (flags & SHV_K_PLACEHOLDER) {
5329 sv = &PL_sv_placeholder;
5330 store_flags |= HVhek_PLACEHOLD;
5332 if (flags & SHV_K_UTF8) {
5333 #ifdef HAS_UTF8_HASHES
5334 store_flags |= HVhek_UTF8;
5336 if (cxt->use_bytes < 0)
5338 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
5340 if (cxt->use_bytes == 0)
5344 #ifdef HAS_UTF8_HASHES
5345 if (flags & SHV_K_WASUTF8)
5346 store_flags |= HVhek_WASUTF8;
5349 RLEN(size); /* Get key size */
5350 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5353 kbuf[size] = '\0'; /* Mark string end, just in case */
5354 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5355 flags, store_flags));
5358 * Enter key/value pair into hash table.
5361 #ifdef HAS_RESTRICTED_HASHES
5362 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5365 if (!(store_flags & HVhek_PLACEHOLD))
5366 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5371 #ifdef HAS_RESTRICTED_HASHES
5372 if (hash_flags & SHV_RESTRICTED)
5376 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5384 * Return a code reference.
5386 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname)
5388 #if PERL_VERSION < 6
5389 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5392 int type, count, tagnum;
5394 SV *sv, *text, *sub;
5396 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5399 * Insert dummy SV in the aseen array so that we don't screw
5400 * up the tag numbers. We would just make the internal
5401 * scalar an untagged item in the stream, but
5402 * retrieve_scalar() calls SEEN(). So we just increase the
5405 tagnum = cxt->tagnum;
5410 * Retrieve the source of the code reference
5411 * as a small or large scalar
5417 text = retrieve_scalar(aTHX_ cxt, cname);
5420 text = retrieve_lscalar(aTHX_ cxt, cname);
5423 CROAK(("Unexpected type %d in retrieve_code\n", type));
5427 * prepend "sub " to the source
5430 sub = newSVpvn("sub ", 4);
5431 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5435 * evaluate the source to a code reference and use the CV value
5438 if (cxt->eval == NULL) {
5439 cxt->eval = perl_get_sv("Storable::Eval", TRUE);
5440 SvREFCNT_inc(cxt->eval);
5442 if (!SvTRUE(cxt->eval)) {
5444 cxt->forgive_me == 0 ||
5445 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5446 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
5448 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5451 /* fix up the dummy entry... */
5452 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5460 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5461 SV* errsv = get_sv("@", TRUE);
5462 sv_setpvn(errsv, "", 0); /* clear $@ */
5464 XPUSHs(sv_2mortal(newSVsv(sub)));
5466 count = call_sv(cxt->eval, G_SCALAR);
5469 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5471 if (SvTRUE(errsv)) {
5472 CROAK(("code %s caused an error: %s",
5473 SvPV_nolen(sub), SvPV_nolen(errsv)));
5477 cv = eval_pv(SvPV_nolen(sub), TRUE);
5479 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5482 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5485 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5490 /* fix up the dummy entry... */
5491 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5498 * old_retrieve_array
5500 * Retrieve a whole array in pre-0.6 binary format.
5502 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5503 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5505 * When we come here, SX_ARRAY has been read already.
5507 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5515 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5518 * Read length, and allocate array, then pre-extend it.
5522 TRACEME(("size = %d", len));
5524 SEEN(av, 0, 0); /* Will return if array not allocated nicely */
5528 return (SV *) av; /* No data follow if array is empty */
5531 * Now get each item in turn...
5534 for (i = 0; i < len; i++) {
5536 if (c == SX_IT_UNDEF) {
5537 TRACEME(("(#%d) undef item", i));
5538 continue; /* av_extend() already filled us with undef */
5541 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5542 TRACEME(("(#%d) item", i));
5543 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5546 if (av_store(av, i, sv) == 0)
5550 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5558 * Retrieve a whole hash table in pre-0.6 binary format.
5560 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5561 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5563 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5565 * When we come here, SX_HASH has been read already.
5567 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5575 SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5577 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5580 * Read length, allocate table.
5584 TRACEME(("size = %d", len));
5586 SEEN(hv, 0, 0); /* Will return if table not allocated properly */
5588 return (SV *) hv; /* No data follow if table empty */
5589 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5592 * Now get each key/value pair in turn...
5595 for (i = 0; i < len; i++) {
5601 if (c == SX_VL_UNDEF) {
5602 TRACEME(("(#%d) undef value", i));
5604 * Due to a bug in hv_store(), it's not possible to pass
5605 * &PL_sv_undef to hv_store() as a value, otherwise the
5606 * associated key will not be creatable any more. -- RAM, 14/01/97
5609 sv_h_undef = newSVsv(&PL_sv_undef);
5610 sv = SvREFCNT_inc(sv_h_undef);
5611 } else if (c == SX_VALUE) {
5612 TRACEME(("(#%d) value", i));
5613 sv = retrieve(aTHX_ cxt, 0);
5617 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5621 * Since we're reading into kbuf, we must ensure we're not
5622 * recursing between the read and the hv_store() where it's used.
5623 * Hence the key comes after the value.
5628 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5629 RLEN(size); /* Get key size */
5630 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5633 kbuf[size] = '\0'; /* Mark string end, just in case */
5634 TRACEME(("(#%d) key '%s'", i, kbuf));
5637 * Enter key/value pair into hash table.
5640 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5644 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5650 *** Retrieval engine.
5656 * Make sure the stored data we're trying to retrieve has been produced
5657 * on an ILP compatible system with the same byteorder. It croaks out in
5658 * case an error is detected. [ILP = integer-long-pointer sizes]
5659 * Returns null if error is detected, &PL_sv_undef otherwise.
5661 * Note that there's no byte ordering info emitted when network order was
5662 * used at store time.
5664 static SV *magic_check(pTHX_ stcxt_t *cxt)
5666 /* The worst case for a malicious header would be old magic (which is
5667 longer), major, minor, byteorder length byte of 255, 255 bytes of
5668 garbage, sizeof int, long, pointer, NV.
5669 So the worse of that we can read is 255 bytes of garbage plus 4.
5670 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5671 compiling perl on a system with chars that are larger than 8 bits.
5672 (Even Crays aren't *that* perverse).
5674 unsigned char buf[4 + 255];
5675 unsigned char *current;
5678 int use_network_order;
5682 int version_minor = 0;
5684 TRACEME(("magic_check"));
5687 * The "magic number" is only for files, not when freezing in memory.
5691 /* This includes the '\0' at the end. I want to read the extra byte,
5692 which is usually going to be the major version number. */
5693 STRLEN len = sizeof(magicstr);
5696 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5698 /* Point at the byte after the byte we read. */
5699 current = buf + --len; /* Do the -- outside of macros. */
5701 if (memNE(buf, magicstr, len)) {
5703 * Try to read more bytes to check for the old magic number, which
5707 TRACEME(("trying for old magic number"));
5709 old_len = sizeof(old_magicstr) - 1;
5710 READ(current + 1, (SSize_t)(old_len - len));
5712 if (memNE(buf, old_magicstr, old_len))
5713 CROAK(("File is not a perl storable"));
5715 current = buf + old_len;
5717 use_network_order = *current;
5719 GETMARK(use_network_order);
5722 * Starting with 0.6, the "use_network_order" byte flag is also used to
5723 * indicate the version number of the binary, and therefore governs the
5724 * setting of sv_retrieve_vtbl. See magic_write().
5726 if (old_magic && use_network_order > 1) {
5727 /* 0.1 dump - use_network_order is really byte order length */
5731 version_major = use_network_order >> 1;
5733 cxt->retrieve_vtbl = (SV*(**)(pTHX_ stcxt_t *cxt, const char *cname)) (version_major > 0 ? sv_retrieve : sv_old_retrieve);
5735 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5739 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5740 * minor version of the protocol. See magic_write().
5743 if (version_major > 1)
5744 GETMARK(version_minor);
5746 cxt->ver_major = version_major;
5747 cxt->ver_minor = version_minor;
5749 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5752 * Inter-operability sanity check: we can't retrieve something stored
5753 * using a format more recent than ours, because we have no way to
5754 * know what has changed, and letting retrieval go would mean a probable
5755 * failure reporting a "corrupted" storable file.
5759 version_major > STORABLE_BIN_MAJOR ||
5760 (version_major == STORABLE_BIN_MAJOR &&
5761 version_minor > STORABLE_BIN_MINOR)
5764 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5765 STORABLE_BIN_MINOR));
5767 if (version_major == STORABLE_BIN_MAJOR) {
5768 TRACEME(("cxt->accept_future_minor is %d",
5769 cxt->accept_future_minor));
5770 if (cxt->accept_future_minor < 0)
5771 cxt->accept_future_minor
5772 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5775 if (cxt->accept_future_minor == 1)
5776 croak_now = 0; /* Don't croak yet. */
5779 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5780 version_major, version_minor,
5781 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5786 * If they stored using network order, there's no byte ordering
5787 * information to check.
5790 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5791 return &PL_sv_undef; /* No byte ordering info */
5793 /* In C truth is 1, falsehood is 0. Very convienient. */
5794 use_NV_size = version_major >= 2 && version_minor >= 2;
5796 if (version_major >= 0) {
5800 c = use_network_order;
5802 length = c + 3 + use_NV_size;
5803 READ(buf, length); /* Not null-terminated */
5805 TRACEME(("byte order '%.*s' %d", c, buf, c));
5807 #ifdef USE_56_INTERWORK_KLUDGE
5808 /* No point in caching this in the context as we only need it once per
5809 retrieve, and we need to recheck it each read. */
5810 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5811 if ((c != (sizeof (byteorderstr_56) - 1))
5812 || memNE(buf, byteorderstr_56, c))
5813 CROAK(("Byte order is not compatible"));
5817 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5818 CROAK(("Byte order is not compatible"));
5824 if ((int) *current++ != sizeof(int))
5825 CROAK(("Integer size is not compatible"));
5828 if ((int) *current++ != sizeof(long))
5829 CROAK(("Long integer size is not compatible"));
5831 /* sizeof(char *) */
5832 if ((int) *current != sizeof(char *))
5833 CROAK(("Pointer size is not compatible"));
5837 if ((int) *++current != sizeof(NV))
5838 CROAK(("Double size is not compatible"));
5841 return &PL_sv_undef; /* OK */
5847 * Recursively retrieve objects from the specified file and return their
5848 * root SV (which may be an AV or an HV for what we care).
5849 * Returns null if there is a problem.
5851 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname)
5857 TRACEME(("retrieve"));
5860 * Grab address tag which identifies the object if we are retrieving
5861 * an older format. Since the new binary format counts objects and no
5862 * longer explicitely tags them, we must keep track of the correspondance
5865 * The following section will disappear one day when the old format is
5866 * no longer supported, hence the final "goto" in the "if" block.
5869 if (cxt->hseen) { /* Retrieving old binary */
5871 if (cxt->netorder) {
5873 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5874 tag = (stag_t) nettag;
5876 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5879 if (type == SX_OBJECT) {
5881 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5883 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5885 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5888 * The following code is common with the SX_OBJECT case below.
5891 svh = av_fetch(cxt->aseen, tagn, FALSE);
5893 CROAK(("Object #%"IVdf" should have been retrieved already",
5896 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5897 SvREFCNT_inc(sv); /* One more reference to this same sv */
5898 return sv; /* The SV pointer where object was retrieved */
5902 * Map new object, but don't increase tagnum. This will be done
5903 * by each of the retrieve_* functions when they call SEEN().
5905 * The mapping associates the "tag" initially present with a unique
5906 * tag number. See test for SX_OBJECT above to see how this is perused.
5909 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5910 newSViv(cxt->tagnum), 0))
5917 * Regular post-0.6 binary format.
5922 TRACEME(("retrieve type = %d", type));
5925 * Are we dealing with an object we should have already retrieved?
5928 if (type == SX_OBJECT) {
5932 svh = av_fetch(cxt->aseen, tag, FALSE);
5934 CROAK(("Object #%"IVdf" should have been retrieved already",
5937 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5938 SvREFCNT_inc(sv); /* One more reference to this same sv */
5939 return sv; /* The SV pointer where object was retrieved */
5940 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5941 if (cxt->accept_future_minor < 0)
5942 cxt->accept_future_minor
5943 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5946 if (cxt->accept_future_minor == 1) {
5947 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5948 "This Storable is v%d.%d and can only handle data types up to %d",
5949 cxt->ver_major, cxt->ver_minor, type,
5950 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5954 first_time: /* Will disappear when support for old format is dropped */
5957 * Okay, first time through for this one.
5960 sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
5962 return (SV *) 0; /* Failed */
5965 * Old binary formats (pre-0.7).
5967 * Final notifications, ended by SX_STORED may now follow.
5968 * Currently, the only pertinent notification to apply on the
5969 * freshly retrieved object is either:
5970 * SX_CLASS <char-len> <classname> for short classnames.
5971 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5972 * Class name is then read into the key buffer pool used by
5973 * hash table key retrieval.
5976 if (cxt->ver_major < 2) {
5977 while ((type = GETCHAR()) != SX_STORED) {
5981 GETMARK(len); /* Length coded on a single char */
5983 case SX_LG_CLASS: /* Length coded on a regular integer */
5988 return (SV *) 0; /* Failed */
5990 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5993 kbuf[len] = '\0'; /* Mark string end */
5998 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5999 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
6007 * Retrieve data held in file and return the root object.
6008 * Common routine for pretrieve and mretrieve.
6010 static SV *do_retrieve(
6018 int is_tainted; /* Is input source tainted? */
6019 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
6021 TRACEME(("do_retrieve (optype = 0x%x)", optype));
6023 optype |= ST_RETRIEVE;
6026 * Sanity assertions for retrieve dispatch tables.
6029 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
6030 ("old and new retrieve dispatch table have same size"));
6031 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
6032 ("SX_ERROR entry correctly initialized in old dispatch table"));
6033 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
6034 ("SX_ERROR entry correctly initialized in new dispatch table"));
6037 * Workaround for CROAK leak: if they enter with a "dirty" context,
6038 * free up memory for them now.
6042 clean_context(aTHX_ cxt);
6045 * Now that STORABLE_xxx hooks exist, it is possible that they try to
6046 * re-enter retrieve() via the hooks.
6050 cxt = allocate_context(aTHX_ cxt);
6054 ASSERT(cxt->entry == 1, ("starting new recursion"));
6055 ASSERT(!cxt->s_dirty, ("clean context"));
6060 * Data is loaded into the memory buffer when f is NULL, unless `in' is
6061 * also NULL, in which case we're expecting the data to already lie
6062 * in the buffer (dclone case).
6065 KBUFINIT(); /* Allocate hash key reading pool once */
6071 const char *orig = SvPV(in, length);
6073 /* This is quite deliberate. I want the UTF8 routines
6074 to encounter the '\0' which perl adds at the end
6075 of all scalars, so that any new string also has
6078 STRLEN klen_tmp = length + 1;
6079 bool is_utf8 = TRUE;
6081 /* Just casting the &klen to (STRLEN) won't work
6082 well if STRLEN and I32 are of different widths.
6084 asbytes = (char*)bytes_from_utf8((U8*)orig,
6088 CROAK(("Frozen string corrupt - contains characters outside 0-255"));
6090 if (asbytes != orig) {
6091 /* String has been converted.
6092 There is no need to keep any reference to
6094 in = sv_newmortal();
6095 /* We donate the SV the malloc()ed string
6096 bytes_from_utf8 returned us. */
6097 SvUPGRADE(in, SVt_PV);
6099 SvPV_set(in, asbytes);
6100 SvLEN_set(in, klen_tmp);
6101 SvCUR_set(in, klen_tmp - 1);
6105 MBUF_SAVE_AND_LOAD(in);
6109 * Magic number verifications.
6111 * This needs to be done before calling init_retrieve_context()
6112 * since the format indication in the file are necessary to conduct
6113 * some of the initializations.
6116 cxt->fio = f; /* Where I/O are performed */
6118 if (!magic_check(aTHX_ cxt))
6119 CROAK(("Magic number checking on storable %s failed",
6120 cxt->fio ? "file" : "string"));
6122 TRACEME(("data stored in %s format",
6123 cxt->netorder ? "net order" : "native"));
6126 * Check whether input source is tainted, so that we don't wrongly
6127 * taint perfectly good values...
6129 * We assume file input is always tainted. If both `f' and `in' are
6130 * NULL, then we come from dclone, and tainted is already filled in
6131 * the context. That's a kludge, but the whole dclone() thing is
6132 * already quite a kludge anyway! -- RAM, 15/09/2000.
6135 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
6136 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
6137 init_retrieve_context(aTHX_ cxt, optype, is_tainted);
6139 ASSERT(is_retrieving(aTHX), ("within retrieve operation"));
6141 sv = retrieve(aTHX_ cxt, 0); /* Recursively retrieve object, get root SV */
6150 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
6153 * The "root" context is never freed.
6156 clean_retrieve_context(aTHX_ cxt);
6157 if (cxt->prev) /* This context was stacked */
6158 free_context(aTHX_ cxt); /* It was not the "root" context */
6161 * Prepare returned value.
6165 TRACEME(("retrieve ERROR"));
6166 #if (PATCHLEVEL <= 4)
6167 /* perl 5.00405 seems to screw up at this point with an
6168 'attempt to modify a read only value' error reported in the
6169 eval { $self = pretrieve(*FILE) } in _retrieve.
6170 I can't see what the cause of this error is, but I suspect a
6171 bug in 5.004, as it seems to be capable of issuing spurious
6172 errors or core dumping with matches on $@. I'm not going to
6173 spend time on what could be a fruitless search for the cause,
6174 so here's a bodge. If you're running 5.004 and don't like
6175 this inefficiency, either upgrade to a newer perl, or you are
6176 welcome to find the problem and send in a patch.
6180 return &PL_sv_undef; /* Something went wrong, return undef */
6184 TRACEME(("retrieve got %s(0x%"UVxf")",
6185 sv_reftype(sv, FALSE), PTR2UV(sv)));
6188 * Backward compatibility with Storable-0.5@9 (which we know we
6189 * are retrieving if hseen is non-null): don't create an extra RV
6190 * for objects since we special-cased it at store time.
6192 * Build a reference to the SV returned by pretrieve even if it is
6193 * already one and not a scalar, for consistency reasons.
6196 if (pre_06_fmt) { /* Was not handling overloading by then */
6198 TRACEME(("fixing for old formats -- pre 0.6"));
6199 if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
6200 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
6206 * If reference is overloaded, restore behaviour.
6208 * NB: minor glitch here: normally, overloaded refs are stored specially
6209 * so that we can croak when behaviour cannot be re-installed, and also
6210 * avoid testing for overloading magic at each reference retrieval.
6212 * Unfortunately, the root reference is implicitely stored, so we must
6213 * check for possible overloading now. Furthermore, if we don't restore
6214 * overloading, we cannot croak as if the original ref was, because we
6215 * have no way to determine whether it was an overloaded ref or not in
6218 * It's a pity that overloading magic is attached to the rv, and not to
6219 * the underlying sv as blessing is.
6223 HV *stash = (HV *) SvSTASH(sv);
6224 SV *rv = newRV_noinc(sv);
6225 if (stash && Gv_AMG(stash)) {
6227 TRACEME(("restored overloading on root reference"));
6229 TRACEME(("ended do_retrieve() with an object"));
6233 TRACEME(("regular do_retrieve() end"));
6235 return newRV_noinc(sv);
6241 * Retrieve data held in file and return the root object, undef on error.
6243 static SV *pretrieve(pTHX_ PerlIO *f)
6245 TRACEME(("pretrieve"));
6246 return do_retrieve(aTHX_ f, Nullsv, 0);
6252 * Retrieve data held in scalar and return the root object, undef on error.
6254 static SV *mretrieve(pTHX_ SV *sv)
6256 TRACEME(("mretrieve"));
6257 return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
6267 * Deep clone: returns a fresh copy of the original referenced SV tree.
6269 * This is achieved by storing the object in memory and restoring from
6270 * there. Not that efficient, but it should be faster than doing it from
6273 static SV *dclone(pTHX_ SV *sv)
6277 stcxt_t *real_context;
6280 TRACEME(("dclone"));
6283 * Workaround for CROAK leak: if they enter with a "dirty" context,
6284 * free up memory for them now.
6288 clean_context(aTHX_ cxt);
6291 * Tied elements seem to need special handling.
6294 if ((SvTYPE(sv) == SVt_PVLV
6295 #if PERL_VERSION < 8
6296 || SvTYPE(sv) == SVt_PVMG
6298 ) && SvRMAGICAL(sv) && mg_find(sv, 'p')) {
6303 * do_store() optimizes for dclone by not freeing its context, should
6304 * we need to allocate one because we're deep cloning from a hook.
6307 if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
6308 return &PL_sv_undef; /* Error during store */
6311 * Because of the above optimization, we have to refresh the context,
6312 * since a new one could have been allocated and stacked by do_store().
6315 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
6316 cxt = real_context; /* And we need this temporary... */
6319 * Now, `cxt' may refer to a new context.
6322 ASSERT(!cxt->s_dirty, ("clean context"));
6323 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
6326 TRACEME(("dclone stored %d bytes", size));
6330 * Since we're passing do_retrieve() both a NULL file and sv, we need
6331 * to pre-compute the taintedness of the input by setting cxt->tainted
6332 * to whatever state our own input string was. -- RAM, 15/09/2000
6334 * do_retrieve() will free non-root context.
6337 cxt->s_tainted = SvTAINTED(sv);
6338 out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
6340 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
6350 * The Perl IO GV object distinguishes between input and output for sockets
6351 * but not for plain files. To allow Storable to transparently work on
6352 * plain files and sockets transparently, we have to ask xsubpp to fetch the
6353 * right object for us. Hence the OutputStream and InputStream declarations.
6355 * Before perl 5.004_05, those entries in the standard typemap are not
6356 * defined in perl include files, so we do that here.
6359 #ifndef OutputStream
6360 #define OutputStream PerlIO *
6361 #define InputStream PerlIO *
6362 #endif /* !OutputStream */
6364 MODULE = Storable PACKAGE = Storable::Cxt
6370 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
6374 if (!cxt->membuf_ro && mbase)
6376 if (cxt->membuf_ro && (cxt->msaved).arena)
6377 Safefree((cxt->msaved).arena);
6380 MODULE = Storable PACKAGE = Storable
6386 HV *stash = gv_stashpvn("Storable", 8, GV_ADD);
6387 newCONSTSUB(stash, "BIN_MAJOR", newSViv(STORABLE_BIN_MAJOR));
6388 newCONSTSUB(stash, "BIN_MINOR", newSViv(STORABLE_BIN_MINOR));
6389 newCONSTSUB(stash, "BIN_WRITE_MINOR", newSViv(STORABLE_BIN_WRITE_MINOR));
6391 init_perinterp(aTHX);
6392 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
6394 /* Only disable the used only once warning if we are in debugging mode. */
6395 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
6397 #ifdef USE_56_INTERWORK_KLUDGE
6398 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
6405 init_perinterp(aTHX);
6412 RETVAL = pstore(aTHX_ f, obj);
6421 RETVAL = net_pstore(aTHX_ f, obj);
6429 RETVAL = mstore(aTHX_ obj);
6437 RETVAL = net_mstore(aTHX_ obj);
6445 RETVAL = pretrieve(aTHX_ f);
6453 RETVAL = mretrieve(aTHX_ sv);
6461 RETVAL = dclone(aTHX_ sv);
6466 last_op_in_netorder()
6468 RETVAL = last_op_in_netorder(aTHX);
6475 RETVAL = is_storing(aTHX);
6482 RETVAL = is_retrieving(aTHX);