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 < 10 || (PERL_VERSION == 10 && PERL_SUBVERSION < 1)
21 #define NEED_load_module
22 #define NEED_vload_module
23 #define NEED_newCONSTSUB
24 #define NEED_newSVpvn_flags
25 #define NEED_newRV_noinc
26 #include "ppport.h" /* handle old perls */
30 #define DEBUGME /* Debug mode, turns assertions on as well */
31 #define DASSERT /* Assertion mode */
35 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
36 * Provide them with the necessary defines so they can build with pre-5.004.
39 #ifndef PERLIO_IS_STDIO
41 #define PerlIO_getc(x) getc(x)
42 #define PerlIO_putc(f,x) putc(x,f)
43 #define PerlIO_read(x,y,z) fread(y,1,z,x)
44 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
45 #define PerlIO_stdoutf printf
46 #endif /* PERLIO_IS_STDIO */
47 #endif /* USE_PERLIO */
50 * Earlier versions of perl might be used, we can't assume they have the latest!
53 #ifndef HvSHAREKEYS_off
54 #define HvSHAREKEYS_off(hv) /* Ignore */
57 /* perl <= 5.8.2 needs this */
59 # define SvIsCOW(sv) 0
63 # define HvRITER_set(hv,r) (HvRITER(hv) = r)
66 # define HvEITER_set(hv,r) (HvEITER(hv) = r)
70 # define HvRITER_get HvRITER
73 # define HvEITER_get HvEITER
76 #ifndef HvPLACEHOLDERS_get
77 # define HvPLACEHOLDERS_get HvPLACEHOLDERS
81 # define HvTOTALKEYS(hv) HvKEYS(hv)
91 * TRACEME() will only output things when the $Storable::DEBUGME is true.
96 if (SvTRUE(perl_get_sv("Storable::DEBUGME", GV_ADD))) \
97 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
104 #define ASSERT(x,y) \
107 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
108 __FILE__, __LINE__); \
109 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
120 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
122 #define SX_OBJECT C(0) /* Already stored object */
123 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
124 #define SX_ARRAY C(2) /* Array forthcoming (size, item list) */
125 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
126 #define SX_REF C(4) /* Reference to object forthcoming */
127 #define SX_UNDEF C(5) /* Undefined scalar */
128 #define SX_INTEGER C(6) /* Integer forthcoming */
129 #define SX_DOUBLE C(7) /* Double forthcoming */
130 #define SX_BYTE C(8) /* (signed) byte forthcoming */
131 #define SX_NETINT C(9) /* Integer in network order forthcoming */
132 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
133 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
134 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
135 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
136 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
137 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
138 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
139 #define SX_BLESS C(17) /* Object is blessed */
140 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
141 #define SX_HOOK C(19) /* Stored via hook, user-defined */
142 #define SX_OVERLOAD C(20) /* Overloaded reference */
143 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
144 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
145 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
146 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
147 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
148 #define SX_CODE C(26) /* Code references as perl source code */
149 #define SX_WEAKREF C(27) /* Weak reference to object forthcoming */
150 #define SX_WEAKOVERLOAD C(28) /* Overloaded weak reference */
151 #define SX_VSTRING C(29) /* vstring forthcoming (small) */
152 #define SX_LVSTRING C(30) /* vstring forthcoming (large) */
153 #define SX_ERROR C(31) /* Error */
156 * Those are only used to retrieve "old" pre-0.6 binary images.
158 #define SX_ITEM 'i' /* An array item introducer */
159 #define SX_IT_UNDEF 'I' /* Undefined array item */
160 #define SX_KEY 'k' /* A hash key introducer */
161 #define SX_VALUE 'v' /* A hash value introducer */
162 #define SX_VL_UNDEF 'V' /* Undefined hash value */
165 * Those are only used to retrieve "old" pre-0.7 binary images
168 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
169 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
170 #define SX_STORED 'X' /* End of object */
173 * Limits between short/long length representation.
176 #define LG_SCALAR 255 /* Large scalar length limit */
177 #define LG_BLESS 127 /* Large classname bless limit */
183 #define ST_STORE 0x1 /* Store operation */
184 #define ST_RETRIEVE 0x2 /* Retrieval operation */
185 #define ST_CLONE 0x4 /* Deep cloning operation */
188 * The following structure is used for hash table key retrieval. Since, when
189 * retrieving objects, we'll be facing blessed hash references, it's best
190 * to pre-allocate that buffer once and resize it as the need arises, never
191 * freeing it (keys will be saved away someplace else anyway, so even large
192 * keys are not enough a motivation to reclaim that space).
194 * This structure is also used for memory store/retrieve operations which
195 * happen in a fixed place before being malloc'ed elsewhere if persistence
196 * is required. Hence the aptr pointer.
199 char *arena; /* Will hold hash key strings, resized as needed */
200 STRLEN asiz; /* Size of aforementioned buffer */
201 char *aptr; /* Arena pointer, for in-place read/write ops */
202 char *aend; /* First invalid address */
207 * A hash table records the objects which have already been stored.
208 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
209 * an arbitrary sequence number) is used to identify them.
212 * An array table records the objects which have already been retrieved,
213 * as seen by the tag determined by counting the objects themselves. The
214 * reference to that retrieved object is kept in the table, and is returned
215 * when an SX_OBJECT is found bearing that same tag.
217 * The same processing is used to record "classname" for blessed objects:
218 * indexing by a hash at store time, and via an array at retrieve time.
221 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
224 * The following "thread-safe" related defines were contributed by
225 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
226 * only renamed things a little bit to ensure consistency with surrounding
227 * code. -- RAM, 14/09/1999
229 * The original patch suffered from the fact that the stcxt_t structure
230 * was global. Murray tried to minimize the impact on the code as much as
233 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
234 * on objects. Therefore, the notion of context needs to be generalized,
238 #define MY_VERSION "Storable(" XS_VERSION ")"
242 * Conditional UTF8 support.
246 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
247 #define HAS_UTF8_SCALARS
249 #define HAS_UTF8_HASHES
252 /* 5.6 perl has utf8 scalars but not hashes */
256 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
259 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
262 #define WEAKREF_CROAK() CROAK(("Cannot retrieve weak references in this perl"))
265 #define VSTRING_CROAK() CROAK(("Cannot retrieve vstring in this perl"))
268 #ifdef HvPLACEHOLDERS
269 #define HAS_RESTRICTED_HASHES
271 #define HVhek_PLACEHOLD 0x200
272 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
276 #define HAS_HASH_KEY_FLAGS
280 #define USE_PTR_TABLE
284 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
285 * files remap tainted and dirty when threading is enabled. That's bad for
286 * perl to remap such common words. -- RAM, 29/09/00
290 typedef struct stcxt {
291 int entry; /* flags recursion */
292 int optype; /* type of traversal operation */
293 /* which objects have been seen, store time.
294 tags are numbers, which are cast to (SV *) and stored directly */
296 /* use pseen if we have ptr_tables. We have to store tag+1, because
297 tag numbers start at 0, and we can't store (SV *) 0 in a ptr_table
298 without it being confused for a fetch lookup failure. */
299 struct ptr_tbl *pseen;
300 /* Still need hseen for the 0.6 file format code. */
303 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
304 AV *aseen; /* which objects have been seen, retrieve time */
305 IV where_is_undef; /* index in aseen of PL_sv_undef */
306 HV *hclass; /* which classnames have been seen, store time */
307 AV *aclass; /* which classnames have been seen, retrieve time */
308 HV *hook; /* cache for hook methods per class name */
309 IV tagnum; /* incremented at store time for each seen object */
310 IV classnum; /* incremented at store time for each seen classname */
311 int netorder; /* true if network order used */
312 int s_tainted; /* true if input source is tainted, at retrieve time */
313 int forgive_me; /* whether to be forgiving... */
314 int deparse; /* whether to deparse code refs */
315 SV *eval; /* whether to eval source code */
316 int canonical; /* whether to store hashes sorted by key */
317 #ifndef HAS_RESTRICTED_HASHES
318 int derestrict; /* whether to downgrade restricted hashes */
321 int use_bytes; /* whether to bytes-ify utf8 */
323 int accept_future_minor; /* croak immediately on future minor versions? */
324 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
325 int membuf_ro; /* true means membuf is read-only and msaved is rw */
326 struct extendable keybuf; /* for hash key retrieval */
327 struct extendable membuf; /* for memory store/retrieve operations */
328 struct extendable msaved; /* where potentially valid mbuf is saved */
329 PerlIO *fio; /* where I/O are performed, NULL for memory */
330 int ver_major; /* major of version for retrieved object */
331 int ver_minor; /* minor of version for retrieved object */
332 SV *(**retrieve_vtbl)(pTHX_ struct stcxt *, const char *); /* retrieve dispatch table */
333 SV *prev; /* contexts chained backwards in real recursion */
334 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
335 int in_retrieve_overloaded; /* performance hack for retrieving overloaded objects */
338 #define NEW_STORABLE_CXT_OBJ(cxt) \
340 SV *self = newSV(sizeof(stcxt_t) - 1); \
341 SV *my_sv = newRV_noinc(self); \
342 sv_bless(my_sv, gv_stashpv("Storable::Cxt", GV_ADD)); \
343 cxt = (stcxt_t *)SvPVX(self); \
344 Zero(cxt, 1, stcxt_t); \
345 cxt->my_sv = my_sv; \
348 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
350 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
352 SV *perinterp_sv = perl_get_sv(MY_VERSION, 0)
353 #else /* >= perl5.004_68 */
355 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
356 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
357 #endif /* < perl5.004_68 */
359 #define dSTCXT_PTR(T,name) \
360 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
361 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
364 dSTCXT_PTR(stcxt_t *, cxt)
368 NEW_STORABLE_CXT_OBJ(cxt); \
369 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
371 #define SET_STCXT(x) \
374 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
377 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
379 static stcxt_t *Context_ptr = NULL;
380 #define dSTCXT stcxt_t *cxt = Context_ptr
381 #define SET_STCXT(x) Context_ptr = x
384 NEW_STORABLE_CXT_OBJ(cxt); \
388 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
392 * Croaking implies a memory leak, since we don't use setjmp/longjmp
393 * to catch the exit and free memory used during store or retrieve
394 * operations. This is not too difficult to fix, but I need to understand
395 * how Perl does it, and croaking is exceptional anyway, so I lack the
396 * motivation to do it.
398 * The current workaround is to mark the context as dirty when croaking,
399 * so that data structures can be freed whenever we renter Storable code
400 * (but only *then*: it's a workaround, not a fix).
402 * This is also imperfect, because we don't really know how far they trapped
403 * the croak(), and when we were recursing, we won't be able to clean anything
404 * but the topmost context stacked.
407 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
410 * End of "thread-safe" related definitions.
416 * Keep only the low 32 bits of a pointer (used for tags, which are not
421 #define LOW_32BITS(x) ((I32) (x))
423 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
429 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
430 * Used in the WLEN and RLEN macros.
434 #define oI(x) ((I32 *) ((char *) (x) + 4))
435 #define oS(x) ((x) - 4)
436 #define oC(x) (x = 0)
445 * key buffer handling
447 #define kbuf (cxt->keybuf).arena
448 #define ksiz (cxt->keybuf).asiz
452 TRACEME(("** allocating kbuf of 128 bytes")); \
453 New(10003, kbuf, 128, char); \
460 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
461 Renew(kbuf, x+1, char); \
467 * memory buffer handling
469 #define mbase (cxt->membuf).arena
470 #define msiz (cxt->membuf).asiz
471 #define mptr (cxt->membuf).aptr
472 #define mend (cxt->membuf).aend
474 #define MGROW (1 << 13)
475 #define MMASK (MGROW - 1)
477 #define round_mgrow(x) \
478 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
479 #define trunc_int(x) \
480 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
481 #define int_aligned(x) \
482 ((unsigned long) (x) == trunc_int(x))
484 #define MBUF_INIT(x) \
487 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
488 New(10003, mbase, MGROW, char); \
489 msiz = (STRLEN)MGROW; \
495 mend = mbase + msiz; \
498 #define MBUF_TRUNC(x) mptr = mbase + x
499 #define MBUF_SIZE() (mptr - mbase)
505 * Those macros are used in do_retrieve() to save the current memory
506 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
507 * data from a string.
509 #define MBUF_SAVE_AND_LOAD(in) \
511 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
512 cxt->membuf_ro = 1; \
513 TRACEME(("saving mbuf")); \
514 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
518 #define MBUF_RESTORE() \
520 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
521 cxt->membuf_ro = 0; \
522 TRACEME(("restoring mbuf")); \
523 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
527 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
528 * See store_scalar() for other usage of this workaround.
530 #define MBUF_LOAD(v) \
532 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
534 CROAK(("Not a scalar string")); \
535 mptr = mbase = SvPV(v, msiz); \
536 mend = mbase + msiz; \
539 #define MBUF_XTEND(x) \
541 int nsz = (int) round_mgrow((x)+msiz); \
542 int offset = mptr - mbase; \
543 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
544 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
546 Renew(mbase, nsz, char); \
548 mptr = mbase + offset; \
549 mend = mbase + nsz; \
552 #define MBUF_CHK(x) \
554 if ((mptr + (x)) > mend) \
558 #define MBUF_GETC(x) \
561 x = (int) (unsigned char) *mptr++; \
567 #define MBUF_GETINT(x) \
570 if ((mptr + 4) <= mend) { \
571 memcpy(oI(&x), mptr, 4); \
577 #define MBUF_GETINT(x) \
579 if ((mptr + sizeof(int)) <= mend) { \
580 if (int_aligned(mptr)) \
583 memcpy(&x, mptr, sizeof(int)); \
584 mptr += sizeof(int); \
590 #define MBUF_READ(x,s) \
592 if ((mptr + (s)) <= mend) { \
593 memcpy(x, mptr, s); \
599 #define MBUF_SAFEREAD(x,s,z) \
601 if ((mptr + (s)) <= mend) { \
602 memcpy(x, mptr, s); \
610 #define MBUF_SAFEPVREAD(x,s,z) \
612 if ((mptr + (s)) <= mend) { \
613 memcpy(x, mptr, s); \
621 #define MBUF_PUTC(c) \
624 *mptr++ = (char) c; \
627 *mptr++ = (char) c; \
632 #define MBUF_PUTINT(i) \
635 memcpy(mptr, oI(&i), 4); \
639 #define MBUF_PUTINT(i) \
641 MBUF_CHK(sizeof(int)); \
642 if (int_aligned(mptr)) \
645 memcpy(mptr, &i, sizeof(int)); \
646 mptr += sizeof(int); \
650 #define MBUF_WRITE(x,s) \
653 memcpy(mptr, x, s); \
658 * Possible return values for sv_type().
662 #define svis_SCALAR 1
666 #define svis_TIED_ITEM 5
674 #define SHF_TYPE_MASK 0x03
675 #define SHF_LARGE_CLASSLEN 0x04
676 #define SHF_LARGE_STRLEN 0x08
677 #define SHF_LARGE_LISTLEN 0x10
678 #define SHF_IDX_CLASSNAME 0x20
679 #define SHF_NEED_RECURSE 0x40
680 #define SHF_HAS_LIST 0x80
683 * Types for SX_HOOK (last 2 bits in flags).
689 #define SHT_EXTRA 3 /* Read extra byte for type */
692 * The following are held in the "extra byte"...
695 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
696 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
697 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
700 * per hash flags for flagged hashes
703 #define SHV_RESTRICTED 0x01
706 * per key flags for flagged hashes
709 #define SHV_K_UTF8 0x01
710 #define SHV_K_WASUTF8 0x02
711 #define SHV_K_LOCKED 0x04
712 #define SHV_K_ISSV 0x08
713 #define SHV_K_PLACEHOLDER 0x10
716 * Before 0.6, the magic string was "perl-store" (binary version number 0).
718 * Since 0.6 introduced many binary incompatibilities, the magic string has
719 * been changed to "pst0" to allow an old image to be properly retrieved by
720 * a newer Storable, but ensure a newer image cannot be retrieved with an
723 * At 0.7, objects are given the ability to serialize themselves, and the
724 * set of markers is extended, backward compatibility is not jeopardized,
725 * so the binary version number could have remained unchanged. To correctly
726 * spot errors if a file making use of 0.7-specific extensions is given to
727 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
728 * a "minor" version, to better track this kind of evolution from now on.
731 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
732 static const char magicstr[] = "pst0"; /* Used as a magic number */
734 #define MAGICSTR_BYTES 'p','s','t','0'
735 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
737 /* 5.6.x introduced the ability to have IVs as long long.
738 However, Configure still defined BYTEORDER based on the size of a long.
739 Storable uses the BYTEORDER value as part of the header, but doesn't
740 explicitly store sizeof(IV) anywhere in the header. Hence on 5.6.x built
741 with IV as long long on a platform that uses Configure (ie most things
742 except VMS and Windows) headers are identical for the different IV sizes,
743 despite the files containing some fields based on sizeof(IV)
745 5.8 is consistent - the following redefinition kludge is only needed on
746 5.6.x, but the interwork is needed on 5.8 while data survives in files
751 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
752 #ifndef NO_56_INTERWORK_KLUDGE
753 #define USE_56_INTERWORK_KLUDGE
755 #if BYTEORDER == 0x1234
757 #define BYTEORDER 0x12345678
759 #if BYTEORDER == 0x4321
761 #define BYTEORDER 0x87654321
766 #if BYTEORDER == 0x1234
767 #define BYTEORDER_BYTES '1','2','3','4'
769 #if BYTEORDER == 0x12345678
770 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
771 #ifdef USE_56_INTERWORK_KLUDGE
772 #define BYTEORDER_BYTES_56 '1','2','3','4'
775 #if BYTEORDER == 0x87654321
776 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
777 #ifdef USE_56_INTERWORK_KLUDGE
778 #define BYTEORDER_BYTES_56 '4','3','2','1'
781 #if BYTEORDER == 0x4321
782 #define BYTEORDER_BYTES '4','3','2','1'
784 #error Unknown byteorder. Please append your byteorder to Storable.xs
790 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
791 #ifdef USE_56_INTERWORK_KLUDGE
792 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
795 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
796 #define STORABLE_BIN_MINOR 9 /* Binary minor "version" */
798 #if (PATCHLEVEL <= 5)
799 #define STORABLE_BIN_WRITE_MINOR 4
800 #elif !defined (SvVOK)
802 * Perl 5.6.0-5.8.0 can do weak references, but not vstring magic.
804 #define STORABLE_BIN_WRITE_MINOR 8
806 #define STORABLE_BIN_WRITE_MINOR 9
807 #endif /* (PATCHLEVEL <= 5) */
809 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
810 #define PL_sv_placeholder PL_sv_undef
814 * Useful store shortcuts...
818 * Note that if you put more than one mark for storing a particular
819 * type of thing, *and* in the retrieve_foo() function you mark both
820 * the thingy's you get off with SEEN(), you *must* increase the
821 * tagnum with cxt->tagnum++ along with this macro!
828 else if (PerlIO_putc(cxt->fio, x) == EOF) \
832 #define WRITE_I32(x) \
834 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
837 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
844 if (cxt->netorder) { \
845 int y = (int) htonl(x); \
848 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
853 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
858 #define WLEN(x) WRITE_I32(x)
865 else if (PerlIO_write(cxt->fio, x, y) != y) \
869 #define STORE_PV_LEN(pv, len, small, large) \
871 if (len <= LG_SCALAR) { \
872 unsigned char clen = (unsigned char) len; \
884 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
887 * Store &PL_sv_undef in arrays without recursing through store().
889 #define STORE_SV_UNDEF() \
892 PUTMARK(SX_SV_UNDEF); \
896 * Useful retrieve shortcuts...
900 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
906 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
910 #define READ_I32(x) \
912 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
916 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
926 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
929 x = (int) ntohl(x); \
932 #define RLEN(x) READ_I32(x)
939 else if (PerlIO_read(cxt->fio, x, y) != y) \
943 #define SAFEREAD(x,y,z) \
946 MBUF_SAFEREAD(x,y,z); \
947 else if (PerlIO_read(cxt->fio, x, y) != y) { \
953 #define SAFEPVREAD(x,y,z) \
956 MBUF_SAFEPVREAD(x,y,z); \
957 else if (PerlIO_read(cxt->fio, x, y) != y) { \
964 * This macro is used at retrieve time, to remember where object 'y', bearing a
965 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
966 * we'll therefore know where it has been retrieved and will be able to
967 * share the same reference, as in the original stored memory image.
969 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
970 * on the objects given to STORABLE_thaw and expect that to be defined), and
971 * also for overloaded objects (for which we might not find the stash if the
972 * object is not blessed yet--this might occur for overloaded objects that
973 * refer to themselves indirectly: if we blessed upon return from a sub
974 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
975 * restored on it because the underlying object would not be blessed yet!).
977 * To achieve that, the class name of the last retrieved object is passed down
978 * recursively, and the first SEEN() call for which the class name is not NULL
979 * will bless the object.
981 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
983 #define SEEN(y,c,i) \
987 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
989 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
990 PTR2UV(y), SvREFCNT(y)-1)); \
992 BLESS((SV *) (y), c); \
996 * Bless 's' in 'p', via a temporary reference, required by sv_bless().
997 * "A" magic is added before the sv_bless for overloaded classes, this avoids
998 * an expensive call to S_reset_amagic in sv_bless.
1000 #define BLESS(s,p) \
1004 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
1005 stash = gv_stashpv((p), GV_ADD); \
1006 ref = newRV_noinc(s); \
1007 if (cxt->in_retrieve_overloaded && Gv_AMG(stash)) \
1009 cxt->in_retrieve_overloaded = 0; \
1012 (void) sv_bless(ref, stash); \
1013 SvRV_set(ref, NULL); \
1014 SvREFCNT_dec(ref); \
1017 * sort (used in store_hash) - conditionally use qsort when
1018 * sortsv is not available ( <= 5.6.1 ).
1021 #if (PATCHLEVEL <= 6)
1023 #if defined(USE_ITHREADS)
1025 #define STORE_HASH_SORT \
1027 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
1028 SAVESPTR(orig_perl); \
1029 PERL_SET_CONTEXT(aTHX); \
1030 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
1033 #else /* ! USE_ITHREADS */
1035 #define STORE_HASH_SORT \
1036 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1038 #endif /* USE_ITHREADS */
1040 #else /* PATCHLEVEL > 6 */
1042 #define STORE_HASH_SORT \
1043 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1045 #endif /* PATCHLEVEL <= 6 */
1047 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1048 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname);
1052 av_pop(cxt->aseen); \
1057 * Dynamic dispatching table for SV store.
1060 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1061 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1062 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1063 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1064 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1065 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1066 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1067 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1068 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1070 typedef int (*sv_store_t)(pTHX_ stcxt_t *cxt, SV *sv);
1072 static const sv_store_t sv_store[] = {
1073 (sv_store_t)store_ref, /* svis_REF */
1074 (sv_store_t)store_scalar, /* svis_SCALAR */
1075 (sv_store_t)store_array, /* svis_ARRAY */
1076 (sv_store_t)store_hash, /* svis_HASH */
1077 (sv_store_t)store_tied, /* svis_TIED */
1078 (sv_store_t)store_tied_item, /* svis_TIED_ITEM */
1079 (sv_store_t)store_code, /* svis_CODE */
1080 (sv_store_t)store_other, /* svis_OTHER */
1083 #define SV_STORE(x) (*sv_store[x])
1086 * Dynamic dispatching tables for SV retrieval.
1089 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname);
1090 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname);
1091 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1092 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1093 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname);
1094 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname);
1095 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname);
1096 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname);
1097 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname);
1098 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname);
1099 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1100 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname);
1101 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname);
1102 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname);
1103 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1104 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname);
1106 typedef SV* (*sv_retrieve_t)(pTHX_ stcxt_t *cxt, const char *name);
1108 static const sv_retrieve_t sv_old_retrieve[] = {
1109 0, /* SX_OBJECT -- entry unused dynamically */
1110 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1111 (sv_retrieve_t)old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1112 (sv_retrieve_t)old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1113 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1114 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1115 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1116 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1117 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1118 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1119 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1120 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1121 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1122 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1123 (sv_retrieve_t)retrieve_other, /* SX_SV_UNDEF not supported */
1124 (sv_retrieve_t)retrieve_other, /* SX_SV_YES not supported */
1125 (sv_retrieve_t)retrieve_other, /* SX_SV_NO not supported */
1126 (sv_retrieve_t)retrieve_other, /* SX_BLESS not supported */
1127 (sv_retrieve_t)retrieve_other, /* SX_IX_BLESS not supported */
1128 (sv_retrieve_t)retrieve_other, /* SX_HOOK not supported */
1129 (sv_retrieve_t)retrieve_other, /* SX_OVERLOADED not supported */
1130 (sv_retrieve_t)retrieve_other, /* SX_TIED_KEY not supported */
1131 (sv_retrieve_t)retrieve_other, /* SX_TIED_IDX not supported */
1132 (sv_retrieve_t)retrieve_other, /* SX_UTF8STR not supported */
1133 (sv_retrieve_t)retrieve_other, /* SX_LUTF8STR not supported */
1134 (sv_retrieve_t)retrieve_other, /* SX_FLAG_HASH not supported */
1135 (sv_retrieve_t)retrieve_other, /* SX_CODE not supported */
1136 (sv_retrieve_t)retrieve_other, /* SX_WEAKREF not supported */
1137 (sv_retrieve_t)retrieve_other, /* SX_WEAKOVERLOAD not supported */
1138 (sv_retrieve_t)retrieve_other, /* SX_VSTRING not supported */
1139 (sv_retrieve_t)retrieve_other, /* SX_LVSTRING not supported */
1140 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1143 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1144 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1145 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname);
1146 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname);
1147 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname);
1148 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1149 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1150 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname);
1151 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname);
1152 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname);
1153 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname);
1154 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname);
1155 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname);
1156 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname);
1157 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname);
1158 static SV *retrieve_vstring(pTHX_ stcxt_t *cxt, const char *cname);
1159 static SV *retrieve_lvstring(pTHX_ stcxt_t *cxt, const char *cname);
1161 static const sv_retrieve_t sv_retrieve[] = {
1162 0, /* SX_OBJECT -- entry unused dynamically */
1163 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1164 (sv_retrieve_t)retrieve_array, /* SX_ARRAY */
1165 (sv_retrieve_t)retrieve_hash, /* SX_HASH */
1166 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1167 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1168 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1169 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1170 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1171 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1172 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1173 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1174 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1175 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1176 (sv_retrieve_t)retrieve_sv_undef, /* SX_SV_UNDEF */
1177 (sv_retrieve_t)retrieve_sv_yes, /* SX_SV_YES */
1178 (sv_retrieve_t)retrieve_sv_no, /* SX_SV_NO */
1179 (sv_retrieve_t)retrieve_blessed, /* SX_BLESS */
1180 (sv_retrieve_t)retrieve_idx_blessed, /* SX_IX_BLESS */
1181 (sv_retrieve_t)retrieve_hook, /* SX_HOOK */
1182 (sv_retrieve_t)retrieve_overloaded, /* SX_OVERLOAD */
1183 (sv_retrieve_t)retrieve_tied_key, /* SX_TIED_KEY */
1184 (sv_retrieve_t)retrieve_tied_idx, /* SX_TIED_IDX */
1185 (sv_retrieve_t)retrieve_utf8str, /* SX_UTF8STR */
1186 (sv_retrieve_t)retrieve_lutf8str, /* SX_LUTF8STR */
1187 (sv_retrieve_t)retrieve_flag_hash, /* SX_HASH */
1188 (sv_retrieve_t)retrieve_code, /* SX_CODE */
1189 (sv_retrieve_t)retrieve_weakref, /* SX_WEAKREF */
1190 (sv_retrieve_t)retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
1191 (sv_retrieve_t)retrieve_vstring, /* SX_VSTRING */
1192 (sv_retrieve_t)retrieve_lvstring, /* SX_LVSTRING */
1193 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1196 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1198 static SV *mbuf2sv(pTHX);
1201 *** Context management.
1207 * Called once per "thread" (interpreter) to initialize some global context.
1209 static void init_perinterp(pTHX)
1213 cxt->netorder = 0; /* true if network order used */
1214 cxt->forgive_me = -1; /* whether to be forgiving... */
1215 cxt->accept_future_minor = -1; /* would otherwise occur too late */
1221 * Called at the end of every context cleaning, to perform common reset
1224 static void reset_context(stcxt_t *cxt)
1228 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1232 * init_store_context
1234 * Initialize a new store context for real recursion.
1236 static void init_store_context(
1243 TRACEME(("init_store_context"));
1245 cxt->netorder = network_order;
1246 cxt->forgive_me = -1; /* Fetched from perl if needed */
1247 cxt->deparse = -1; /* Idem */
1248 cxt->eval = NULL; /* Idem */
1249 cxt->canonical = -1; /* Idem */
1250 cxt->tagnum = -1; /* Reset tag numbers */
1251 cxt->classnum = -1; /* Reset class numbers */
1252 cxt->fio = f; /* Where I/O are performed */
1253 cxt->optype = optype; /* A store, or a deep clone */
1254 cxt->entry = 1; /* No recursion yet */
1257 * The 'hseen' table is used to keep track of each SV stored and their
1258 * associated tag numbers is special. It is "abused" because the
1259 * values stored are not real SV, just integers cast to (SV *),
1260 * which explains the freeing below.
1262 * It is also one possible bottleneck to achieve good storing speed,
1263 * so the "shared keys" optimization is turned off (unlikely to be
1264 * of any use here), and the hash table is "pre-extended". Together,
1265 * those optimizations increase the throughput by 12%.
1268 #ifdef USE_PTR_TABLE
1269 cxt->pseen = ptr_table_new();
1272 cxt->hseen = newHV(); /* Table where seen objects are stored */
1273 HvSHAREKEYS_off(cxt->hseen);
1276 * The following does not work well with perl5.004_04, and causes
1277 * a core dump later on, in a completely unrelated spot, which
1278 * makes me think there is a memory corruption going on.
1280 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1281 * it below does not make any difference. It seems to work fine
1282 * with perl5.004_68 but given the probable nature of the bug,
1283 * that does not prove anything.
1285 * It's a shame because increasing the amount of buckets raises
1286 * store() throughput by 5%, but until I figure this out, I can't
1287 * allow for this to go into production.
1289 * It is reported fixed in 5.005, hence the #if.
1291 #if PERL_VERSION >= 5
1292 #define HBUCKETS 4096 /* Buckets for %hseen */
1293 #ifndef USE_PTR_TABLE
1294 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1299 * The 'hclass' hash uses the same settings as 'hseen' above, but it is
1300 * used to assign sequential tags (numbers) to class names for blessed
1303 * We turn the shared key optimization on.
1306 cxt->hclass = newHV(); /* Where seen classnames are stored */
1308 #if PERL_VERSION >= 5
1309 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1313 * The 'hook' hash table is used to keep track of the references on
1314 * the STORABLE_freeze hook routines, when found in some class name.
1316 * It is assumed that the inheritance tree will not be changed during
1317 * storing, and that no new method will be dynamically created by the
1321 cxt->hook = newHV(); /* Table where hooks are cached */
1324 * The 'hook_seen' array keeps track of all the SVs returned by
1325 * STORABLE_freeze hooks for us to serialize, so that they are not
1326 * reclaimed until the end of the serialization process. Each SV is
1327 * only stored once, the first time it is seen.
1330 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1334 * clean_store_context
1336 * Clean store context by
1338 static void clean_store_context(pTHX_ stcxt_t *cxt)
1342 TRACEME(("clean_store_context"));
1344 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1347 * Insert real values into hashes where we stored faked pointers.
1350 #ifndef USE_PTR_TABLE
1352 hv_iterinit(cxt->hseen);
1353 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1354 HeVAL(he) = &PL_sv_undef;
1359 hv_iterinit(cxt->hclass);
1360 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1361 HeVAL(he) = &PL_sv_undef;
1365 * And now dispose of them...
1367 * The surrounding if() protection has been added because there might be
1368 * some cases where this routine is called more than once, during
1369 * exceptional events. This was reported by Marc Lehmann when Storable
1370 * is executed from mod_perl, and the fix was suggested by him.
1371 * -- RAM, 20/12/2000
1374 #ifdef USE_PTR_TABLE
1376 struct ptr_tbl *pseen = cxt->pseen;
1378 ptr_table_free(pseen);
1380 assert(!cxt->hseen);
1383 HV *hseen = cxt->hseen;
1386 sv_free((SV *) hseen);
1391 HV *hclass = cxt->hclass;
1394 sv_free((SV *) hclass);
1398 HV *hook = cxt->hook;
1401 sv_free((SV *) hook);
1404 if (cxt->hook_seen) {
1405 AV *hook_seen = cxt->hook_seen;
1407 av_undef(hook_seen);
1408 sv_free((SV *) hook_seen);
1411 cxt->forgive_me = -1; /* Fetched from perl if needed */
1412 cxt->deparse = -1; /* Idem */
1414 SvREFCNT_dec(cxt->eval);
1416 cxt->eval = NULL; /* Idem */
1417 cxt->canonical = -1; /* Idem */
1423 * init_retrieve_context
1425 * Initialize a new retrieve context for real recursion.
1427 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1429 TRACEME(("init_retrieve_context"));
1432 * The hook hash table is used to keep track of the references on
1433 * the STORABLE_thaw hook routines, when found in some class name.
1435 * It is assumed that the inheritance tree will not be changed during
1436 * storing, and that no new method will be dynamically created by the
1440 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1442 #ifdef USE_PTR_TABLE
1447 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1448 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1449 * the correspondence between the tags and the tag number used by the
1450 * new retrieve routines.
1453 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1456 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1457 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1458 cxt->aclass = newAV(); /* Where seen classnames are kept */
1459 cxt->tagnum = 0; /* Have to count objects... */
1460 cxt->classnum = 0; /* ...and class names as well */
1461 cxt->optype = optype;
1462 cxt->s_tainted = is_tainted;
1463 cxt->entry = 1; /* No recursion yet */
1464 #ifndef HAS_RESTRICTED_HASHES
1465 cxt->derestrict = -1; /* Fetched from perl if needed */
1467 #ifndef HAS_UTF8_ALL
1468 cxt->use_bytes = -1; /* Fetched from perl if needed */
1470 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1471 cxt->in_retrieve_overloaded = 0;
1475 * clean_retrieve_context
1477 * Clean retrieve context by
1479 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1481 TRACEME(("clean_retrieve_context"));
1483 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1486 AV *aseen = cxt->aseen;
1489 sv_free((SV *) aseen);
1491 cxt->where_is_undef = -1;
1494 AV *aclass = cxt->aclass;
1497 sv_free((SV *) aclass);
1501 HV *hook = cxt->hook;
1504 sv_free((SV *) hook);
1508 HV *hseen = cxt->hseen;
1511 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1514 #ifndef HAS_RESTRICTED_HASHES
1515 cxt->derestrict = -1; /* Fetched from perl if needed */
1517 #ifndef HAS_UTF8_ALL
1518 cxt->use_bytes = -1; /* Fetched from perl if needed */
1520 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1522 cxt->in_retrieve_overloaded = 0;
1529 * A workaround for the CROAK bug: cleanup the last context.
1531 static void clean_context(pTHX_ stcxt_t *cxt)
1533 TRACEME(("clean_context"));
1535 ASSERT(cxt->s_dirty, ("dirty context"));
1540 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1542 if (cxt->optype & ST_RETRIEVE)
1543 clean_retrieve_context(aTHX_ cxt);
1544 else if (cxt->optype & ST_STORE)
1545 clean_store_context(aTHX_ cxt);
1549 ASSERT(!cxt->s_dirty, ("context is clean"));
1550 ASSERT(cxt->entry == 0, ("context is reset"));
1556 * Allocate a new context and push it on top of the parent one.
1557 * This new context is made globally visible via SET_STCXT().
1559 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1563 TRACEME(("allocate_context"));
1565 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1567 NEW_STORABLE_CXT_OBJ(cxt);
1568 cxt->prev = parent_cxt->my_sv;
1571 ASSERT(!cxt->s_dirty, ("clean context"));
1579 * Free current context, which cannot be the "root" one.
1580 * Make the context underneath globally visible via SET_STCXT().
1582 static void free_context(pTHX_ stcxt_t *cxt)
1584 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1586 TRACEME(("free_context"));
1588 ASSERT(!cxt->s_dirty, ("clean context"));
1589 ASSERT(prev, ("not freeing root context"));
1591 SvREFCNT_dec(cxt->my_sv);
1594 ASSERT(cxt, ("context not void"));
1604 * Tells whether we're in the middle of a store operation.
1606 static int is_storing(pTHX)
1610 return cxt->entry && (cxt->optype & ST_STORE);
1616 * Tells whether we're in the middle of a retrieve operation.
1618 static int is_retrieving(pTHX)
1622 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1626 * last_op_in_netorder
1628 * Returns whether last operation was made using network order.
1630 * This is typically out-of-band information that might prove useful
1631 * to people wishing to convert native to network order data when used.
1633 static int last_op_in_netorder(pTHX)
1637 return cxt->netorder;
1641 *** Hook lookup and calling routines.
1647 * A wrapper on gv_fetchmethod_autoload() which caches results.
1649 * Returns the routine reference as an SV*, or null if neither the package
1650 * nor its ancestors know about the method.
1652 static SV *pkg_fetchmeth(
1660 const char *hvname = HvNAME_get(pkg);
1664 * The following code is the same as the one performed by UNIVERSAL::can
1668 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1669 if (gv && isGV(gv)) {
1670 sv = newRV((SV*) GvCV(gv));
1671 TRACEME(("%s->%s: 0x%"UVxf, hvname, method, PTR2UV(sv)));
1673 sv = newSVsv(&PL_sv_undef);
1674 TRACEME(("%s->%s: not found", hvname, method));
1678 * Cache the result, ignoring failure: if we can't store the value,
1679 * it just won't be cached.
1682 (void) hv_store(cache, hvname, strlen(hvname), sv, 0);
1684 return SvOK(sv) ? sv : (SV *) 0;
1690 * Force cached value to be undef: hook ignored even if present.
1692 static void pkg_hide(
1698 const char *hvname = HvNAME_get(pkg);
1699 PERL_UNUSED_ARG(method);
1700 (void) hv_store(cache,
1701 hvname, strlen(hvname), newSVsv(&PL_sv_undef), 0);
1707 * Discard cached value: a whole fetch loop will be retried at next lookup.
1709 static void pkg_uncache(
1715 const char *hvname = HvNAME_get(pkg);
1716 PERL_UNUSED_ARG(method);
1717 (void) hv_delete(cache, hvname, strlen(hvname), G_DISCARD);
1723 * Our own "UNIVERSAL::can", which caches results.
1725 * Returns the routine reference as an SV*, or null if the object does not
1726 * know about the method.
1736 const char *hvname = HvNAME_get(pkg);
1738 TRACEME(("pkg_can for %s->%s", hvname, method));
1741 * Look into the cache to see whether we already have determined
1742 * where the routine was, if any.
1744 * NOTA BENE: we don't use 'method' at all in our lookup, since we know
1745 * that only one hook (i.e. always the same) is cached in a given cache.
1748 svh = hv_fetch(cache, hvname, strlen(hvname), FALSE);
1752 TRACEME(("cached %s->%s: not found", hvname, method));
1755 TRACEME(("cached %s->%s: 0x%"UVxf,
1756 hvname, method, PTR2UV(sv)));
1761 TRACEME(("not cached yet"));
1762 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1768 * Call routine as obj->hook(av) in scalar context.
1769 * Propagates the single returned value if not called in void context.
1771 static SV *scalar_call(
1783 TRACEME(("scalar_call (cloning=%d)", cloning));
1790 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1792 SV **ary = AvARRAY(av);
1793 int cnt = AvFILLp(av) + 1;
1795 XPUSHs(ary[0]); /* Frozen string */
1796 for (i = 1; i < cnt; i++) {
1797 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1798 i, PTR2UV(ary[i])));
1799 XPUSHs(sv_2mortal(newRV(ary[i])));
1804 TRACEME(("calling..."));
1805 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1806 TRACEME(("count = %d", count));
1812 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1825 * Call routine obj->hook(cloning) in list context.
1826 * Returns the list of returned values in an array.
1828 static AV *array_call(
1839 TRACEME(("array_call (cloning=%d)", cloning));
1845 XPUSHs(obj); /* Target object */
1846 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1849 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1854 for (i = count - 1; i >= 0; i--) {
1856 av_store(av, i, SvREFCNT_inc(sv));
1869 * Lookup the class name in the 'hclass' table and either assign it a new ID
1870 * or return the existing one, by filling in 'classnum'.
1872 * Return true if the class was known, false if the ID was just generated.
1874 static int known_class(
1877 char *name, /* Class name */
1878 int len, /* Name length */
1882 HV *hclass = cxt->hclass;
1884 TRACEME(("known_class (%s)", name));
1887 * Recall that we don't store pointers in this hash table, but tags.
1888 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1891 svh = hv_fetch(hclass, name, len, FALSE);
1893 *classnum = LOW_32BITS(*svh);
1898 * Unknown classname, we need to record it.
1902 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1903 CROAK(("Unable to record new classname"));
1905 *classnum = cxt->classnum;
1910 *** Specific store routines.
1916 * Store a reference.
1917 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1919 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1922 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1925 * Follow reference, and check if target is overloaded.
1931 TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1936 HV *stash = (HV *) SvSTASH(sv);
1937 if (stash && Gv_AMG(stash)) {
1938 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1939 PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1941 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1943 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1945 return store(aTHX_ cxt, sv);
1953 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1954 * SX_LUTF8STR and SX_UTF8STR are used for UTF-8 strings.
1955 * The <data> section is omitted if <length> is 0.
1957 * For vstrings, the vstring portion is stored first with
1958 * SX_LVSTRING <length> <data> or SX_VSTRING <length> <data>, followed by
1959 * SX_(L)SCALAR or SX_(L)UTF8STR with the actual PV.
1961 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1962 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1964 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
1969 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1971 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1974 * For efficiency, break the SV encapsulation by peaking at the flags
1975 * directly without using the Perl macros to avoid dereferencing
1976 * sv->sv_flags each time we wish to check the flags.
1979 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1980 if (sv == &PL_sv_undef) {
1981 TRACEME(("immortal undef"));
1982 PUTMARK(SX_SV_UNDEF);
1984 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
1991 * Always store the string representation of a scalar if it exists.
1992 * Gisle Aas provided me with this test case, better than a long speach:
1994 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1995 * SV = PVNV(0x80c8520)
1997 * FLAGS = (NOK,POK,pNOK,pPOK)
2000 * PV = 0x80c83d0 "abc"\0
2004 * Write SX_SCALAR, length, followed by the actual data.
2006 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
2007 * appropriate, followed by the actual (binary) data. A double
2008 * is written as a string if network order, for portability.
2010 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
2011 * The reason is that when the scalar value is tainted, the SvNOK(sv)
2014 * The test for a read-only scalar with both POK and NOK set is meant
2015 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
2016 * address comparison for each scalar we store.
2019 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
2021 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
2022 if (sv == &PL_sv_yes) {
2023 TRACEME(("immortal yes"));
2025 } else if (sv == &PL_sv_no) {
2026 TRACEME(("immortal no"));
2029 pv = SvPV(sv, len); /* We know it's SvPOK */
2030 goto string; /* Share code below */
2032 } else if (flags & SVf_POK) {
2033 /* public string - go direct to string read. */
2034 goto string_readlen;
2036 #if (PATCHLEVEL <= 6)
2037 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
2038 direct if NV flag is off. */
2039 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
2041 /* 5.7 rules are that if IV public flag is set, IV value is as
2042 good, if not better, than NV value. */
2048 * Will come here from below with iv set if double is an integer.
2052 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2054 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
2055 * (for example) and that ends up in the optimised small integer
2058 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
2059 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
2060 goto string_readlen;
2064 * Optimize small integers into a single byte, otherwise store as
2065 * a real integer (converted into network order if they asked).
2068 if (iv >= -128 && iv <= 127) {
2069 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
2072 TRACEME(("small integer stored as %d", siv));
2073 } else if (cxt->netorder) {
2075 TRACEME(("no htonl, fall back to string for integer"));
2076 goto string_readlen;
2084 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2085 ((flags & SVf_IVisUV) && SvUV(sv) > (UV)0x7FFFFFFF) ||
2087 (iv > (IV)0x7FFFFFFF) || (iv < -(IV)0x80000000)) {
2088 /* Bigger than 32 bits. */
2089 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2090 goto string_readlen;
2094 niv = (I32) htonl((I32) iv);
2095 TRACEME(("using network order"));
2100 PUTMARK(SX_INTEGER);
2101 WRITE(&iv, sizeof(iv));
2104 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2105 } else if (flags & SVf_NOK) {
2107 #if (PATCHLEVEL <= 6)
2110 * Watch for number being an integer in disguise.
2112 if (nv == (NV) (iv = I_V(nv))) {
2113 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2114 goto integer; /* Share code above */
2119 if (SvIOK_notUV(sv)) {
2121 goto integer; /* Share code above */
2126 if (cxt->netorder) {
2127 TRACEME(("double %"NVff" stored as string", nv));
2128 goto string_readlen; /* Share code below */
2132 WRITE(&nv, sizeof(nv));
2134 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2136 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2140 I32 wlen; /* For 64-bit machines */
2146 * Will come here from above if it was readonly, POK and NOK but
2147 * neither &PL_sv_yes nor &PL_sv_no.
2152 if (SvMAGICAL(sv) && (mg = mg_find(sv, 'V')))
2153 STORE_PV_LEN((const char *)mg->mg_ptr,
2154 mg->mg_len, SX_VSTRING, SX_LVSTRING);
2157 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2159 STORE_UTF8STR(pv, wlen);
2161 STORE_SCALAR(pv, wlen);
2162 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2163 PTR2UV(sv), SvPVX(sv), (IV)len));
2165 CROAK(("Can't determine type of %s(0x%"UVxf")",
2166 sv_reftype(sv, FALSE),
2168 return 0; /* Ok, no recursion on scalars */
2176 * Layout is SX_ARRAY <size> followed by each item, in increasing index order.
2177 * Each item is stored as <object>.
2179 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2182 I32 len = av_len(av) + 1;
2186 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2189 * Signal array by emitting SX_ARRAY, followed by the array length.
2194 TRACEME(("size = %d", len));
2197 * Now store each item recursively.
2200 for (i = 0; i < len; i++) {
2201 sav = av_fetch(av, i, 0);
2203 TRACEME(("(#%d) undef item", i));
2207 TRACEME(("(#%d) item", i));
2208 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2212 TRACEME(("ok (array)"));
2218 #if (PATCHLEVEL <= 6)
2224 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2227 sortcmp(const void *a, const void *b)
2229 #if defined(USE_ITHREADS)
2231 #endif /* USE_ITHREADS */
2232 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2235 #endif /* PATCHLEVEL <= 6 */
2240 * Store a hash table.
2242 * For a "normal" hash (not restricted, no utf8 keys):
2244 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2245 * Values are stored as <object>.
2246 * Keys are stored as <length> <data>, the <data> section being omitted
2249 * For a "fancy" hash (restricted or utf8 keys):
2251 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2253 * Values are stored as <object>.
2254 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2256 * Currently the only hash flag is "restricted"
2257 * Key flags are as for hv.h
2259 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2262 I32 len = HvTOTALKEYS(hv);
2267 int flagged_hash = ((SvREADONLY(hv)
2268 #ifdef HAS_HASH_KEY_FLAGS
2272 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2275 /* needs int cast for C++ compilers, doesn't it? */
2276 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2279 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2283 * Signal hash by emitting SX_HASH, followed by the table length.
2287 PUTMARK(SX_FLAG_HASH);
2288 PUTMARK(hash_flags);
2293 TRACEME(("size = %d", len));
2296 * Save possible iteration state via each() on that table.
2299 riter = HvRITER_get(hv);
2300 eiter = HvEITER_get(hv);
2304 * Now store each item recursively.
2306 * If canonical is defined to some true value then store each
2307 * key/value pair in sorted order otherwise the order is random.
2308 * Canonical order is irrelevant when a deep clone operation is performed.
2310 * Fetch the value from perl only once per store() operation, and only
2315 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2316 (cxt->canonical < 0 && (cxt->canonical =
2317 (SvTRUE(perl_get_sv("Storable::canonical", GV_ADD)) ? 1 : 0))))
2320 * Storing in order, sorted by key.
2321 * Run through the hash, building up an array of keys in a
2322 * mortal array, sort the array and then run through the
2328 /*av_extend (av, len);*/
2330 TRACEME(("using canonical order"));
2332 for (i = 0; i < len; i++) {
2333 #ifdef HAS_RESTRICTED_HASHES
2334 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2336 HE *he = hv_iternext(hv);
2341 CROAK(("Hash %p inconsistent - expected %d keys, %dth is NULL", hv, (int)len, (int)i));
2342 key = hv_iterkeysv(he);
2343 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2348 for (i = 0; i < len; i++) {
2349 #ifdef HAS_RESTRICTED_HASHES
2350 int placeholders = (int)HvPLACEHOLDERS_get(hv);
2352 unsigned char flags = 0;
2356 SV *key = av_shift(av);
2357 /* This will fail if key is a placeholder.
2358 Track how many placeholders we have, and error if we
2360 HE *he = hv_fetch_ent(hv, key, 0, 0);
2364 if (!(val = HeVAL(he))) {
2365 /* Internal error, not I/O error */
2369 #ifdef HAS_RESTRICTED_HASHES
2370 /* Should be a placeholder. */
2371 if (placeholders-- < 0) {
2372 /* This should not happen - number of
2373 retrieves should be identical to
2374 number of placeholders. */
2377 /* Value is never needed, and PL_sv_undef is
2378 more space efficient to store. */
2381 ("Flags not 0 but %d", flags));
2382 flags = SHV_K_PLACEHOLDER;
2389 * Store value first.
2392 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2394 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2399 * Keys are written after values to make sure retrieval
2400 * can be optimal in terms of memory usage, where keys are
2401 * read into a fixed unique buffer called kbuf.
2402 * See retrieve_hash() for details.
2405 /* Implementation of restricted hashes isn't nicely
2407 if ((hash_flags & SHV_RESTRICTED)
2408 && SvREADONLY(val) && !SvIsCOW(val)) {
2409 flags |= SHV_K_LOCKED;
2412 keyval = SvPV(key, keylen_tmp);
2413 keylen = keylen_tmp;
2414 #ifdef HAS_UTF8_HASHES
2415 /* If you build without optimisation on pre 5.6
2416 then nothing spots that SvUTF8(key) is always 0,
2417 so the block isn't optimised away, at which point
2418 the linker dislikes the reference to
2421 const char *keysave = keyval;
2422 bool is_utf8 = TRUE;
2424 /* Just casting the &klen to (STRLEN) won't work
2425 well if STRLEN and I32 are of different widths.
2427 keyval = (char*)bytes_from_utf8((U8*)keyval,
2431 /* If we were able to downgrade here, then than
2432 means that we have a key which only had chars
2433 0-255, but was utf8 encoded. */
2435 if (keyval != keysave) {
2436 keylen = keylen_tmp;
2437 flags |= SHV_K_WASUTF8;
2439 /* keylen_tmp can't have changed, so no need
2440 to assign back to keylen. */
2441 flags |= SHV_K_UTF8;
2448 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2450 /* This is a workaround for a bug in 5.8.0
2451 that causes the HEK_WASUTF8 flag to be
2452 set on an HEK without the hash being
2453 marked as having key flags. We just
2454 cross our fingers and drop the flag.
2456 assert (flags == 0 || flags == SHV_K_WASUTF8);
2457 TRACEME(("(#%d) key '%s'", i, keyval));
2461 WRITE(keyval, keylen);
2462 if (flags & SHV_K_WASUTF8)
2467 * Free up the temporary array
2476 * Storing in "random" order (in the order the keys are stored
2477 * within the hash). This is the default and will be faster!
2480 for (i = 0; i < len; i++) {
2483 unsigned char flags;
2484 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2485 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2487 HE *he = hv_iternext(hv);
2489 SV *val = (he ? hv_iterval(hv, he) : 0);
2494 return 1; /* Internal error, not I/O error */
2496 /* Implementation of restricted hashes isn't nicely
2499 = (((hash_flags & SHV_RESTRICTED)
2500 && SvREADONLY(val) && !SvIsCOW(val))
2501 ? SHV_K_LOCKED : 0);
2503 if (val == &PL_sv_placeholder) {
2504 flags |= SHV_K_PLACEHOLDER;
2509 * Store value first.
2512 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2514 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2518 hek = HeKEY_hek(he);
2520 if (len == HEf_SVKEY) {
2521 /* This is somewhat sick, but the internal APIs are
2522 * such that XS code could put one of these in in
2524 * Maybe we should be capable of storing one if
2527 key_sv = HeKEY_sv(he);
2528 flags |= SHV_K_ISSV;
2530 /* Regular string key. */
2531 #ifdef HAS_HASH_KEY_FLAGS
2533 flags |= SHV_K_UTF8;
2534 if (HEK_WASUTF8(hek))
2535 flags |= SHV_K_WASUTF8;
2541 * Keys are written after values to make sure retrieval
2542 * can be optimal in terms of memory usage, where keys are
2543 * read into a fixed unique buffer called kbuf.
2544 * See retrieve_hash() for details.
2549 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2551 /* This is a workaround for a bug in 5.8.0
2552 that causes the HEK_WASUTF8 flag to be
2553 set on an HEK without the hash being
2554 marked as having key flags. We just
2555 cross our fingers and drop the flag.
2557 assert (flags == 0 || flags == SHV_K_WASUTF8);
2558 TRACEME(("(#%d) key '%s'", i, key));
2560 if (flags & SHV_K_ISSV) {
2561 store(aTHX_ cxt, key_sv);
2570 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2573 HvRITER_set(hv, riter); /* Restore hash iterator state */
2574 HvEITER_set(hv, eiter);
2582 * Store a code reference.
2584 * Layout is SX_CODE <length> followed by a scalar containing the perl
2585 * source code of the code reference.
2587 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2589 #if PERL_VERSION < 6
2591 * retrieve_code does not work with perl 5.005 or less
2593 return store_other(aTHX_ cxt, (SV*)cv);
2598 SV *text, *bdeparse;
2600 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2603 cxt->deparse == 0 ||
2604 (cxt->deparse < 0 && !(cxt->deparse =
2605 SvTRUE(perl_get_sv("Storable::Deparse", GV_ADD)) ? 1 : 0))
2607 return store_other(aTHX_ cxt, (SV*)cv);
2611 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2612 * blessed code references.
2614 /* Ownership of both SVs is passed to load_module, which frees them. */
2615 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2622 * create the B::Deparse object
2626 XPUSHs(newSVpvs_flags("B::Deparse", SVs_TEMP));
2628 count = call_method("new", G_SCALAR);
2631 CROAK(("Unexpected return value from B::Deparse::new\n"));
2635 * call the coderef2text method
2639 XPUSHs(bdeparse); /* XXX is this already mortal? */
2640 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2642 count = call_method("coderef2text", G_SCALAR);
2645 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2649 reallen = strlen(SvPV_nolen(text));
2652 * Empty code references or XS functions are deparsed as
2653 * "(prototype) ;" or ";".
2656 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2657 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2661 * Signal code by emitting SX_CODE.
2665 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2666 TRACEME(("size = %d", len));
2667 TRACEME(("code = %s", SvPV_nolen(text)));
2670 * Now store the source code.
2674 STORE_UTF8STR(SvPV_nolen(text), len);
2676 STORE_SCALAR(SvPV_nolen(text), len);
2681 TRACEME(("ok (code)"));
2690 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2691 * a special mark, followed by the underlying tied object. For instance, when
2692 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2693 * <hash object> stands for the serialization of the tied hash.
2695 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2700 int svt = SvTYPE(sv);
2703 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2706 * We have a small run-time penalty here because we chose to factorise
2707 * all tieds objects into the same routine, and not have a store_tied_hash,
2708 * a store_tied_array, etc...
2710 * Don't use a switch() statement, as most compilers don't optimize that
2711 * well for 2/3 values. An if() else if() cascade is just fine. We put
2712 * tied hashes first, as they are the most likely beasts.
2715 if (svt == SVt_PVHV) {
2716 TRACEME(("tied hash"));
2717 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2718 } else if (svt == SVt_PVAV) {
2719 TRACEME(("tied array"));
2720 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2722 TRACEME(("tied scalar"));
2723 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2727 if (!(mg = mg_find(sv, mtype)))
2728 CROAK(("No magic '%c' found while storing tied %s", mtype,
2729 (svt == SVt_PVHV) ? "hash" :
2730 (svt == SVt_PVAV) ? "array" : "scalar"));
2733 * The mg->mg_obj found by mg_find() above actually points to the
2734 * underlying tied Perl object implementation. For instance, if the
2735 * original SV was that of a tied array, then mg->mg_obj is an AV.
2737 * Note that we store the Perl object as-is. We don't call its FETCH
2738 * method along the way. At retrieval time, we won't call its STORE
2739 * method either, but the tieing magic will be re-installed. In itself,
2740 * that ensures that the tieing semantics are preserved since further
2741 * accesses on the retrieved object will indeed call the magic methods...
2744 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2745 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2746 if ((ret = store(aTHX_ cxt, obj)))
2749 TRACEME(("ok (tied)"));
2757 * Stores a reference to an item within a tied structure:
2759 * . \$h{key}, stores both the (tied %h) object and 'key'.
2760 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2762 * Layout is therefore either:
2763 * SX_TIED_KEY <object> <key>
2764 * SX_TIED_IDX <object> <index>
2766 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2771 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2773 if (!(mg = mg_find(sv, 'p')))
2774 CROAK(("No magic 'p' found while storing reference to tied item"));
2777 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2781 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2782 PUTMARK(SX_TIED_KEY);
2783 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2785 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2788 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2790 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2793 I32 idx = mg->mg_len;
2795 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2796 PUTMARK(SX_TIED_IDX);
2797 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2799 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2802 TRACEME(("store_tied_item: storing IDX %d", idx));
2807 TRACEME(("ok (tied item)"));
2813 * store_hook -- dispatched manually, not via sv_store[]
2815 * The blessed SV is serialized by a hook.
2819 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2821 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2822 * the trailing part [] is present, the type of object (scalar, array or hash).
2823 * There is also a bit which says how the classname is stored between:
2828 * and when the <index> form is used (classname already seen), the "large
2829 * classname" bit in <flags> indicates how large the <index> is.
2831 * The serialized string returned by the hook is of length <len2> and comes
2832 * next. It is an opaque string for us.
2834 * Those <len3> object IDs which are listed last represent the extra references
2835 * not directly serialized by the hook, but which are linked to the object.
2837 * When recursion is mandated to resolve object-IDs not yet seen, we have
2838 * instead, with <header> being flags with bits set to indicate the object type
2839 * and that recursion was indeed needed:
2841 * SX_HOOK <header> <object> <header> <object> <flags>
2843 * that same header being repeated between serialized objects obtained through
2844 * recursion, until we reach flags indicating no recursion, at which point
2845 * we know we've resynchronized with a single layout, after <flags>.
2847 * When storing a blessed ref to a tied variable, the following format is
2850 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2852 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2853 * real object type is held in the <extra> flag. At the very end of the
2854 * serialization stream, the underlying magic object is serialized, just like
2855 * any other tied variable.
2857 static int store_hook(
2871 int count; /* really len3 + 1 */
2872 unsigned char flags;
2875 int recursed = 0; /* counts recursion */
2876 int obj_type; /* object type, on 2 bits */
2879 int clone = cxt->optype & ST_CLONE;
2880 char mtype = '\0'; /* for blessed ref to tied structures */
2881 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2883 TRACEME(("store_hook, classname \"%s\", tagged #%d", HvNAME_get(pkg), cxt->tagnum));
2886 * Determine object type on 2 bits.
2892 obj_type = SHT_SCALAR;
2895 obj_type = SHT_ARRAY;
2898 obj_type = SHT_HASH;
2902 * Produced by a blessed ref to a tied data structure, $o in the
2903 * following Perl code.
2907 * my $o = bless \%h, 'BAR';
2909 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2910 * (since we have only 2 bits in <flags> to store the type), and an
2911 * <extra> byte flag will be emitted after the FIRST <flags> in the
2912 * stream, carrying what we put in 'eflags'.
2914 obj_type = SHT_EXTRA;
2915 switch (SvTYPE(sv)) {
2917 eflags = (unsigned char) SHT_THASH;
2921 eflags = (unsigned char) SHT_TARRAY;
2925 eflags = (unsigned char) SHT_TSCALAR;
2931 CROAK(("Unexpected object type (%d) in store_hook()", type));
2933 flags = SHF_NEED_RECURSE | obj_type;
2935 classname = HvNAME_get(pkg);
2936 len = strlen(classname);
2939 * To call the hook, we need to fake a call like:
2941 * $object->STORABLE_freeze($cloning);
2943 * but we don't have the $object here. For instance, if $object is
2944 * a blessed array, what we have in 'sv' is the array, and we can't
2945 * call a method on those.
2947 * Therefore, we need to create a temporary reference to the object and
2948 * make the call on that reference.
2951 TRACEME(("about to call STORABLE_freeze on class %s", classname));
2953 ref = newRV_inc(sv); /* Temporary reference */
2954 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2955 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2957 count = AvFILLp(av) + 1;
2958 TRACEME(("store_hook, array holds %d items", count));
2961 * If they return an empty list, it means they wish to ignore the
2962 * hook for this class (and not just this instance -- that's for them
2963 * to handle if they so wish).
2965 * Simply disable the cached entry for the hook (it won't be recomputed
2966 * since it's present in the cache) and recurse to store_blessed().
2971 * They must not change their mind in the middle of a serialization.
2974 if (hv_fetch(cxt->hclass, classname, len, FALSE))
2975 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2976 (cxt->optype & ST_CLONE) ? "cloning" : "storing", classname));
2978 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
2980 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2981 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", classname));
2983 return store_blessed(aTHX_ cxt, sv, type, pkg);
2987 * Get frozen string.
2991 pv = SvPV(ary[0], len2);
2992 /* We can't use pkg_can here because it only caches one method per
2995 GV* gv = gv_fetchmethod_autoload(pkg, "STORABLE_attach", FALSE);
2996 if (gv && isGV(gv)) {
2998 CROAK(("Freeze cannot return references if %s class is using STORABLE_attach", classname));
3004 * If they returned more than one item, we need to serialize some
3005 * extra references if not already done.
3007 * Loop over the array, starting at position #1, and for each item,
3008 * ensure it is a reference, serialize it if not already done, and
3009 * replace the entry with the tag ID of the corresponding serialized
3012 * We CHEAT by not calling av_fetch() and read directly within the
3016 for (i = 1; i < count; i++) {
3017 #ifdef USE_PTR_TABLE
3025 AV *av_hook = cxt->hook_seen;
3028 CROAK(("Item #%d returned by STORABLE_freeze "
3029 "for %s is not a reference", i, classname));
3030 xsv = SvRV(rsv); /* Follow ref to know what to look for */
3033 * Look in hseen and see if we have a tag already.
3034 * Serialize entry if not done already, and get its tag.
3037 #ifdef USE_PTR_TABLE
3038 /* Fakery needed because ptr_table_fetch returns zero for a
3039 failure, whereas the existing code assumes that it can
3040 safely store a tag zero. So for ptr_tables we store tag+1
3042 if ((fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv)))
3043 goto sv_seen; /* Avoid moving code too far to the right */
3045 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
3046 goto sv_seen; /* Avoid moving code too far to the right */
3049 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
3052 * We need to recurse to store that object and get it to be known
3053 * so that we can resolve the list of object-IDs at retrieve time.
3055 * The first time we do this, we need to emit the proper header
3056 * indicating that we recursed, and what the type of object is (the
3057 * object we're storing via a user-hook). Indeed, during retrieval,
3058 * we'll have to create the object before recursing to retrieve the
3059 * others, in case those would point back at that object.
3062 /* [SX_HOOK] <flags> [<extra>] <object>*/
3066 if (obj_type == SHT_EXTRA)
3071 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
3074 #ifdef USE_PTR_TABLE
3075 fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv);
3077 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3079 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
3081 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3084 * It was the first time we serialized 'xsv'.
3086 * Keep this SV alive until the end of the serialization: if we
3087 * disposed of it right now by decrementing its refcount, and it was
3088 * a temporary value, some next temporary value allocated during
3089 * another STORABLE_freeze might take its place, and we'd wrongly
3090 * assume that new SV was already serialized, based on its presence
3093 * Therefore, push it away in cxt->hook_seen.
3096 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
3100 * Dispose of the REF they returned. If we saved the 'xsv' away
3101 * in the array of returned SVs, that will not cause the underlying
3102 * referenced SV to be reclaimed.
3105 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
3106 SvREFCNT_dec(rsv); /* Dispose of reference */
3109 * Replace entry with its tag (not a real SV, so no refcnt increment)
3112 #ifdef USE_PTR_TABLE
3113 tag = (SV *)--fake_tag;
3118 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
3119 i-1, PTR2UV(xsv), PTR2UV(tag)));
3123 * Allocate a class ID if not already done.
3125 * This needs to be done after the recursion above, since at retrieval
3126 * time, we'll see the inner objects first. Many thanks to
3127 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
3128 * proposed the right fix. -- RAM, 15/09/2000
3132 if (!known_class(aTHX_ cxt, classname, len, &classnum)) {
3133 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3134 classnum = -1; /* Mark: we must store classname */
3136 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3140 * Compute leading flags.
3144 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3145 flags |= SHF_LARGE_CLASSLEN;
3147 flags |= SHF_IDX_CLASSNAME;
3148 if (len2 > LG_SCALAR)
3149 flags |= SHF_LARGE_STRLEN;
3151 flags |= SHF_HAS_LIST;
3152 if (count > (LG_SCALAR + 1))
3153 flags |= SHF_LARGE_LISTLEN;
3156 * We're ready to emit either serialized form:
3158 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3159 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3161 * If we recursed, the SX_HOOK has already been emitted.
3164 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3165 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3166 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3168 /* SX_HOOK <flags> [<extra>] */
3172 if (obj_type == SHT_EXTRA)
3177 /* <len> <classname> or <index> */
3178 if (flags & SHF_IDX_CLASSNAME) {
3179 if (flags & SHF_LARGE_CLASSLEN)
3182 unsigned char cnum = (unsigned char) classnum;
3186 if (flags & SHF_LARGE_CLASSLEN)
3189 unsigned char clen = (unsigned char) len;
3192 WRITE(classname, len); /* Final \0 is omitted */
3195 /* <len2> <frozen-str> */
3196 if (flags & SHF_LARGE_STRLEN) {
3197 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3198 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3200 unsigned char clen = (unsigned char) len2;
3204 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3206 /* [<len3> <object-IDs>] */
3207 if (flags & SHF_HAS_LIST) {
3208 int len3 = count - 1;
3209 if (flags & SHF_LARGE_LISTLEN)
3212 unsigned char clen = (unsigned char) len3;
3217 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3218 * real pointer, rather a tag number, well under the 32-bit limit.
3221 for (i = 1; i < count; i++) {
3222 I32 tagval = htonl(LOW_32BITS(ary[i]));
3224 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3229 * Free the array. We need extra care for indices after 0, since they
3230 * don't hold real SVs but integers cast.
3234 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3239 * If object was tied, need to insert serialization of the magic object.
3242 if (obj_type == SHT_EXTRA) {
3245 if (!(mg = mg_find(sv, mtype))) {
3246 int svt = SvTYPE(sv);
3247 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3248 mtype, (svt == SVt_PVHV) ? "hash" :
3249 (svt == SVt_PVAV) ? "array" : "scalar"));
3252 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3253 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3259 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3267 * store_blessed -- dispatched manually, not via sv_store[]
3269 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3270 * of its ancestors. If there is, then redispatch to store_hook();
3272 * Otherwise, the blessed SV is stored using the following layout:
3274 * SX_BLESS <flag> <len> <classname> <object>
3276 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3277 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3278 * Otherwise, the low order bits give the length, thereby giving a compact
3279 * representation for class names less than 127 chars long.
3281 * Each <classname> seen is remembered and indexed, so that the next time
3282 * an object in the blessed in the same <classname> is stored, the following
3285 * SX_IX_BLESS <flag> <index> <object>
3287 * where <index> is the classname index, stored on 0 or 4 bytes depending
3288 * on the high-order bit in flag (same encoding as above for <len>).
3290 static int store_blessed(
3302 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME_get(pkg)));
3305 * Look for a hook for this blessed SV and redirect to store_hook()
3309 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3311 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3314 * This is a blessed SV without any serialization hook.
3317 classname = HvNAME_get(pkg);
3318 len = strlen(classname);
3320 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3321 PTR2UV(sv), classname, cxt->tagnum));
3324 * Determine whether it is the first time we see that class name (in which
3325 * case it will be stored in the SX_BLESS form), or whether we already
3326 * saw that class name before (in which case the SX_IX_BLESS form will be
3330 if (known_class(aTHX_ cxt, classname, len, &classnum)) {
3331 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3332 PUTMARK(SX_IX_BLESS);
3333 if (classnum <= LG_BLESS) {
3334 unsigned char cnum = (unsigned char) classnum;
3337 unsigned char flag = (unsigned char) 0x80;
3342 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3344 if (len <= LG_BLESS) {
3345 unsigned char clen = (unsigned char) len;
3348 unsigned char flag = (unsigned char) 0x80;
3350 WLEN(len); /* Don't BER-encode, this should be rare */
3352 WRITE(classname, len); /* Final \0 is omitted */
3356 * Now emit the <object> part.
3359 return SV_STORE(type)(aTHX_ cxt, sv);
3365 * We don't know how to store the item we reached, so return an error condition.
3366 * (it's probably a GLOB, some CODE reference, etc...)
3368 * If they defined the 'forgive_me' variable at the Perl level to some
3369 * true value, then don't croak, just warn, and store a placeholder string
3372 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3377 TRACEME(("store_other"));
3380 * Fetch the value from perl only once per store() operation.
3384 cxt->forgive_me == 0 ||
3385 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3386 SvTRUE(perl_get_sv("Storable::forgive_me", GV_ADD)) ? 1 : 0))
3388 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3390 warn("Can't store item %s(0x%"UVxf")",
3391 sv_reftype(sv, FALSE), PTR2UV(sv));
3394 * Store placeholder string as a scalar instead...
3397 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3398 PTR2UV(sv), (char) 0);
3401 STORE_SCALAR(buf, len);
3402 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3408 *** Store driving routines
3414 * WARNING: partially duplicates Perl's sv_reftype for speed.
3416 * Returns the type of the SV, identified by an integer. That integer
3417 * may then be used to index the dynamic routine dispatch table.
3419 static int sv_type(pTHX_ SV *sv)
3421 switch (SvTYPE(sv)) {
3423 #if PERL_VERSION <= 10
3428 * No need to check for ROK, that can't be set here since there
3429 * is no field capable of hodling the xrv_rv reference.
3433 #if PERL_VERSION <= 10
3441 * Starting from SVt_PV, it is possible to have the ROK flag
3442 * set, the pointer to the other SV being either stored in
3443 * the xrv_rv (in the case of a pure SVt_RV), or as the
3444 * xpv_pv field of an SVt_PV and its heirs.
3446 * However, those SV cannot be magical or they would be an
3447 * SVt_PVMG at least.
3449 return SvROK(sv) ? svis_REF : svis_SCALAR;
3451 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3452 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3453 return svis_TIED_ITEM;
3455 #if PERL_VERSION < 9
3458 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3460 return SvROK(sv) ? svis_REF : svis_SCALAR;
3462 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3466 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3471 #if PERL_VERSION > 8
3472 /* case SVt_BIND: */
3484 * Recursively store objects pointed to by the sv to the specified file.
3486 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3487 * object (one for which storage has started -- it may not be over if we have
3488 * a self-referenced structure). This data set forms a stored <object>.
3490 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3495 #ifdef USE_PTR_TABLE
3496 struct ptr_tbl *pseen = cxt->pseen;
3498 HV *hseen = cxt->hseen;
3501 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3504 * If object has already been stored, do not duplicate data.
3505 * Simply emit the SX_OBJECT marker followed by its tag data.
3506 * The tag is always written in network order.
3508 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3509 * real pointer, rather a tag number (watch the insertion code below).
3510 * That means it probably safe to assume it is well under the 32-bit limit,
3511 * and makes the truncation safe.
3512 * -- RAM, 14/09/1999
3515 #ifdef USE_PTR_TABLE
3516 svh = (SV **)ptr_table_fetch(pseen, sv);
3518 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3523 if (sv == &PL_sv_undef) {
3524 /* We have seen PL_sv_undef before, but fake it as
3527 Not the simplest solution to making restricted
3528 hashes work on 5.8.0, but it does mean that
3529 repeated references to the one true undef will
3530 take up less space in the output file.
3532 /* Need to jump past the next hv_store, because on the
3533 second store of undef the old hash value will be
3534 SvREFCNT_dec()ed, and as Storable cheats horribly
3535 by storing non-SVs in the hash a SEGV will ensure.
3536 Need to increase the tag number so that the
3537 receiver has no idea what games we're up to. This
3538 special casing doesn't affect hooks that store
3539 undef, as the hook routine does its own lookup into
3540 hseen. Also this means that any references back
3541 to PL_sv_undef (from the pathological case of hooks
3542 storing references to it) will find the seen hash
3543 entry for the first time, as if we didn't have this
3544 hackery here. (That hseen lookup works even on 5.8.0
3545 because it's a key of &PL_sv_undef and a value
3546 which is a tag number, not a value which is
3550 goto undef_special_case;
3553 #ifdef USE_PTR_TABLE
3554 tagval = htonl(LOW_32BITS(((char *)svh)-1));
3556 tagval = htonl(LOW_32BITS(*svh));
3559 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3567 * Allocate a new tag and associate it with the address of the sv being
3568 * stored, before recursing...
3570 * In order to avoid creating new SvIVs to hold the tagnum we just
3571 * cast the tagnum to an SV pointer and store that in the hash. This
3572 * means that we must clean up the hash manually afterwards, but gives
3573 * us a 15% throughput increase.
3578 #ifdef USE_PTR_TABLE
3579 ptr_table_store(pseen, sv, INT2PTR(SV*, 1 + cxt->tagnum));
3581 if (!hv_store(hseen,
3582 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3587 * Store 'sv' and everything beneath it, using appropriate routine.
3588 * Abort immediately if we get a non-zero status back.
3591 type = sv_type(aTHX_ sv);
3594 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3595 PTR2UV(sv), cxt->tagnum, type));
3598 HV *pkg = SvSTASH(sv);
3599 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3601 ret = SV_STORE(type)(aTHX_ cxt, sv);
3603 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3604 ret ? "FAILED" : "ok", PTR2UV(sv),
3605 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3613 * Write magic number and system information into the file.
3614 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3615 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3616 * All size and lenghts are written as single characters here.
3618 * Note that no byte ordering info is emitted when <network> is true, since
3619 * integers will be emitted in network order in that case.
3621 static int magic_write(pTHX_ stcxt_t *cxt)
3624 * Starting with 0.6, the "use_network_order" byte flag is also used to
3625 * indicate the version number of the binary image, encoded in the upper
3626 * bits. The bit 0 is always used to indicate network order.
3629 * Starting with 0.7, a full byte is dedicated to the minor version of
3630 * the binary format, which is incremented only when new markers are
3631 * introduced, for instance, but when backward compatibility is preserved.
3634 /* Make these at compile time. The WRITE() macro is sufficiently complex
3635 that it saves about 200 bytes doing it this way and only using it
3637 static const unsigned char network_file_header[] = {
3639 (STORABLE_BIN_MAJOR << 1) | 1,
3640 STORABLE_BIN_WRITE_MINOR
3642 static const unsigned char file_header[] = {
3644 (STORABLE_BIN_MAJOR << 1) | 0,
3645 STORABLE_BIN_WRITE_MINOR,
3646 /* sizeof the array includes the 0 byte at the end: */
3647 (char) sizeof (byteorderstr) - 1,
3649 (unsigned char) sizeof(int),
3650 (unsigned char) sizeof(long),
3651 (unsigned char) sizeof(char *),
3652 (unsigned char) sizeof(NV)
3654 #ifdef USE_56_INTERWORK_KLUDGE
3655 static const unsigned char file_header_56[] = {
3657 (STORABLE_BIN_MAJOR << 1) | 0,
3658 STORABLE_BIN_WRITE_MINOR,
3659 /* sizeof the array includes the 0 byte at the end: */
3660 (char) sizeof (byteorderstr_56) - 1,
3662 (unsigned char) sizeof(int),
3663 (unsigned char) sizeof(long),
3664 (unsigned char) sizeof(char *),
3665 (unsigned char) sizeof(NV)
3668 const unsigned char *header;
3671 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3673 if (cxt->netorder) {
3674 header = network_file_header;
3675 length = sizeof (network_file_header);
3677 #ifdef USE_56_INTERWORK_KLUDGE
3678 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", GV_ADD))) {
3679 header = file_header_56;
3680 length = sizeof (file_header_56);
3684 header = file_header;
3685 length = sizeof (file_header);
3690 /* sizeof the array includes the 0 byte at the end. */
3691 header += sizeof (magicstr) - 1;
3692 length -= sizeof (magicstr) - 1;
3695 WRITE( (unsigned char*) header, length);
3697 if (!cxt->netorder) {
3698 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3699 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3700 (int) sizeof(int), (int) sizeof(long),
3701 (int) sizeof(char *), (int) sizeof(NV)));
3709 * Common code for store operations.
3711 * When memory store is requested (f = NULL) and a non null SV* is given in
3712 * 'res', it is filled with a new SV created out of the memory buffer.
3714 * It is required to provide a non-null 'res' when the operation type is not
3715 * dclone() and store() is performed to memory.
3717 static int do_store(
3728 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3729 ("must supply result SV pointer for real recursion to memory"));
3731 TRACEME(("do_store (optype=%d, netorder=%d)",
3732 optype, network_order));
3737 * Workaround for CROAK leak: if they enter with a "dirty" context,
3738 * free up memory for them now.
3742 clean_context(aTHX_ cxt);
3745 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3746 * re-enter store() via the hooks. We need to stack contexts.
3750 cxt = allocate_context(aTHX_ cxt);
3754 ASSERT(cxt->entry == 1, ("starting new recursion"));
3755 ASSERT(!cxt->s_dirty, ("clean context"));
3758 * Ensure sv is actually a reference. From perl, we called something
3760 * pstore(aTHX_ FILE, \@array);
3761 * so we must get the scalar value behind that reference.
3765 CROAK(("Not a reference"));
3766 sv = SvRV(sv); /* So follow it to know what to store */
3769 * If we're going to store to memory, reset the buffer.
3776 * Prepare context and emit headers.
3779 init_store_context(aTHX_ cxt, f, optype, network_order);
3781 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3782 return 0; /* Error */
3785 * Recursively store object...
3788 ASSERT(is_storing(aTHX), ("within store operation"));
3790 status = store(aTHX_ cxt, sv); /* Just do it! */
3793 * If they asked for a memory store and they provided an SV pointer,
3794 * make an SV string out of the buffer and fill their pointer.
3796 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3797 * an SV, since context cleanup might free the buffer if we did recurse.
3798 * (unless caller is dclone(), which is aware of that).
3801 if (!cxt->fio && res)
3802 *res = mbuf2sv(aTHX);
3807 * The "root" context is never freed, since it is meant to be always
3808 * handy for the common case where no recursion occurs at all (i.e.
3809 * we enter store() outside of any Storable code and leave it, period).
3810 * We know it's the "root" context because there's nothing stacked
3815 * When deep cloning, we don't free the context: doing so would force
3816 * us to copy the data in the memory buffer. Sicne we know we're
3817 * about to enter do_retrieve...
3820 clean_store_context(aTHX_ cxt);
3821 if (cxt->prev && !(cxt->optype & ST_CLONE))
3822 free_context(aTHX_ cxt);
3824 TRACEME(("do_store returns %d", status));
3836 * Build a new SV out of the content of the internal memory buffer.
3838 static SV *mbuf2sv(pTHX)
3842 return newSVpv(mbase, MBUF_SIZE());
3846 *** Specific retrieve callbacks.
3852 * Return an error via croak, since it is not possible that we get here
3853 * under normal conditions, when facing a file produced via pstore().
3855 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname)
3857 PERL_UNUSED_ARG(cname);
3859 cxt->ver_major != STORABLE_BIN_MAJOR &&
3860 cxt->ver_minor != STORABLE_BIN_MINOR
3862 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3863 cxt->fio ? "file" : "string",
3864 cxt->ver_major, cxt->ver_minor,
3865 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3867 CROAK(("Corrupted storable %s (binary v%d.%d)",
3868 cxt->fio ? "file" : "string",
3869 cxt->ver_major, cxt->ver_minor));
3872 return (SV *) 0; /* Just in case */
3876 * retrieve_idx_blessed
3878 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3879 * <index> can be coded on either 1 or 5 bytes.
3881 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3884 const char *classname;
3888 PERL_UNUSED_ARG(cname);
3889 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3890 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3892 GETMARK(idx); /* Index coded on a single char? */
3897 * Fetch classname in 'aclass'
3900 sva = av_fetch(cxt->aclass, idx, FALSE);
3902 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3904 classname = SvPVX(*sva); /* We know it's a PV, by construction */
3906 TRACEME(("class ID %d => %s", idx, classname));
3909 * Retrieve object and bless it.
3912 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3920 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3921 * <len> can be coded on either 1 or 5 bytes.
3923 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3927 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3928 char *classname = buf;
3929 char *malloced_classname = NULL;
3931 PERL_UNUSED_ARG(cname);
3932 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3933 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3936 * Decode class name length and read that name.
3938 * Short classnames have two advantages: their length is stored on one
3939 * single byte, and the string can be read on the stack.
3942 GETMARK(len); /* Length coded on a single char? */
3945 TRACEME(("** allocating %d bytes for class name", len+1));
3946 New(10003, classname, len+1, char);
3947 malloced_classname = classname;
3949 SAFEPVREAD(classname, len, malloced_classname);
3950 classname[len] = '\0'; /* Mark string end */
3953 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3956 TRACEME(("new class name \"%s\" will bear ID = %d", classname, cxt->classnum));
3958 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len))) {
3959 Safefree(malloced_classname);
3964 * Retrieve object and bless it.
3967 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3968 if (malloced_classname)
3969 Safefree(malloced_classname);
3977 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3978 * with leading mark already read, as usual.
3980 * When recursion was involved during serialization of the object, there
3981 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
3982 * we reach a <flags> marker with the recursion bit cleared.
3984 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
3985 * is held in the <extra> byte, and if the object is tied, the serialized
3986 * magic object comes at the very end:
3988 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
3990 * This means the STORABLE_thaw hook will NOT get a tied variable during its
3991 * processing (since we won't have seen the magic object by the time the hook
3992 * is called). See comments below for why it was done that way.
3994 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname)
3997 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3998 char *classname = buf;
4009 int clone = cxt->optype & ST_CLONE;
4011 unsigned int extra_type = 0;
4013 PERL_UNUSED_ARG(cname);
4014 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
4015 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
4018 * Read flags, which tell us about the type, and whether we need to recurse.
4024 * Create the (empty) object, and mark it as seen.
4026 * This must be done now, because tags are incremented, and during
4027 * serialization, the object tag was affected before recursion could
4031 obj_type = flags & SHF_TYPE_MASK;
4037 sv = (SV *) newAV();
4040 sv = (SV *) newHV();
4044 * Read <extra> flag to know the type of the object.
4045 * Record associated magic type for later.
4047 GETMARK(extra_type);
4048 switch (extra_type) {
4054 sv = (SV *) newAV();
4058 sv = (SV *) newHV();
4062 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4066 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
4068 SEEN(sv, 0, 0); /* Don't bless yet */
4071 * Whilst flags tell us to recurse, do so.
4073 * We don't need to remember the addresses returned by retrieval, because
4074 * all the references will be obtained through indirection via the object
4075 * tags in the object-ID list.
4077 * We need to decrement the reference count for these objects
4078 * because, if the user doesn't save a reference to them in the hook,
4079 * they must be freed when this context is cleaned.
4082 while (flags & SHF_NEED_RECURSE) {
4083 TRACEME(("retrieve_hook recursing..."));
4084 rv = retrieve(aTHX_ cxt, 0);
4088 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
4093 if (flags & SHF_IDX_CLASSNAME) {
4098 * Fetch index from 'aclass'
4101 if (flags & SHF_LARGE_CLASSLEN)
4106 sva = av_fetch(cxt->aclass, idx, FALSE);
4108 CROAK(("Class name #%"IVdf" should have been seen already",
4111 classname = SvPVX(*sva); /* We know it's a PV, by construction */
4112 TRACEME(("class ID %d => %s", idx, classname));
4116 * Decode class name length and read that name.
4118 * NOTA BENE: even if the length is stored on one byte, we don't read
4119 * on the stack. Just like retrieve_blessed(), we limit the name to
4120 * LG_BLESS bytes. This is an arbitrary decision.
4122 char *malloced_classname = NULL;
4124 if (flags & SHF_LARGE_CLASSLEN)
4129 if (len > LG_BLESS) {
4130 TRACEME(("** allocating %d bytes for class name", len+1));
4131 New(10003, classname, len+1, char);
4132 malloced_classname = classname;
4135 SAFEPVREAD(classname, len, malloced_classname);
4136 classname[len] = '\0'; /* Mark string end */
4139 * Record new classname.
4142 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len))) {
4143 Safefree(malloced_classname);
4148 TRACEME(("class name: %s", classname));
4151 * Decode user-frozen string length and read it in an SV.
4153 * For efficiency reasons, we read data directly into the SV buffer.
4154 * To understand that code, read retrieve_scalar()
4157 if (flags & SHF_LARGE_STRLEN)
4162 frozen = NEWSV(10002, len2);
4164 SAFEREAD(SvPVX(frozen), len2, frozen);
4165 SvCUR_set(frozen, len2);
4166 *SvEND(frozen) = '\0';
4168 (void) SvPOK_only(frozen); /* Validates string pointer */
4169 if (cxt->s_tainted) /* Is input source tainted? */
4172 TRACEME(("frozen string: %d bytes", len2));
4175 * Decode object-ID list length, if present.
4178 if (flags & SHF_HAS_LIST) {
4179 if (flags & SHF_LARGE_LISTLEN)
4185 av_extend(av, len3 + 1); /* Leave room for [0] */
4186 AvFILLp(av) = len3; /* About to be filled anyway */
4190 TRACEME(("has %d object IDs to link", len3));
4193 * Read object-ID list into array.
4194 * Because we pre-extended it, we can cheat and fill it manually.
4196 * We read object tags and we can convert them into SV* on the fly
4197 * because we know all the references listed in there (as tags)
4198 * have been already serialized, hence we have a valid correspondence
4199 * between each of those tags and the recreated SV.
4203 SV **ary = AvARRAY(av);
4205 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
4212 svh = av_fetch(cxt->aseen, tag, FALSE);
4214 if (tag == cxt->where_is_undef) {
4215 /* av_fetch uses PL_sv_undef internally, hence this
4216 somewhat gruesome hack. */
4220 CROAK(("Object #%"IVdf" should have been retrieved already",
4225 ary[i] = SvREFCNT_inc(xsv);
4230 * Bless the object and look up the STORABLE_thaw hook.
4233 BLESS(sv, classname);
4235 /* Handle attach case; again can't use pkg_can because it only
4236 * caches one method */
4237 attach = gv_fetchmethod_autoload(SvSTASH(sv), "STORABLE_attach", FALSE);
4238 if (attach && isGV(attach)) {
4240 SV* attach_hook = newRV((SV*) GvCV(attach));
4243 CROAK(("STORABLE_attach called with unexpected references"));
4247 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4248 rv = newSVpv(classname, 0);
4249 attached = scalar_call(aTHX_ rv, attach_hook, clone, av, G_SCALAR);
4252 sv_derived_from(attached, classname)
4255 SEEN(SvRV(attached), 0, 0);
4256 return SvRV(attached);
4258 CROAK(("STORABLE_attach did not return a %s object", classname));
4261 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4264 * Hook not found. Maybe they did not require the module where this
4265 * hook is defined yet?
4267 * If the load below succeeds, we'll be able to find the hook.
4268 * Still, it only works reliably when each class is defined in a
4272 TRACEME(("No STORABLE_thaw defined for objects of class %s", classname));
4273 TRACEME(("Going to load module '%s'", classname));
4274 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(classname, 0), Nullsv);
4277 * We cache results of pkg_can, so we need to uncache before attempting
4281 pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4282 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4285 CROAK(("No STORABLE_thaw defined for objects of class %s "
4286 "(even after a \"require %s;\")", classname, classname));
4290 * If we don't have an 'av' yet, prepare one.
4291 * Then insert the frozen string as item [0].
4299 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4304 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4306 * where $object is our blessed (empty) object, $cloning is a boolean
4307 * telling whether we're running a deep clone, $frozen is the frozen
4308 * string the user gave us in his serializing hook, and @refs, which may
4309 * be empty, is the list of extra references he returned along for us
4312 * In effect, the hook is an alternate creation routine for the class,
4313 * the object itself being already created by the runtime.
4316 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4317 classname, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4320 (void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
4327 SvREFCNT_dec(frozen);
4330 if (!(flags & SHF_IDX_CLASSNAME) && classname != buf)
4331 Safefree(classname);
4334 * If we had an <extra> type, then the object was not as simple, and
4335 * we need to restore extra magic now.
4341 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4343 rv = retrieve(aTHX_ cxt, 0); /* Retrieve <magic object> */
4345 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4346 PTR2UV(rv), PTR2UV(sv)));
4348 switch (extra_type) {
4350 sv_upgrade(sv, SVt_PVMG);
4353 sv_upgrade(sv, SVt_PVAV);
4354 AvREAL_off((AV *)sv);
4357 sv_upgrade(sv, SVt_PVHV);
4360 CROAK(("Forgot to deal with extra type %d", extra_type));
4365 * Adding the magic only now, well after the STORABLE_thaw hook was called
4366 * means the hook cannot know it deals with an object whose variable is
4367 * tied. But this is happening when retrieving $o in the following case:
4371 * my $o = bless \%h, 'BAR';
4373 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4374 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4375 * hash but a tied one should not matter at all, and remain transparent.
4376 * This means the magic must be restored by Storable AFTER the hook is
4379 * That looks very reasonable to me, but then I've come up with this
4380 * after a bug report from David Nesting, who was trying to store such
4381 * an object and caused Storable to fail. And unfortunately, it was
4382 * also the easiest way to retrofit support for blessed ref to tied objects
4383 * into the existing design. -- RAM, 17/02/2001
4386 sv_magic(sv, rv, mtype, (char *)NULL, 0);
4387 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4395 * Retrieve reference to some other scalar.
4396 * Layout is SX_REF <object>, with SX_REF already read.
4398 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname)
4403 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4406 * We need to create the SV that holds the reference to the yet-to-retrieve
4407 * object now, so that we may record the address in the seen table.
4408 * Otherwise, if the object to retrieve references us, we won't be able
4409 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4410 * do the retrieve first and use rv = newRV(sv) since it will be too late
4411 * for SEEN() recording.
4414 rv = NEWSV(10002, 0);
4415 SEEN(rv, cname, 0); /* Will return if rv is null */
4416 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4418 return (SV *) 0; /* Failed */
4421 * WARNING: breaks RV encapsulation.
4423 * Now for the tricky part. We have to upgrade our existing SV, so that
4424 * it is now an RV on sv... Again, we cheat by duplicating the code
4425 * held in newSVrv(), since we already got our SV from retrieve().
4429 * SvRV(rv) = SvREFCNT_inc(sv);
4431 * here because the reference count we got from retrieve() above is
4432 * already correct: if the object was retrieved from the file, then
4433 * its reference count is one. Otherwise, if it was retrieved via
4434 * an SX_OBJECT indication, a ref count increment was done.
4438 /* No need to do anything, as rv will already be PVMG. */
4439 assert (SvTYPE(rv) == SVt_RV || SvTYPE(rv) >= SVt_PV);
4441 sv_upgrade(rv, SVt_RV);
4444 SvRV_set(rv, sv); /* $rv = \$sv */
4447 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4455 * Retrieve weak reference to some other scalar.
4456 * Layout is SX_WEAKREF <object>, with SX_WEAKREF already read.
4458 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname)
4462 TRACEME(("retrieve_weakref (#%d)", cxt->tagnum));
4464 sv = retrieve_ref(aTHX_ cxt, cname);
4476 * retrieve_overloaded
4478 * Retrieve reference to some other scalar with overloading.
4479 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4481 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname)
4487 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4490 * Same code as retrieve_ref(), duplicated to avoid extra call.
4493 rv = NEWSV(10002, 0);
4494 SEEN(rv, cname, 0); /* Will return if rv is null */
4495 cxt->in_retrieve_overloaded = 1; /* so sv_bless doesn't call S_reset_amagic */
4496 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4497 cxt->in_retrieve_overloaded = 0;
4499 return (SV *) 0; /* Failed */
4502 * WARNING: breaks RV encapsulation.
4505 SvUPGRADE(rv, SVt_RV);
4506 SvRV_set(rv, sv); /* $rv = \$sv */
4510 * Restore overloading magic.
4513 stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
4515 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4516 ") (package <unknown>)",
4517 sv_reftype(sv, FALSE),
4520 if (!Gv_AMG(stash)) {
4521 const char *package = HvNAME_get(stash);
4522 TRACEME(("No overloading defined for package %s", package));
4523 TRACEME(("Going to load module '%s'", package));
4524 load_module(PERL_LOADMOD_NOIMPORT, newSVpv(package, 0), Nullsv);
4525 if (!Gv_AMG(stash)) {
4526 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4527 ") (package %s) (even after a \"require %s;\")",
4528 sv_reftype(sv, FALSE),
4536 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4542 * retrieve_weakoverloaded
4544 * Retrieve weak overloaded reference to some other scalar.
4545 * Layout is SX_WEAKOVERLOADED <object>, with SX_WEAKOVERLOADED already read.
4547 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname)
4551 TRACEME(("retrieve_weakoverloaded (#%d)", cxt->tagnum));
4553 sv = retrieve_overloaded(aTHX_ cxt, cname);
4565 * retrieve_tied_array
4567 * Retrieve tied array
4568 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4570 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname)
4575 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4577 tv = NEWSV(10002, 0);
4578 SEEN(tv, cname, 0); /* Will return if tv is null */
4579 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4581 return (SV *) 0; /* Failed */
4583 sv_upgrade(tv, SVt_PVAV);
4584 AvREAL_off((AV *)tv);
4585 sv_magic(tv, sv, 'P', (char *)NULL, 0);
4586 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4588 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4594 * retrieve_tied_hash
4596 * Retrieve tied hash
4597 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4599 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname)
4604 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4606 tv = NEWSV(10002, 0);
4607 SEEN(tv, cname, 0); /* Will return if tv is null */
4608 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4610 return (SV *) 0; /* Failed */
4612 sv_upgrade(tv, SVt_PVHV);
4613 sv_magic(tv, sv, 'P', (char *)NULL, 0);
4614 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4616 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4622 * retrieve_tied_scalar
4624 * Retrieve tied scalar
4625 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4627 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4630 SV *sv, *obj = NULL;
4632 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4634 tv = NEWSV(10002, 0);
4635 SEEN(tv, cname, 0); /* Will return if rv is null */
4636 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4638 return (SV *) 0; /* Failed */
4640 else if (SvTYPE(sv) != SVt_NULL) {
4644 sv_upgrade(tv, SVt_PVMG);
4645 sv_magic(tv, obj, 'q', (char *)NULL, 0);
4648 /* Undo refcnt inc from sv_magic() */
4652 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4660 * Retrieve reference to value in a tied hash.
4661 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4663 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname)
4669 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4671 tv = NEWSV(10002, 0);
4672 SEEN(tv, cname, 0); /* Will return if tv is null */
4673 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4675 return (SV *) 0; /* Failed */
4677 key = retrieve(aTHX_ cxt, 0); /* Retrieve <key> */
4679 return (SV *) 0; /* Failed */
4681 sv_upgrade(tv, SVt_PVMG);
4682 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4683 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4684 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4692 * Retrieve reference to value in a tied array.
4693 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4695 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname)
4701 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4703 tv = NEWSV(10002, 0);
4704 SEEN(tv, cname, 0); /* Will return if tv is null */
4705 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4707 return (SV *) 0; /* Failed */
4709 RLEN(idx); /* Retrieve <idx> */
4711 sv_upgrade(tv, SVt_PVMG);
4712 sv_magic(tv, sv, 'p', (char *)NULL, idx);
4713 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4722 * Retrieve defined long (string) scalar.
4724 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4725 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4726 * was not stored on a single byte.
4728 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname)
4734 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4737 * Allocate an empty scalar of the suitable length.
4740 sv = NEWSV(10002, len);
4741 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4744 sv_setpvn(sv, "", 0);
4749 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4751 * Now, for efficiency reasons, read data directly inside the SV buffer,
4752 * and perform the SV final settings directly by duplicating the final
4753 * work done by sv_setpv. Since we're going to allocate lots of scalars
4754 * this way, it's worth the hassle and risk.
4757 SAFEREAD(SvPVX(sv), len, sv);
4758 SvCUR_set(sv, len); /* Record C string length */
4759 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4760 (void) SvPOK_only(sv); /* Validate string pointer */
4761 if (cxt->s_tainted) /* Is input source tainted? */
4762 SvTAINT(sv); /* External data cannot be trusted */
4764 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4765 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4773 * Retrieve defined short (string) scalar.
4775 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4776 * The scalar is "short" so <length> is single byte. If it is 0, there
4777 * is no <data> section.
4779 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname)
4785 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4788 * Allocate an empty scalar of the suitable length.
4791 sv = NEWSV(10002, len);
4792 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4795 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4800 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4801 * To make it defined with an empty length, upgrade it now...
4802 * Don't upgrade to a PV if the original type contains more
4803 * information than a scalar.
4805 if (SvTYPE(sv) <= SVt_PV) {
4806 sv_upgrade(sv, SVt_PV);
4809 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4810 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4813 * Now, for efficiency reasons, read data directly inside the SV buffer,
4814 * and perform the SV final settings directly by duplicating the final
4815 * work done by sv_setpv. Since we're going to allocate lots of scalars
4816 * this way, it's worth the hassle and risk.
4818 SAFEREAD(SvPVX(sv), len, sv);
4819 SvCUR_set(sv, len); /* Record C string length */
4820 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4821 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4824 (void) SvPOK_only(sv); /* Validate string pointer */
4825 if (cxt->s_tainted) /* Is input source tainted? */
4826 SvTAINT(sv); /* External data cannot be trusted */
4828 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4835 * Like retrieve_scalar(), but tag result as utf8.
4836 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4838 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname)
4842 TRACEME(("retrieve_utf8str"));
4844 sv = retrieve_scalar(aTHX_ cxt, cname);
4846 #ifdef HAS_UTF8_SCALARS
4849 if (cxt->use_bytes < 0)
4851 = (SvTRUE(perl_get_sv("Storable::drop_utf8", GV_ADD))
4853 if (cxt->use_bytes == 0)
4864 * Like retrieve_lscalar(), but tag result as utf8.
4865 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4867 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname)
4871 TRACEME(("retrieve_lutf8str"));
4873 sv = retrieve_lscalar(aTHX_ cxt, cname);
4875 #ifdef HAS_UTF8_SCALARS
4878 if (cxt->use_bytes < 0)
4880 = (SvTRUE(perl_get_sv("Storable::drop_utf8", GV_ADD))
4882 if (cxt->use_bytes == 0)
4892 * Retrieve a vstring, and then retrieve the stringy scalar following it,
4893 * attaching the vstring to the scalar via magic.
4894 * If we're retrieving a vstring in a perl without vstring magic, croaks.
4896 * The vstring layout mirrors an SX_SCALAR string:
4897 * SX_VSTRING <length> <data> with SX_VSTRING already read.
4899 static SV *retrieve_vstring(pTHX_ stcxt_t *cxt, const char *cname)
4908 TRACEME(("retrieve_vstring (#%d), len = %d", cxt->tagnum, len));
4912 sv = retrieve(aTHX_ cxt, cname);
4914 sv_magic(sv,NULL,PERL_MAGIC_vstring,s,len);
4915 /* 5.10.0 and earlier seem to need this */
4918 TRACEME(("ok (retrieve_vstring at 0x%"UVxf")", PTR2UV(sv)));
4929 * Like retrieve_vstring, but for longer vstrings.
4931 static SV *retrieve_lvstring(pTHX_ stcxt_t *cxt, const char *cname)
4940 TRACEME(("retrieve_lvstring (#%d), len = %"IVdf,
4941 cxt->tagnum, (IV)len));
4943 New(10003, s, len+1, char);
4944 SAFEPVREAD(s, len, s);
4946 sv = retrieve(aTHX_ cxt, cname);
4948 sv_magic(sv,NULL,PERL_MAGIC_vstring,s,len);
4949 /* 5.10.0 and earlier seem to need this */
4954 TRACEME(("ok (retrieve_lvstring at 0x%"UVxf")", PTR2UV(sv)));
4965 * Retrieve defined integer.
4966 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4968 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname)
4973 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4975 READ(&iv, sizeof(iv));
4977 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4979 TRACEME(("integer %"IVdf, iv));
4980 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4988 * Retrieve defined integer in network order.
4989 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4991 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname)
4996 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
5000 sv = newSViv((int) ntohl(iv));
5001 TRACEME(("network integer %d", (int) ntohl(iv)));
5004 TRACEME(("network integer (as-is) %d", iv));
5006 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5008 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
5016 * Retrieve defined double.
5017 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
5019 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname)
5024 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
5026 READ(&nv, sizeof(nv));
5028 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5030 TRACEME(("double %"NVff, nv));
5031 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
5039 * Retrieve defined byte (small integer within the [-128, +127] range).
5040 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
5042 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname)
5046 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
5048 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
5051 TRACEME(("small integer read as %d", (unsigned char) siv));
5052 tmp = (unsigned char) siv - 128;
5054 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
5056 TRACEME(("byte %d", tmp));
5057 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
5065 * Return the undefined value.
5067 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname)
5071 TRACEME(("retrieve_undef"));
5082 * Return the immortal undefined value.
5084 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname)
5086 SV *sv = &PL_sv_undef;
5088 TRACEME(("retrieve_sv_undef"));
5090 /* Special case PL_sv_undef, as av_fetch uses it internally to mark
5091 deleted elements, and will return NULL (fetch failed) whenever it
5093 if (cxt->where_is_undef == -1) {
5094 cxt->where_is_undef = cxt->tagnum;
5103 * Return the immortal yes value.
5105 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname)
5107 SV *sv = &PL_sv_yes;
5109 TRACEME(("retrieve_sv_yes"));
5118 * Return the immortal no value.
5120 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname)
5124 TRACEME(("retrieve_sv_no"));
5133 * Retrieve a whole array.
5134 * Layout is SX_ARRAY <size> followed by each item, in increasing index order.
5135 * Each item is stored as <object>.
5137 * When we come here, SX_ARRAY has been read already.
5139 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5146 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
5149 * Read length, and allocate array, then pre-extend it.
5153 TRACEME(("size = %d", len));
5155 SEEN(av, cname, 0); /* Will return if array not allocated nicely */
5159 return (SV *) av; /* No data follow if array is empty */
5162 * Now get each item in turn...
5165 for (i = 0; i < len; i++) {
5166 TRACEME(("(#%d) item", i));
5167 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5170 if (av_store(av, i, sv) == 0)
5174 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5182 * Retrieve a whole hash table.
5183 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5184 * Keys are stored as <length> <data>, the <data> section being omitted
5186 * Values are stored as <object>.
5188 * When we come here, SX_HASH has been read already.
5190 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5198 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
5201 * Read length, allocate table.
5205 TRACEME(("size = %d", len));
5207 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5209 return (SV *) hv; /* No data follow if table empty */
5210 hv_ksplit(hv, len + 1); /* pre-extend hash to save multiple splits */
5213 * Now get each key/value pair in turn...
5216 for (i = 0; i < len; i++) {
5221 TRACEME(("(#%d) value", i));
5222 sv = retrieve(aTHX_ cxt, 0);
5228 * Since we're reading into kbuf, we must ensure we're not
5229 * recursing between the read and the hv_store() where it's used.
5230 * Hence the key comes after the value.
5233 RLEN(size); /* Get key size */
5234 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5237 kbuf[size] = '\0'; /* Mark string end, just in case */
5238 TRACEME(("(#%d) key '%s'", i, kbuf));
5241 * Enter key/value pair into hash table.
5244 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5248 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5256 * Retrieve a whole hash table.
5257 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5258 * Keys are stored as <length> <data>, the <data> section being omitted
5260 * Values are stored as <object>.
5262 * When we come here, SX_HASH has been read already.
5264 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname)
5274 GETMARK(hash_flags);
5275 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
5277 * Read length, allocate table.
5280 #ifndef HAS_RESTRICTED_HASHES
5281 if (hash_flags & SHV_RESTRICTED) {
5282 if (cxt->derestrict < 0)
5284 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", GV_ADD))
5286 if (cxt->derestrict == 0)
5287 RESTRICTED_HASH_CROAK();
5292 TRACEME(("size = %d, flags = %d", len, hash_flags));
5294 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5296 return (SV *) hv; /* No data follow if table empty */
5297 hv_ksplit(hv, len + 1); /* pre-extend hash to save multiple splits */
5300 * Now get each key/value pair in turn...
5303 for (i = 0; i < len; i++) {
5305 int store_flags = 0;
5310 TRACEME(("(#%d) value", i));
5311 sv = retrieve(aTHX_ cxt, 0);
5316 #ifdef HAS_RESTRICTED_HASHES
5317 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
5321 if (flags & SHV_K_ISSV) {
5322 /* XXX you can't set a placeholder with an SV key.
5323 Then again, you can't get an SV key.
5324 Without messing around beyond what the API is supposed to do.
5327 TRACEME(("(#%d) keysv, flags=%d", i, flags));
5328 keysv = retrieve(aTHX_ cxt, 0);
5332 if (!hv_store_ent(hv, keysv, sv, 0))
5337 * Since we're reading into kbuf, we must ensure we're not
5338 * recursing between the read and the hv_store() where it's used.
5339 * Hence the key comes after the value.
5342 if (flags & SHV_K_PLACEHOLDER) {
5344 sv = &PL_sv_placeholder;
5345 store_flags |= HVhek_PLACEHOLD;
5347 if (flags & SHV_K_UTF8) {
5348 #ifdef HAS_UTF8_HASHES
5349 store_flags |= HVhek_UTF8;
5351 if (cxt->use_bytes < 0)
5353 = (SvTRUE(perl_get_sv("Storable::drop_utf8", GV_ADD))
5355 if (cxt->use_bytes == 0)
5359 #ifdef HAS_UTF8_HASHES
5360 if (flags & SHV_K_WASUTF8)
5361 store_flags |= HVhek_WASUTF8;
5364 RLEN(size); /* Get key size */
5365 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5368 kbuf[size] = '\0'; /* Mark string end, just in case */
5369 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5370 flags, store_flags));
5373 * Enter key/value pair into hash table.
5376 #ifdef HAS_RESTRICTED_HASHES
5377 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5380 if (!(store_flags & HVhek_PLACEHOLD))
5381 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5386 #ifdef HAS_RESTRICTED_HASHES
5387 if (hash_flags & SHV_RESTRICTED)
5391 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5399 * Return a code reference.
5401 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname)
5403 #if PERL_VERSION < 6
5404 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5407 int type, count, tagnum;
5409 SV *sv, *text, *sub, *errsv;
5411 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5414 * Insert dummy SV in the aseen array so that we don't screw
5415 * up the tag numbers. We would just make the internal
5416 * scalar an untagged item in the stream, but
5417 * retrieve_scalar() calls SEEN(). So we just increase the
5420 tagnum = cxt->tagnum;
5425 * Retrieve the source of the code reference
5426 * as a small or large scalar
5432 text = retrieve_scalar(aTHX_ cxt, cname);
5435 text = retrieve_lscalar(aTHX_ cxt, cname);
5438 text = retrieve_utf8str(aTHX_ cxt, cname);
5441 text = retrieve_lutf8str(aTHX_ cxt, cname);
5444 CROAK(("Unexpected type %d in retrieve_code\n", type));
5448 * prepend "sub " to the source
5451 sub = newSVpvn("sub ", 4);
5454 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5458 * evaluate the source to a code reference and use the CV value
5461 if (cxt->eval == NULL) {
5462 cxt->eval = perl_get_sv("Storable::Eval", GV_ADD);
5463 SvREFCNT_inc(cxt->eval);
5465 if (!SvTRUE(cxt->eval)) {
5467 cxt->forgive_me == 0 ||
5468 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5469 SvTRUE(perl_get_sv("Storable::forgive_me", GV_ADD)) ? 1 : 0))
5471 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5474 /* fix up the dummy entry... */
5475 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5483 errsv = get_sv("@", GV_ADD);
5484 sv_setpvn(errsv, "", 0); /* clear $@ */
5485 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5487 XPUSHs(sv_2mortal(newSVsv(sub)));
5489 count = call_sv(cxt->eval, G_SCALAR);
5491 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5493 eval_sv(sub, G_SCALAR);
5499 if (SvTRUE(errsv)) {
5500 CROAK(("code %s caused an error: %s",
5501 SvPV_nolen(sub), SvPV_nolen(errsv)));
5504 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5507 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5510 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5515 /* fix up the dummy entry... */
5516 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5523 * old_retrieve_array
5525 * Retrieve a whole array in pre-0.6 binary format.
5527 * Layout is SX_ARRAY <size> followed by each item, in increasing index order.
5528 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5530 * When we come here, SX_ARRAY has been read already.
5532 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname)
5540 PERL_UNUSED_ARG(cname);
5541 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5544 * Read length, and allocate array, then pre-extend it.
5548 TRACEME(("size = %d", len));
5550 SEEN(av, 0, 0); /* Will return if array not allocated nicely */
5554 return (SV *) av; /* No data follow if array is empty */
5557 * Now get each item in turn...
5560 for (i = 0; i < len; i++) {
5562 if (c == SX_IT_UNDEF) {
5563 TRACEME(("(#%d) undef item", i));
5564 continue; /* av_extend() already filled us with undef */
5567 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5568 TRACEME(("(#%d) item", i));
5569 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5572 if (av_store(av, i, sv) == 0)
5576 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5584 * Retrieve a whole hash table in pre-0.6 binary format.
5586 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5587 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5589 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5591 * When we come here, SX_HASH has been read already.
5593 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname)
5601 SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5603 PERL_UNUSED_ARG(cname);
5604 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5607 * Read length, allocate table.
5611 TRACEME(("size = %d", len));
5613 SEEN(hv, 0, 0); /* Will return if table not allocated properly */
5615 return (SV *) hv; /* No data follow if table empty */
5616 hv_ksplit(hv, len + 1); /* pre-extend hash to save multiple splits */
5619 * Now get each key/value pair in turn...
5622 for (i = 0; i < len; i++) {
5628 if (c == SX_VL_UNDEF) {
5629 TRACEME(("(#%d) undef value", i));
5631 * Due to a bug in hv_store(), it's not possible to pass
5632 * &PL_sv_undef to hv_store() as a value, otherwise the
5633 * associated key will not be creatable any more. -- RAM, 14/01/97
5636 sv_h_undef = newSVsv(&PL_sv_undef);
5637 sv = SvREFCNT_inc(sv_h_undef);
5638 } else if (c == SX_VALUE) {
5639 TRACEME(("(#%d) value", i));
5640 sv = retrieve(aTHX_ cxt, 0);
5644 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5648 * Since we're reading into kbuf, we must ensure we're not
5649 * recursing between the read and the hv_store() where it's used.
5650 * Hence the key comes after the value.
5655 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5656 RLEN(size); /* Get key size */
5657 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5660 kbuf[size] = '\0'; /* Mark string end, just in case */
5661 TRACEME(("(#%d) key '%s'", i, kbuf));
5664 * Enter key/value pair into hash table.
5667 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5671 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5677 *** Retrieval engine.
5683 * Make sure the stored data we're trying to retrieve has been produced
5684 * on an ILP compatible system with the same byteorder. It croaks out in
5685 * case an error is detected. [ILP = integer-long-pointer sizes]
5686 * Returns null if error is detected, &PL_sv_undef otherwise.
5688 * Note that there's no byte ordering info emitted when network order was
5689 * used at store time.
5691 static SV *magic_check(pTHX_ stcxt_t *cxt)
5693 /* The worst case for a malicious header would be old magic (which is
5694 longer), major, minor, byteorder length byte of 255, 255 bytes of
5695 garbage, sizeof int, long, pointer, NV.
5696 So the worse of that we can read is 255 bytes of garbage plus 4.
5697 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5698 compiling perl on a system with chars that are larger than 8 bits.
5699 (Even Crays aren't *that* perverse).
5701 unsigned char buf[4 + 255];
5702 unsigned char *current;
5705 int use_network_order;
5709 int version_minor = 0;
5711 TRACEME(("magic_check"));
5714 * The "magic number" is only for files, not when freezing in memory.
5718 /* This includes the '\0' at the end. I want to read the extra byte,
5719 which is usually going to be the major version number. */
5720 STRLEN len = sizeof(magicstr);
5723 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5725 /* Point at the byte after the byte we read. */
5726 current = buf + --len; /* Do the -- outside of macros. */
5728 if (memNE(buf, magicstr, len)) {
5730 * Try to read more bytes to check for the old magic number, which
5734 TRACEME(("trying for old magic number"));
5736 old_len = sizeof(old_magicstr) - 1;
5737 READ(current + 1, (SSize_t)(old_len - len));
5739 if (memNE(buf, old_magicstr, old_len))
5740 CROAK(("File is not a perl storable"));
5742 current = buf + old_len;
5744 use_network_order = *current;
5746 GETMARK(use_network_order);
5749 * Starting with 0.6, the "use_network_order" byte flag is also used to
5750 * indicate the version number of the binary, and therefore governs the
5751 * setting of sv_retrieve_vtbl. See magic_write().
5753 if (old_magic && use_network_order > 1) {
5754 /* 0.1 dump - use_network_order is really byte order length */
5758 version_major = use_network_order >> 1;
5760 cxt->retrieve_vtbl = (SV*(**)(pTHX_ stcxt_t *cxt, const char *cname)) (version_major > 0 ? sv_retrieve : sv_old_retrieve);
5762 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5766 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5767 * minor version of the protocol. See magic_write().
5770 if (version_major > 1)
5771 GETMARK(version_minor);
5773 cxt->ver_major = version_major;
5774 cxt->ver_minor = version_minor;
5776 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5779 * Inter-operability sanity check: we can't retrieve something stored
5780 * using a format more recent than ours, because we have no way to
5781 * know what has changed, and letting retrieval go would mean a probable
5782 * failure reporting a "corrupted" storable file.
5786 version_major > STORABLE_BIN_MAJOR ||
5787 (version_major == STORABLE_BIN_MAJOR &&
5788 version_minor > STORABLE_BIN_MINOR)
5791 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5792 STORABLE_BIN_MINOR));
5794 if (version_major == STORABLE_BIN_MAJOR) {
5795 TRACEME(("cxt->accept_future_minor is %d",
5796 cxt->accept_future_minor));
5797 if (cxt->accept_future_minor < 0)
5798 cxt->accept_future_minor
5799 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5802 if (cxt->accept_future_minor == 1)
5803 croak_now = 0; /* Don't croak yet. */
5806 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5807 version_major, version_minor,
5808 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5813 * If they stored using network order, there's no byte ordering
5814 * information to check.
5817 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5818 return &PL_sv_undef; /* No byte ordering info */
5820 /* In C truth is 1, falsehood is 0. Very convenient. */
5821 use_NV_size = version_major >= 2 && version_minor >= 2;
5823 if (version_major >= 0) {
5827 c = use_network_order;
5829 length = c + 3 + use_NV_size;
5830 READ(buf, length); /* Not null-terminated */
5832 TRACEME(("byte order '%.*s' %d", c, buf, c));
5834 #ifdef USE_56_INTERWORK_KLUDGE
5835 /* No point in caching this in the context as we only need it once per
5836 retrieve, and we need to recheck it each read. */
5837 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", GV_ADD))) {
5838 if ((c != (sizeof (byteorderstr_56) - 1))
5839 || memNE(buf, byteorderstr_56, c))
5840 CROAK(("Byte order is not compatible"));
5844 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5845 CROAK(("Byte order is not compatible"));
5851 if ((int) *current++ != sizeof(int))
5852 CROAK(("Integer size is not compatible"));
5855 if ((int) *current++ != sizeof(long))
5856 CROAK(("Long integer size is not compatible"));
5858 /* sizeof(char *) */
5859 if ((int) *current != sizeof(char *))
5860 CROAK(("Pointer size is not compatible"));
5864 if ((int) *++current != sizeof(NV))
5865 CROAK(("Double size is not compatible"));
5868 return &PL_sv_undef; /* OK */
5874 * Recursively retrieve objects from the specified file and return their
5875 * root SV (which may be an AV or an HV for what we care).
5876 * Returns null if there is a problem.
5878 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname)
5884 TRACEME(("retrieve"));
5887 * Grab address tag which identifies the object if we are retrieving
5888 * an older format. Since the new binary format counts objects and no
5889 * longer explicitly tags them, we must keep track of the correspondence
5892 * The following section will disappear one day when the old format is
5893 * no longer supported, hence the final "goto" in the "if" block.
5896 if (cxt->hseen) { /* Retrieving old binary */
5898 if (cxt->netorder) {
5900 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5901 tag = (stag_t) nettag;
5903 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5906 if (type == SX_OBJECT) {
5908 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5910 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5912 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5915 * The following code is common with the SX_OBJECT case below.
5918 svh = av_fetch(cxt->aseen, tagn, FALSE);
5920 CROAK(("Object #%"IVdf" should have been retrieved already",
5923 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5924 SvREFCNT_inc(sv); /* One more reference to this same sv */
5925 return sv; /* The SV pointer where object was retrieved */
5929 * Map new object, but don't increase tagnum. This will be done
5930 * by each of the retrieve_* functions when they call SEEN().
5932 * The mapping associates the "tag" initially present with a unique
5933 * tag number. See test for SX_OBJECT above to see how this is perused.
5936 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5937 newSViv(cxt->tagnum), 0))
5944 * Regular post-0.6 binary format.
5949 TRACEME(("retrieve type = %d", type));
5952 * Are we dealing with an object we should have already retrieved?
5955 if (type == SX_OBJECT) {
5959 svh = av_fetch(cxt->aseen, tag, FALSE);
5961 CROAK(("Object #%"IVdf" should have been retrieved already",
5964 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5965 SvREFCNT_inc(sv); /* One more reference to this same sv */
5966 return sv; /* The SV pointer where object was retrieved */
5967 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5968 if (cxt->accept_future_minor < 0)
5969 cxt->accept_future_minor
5970 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5973 if (cxt->accept_future_minor == 1) {
5974 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5975 "This Storable is v%d.%d and can only handle data types up to %d",
5976 cxt->ver_major, cxt->ver_minor, type,
5977 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5981 first_time: /* Will disappear when support for old format is dropped */
5984 * Okay, first time through for this one.
5987 sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
5989 return (SV *) 0; /* Failed */
5992 * Old binary formats (pre-0.7).
5994 * Final notifications, ended by SX_STORED may now follow.
5995 * Currently, the only pertinent notification to apply on the
5996 * freshly retrieved object is either:
5997 * SX_CLASS <char-len> <classname> for short classnames.
5998 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5999 * Class name is then read into the key buffer pool used by
6000 * hash table key retrieval.
6003 if (cxt->ver_major < 2) {
6004 while ((type = GETCHAR()) != SX_STORED) {
6008 GETMARK(len); /* Length coded on a single char */
6010 case SX_LG_CLASS: /* Length coded on a regular integer */
6015 return (SV *) 0; /* Failed */
6017 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
6020 kbuf[len] = '\0'; /* Mark string end */
6025 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
6026 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
6034 * Retrieve data held in file and return the root object.
6035 * Common routine for pretrieve and mretrieve.
6037 static SV *do_retrieve(
6045 int is_tainted; /* Is input source tainted? */
6046 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
6048 TRACEME(("do_retrieve (optype = 0x%x)", optype));
6050 optype |= ST_RETRIEVE;
6053 * Sanity assertions for retrieve dispatch tables.
6056 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
6057 ("old and new retrieve dispatch table have same size"));
6058 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
6059 ("SX_ERROR entry correctly initialized in old dispatch table"));
6060 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
6061 ("SX_ERROR entry correctly initialized in new dispatch table"));
6064 * Workaround for CROAK leak: if they enter with a "dirty" context,
6065 * free up memory for them now.
6069 clean_context(aTHX_ cxt);
6072 * Now that STORABLE_xxx hooks exist, it is possible that they try to
6073 * re-enter retrieve() via the hooks.
6077 cxt = allocate_context(aTHX_ cxt);
6081 ASSERT(cxt->entry == 1, ("starting new recursion"));
6082 ASSERT(!cxt->s_dirty, ("clean context"));
6087 * Data is loaded into the memory buffer when f is NULL, unless 'in' is
6088 * also NULL, in which case we're expecting the data to already lie
6089 * in the buffer (dclone case).
6092 KBUFINIT(); /* Allocate hash key reading pool once */
6098 const char *orig = SvPV(in, length);
6100 /* This is quite deliberate. I want the UTF8 routines
6101 to encounter the '\0' which perl adds at the end
6102 of all scalars, so that any new string also has
6105 STRLEN klen_tmp = length + 1;
6106 bool is_utf8 = TRUE;
6108 /* Just casting the &klen to (STRLEN) won't work
6109 well if STRLEN and I32 are of different widths.
6111 asbytes = (char*)bytes_from_utf8((U8*)orig,
6115 CROAK(("Frozen string corrupt - contains characters outside 0-255"));
6117 if (asbytes != orig) {
6118 /* String has been converted.
6119 There is no need to keep any reference to
6121 in = sv_newmortal();
6122 /* We donate the SV the malloc()ed string
6123 bytes_from_utf8 returned us. */
6124 SvUPGRADE(in, SVt_PV);
6126 SvPV_set(in, asbytes);
6127 SvLEN_set(in, klen_tmp);
6128 SvCUR_set(in, klen_tmp - 1);
6132 MBUF_SAVE_AND_LOAD(in);
6136 * Magic number verifications.
6138 * This needs to be done before calling init_retrieve_context()
6139 * since the format indication in the file are necessary to conduct
6140 * some of the initializations.
6143 cxt->fio = f; /* Where I/O are performed */
6145 if (!magic_check(aTHX_ cxt))
6146 CROAK(("Magic number checking on storable %s failed",
6147 cxt->fio ? "file" : "string"));
6149 TRACEME(("data stored in %s format",
6150 cxt->netorder ? "net order" : "native"));
6153 * Check whether input source is tainted, so that we don't wrongly
6154 * taint perfectly good values...
6156 * We assume file input is always tainted. If both 'f' and 'in' are
6157 * NULL, then we come from dclone, and tainted is already filled in
6158 * the context. That's a kludge, but the whole dclone() thing is
6159 * already quite a kludge anyway! -- RAM, 15/09/2000.
6162 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
6163 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
6164 init_retrieve_context(aTHX_ cxt, optype, is_tainted);
6166 ASSERT(is_retrieving(aTHX), ("within retrieve operation"));
6168 sv = retrieve(aTHX_ cxt, 0); /* Recursively retrieve object, get root SV */
6177 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
6180 * The "root" context is never freed.
6183 clean_retrieve_context(aTHX_ cxt);
6184 if (cxt->prev) /* This context was stacked */
6185 free_context(aTHX_ cxt); /* It was not the "root" context */
6188 * Prepare returned value.
6192 TRACEME(("retrieve ERROR"));
6193 #if (PATCHLEVEL <= 4)
6194 /* perl 5.00405 seems to screw up at this point with an
6195 'attempt to modify a read only value' error reported in the
6196 eval { $self = pretrieve(*FILE) } in _retrieve.
6197 I can't see what the cause of this error is, but I suspect a
6198 bug in 5.004, as it seems to be capable of issuing spurious
6199 errors or core dumping with matches on $@. I'm not going to
6200 spend time on what could be a fruitless search for the cause,
6201 so here's a bodge. If you're running 5.004 and don't like
6202 this inefficiency, either upgrade to a newer perl, or you are
6203 welcome to find the problem and send in a patch.
6207 return &PL_sv_undef; /* Something went wrong, return undef */
6211 TRACEME(("retrieve got %s(0x%"UVxf")",
6212 sv_reftype(sv, FALSE), PTR2UV(sv)));
6215 * Backward compatibility with Storable-0.5@9 (which we know we
6216 * are retrieving if hseen is non-null): don't create an extra RV
6217 * for objects since we special-cased it at store time.
6219 * Build a reference to the SV returned by pretrieve even if it is
6220 * already one and not a scalar, for consistency reasons.
6223 if (pre_06_fmt) { /* Was not handling overloading by then */
6225 TRACEME(("fixing for old formats -- pre 0.6"));
6226 if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
6227 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
6233 * If reference is overloaded, restore behaviour.
6235 * NB: minor glitch here: normally, overloaded refs are stored specially
6236 * so that we can croak when behaviour cannot be re-installed, and also
6237 * avoid testing for overloading magic at each reference retrieval.
6239 * Unfortunately, the root reference is implicitly stored, so we must
6240 * check for possible overloading now. Furthermore, if we don't restore
6241 * overloading, we cannot croak as if the original ref was, because we
6242 * have no way to determine whether it was an overloaded ref or not in
6245 * It's a pity that overloading magic is attached to the rv, and not to
6246 * the underlying sv as blessing is.
6250 HV *stash = (HV *) SvSTASH(sv);
6251 SV *rv = newRV_noinc(sv);
6252 if (stash && Gv_AMG(stash)) {
6254 TRACEME(("restored overloading on root reference"));
6256 TRACEME(("ended do_retrieve() with an object"));
6260 TRACEME(("regular do_retrieve() end"));
6262 return newRV_noinc(sv);
6268 * Retrieve data held in file and return the root object, undef on error.
6270 static SV *pretrieve(pTHX_ PerlIO *f)
6272 TRACEME(("pretrieve"));
6273 return do_retrieve(aTHX_ f, Nullsv, 0);
6279 * Retrieve data held in scalar and return the root object, undef on error.
6281 static SV *mretrieve(pTHX_ SV *sv)
6283 TRACEME(("mretrieve"));
6284 return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
6294 * Deep clone: returns a fresh copy of the original referenced SV tree.
6296 * This is achieved by storing the object in memory and restoring from
6297 * there. Not that efficient, but it should be faster than doing it from
6300 static SV *dclone(pTHX_ SV *sv)
6304 stcxt_t *real_context;
6307 TRACEME(("dclone"));
6310 * Workaround for CROAK leak: if they enter with a "dirty" context,
6311 * free up memory for them now.
6315 clean_context(aTHX_ cxt);
6318 * Tied elements seem to need special handling.
6321 if ((SvTYPE(sv) == SVt_PVLV
6322 #if PERL_VERSION < 8
6323 || SvTYPE(sv) == SVt_PVMG
6325 ) && SvRMAGICAL(sv) && mg_find(sv, 'p')) {
6330 * do_store() optimizes for dclone by not freeing its context, should
6331 * we need to allocate one because we're deep cloning from a hook.
6334 if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
6335 return &PL_sv_undef; /* Error during store */
6338 * Because of the above optimization, we have to refresh the context,
6339 * since a new one could have been allocated and stacked by do_store().
6342 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
6343 cxt = real_context; /* And we need this temporary... */
6346 * Now, 'cxt' may refer to a new context.
6349 ASSERT(!cxt->s_dirty, ("clean context"));
6350 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
6353 TRACEME(("dclone stored %d bytes", size));
6357 * Since we're passing do_retrieve() both a NULL file and sv, we need
6358 * to pre-compute the taintedness of the input by setting cxt->tainted
6359 * to whatever state our own input string was. -- RAM, 15/09/2000
6361 * do_retrieve() will free non-root context.
6364 cxt->s_tainted = SvTAINTED(sv);
6365 out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
6367 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
6377 * The Perl IO GV object distinguishes between input and output for sockets
6378 * but not for plain files. To allow Storable to transparently work on
6379 * plain files and sockets transparently, we have to ask xsubpp to fetch the
6380 * right object for us. Hence the OutputStream and InputStream declarations.
6382 * Before perl 5.004_05, those entries in the standard typemap are not
6383 * defined in perl include files, so we do that here.
6386 #ifndef OutputStream
6387 #define OutputStream PerlIO *
6388 #define InputStream PerlIO *
6389 #endif /* !OutputStream */
6391 MODULE = Storable PACKAGE = Storable::Cxt
6397 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
6401 if (!cxt->membuf_ro && mbase)
6403 if (cxt->membuf_ro && (cxt->msaved).arena)
6404 Safefree((cxt->msaved).arena);
6407 MODULE = Storable PACKAGE = Storable
6413 HV *stash = gv_stashpvn("Storable", 8, GV_ADD);
6414 newCONSTSUB(stash, "BIN_MAJOR", newSViv(STORABLE_BIN_MAJOR));
6415 newCONSTSUB(stash, "BIN_MINOR", newSViv(STORABLE_BIN_MINOR));
6416 newCONSTSUB(stash, "BIN_WRITE_MINOR", newSViv(STORABLE_BIN_WRITE_MINOR));
6418 init_perinterp(aTHX);
6419 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
6421 /* Only disable the used only once warning if we are in debugging mode. */
6422 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
6424 #ifdef USE_56_INTERWORK_KLUDGE
6425 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
6432 init_perinterp(aTHX);
6436 # Store the transitive data closure of given object to disk.
6437 # Returns undef on error, a true value otherwise.
6441 # Same as pstore(), but network order is used for integers and doubles are
6442 # emitted as strings.
6451 RETVAL = do_store(aTHX_ f, obj, 0, ix, (SV **)0) ? &PL_sv_yes : &PL_sv_undef;
6452 /* do_store() can reallocate the stack, so need a sequence point to ensure
6453 that ST(0) knows about it. Hence using two statements. */
6459 # Store the transitive data closure of given object to memory.
6460 # Returns undef on error, a scalar value containing the data otherwise.
6464 # Same as mstore(), but network order is used for integers and doubles are
6465 # emitted as strings.
6473 if (!do_store(aTHX_ (PerlIO*) 0, obj, 0, ix, &RETVAL))
6474 RETVAL = &PL_sv_undef;
6482 RETVAL = pretrieve(aTHX_ f);
6490 RETVAL = mretrieve(aTHX_ sv);
6498 RETVAL = dclone(aTHX_ sv);
6503 last_op_in_netorder()
6505 is_storing = ST_STORE
6506 is_retrieving = ST_RETRIEVE
6513 result = cxt->entry && (cxt->optype & ix) ? TRUE : FALSE;
6515 result = !!last_op_in_netorder(aTHX);
6517 ST(0) = boolSV(result);
https://perl5.git.perl.org / perl5.git / blob