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 static int storable_free(pTHX_ SV *sv, MAGIC* mg);
340 static MGVTBL vtbl_storable = {
357 /* From Digest::MD5. */
359 # define sv_magicext(sv, obj, type, vtbl, name, namlen) \
360 THX_sv_magicext(aTHX_ sv, obj, type, vtbl, name, namlen)
361 static MAGIC *THX_sv_magicext(pTHX_ SV *sv, SV *obj, int type,
362 MGVTBL const *vtbl, char const *name, I32 namlen)
366 /* exceeded intended usage of this reserve implementation */
369 mg->mg_virtual = (MGVTBL*)vtbl;
371 mg->mg_ptr = (char *)name;
373 (void) SvUPGRADE(sv, SVt_PVMG);
374 mg->mg_moremagic = SvMAGIC(sv);
382 #define NEW_STORABLE_CXT_OBJ(cxt) \
384 SV *self = newSV(sizeof(stcxt_t) - 1); \
385 SV *my_sv = newRV_noinc(self); \
386 sv_magicext(self, NULL, PERL_MAGIC_ext, &vtbl_storable, NULL, 0); \
387 cxt = (stcxt_t *)SvPVX(self); \
388 Zero(cxt, 1, stcxt_t); \
389 cxt->my_sv = my_sv; \
392 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
394 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
396 SV *perinterp_sv = perl_get_sv(MY_VERSION, 0)
397 #else /* >= perl5.004_68 */
399 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
400 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
401 #endif /* < perl5.004_68 */
403 #define dSTCXT_PTR(T,name) \
404 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
405 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
408 dSTCXT_PTR(stcxt_t *, cxt)
412 NEW_STORABLE_CXT_OBJ(cxt); \
413 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
415 #define SET_STCXT(x) \
418 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
421 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
423 static stcxt_t *Context_ptr = NULL;
424 #define dSTCXT stcxt_t *cxt = Context_ptr
425 #define SET_STCXT(x) Context_ptr = x
428 NEW_STORABLE_CXT_OBJ(cxt); \
432 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
436 * Croaking implies a memory leak, since we don't use setjmp/longjmp
437 * to catch the exit and free memory used during store or retrieve
438 * operations. This is not too difficult to fix, but I need to understand
439 * how Perl does it, and croaking is exceptional anyway, so I lack the
440 * motivation to do it.
442 * The current workaround is to mark the context as dirty when croaking,
443 * so that data structures can be freed whenever we renter Storable code
444 * (but only *then*: it's a workaround, not a fix).
446 * This is also imperfect, because we don't really know how far they trapped
447 * the croak(), and when we were recursing, we won't be able to clean anything
448 * but the topmost context stacked.
451 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
454 * End of "thread-safe" related definitions.
460 * Keep only the low 32 bits of a pointer (used for tags, which are not
465 #define LOW_32BITS(x) ((I32) (x))
467 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
473 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
474 * Used in the WLEN and RLEN macros.
478 #define oI(x) ((I32 *) ((char *) (x) + 4))
479 #define oS(x) ((x) - 4)
480 #define oC(x) (x = 0)
489 * key buffer handling
491 #define kbuf (cxt->keybuf).arena
492 #define ksiz (cxt->keybuf).asiz
496 TRACEME(("** allocating kbuf of 128 bytes")); \
497 New(10003, kbuf, 128, char); \
504 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
505 Renew(kbuf, x+1, char); \
511 * memory buffer handling
513 #define mbase (cxt->membuf).arena
514 #define msiz (cxt->membuf).asiz
515 #define mptr (cxt->membuf).aptr
516 #define mend (cxt->membuf).aend
518 #define MGROW (1 << 13)
519 #define MMASK (MGROW - 1)
521 #define round_mgrow(x) \
522 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
523 #define trunc_int(x) \
524 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
525 #define int_aligned(x) \
526 ((unsigned long) (x) == trunc_int(x))
528 #define MBUF_INIT(x) \
531 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
532 New(10003, mbase, MGROW, char); \
533 msiz = (STRLEN)MGROW; \
539 mend = mbase + msiz; \
542 #define MBUF_TRUNC(x) mptr = mbase + x
543 #define MBUF_SIZE() (mptr - mbase)
549 * Those macros are used in do_retrieve() to save the current memory
550 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
551 * data from a string.
553 #define MBUF_SAVE_AND_LOAD(in) \
555 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
556 cxt->membuf_ro = 1; \
557 TRACEME(("saving mbuf")); \
558 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
562 #define MBUF_RESTORE() \
564 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
565 cxt->membuf_ro = 0; \
566 TRACEME(("restoring mbuf")); \
567 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
571 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
572 * See store_scalar() for other usage of this workaround.
574 #define MBUF_LOAD(v) \
576 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
578 CROAK(("Not a scalar string")); \
579 mptr = mbase = SvPV(v, msiz); \
580 mend = mbase + msiz; \
583 #define MBUF_XTEND(x) \
585 int nsz = (int) round_mgrow((x)+msiz); \
586 int offset = mptr - mbase; \
587 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
588 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
590 Renew(mbase, nsz, char); \
592 mptr = mbase + offset; \
593 mend = mbase + nsz; \
596 #define MBUF_CHK(x) \
598 if ((mptr + (x)) > mend) \
602 #define MBUF_GETC(x) \
605 x = (int) (unsigned char) *mptr++; \
611 #define MBUF_GETINT(x) \
614 if ((mptr + 4) <= mend) { \
615 memcpy(oI(&x), mptr, 4); \
621 #define MBUF_GETINT(x) \
623 if ((mptr + sizeof(int)) <= mend) { \
624 if (int_aligned(mptr)) \
627 memcpy(&x, mptr, sizeof(int)); \
628 mptr += sizeof(int); \
634 #define MBUF_READ(x,s) \
636 if ((mptr + (s)) <= mend) { \
637 memcpy(x, mptr, s); \
643 #define MBUF_SAFEREAD(x,s,z) \
645 if ((mptr + (s)) <= mend) { \
646 memcpy(x, mptr, s); \
654 #define MBUF_SAFEPVREAD(x,s,z) \
656 if ((mptr + (s)) <= mend) { \
657 memcpy(x, mptr, s); \
665 #define MBUF_PUTC(c) \
668 *mptr++ = (char) c; \
671 *mptr++ = (char) c; \
676 #define MBUF_PUTINT(i) \
679 memcpy(mptr, oI(&i), 4); \
683 #define MBUF_PUTINT(i) \
685 MBUF_CHK(sizeof(int)); \
686 if (int_aligned(mptr)) \
689 memcpy(mptr, &i, sizeof(int)); \
690 mptr += sizeof(int); \
694 #define MBUF_WRITE(x,s) \
697 memcpy(mptr, x, s); \
702 * Possible return values for sv_type().
706 #define svis_SCALAR 1
710 #define svis_TIED_ITEM 5
718 #define SHF_TYPE_MASK 0x03
719 #define SHF_LARGE_CLASSLEN 0x04
720 #define SHF_LARGE_STRLEN 0x08
721 #define SHF_LARGE_LISTLEN 0x10
722 #define SHF_IDX_CLASSNAME 0x20
723 #define SHF_NEED_RECURSE 0x40
724 #define SHF_HAS_LIST 0x80
727 * Types for SX_HOOK (last 2 bits in flags).
733 #define SHT_EXTRA 3 /* Read extra byte for type */
736 * The following are held in the "extra byte"...
739 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
740 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
741 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
744 * per hash flags for flagged hashes
747 #define SHV_RESTRICTED 0x01
750 * per key flags for flagged hashes
753 #define SHV_K_UTF8 0x01
754 #define SHV_K_WASUTF8 0x02
755 #define SHV_K_LOCKED 0x04
756 #define SHV_K_ISSV 0x08
757 #define SHV_K_PLACEHOLDER 0x10
760 * Before 0.6, the magic string was "perl-store" (binary version number 0).
762 * Since 0.6 introduced many binary incompatibilities, the magic string has
763 * been changed to "pst0" to allow an old image to be properly retrieved by
764 * a newer Storable, but ensure a newer image cannot be retrieved with an
767 * At 0.7, objects are given the ability to serialize themselves, and the
768 * set of markers is extended, backward compatibility is not jeopardized,
769 * so the binary version number could have remained unchanged. To correctly
770 * spot errors if a file making use of 0.7-specific extensions is given to
771 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
772 * a "minor" version, to better track this kind of evolution from now on.
775 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
776 static const char magicstr[] = "pst0"; /* Used as a magic number */
778 #define MAGICSTR_BYTES 'p','s','t','0'
779 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
781 /* 5.6.x introduced the ability to have IVs as long long.
782 However, Configure still defined BYTEORDER based on the size of a long.
783 Storable uses the BYTEORDER value as part of the header, but doesn't
784 explicitly store sizeof(IV) anywhere in the header. Hence on 5.6.x built
785 with IV as long long on a platform that uses Configure (ie most things
786 except VMS and Windows) headers are identical for the different IV sizes,
787 despite the files containing some fields based on sizeof(IV)
789 5.8 is consistent - the following redefinition kludge is only needed on
790 5.6.x, but the interwork is needed on 5.8 while data survives in files
795 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
796 #ifndef NO_56_INTERWORK_KLUDGE
797 #define USE_56_INTERWORK_KLUDGE
799 #if BYTEORDER == 0x1234
801 #define BYTEORDER 0x12345678
803 #if BYTEORDER == 0x4321
805 #define BYTEORDER 0x87654321
810 #if BYTEORDER == 0x1234
811 #define BYTEORDER_BYTES '1','2','3','4'
813 #if BYTEORDER == 0x12345678
814 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
815 #ifdef USE_56_INTERWORK_KLUDGE
816 #define BYTEORDER_BYTES_56 '1','2','3','4'
819 #if BYTEORDER == 0x87654321
820 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
821 #ifdef USE_56_INTERWORK_KLUDGE
822 #define BYTEORDER_BYTES_56 '4','3','2','1'
825 #if BYTEORDER == 0x4321
826 #define BYTEORDER_BYTES '4','3','2','1'
828 #error Unknown byteorder. Please append your byteorder to Storable.xs
834 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
835 #ifdef USE_56_INTERWORK_KLUDGE
836 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
839 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
840 #define STORABLE_BIN_MINOR 9 /* Binary minor "version" */
842 #if (PATCHLEVEL <= 5)
843 #define STORABLE_BIN_WRITE_MINOR 4
844 #elif !defined (SvVOK)
846 * Perl 5.6.0-5.8.0 can do weak references, but not vstring magic.
848 #define STORABLE_BIN_WRITE_MINOR 8
850 #define STORABLE_BIN_WRITE_MINOR 9
851 #endif /* (PATCHLEVEL <= 5) */
853 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
854 #define PL_sv_placeholder PL_sv_undef
858 * Useful store shortcuts...
862 * Note that if you put more than one mark for storing a particular
863 * type of thing, *and* in the retrieve_foo() function you mark both
864 * the thingy's you get off with SEEN(), you *must* increase the
865 * tagnum with cxt->tagnum++ along with this macro!
872 else if (PerlIO_putc(cxt->fio, x) == EOF) \
876 #define WRITE_I32(x) \
878 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
881 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
888 if (cxt->netorder) { \
889 int y = (int) htonl(x); \
892 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
897 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
902 #define WLEN(x) WRITE_I32(x)
909 else if (PerlIO_write(cxt->fio, x, y) != y) \
913 #define STORE_PV_LEN(pv, len, small, large) \
915 if (len <= LG_SCALAR) { \
916 unsigned char clen = (unsigned char) len; \
928 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
931 * Store &PL_sv_undef in arrays without recursing through store().
933 #define STORE_SV_UNDEF() \
936 PUTMARK(SX_SV_UNDEF); \
940 * Useful retrieve shortcuts...
944 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
950 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
954 #define READ_I32(x) \
956 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
960 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
970 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
973 x = (int) ntohl(x); \
976 #define RLEN(x) READ_I32(x)
983 else if (PerlIO_read(cxt->fio, x, y) != y) \
987 #define SAFEREAD(x,y,z) \
990 MBUF_SAFEREAD(x,y,z); \
991 else if (PerlIO_read(cxt->fio, x, y) != y) { \
997 #define SAFEPVREAD(x,y,z) \
1000 MBUF_SAFEPVREAD(x,y,z); \
1001 else if (PerlIO_read(cxt->fio, x, y) != y) { \
1008 * This macro is used at retrieve time, to remember where object 'y', bearing a
1009 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
1010 * we'll therefore know where it has been retrieved and will be able to
1011 * share the same reference, as in the original stored memory image.
1013 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
1014 * on the objects given to STORABLE_thaw and expect that to be defined), and
1015 * also for overloaded objects (for which we might not find the stash if the
1016 * object is not blessed yet--this might occur for overloaded objects that
1017 * refer to themselves indirectly: if we blessed upon return from a sub
1018 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
1019 * restored on it because the underlying object would not be blessed yet!).
1021 * To achieve that, the class name of the last retrieved object is passed down
1022 * recursively, and the first SEEN() call for which the class name is not NULL
1023 * will bless the object.
1025 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
1027 #define SEEN(y,c,i) \
1031 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
1033 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
1034 PTR2UV(y), SvREFCNT(y)-1)); \
1036 BLESS((SV *) (y), c); \
1040 * Bless 's' in 'p', via a temporary reference, required by sv_bless().
1041 * "A" magic is added before the sv_bless for overloaded classes, this avoids
1042 * an expensive call to S_reset_amagic in sv_bless.
1044 #define BLESS(s,p) \
1048 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
1049 stash = gv_stashpv((p), GV_ADD); \
1050 ref = newRV_noinc(s); \
1051 if (cxt->in_retrieve_overloaded && Gv_AMG(stash)) \
1053 cxt->in_retrieve_overloaded = 0; \
1056 (void) sv_bless(ref, stash); \
1057 SvRV_set(ref, NULL); \
1058 SvREFCNT_dec(ref); \
1061 * sort (used in store_hash) - conditionally use qsort when
1062 * sortsv is not available ( <= 5.6.1 ).
1065 #if (PATCHLEVEL <= 6)
1067 #if defined(USE_ITHREADS)
1069 #define STORE_HASH_SORT \
1071 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
1072 SAVESPTR(orig_perl); \
1073 PERL_SET_CONTEXT(aTHX); \
1074 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
1077 #else /* ! USE_ITHREADS */
1079 #define STORE_HASH_SORT \
1080 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1082 #endif /* USE_ITHREADS */
1084 #else /* PATCHLEVEL > 6 */
1086 #define STORE_HASH_SORT \
1087 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1089 #endif /* PATCHLEVEL <= 6 */
1091 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1092 static SV *retrieve(pTHX_ stcxt_t *cxt, const char *cname);
1096 av_pop(cxt->aseen); \
1101 * Dynamic dispatching table for SV store.
1104 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1105 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1106 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1107 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1108 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1109 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1110 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1111 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1112 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1114 typedef int (*sv_store_t)(pTHX_ stcxt_t *cxt, SV *sv);
1116 static const sv_store_t sv_store[] = {
1117 (sv_store_t)store_ref, /* svis_REF */
1118 (sv_store_t)store_scalar, /* svis_SCALAR */
1119 (sv_store_t)store_array, /* svis_ARRAY */
1120 (sv_store_t)store_hash, /* svis_HASH */
1121 (sv_store_t)store_tied, /* svis_TIED */
1122 (sv_store_t)store_tied_item, /* svis_TIED_ITEM */
1123 (sv_store_t)store_code, /* svis_CODE */
1124 (sv_store_t)store_other, /* svis_OTHER */
1127 #define SV_STORE(x) (*sv_store[x])
1130 * Dynamic dispatching tables for SV retrieval.
1133 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, const char *cname);
1134 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, const char *cname);
1135 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1136 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1137 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, const char *cname);
1138 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, const char *cname);
1139 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, const char *cname);
1140 static SV *retrieve_double(pTHX_ stcxt_t *cxt, const char *cname);
1141 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, const char *cname);
1142 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, const char *cname);
1143 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1144 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, const char *cname);
1145 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, const char *cname);
1146 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, const char *cname);
1147 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, const char *cname);
1148 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname);
1150 typedef SV* (*sv_retrieve_t)(pTHX_ stcxt_t *cxt, const char *name);
1152 static const sv_retrieve_t sv_old_retrieve[] = {
1153 0, /* SX_OBJECT -- entry unused dynamically */
1154 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1155 (sv_retrieve_t)old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1156 (sv_retrieve_t)old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1157 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1158 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1159 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1160 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1161 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1162 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1163 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1164 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1165 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1166 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1167 (sv_retrieve_t)retrieve_other, /* SX_SV_UNDEF not supported */
1168 (sv_retrieve_t)retrieve_other, /* SX_SV_YES not supported */
1169 (sv_retrieve_t)retrieve_other, /* SX_SV_NO not supported */
1170 (sv_retrieve_t)retrieve_other, /* SX_BLESS not supported */
1171 (sv_retrieve_t)retrieve_other, /* SX_IX_BLESS not supported */
1172 (sv_retrieve_t)retrieve_other, /* SX_HOOK not supported */
1173 (sv_retrieve_t)retrieve_other, /* SX_OVERLOADED not supported */
1174 (sv_retrieve_t)retrieve_other, /* SX_TIED_KEY not supported */
1175 (sv_retrieve_t)retrieve_other, /* SX_TIED_IDX not supported */
1176 (sv_retrieve_t)retrieve_other, /* SX_UTF8STR not supported */
1177 (sv_retrieve_t)retrieve_other, /* SX_LUTF8STR not supported */
1178 (sv_retrieve_t)retrieve_other, /* SX_FLAG_HASH not supported */
1179 (sv_retrieve_t)retrieve_other, /* SX_CODE not supported */
1180 (sv_retrieve_t)retrieve_other, /* SX_WEAKREF not supported */
1181 (sv_retrieve_t)retrieve_other, /* SX_WEAKOVERLOAD not supported */
1182 (sv_retrieve_t)retrieve_other, /* SX_VSTRING not supported */
1183 (sv_retrieve_t)retrieve_other, /* SX_LVSTRING not supported */
1184 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1187 static SV *retrieve_array(pTHX_ stcxt_t *cxt, const char *cname);
1188 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, const char *cname);
1189 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, const char *cname);
1190 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, const char *cname);
1191 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, const char *cname);
1192 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1193 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname);
1194 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, const char *cname);
1195 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, const char *cname);
1196 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, const char *cname);
1197 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, const char *cname);
1198 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, const char *cname);
1199 static SV *retrieve_code(pTHX_ stcxt_t *cxt, const char *cname);
1200 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, const char *cname);
1201 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, const char *cname);
1202 static SV *retrieve_vstring(pTHX_ stcxt_t *cxt, const char *cname);
1203 static SV *retrieve_lvstring(pTHX_ stcxt_t *cxt, const char *cname);
1205 static const sv_retrieve_t sv_retrieve[] = {
1206 0, /* SX_OBJECT -- entry unused dynamically */
1207 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1208 (sv_retrieve_t)retrieve_array, /* SX_ARRAY */
1209 (sv_retrieve_t)retrieve_hash, /* SX_HASH */
1210 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1211 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1212 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1213 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1214 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1215 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1216 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1217 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1218 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1219 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1220 (sv_retrieve_t)retrieve_sv_undef, /* SX_SV_UNDEF */
1221 (sv_retrieve_t)retrieve_sv_yes, /* SX_SV_YES */
1222 (sv_retrieve_t)retrieve_sv_no, /* SX_SV_NO */
1223 (sv_retrieve_t)retrieve_blessed, /* SX_BLESS */
1224 (sv_retrieve_t)retrieve_idx_blessed, /* SX_IX_BLESS */
1225 (sv_retrieve_t)retrieve_hook, /* SX_HOOK */
1226 (sv_retrieve_t)retrieve_overloaded, /* SX_OVERLOAD */
1227 (sv_retrieve_t)retrieve_tied_key, /* SX_TIED_KEY */
1228 (sv_retrieve_t)retrieve_tied_idx, /* SX_TIED_IDX */
1229 (sv_retrieve_t)retrieve_utf8str, /* SX_UTF8STR */
1230 (sv_retrieve_t)retrieve_lutf8str, /* SX_LUTF8STR */
1231 (sv_retrieve_t)retrieve_flag_hash, /* SX_HASH */
1232 (sv_retrieve_t)retrieve_code, /* SX_CODE */
1233 (sv_retrieve_t)retrieve_weakref, /* SX_WEAKREF */
1234 (sv_retrieve_t)retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
1235 (sv_retrieve_t)retrieve_vstring, /* SX_VSTRING */
1236 (sv_retrieve_t)retrieve_lvstring, /* SX_LVSTRING */
1237 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1240 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1242 static SV *mbuf2sv(pTHX);
1245 *** Context management.
1251 * Called once per "thread" (interpreter) to initialize some global context.
1253 static void init_perinterp(pTHX)
1257 cxt->netorder = 0; /* true if network order used */
1258 cxt->forgive_me = -1; /* whether to be forgiving... */
1259 cxt->accept_future_minor = -1; /* would otherwise occur too late */
1265 * Called at the end of every context cleaning, to perform common reset
1268 static void reset_context(stcxt_t *cxt)
1272 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1276 * init_store_context
1278 * Initialize a new store context for real recursion.
1280 static void init_store_context(
1287 TRACEME(("init_store_context"));
1289 cxt->netorder = network_order;
1290 cxt->forgive_me = -1; /* Fetched from perl if needed */
1291 cxt->deparse = -1; /* Idem */
1292 cxt->eval = NULL; /* Idem */
1293 cxt->canonical = -1; /* Idem */
1294 cxt->tagnum = -1; /* Reset tag numbers */
1295 cxt->classnum = -1; /* Reset class numbers */
1296 cxt->fio = f; /* Where I/O are performed */
1297 cxt->optype = optype; /* A store, or a deep clone */
1298 cxt->entry = 1; /* No recursion yet */
1301 * The 'hseen' table is used to keep track of each SV stored and their
1302 * associated tag numbers is special. It is "abused" because the
1303 * values stored are not real SV, just integers cast to (SV *),
1304 * which explains the freeing below.
1306 * It is also one possible bottleneck to achieve good storing speed,
1307 * so the "shared keys" optimization is turned off (unlikely to be
1308 * of any use here), and the hash table is "pre-extended". Together,
1309 * those optimizations increase the throughput by 12%.
1312 #ifdef USE_PTR_TABLE
1313 cxt->pseen = ptr_table_new();
1316 cxt->hseen = newHV(); /* Table where seen objects are stored */
1317 HvSHAREKEYS_off(cxt->hseen);
1320 * The following does not work well with perl5.004_04, and causes
1321 * a core dump later on, in a completely unrelated spot, which
1322 * makes me think there is a memory corruption going on.
1324 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1325 * it below does not make any difference. It seems to work fine
1326 * with perl5.004_68 but given the probable nature of the bug,
1327 * that does not prove anything.
1329 * It's a shame because increasing the amount of buckets raises
1330 * store() throughput by 5%, but until I figure this out, I can't
1331 * allow for this to go into production.
1333 * It is reported fixed in 5.005, hence the #if.
1335 #if PERL_VERSION >= 5
1336 #define HBUCKETS 4096 /* Buckets for %hseen */
1337 #ifndef USE_PTR_TABLE
1338 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1343 * The 'hclass' hash uses the same settings as 'hseen' above, but it is
1344 * used to assign sequential tags (numbers) to class names for blessed
1347 * We turn the shared key optimization on.
1350 cxt->hclass = newHV(); /* Where seen classnames are stored */
1352 #if PERL_VERSION >= 5
1353 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1357 * The 'hook' hash table is used to keep track of the references on
1358 * the STORABLE_freeze hook routines, when found in some class name.
1360 * It is assumed that the inheritance tree will not be changed during
1361 * storing, and that no new method will be dynamically created by the
1365 cxt->hook = newHV(); /* Table where hooks are cached */
1368 * The 'hook_seen' array keeps track of all the SVs returned by
1369 * STORABLE_freeze hooks for us to serialize, so that they are not
1370 * reclaimed until the end of the serialization process. Each SV is
1371 * only stored once, the first time it is seen.
1374 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1378 * clean_store_context
1380 * Clean store context by
1382 static void clean_store_context(pTHX_ stcxt_t *cxt)
1386 TRACEME(("clean_store_context"));
1388 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1391 * Insert real values into hashes where we stored faked pointers.
1394 #ifndef USE_PTR_TABLE
1396 hv_iterinit(cxt->hseen);
1397 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1398 HeVAL(he) = &PL_sv_undef;
1403 hv_iterinit(cxt->hclass);
1404 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1405 HeVAL(he) = &PL_sv_undef;
1409 * And now dispose of them...
1411 * The surrounding if() protection has been added because there might be
1412 * some cases where this routine is called more than once, during
1413 * exceptional events. This was reported by Marc Lehmann when Storable
1414 * is executed from mod_perl, and the fix was suggested by him.
1415 * -- RAM, 20/12/2000
1418 #ifdef USE_PTR_TABLE
1420 struct ptr_tbl *pseen = cxt->pseen;
1422 ptr_table_free(pseen);
1424 assert(!cxt->hseen);
1427 HV *hseen = cxt->hseen;
1430 sv_free((SV *) hseen);
1435 HV *hclass = cxt->hclass;
1438 sv_free((SV *) hclass);
1442 HV *hook = cxt->hook;
1445 sv_free((SV *) hook);
1448 if (cxt->hook_seen) {
1449 AV *hook_seen = cxt->hook_seen;
1451 av_undef(hook_seen);
1452 sv_free((SV *) hook_seen);
1455 cxt->forgive_me = -1; /* Fetched from perl if needed */
1456 cxt->deparse = -1; /* Idem */
1458 SvREFCNT_dec(cxt->eval);
1460 cxt->eval = NULL; /* Idem */
1461 cxt->canonical = -1; /* Idem */
1467 * init_retrieve_context
1469 * Initialize a new retrieve context for real recursion.
1471 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1473 TRACEME(("init_retrieve_context"));
1476 * The hook hash table is used to keep track of the references on
1477 * the STORABLE_thaw hook routines, when found in some class name.
1479 * It is assumed that the inheritance tree will not be changed during
1480 * storing, and that no new method will be dynamically created by the
1484 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1486 #ifdef USE_PTR_TABLE
1491 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1492 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1493 * the correspondence between the tags and the tag number used by the
1494 * new retrieve routines.
1497 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1500 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1501 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1502 cxt->aclass = newAV(); /* Where seen classnames are kept */
1503 cxt->tagnum = 0; /* Have to count objects... */
1504 cxt->classnum = 0; /* ...and class names as well */
1505 cxt->optype = optype;
1506 cxt->s_tainted = is_tainted;
1507 cxt->entry = 1; /* No recursion yet */
1508 #ifndef HAS_RESTRICTED_HASHES
1509 cxt->derestrict = -1; /* Fetched from perl if needed */
1511 #ifndef HAS_UTF8_ALL
1512 cxt->use_bytes = -1; /* Fetched from perl if needed */
1514 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1515 cxt->in_retrieve_overloaded = 0;
1519 * clean_retrieve_context
1521 * Clean retrieve context by
1523 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1525 TRACEME(("clean_retrieve_context"));
1527 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1530 AV *aseen = cxt->aseen;
1533 sv_free((SV *) aseen);
1535 cxt->where_is_undef = -1;
1538 AV *aclass = cxt->aclass;
1541 sv_free((SV *) aclass);
1545 HV *hook = cxt->hook;
1548 sv_free((SV *) hook);
1552 HV *hseen = cxt->hseen;
1555 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1558 #ifndef HAS_RESTRICTED_HASHES
1559 cxt->derestrict = -1; /* Fetched from perl if needed */
1561 #ifndef HAS_UTF8_ALL
1562 cxt->use_bytes = -1; /* Fetched from perl if needed */
1564 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1566 cxt->in_retrieve_overloaded = 0;
1573 * A workaround for the CROAK bug: cleanup the last context.
1575 static void clean_context(pTHX_ stcxt_t *cxt)
1577 TRACEME(("clean_context"));
1579 ASSERT(cxt->s_dirty, ("dirty context"));
1584 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1586 if (cxt->optype & ST_RETRIEVE)
1587 clean_retrieve_context(aTHX_ cxt);
1588 else if (cxt->optype & ST_STORE)
1589 clean_store_context(aTHX_ cxt);
1593 ASSERT(!cxt->s_dirty, ("context is clean"));
1594 ASSERT(cxt->entry == 0, ("context is reset"));
1600 * Allocate a new context and push it on top of the parent one.
1601 * This new context is made globally visible via SET_STCXT().
1603 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1607 TRACEME(("allocate_context"));
1609 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1611 NEW_STORABLE_CXT_OBJ(cxt);
1612 cxt->prev = parent_cxt->my_sv;
1615 ASSERT(!cxt->s_dirty, ("clean context"));
1623 * Free current context, which cannot be the "root" one.
1624 * Make the context underneath globally visible via SET_STCXT().
1626 static void free_context(pTHX_ stcxt_t *cxt)
1628 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1630 TRACEME(("free_context"));
1632 ASSERT(!cxt->s_dirty, ("clean context"));
1633 ASSERT(prev, ("not freeing root context"));
1635 SvREFCNT_dec(cxt->my_sv);
1638 ASSERT(cxt, ("context not void"));
1648 * Tells whether we're in the middle of a store operation.
1650 static int is_storing(pTHX)
1654 return cxt->entry && (cxt->optype & ST_STORE);
1660 * Tells whether we're in the middle of a retrieve operation.
1662 static int is_retrieving(pTHX)
1666 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1670 * last_op_in_netorder
1672 * Returns whether last operation was made using network order.
1674 * This is typically out-of-band information that might prove useful
1675 * to people wishing to convert native to network order data when used.
1677 static int last_op_in_netorder(pTHX)
1681 return cxt->netorder;
1685 *** Hook lookup and calling routines.
1691 * A wrapper on gv_fetchmethod_autoload() which caches results.
1693 * Returns the routine reference as an SV*, or null if neither the package
1694 * nor its ancestors know about the method.
1696 static SV *pkg_fetchmeth(
1704 const char *hvname = HvNAME_get(pkg);
1708 * The following code is the same as the one performed by UNIVERSAL::can
1712 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1713 if (gv && isGV(gv)) {
1714 sv = newRV((SV*) GvCV(gv));
1715 TRACEME(("%s->%s: 0x%"UVxf, hvname, method, PTR2UV(sv)));
1717 sv = newSVsv(&PL_sv_undef);
1718 TRACEME(("%s->%s: not found", hvname, method));
1722 * Cache the result, ignoring failure: if we can't store the value,
1723 * it just won't be cached.
1726 (void) hv_store(cache, hvname, strlen(hvname), sv, 0);
1728 return SvOK(sv) ? sv : (SV *) 0;
1734 * Force cached value to be undef: hook ignored even if present.
1736 static void pkg_hide(
1742 const char *hvname = HvNAME_get(pkg);
1743 PERL_UNUSED_ARG(method);
1744 (void) hv_store(cache,
1745 hvname, strlen(hvname), newSVsv(&PL_sv_undef), 0);
1751 * Discard cached value: a whole fetch loop will be retried at next lookup.
1753 static void pkg_uncache(
1759 const char *hvname = HvNAME_get(pkg);
1760 PERL_UNUSED_ARG(method);
1761 (void) hv_delete(cache, hvname, strlen(hvname), G_DISCARD);
1767 * Our own "UNIVERSAL::can", which caches results.
1769 * Returns the routine reference as an SV*, or null if the object does not
1770 * know about the method.
1780 const char *hvname = HvNAME_get(pkg);
1782 TRACEME(("pkg_can for %s->%s", hvname, method));
1785 * Look into the cache to see whether we already have determined
1786 * where the routine was, if any.
1788 * NOTA BENE: we don't use 'method' at all in our lookup, since we know
1789 * that only one hook (i.e. always the same) is cached in a given cache.
1792 svh = hv_fetch(cache, hvname, strlen(hvname), FALSE);
1796 TRACEME(("cached %s->%s: not found", hvname, method));
1799 TRACEME(("cached %s->%s: 0x%"UVxf,
1800 hvname, method, PTR2UV(sv)));
1805 TRACEME(("not cached yet"));
1806 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1812 * Call routine as obj->hook(av) in scalar context.
1813 * Propagates the single returned value if not called in void context.
1815 static SV *scalar_call(
1827 TRACEME(("scalar_call (cloning=%d)", cloning));
1834 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1836 SV **ary = AvARRAY(av);
1837 int cnt = AvFILLp(av) + 1;
1839 XPUSHs(ary[0]); /* Frozen string */
1840 for (i = 1; i < cnt; i++) {
1841 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1842 i, PTR2UV(ary[i])));
1843 XPUSHs(sv_2mortal(newRV(ary[i])));
1848 TRACEME(("calling..."));
1849 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1850 TRACEME(("count = %d", count));
1856 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1869 * Call routine obj->hook(cloning) in list context.
1870 * Returns the list of returned values in an array.
1872 static AV *array_call(
1883 TRACEME(("array_call (cloning=%d)", cloning));
1889 XPUSHs(obj); /* Target object */
1890 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1893 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1898 for (i = count - 1; i >= 0; i--) {
1900 av_store(av, i, SvREFCNT_inc(sv));
1913 * Lookup the class name in the 'hclass' table and either assign it a new ID
1914 * or return the existing one, by filling in 'classnum'.
1916 * Return true if the class was known, false if the ID was just generated.
1918 static int known_class(
1921 char *name, /* Class name */
1922 int len, /* Name length */
1926 HV *hclass = cxt->hclass;
1928 TRACEME(("known_class (%s)", name));
1931 * Recall that we don't store pointers in this hash table, but tags.
1932 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1935 svh = hv_fetch(hclass, name, len, FALSE);
1937 *classnum = LOW_32BITS(*svh);
1942 * Unknown classname, we need to record it.
1946 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1947 CROAK(("Unable to record new classname"));
1949 *classnum = cxt->classnum;
1954 *** Specific store routines.
1960 * Store a reference.
1961 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1963 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1966 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1969 * Follow reference, and check if target is overloaded.
1975 TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1980 HV *stash = (HV *) SvSTASH(sv);
1981 if (stash && Gv_AMG(stash)) {
1982 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1983 PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1985 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1987 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1989 return store(aTHX_ cxt, sv);
1997 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1998 * SX_LUTF8STR and SX_UTF8STR are used for UTF-8 strings.
1999 * The <data> section is omitted if <length> is 0.
2001 * For vstrings, the vstring portion is stored first with
2002 * SX_LVSTRING <length> <data> or SX_VSTRING <length> <data>, followed by
2003 * SX_(L)SCALAR or SX_(L)UTF8STR with the actual PV.
2005 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
2006 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
2008 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
2013 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
2015 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
2018 * For efficiency, break the SV encapsulation by peaking at the flags
2019 * directly without using the Perl macros to avoid dereferencing
2020 * sv->sv_flags each time we wish to check the flags.
2023 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
2024 if (sv == &PL_sv_undef) {
2025 TRACEME(("immortal undef"));
2026 PUTMARK(SX_SV_UNDEF);
2028 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
2035 * Always store the string representation of a scalar if it exists.
2036 * Gisle Aas provided me with this test case, better than a long speach:
2038 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
2039 * SV = PVNV(0x80c8520)
2041 * FLAGS = (NOK,POK,pNOK,pPOK)
2044 * PV = 0x80c83d0 "abc"\0
2048 * Write SX_SCALAR, length, followed by the actual data.
2050 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
2051 * appropriate, followed by the actual (binary) data. A double
2052 * is written as a string if network order, for portability.
2054 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
2055 * The reason is that when the scalar value is tainted, the SvNOK(sv)
2058 * The test for a read-only scalar with both POK and NOK set is meant
2059 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
2060 * address comparison for each scalar we store.
2063 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
2065 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
2066 if (sv == &PL_sv_yes) {
2067 TRACEME(("immortal yes"));
2069 } else if (sv == &PL_sv_no) {
2070 TRACEME(("immortal no"));
2073 pv = SvPV(sv, len); /* We know it's SvPOK */
2074 goto string; /* Share code below */
2076 } else if (flags & SVf_POK) {
2077 /* public string - go direct to string read. */
2078 goto string_readlen;
2080 #if (PATCHLEVEL <= 6)
2081 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
2082 direct if NV flag is off. */
2083 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
2085 /* 5.7 rules are that if IV public flag is set, IV value is as
2086 good, if not better, than NV value. */
2092 * Will come here from below with iv set if double is an integer.
2096 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2098 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
2099 * (for example) and that ends up in the optimised small integer
2102 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
2103 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
2104 goto string_readlen;
2108 * Optimize small integers into a single byte, otherwise store as
2109 * a real integer (converted into network order if they asked).
2112 if (iv >= -128 && iv <= 127) {
2113 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
2116 TRACEME(("small integer stored as %d", siv));
2117 } else if (cxt->netorder) {
2119 TRACEME(("no htonl, fall back to string for integer"));
2120 goto string_readlen;
2128 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2129 ((flags & SVf_IVisUV) && SvUV(sv) > (UV)0x7FFFFFFF) ||
2131 (iv > (IV)0x7FFFFFFF) || (iv < -(IV)0x80000000)) {
2132 /* Bigger than 32 bits. */
2133 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2134 goto string_readlen;
2138 niv = (I32) htonl((I32) iv);
2139 TRACEME(("using network order"));
2144 PUTMARK(SX_INTEGER);
2145 WRITE(&iv, sizeof(iv));
2148 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2149 } else if (flags & SVf_NOK) {
2151 #if (PATCHLEVEL <= 6)
2154 * Watch for number being an integer in disguise.
2156 if (nv == (NV) (iv = I_V(nv))) {
2157 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2158 goto integer; /* Share code above */
2163 if (SvIOK_notUV(sv)) {
2165 goto integer; /* Share code above */
2170 if (cxt->netorder) {
2171 TRACEME(("double %"NVff" stored as string", nv));
2172 goto string_readlen; /* Share code below */
2176 WRITE(&nv, sizeof(nv));
2178 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2180 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2184 I32 wlen; /* For 64-bit machines */
2190 * Will come here from above if it was readonly, POK and NOK but
2191 * neither &PL_sv_yes nor &PL_sv_no.
2196 if (SvMAGICAL(sv) && (mg = mg_find(sv, 'V')))
2197 STORE_PV_LEN((const char *)mg->mg_ptr,
2198 mg->mg_len, SX_VSTRING, SX_LVSTRING);
2201 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2203 STORE_UTF8STR(pv, wlen);
2205 STORE_SCALAR(pv, wlen);
2206 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2207 PTR2UV(sv), SvPVX(sv), (IV)len));
2209 CROAK(("Can't determine type of %s(0x%"UVxf")",
2210 sv_reftype(sv, FALSE),
2212 return 0; /* Ok, no recursion on scalars */
2220 * Layout is SX_ARRAY <size> followed by each item, in increasing index order.
2221 * Each item is stored as <object>.
2223 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2226 I32 len = av_len(av) + 1;
2230 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2233 * Signal array by emitting SX_ARRAY, followed by the array length.
2238 TRACEME(("size = %d", len));
2241 * Now store each item recursively.
2244 for (i = 0; i < len; i++) {
2245 sav = av_fetch(av, i, 0);
2247 TRACEME(("(#%d) undef item", i));
2251 TRACEME(("(#%d) item", i));
2252 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2256 TRACEME(("ok (array)"));
2262 #if (PATCHLEVEL <= 6)
2268 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2271 sortcmp(const void *a, const void *b)
2273 #if defined(USE_ITHREADS)
2275 #endif /* USE_ITHREADS */
2276 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2279 #endif /* PATCHLEVEL <= 6 */
2284 * Store a hash table.
2286 * For a "normal" hash (not restricted, no utf8 keys):
2288 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2289 * Values are stored as <object>.
2290 * Keys are stored as <length> <data>, the <data> section being omitted
2293 * For a "fancy" hash (restricted or utf8 keys):
2295 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2297 * Values are stored as <object>.
2298 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2300 * Currently the only hash flag is "restricted"
2301 * Key flags are as for hv.h
2303 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2306 I32 len = HvTOTALKEYS(hv);
2311 int flagged_hash = ((SvREADONLY(hv)
2312 #ifdef HAS_HASH_KEY_FLAGS
2316 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2319 /* needs int cast for C++ compilers, doesn't it? */
2320 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2323 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2327 * Signal hash by emitting SX_HASH, followed by the table length.
2331 PUTMARK(SX_FLAG_HASH);
2332 PUTMARK(hash_flags);
2337 TRACEME(("size = %d", len));
2340 * Save possible iteration state via each() on that table.
2343 riter = HvRITER_get(hv);
2344 eiter = HvEITER_get(hv);
2348 * Now store each item recursively.
2350 * If canonical is defined to some true value then store each
2351 * key/value pair in sorted order otherwise the order is random.
2352 * Canonical order is irrelevant when a deep clone operation is performed.
2354 * Fetch the value from perl only once per store() operation, and only
2359 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2360 (cxt->canonical < 0 && (cxt->canonical =
2361 (SvTRUE(perl_get_sv("Storable::canonical", GV_ADD)) ? 1 : 0))))
2364 * Storing in order, sorted by key.
2365 * Run through the hash, building up an array of keys in a
2366 * mortal array, sort the array and then run through the
2372 /*av_extend (av, len);*/
2374 TRACEME(("using canonical order"));
2376 for (i = 0; i < len; i++) {
2377 #ifdef HAS_RESTRICTED_HASHES
2378 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2380 HE *he = hv_iternext(hv);
2385 CROAK(("Hash %p inconsistent - expected %d keys, %dth is NULL", hv, (int)len, (int)i));
2386 key = hv_iterkeysv(he);
2387 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2392 for (i = 0; i < len; i++) {
2393 #ifdef HAS_RESTRICTED_HASHES
2394 int placeholders = (int)HvPLACEHOLDERS_get(hv);
2396 unsigned char flags = 0;
2400 SV *key = av_shift(av);
2401 /* This will fail if key is a placeholder.
2402 Track how many placeholders we have, and error if we
2404 HE *he = hv_fetch_ent(hv, key, 0, 0);
2408 if (!(val = HeVAL(he))) {
2409 /* Internal error, not I/O error */
2413 #ifdef HAS_RESTRICTED_HASHES
2414 /* Should be a placeholder. */
2415 if (placeholders-- < 0) {
2416 /* This should not happen - number of
2417 retrieves should be identical to
2418 number of placeholders. */
2421 /* Value is never needed, and PL_sv_undef is
2422 more space efficient to store. */
2425 ("Flags not 0 but %d", flags));
2426 flags = SHV_K_PLACEHOLDER;
2433 * Store value first.
2436 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2438 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2443 * Keys are written after values to make sure retrieval
2444 * can be optimal in terms of memory usage, where keys are
2445 * read into a fixed unique buffer called kbuf.
2446 * See retrieve_hash() for details.
2449 /* Implementation of restricted hashes isn't nicely
2451 if ((hash_flags & SHV_RESTRICTED)
2452 && SvREADONLY(val) && !SvIsCOW(val)) {
2453 flags |= SHV_K_LOCKED;
2456 keyval = SvPV(key, keylen_tmp);
2457 keylen = keylen_tmp;
2458 #ifdef HAS_UTF8_HASHES
2459 /* If you build without optimisation on pre 5.6
2460 then nothing spots that SvUTF8(key) is always 0,
2461 so the block isn't optimised away, at which point
2462 the linker dislikes the reference to
2465 const char *keysave = keyval;
2466 bool is_utf8 = TRUE;
2468 /* Just casting the &klen to (STRLEN) won't work
2469 well if STRLEN and I32 are of different widths.
2471 keyval = (char*)bytes_from_utf8((U8*)keyval,
2475 /* If we were able to downgrade here, then than
2476 means that we have a key which only had chars
2477 0-255, but was utf8 encoded. */
2479 if (keyval != keysave) {
2480 keylen = keylen_tmp;
2481 flags |= SHV_K_WASUTF8;
2483 /* keylen_tmp can't have changed, so no need
2484 to assign back to keylen. */
2485 flags |= SHV_K_UTF8;
2492 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2494 /* This is a workaround for a bug in 5.8.0
2495 that causes the HEK_WASUTF8 flag to be
2496 set on an HEK without the hash being
2497 marked as having key flags. We just
2498 cross our fingers and drop the flag.
2500 assert (flags == 0 || flags == SHV_K_WASUTF8);
2501 TRACEME(("(#%d) key '%s'", i, keyval));
2505 WRITE(keyval, keylen);
2506 if (flags & SHV_K_WASUTF8)
2511 * Free up the temporary array
2520 * Storing in "random" order (in the order the keys are stored
2521 * within the hash). This is the default and will be faster!
2524 for (i = 0; i < len; i++) {
2527 unsigned char flags;
2528 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2529 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2531 HE *he = hv_iternext(hv);
2533 SV *val = (he ? hv_iterval(hv, he) : 0);
2538 return 1; /* Internal error, not I/O error */
2540 /* Implementation of restricted hashes isn't nicely
2543 = (((hash_flags & SHV_RESTRICTED)
2544 && SvREADONLY(val) && !SvIsCOW(val))
2545 ? SHV_K_LOCKED : 0);
2547 if (val == &PL_sv_placeholder) {
2548 flags |= SHV_K_PLACEHOLDER;
2553 * Store value first.
2556 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2558 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2562 hek = HeKEY_hek(he);
2564 if (len == HEf_SVKEY) {
2565 /* This is somewhat sick, but the internal APIs are
2566 * such that XS code could put one of these in in
2568 * Maybe we should be capable of storing one if
2571 key_sv = HeKEY_sv(he);
2572 flags |= SHV_K_ISSV;
2574 /* Regular string key. */
2575 #ifdef HAS_HASH_KEY_FLAGS
2577 flags |= SHV_K_UTF8;
2578 if (HEK_WASUTF8(hek))
2579 flags |= SHV_K_WASUTF8;
2585 * Keys are written after values to make sure retrieval
2586 * can be optimal in terms of memory usage, where keys are
2587 * read into a fixed unique buffer called kbuf.
2588 * See retrieve_hash() for details.
2593 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2595 /* This is a workaround for a bug in 5.8.0
2596 that causes the HEK_WASUTF8 flag to be
2597 set on an HEK without the hash being
2598 marked as having key flags. We just
2599 cross our fingers and drop the flag.
2601 assert (flags == 0 || flags == SHV_K_WASUTF8);
2602 TRACEME(("(#%d) key '%s'", i, key));
2604 if (flags & SHV_K_ISSV) {
2605 store(aTHX_ cxt, key_sv);
2614 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2617 HvRITER_set(hv, riter); /* Restore hash iterator state */
2618 HvEITER_set(hv, eiter);
2626 * Store a code reference.
2628 * Layout is SX_CODE <length> followed by a scalar containing the perl
2629 * source code of the code reference.
2631 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2633 #if PERL_VERSION < 6
2635 * retrieve_code does not work with perl 5.005 or less
2637 return store_other(aTHX_ cxt, (SV*)cv);
2642 SV *text, *bdeparse;
2644 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2647 cxt->deparse == 0 ||
2648 (cxt->deparse < 0 && !(cxt->deparse =
2649 SvTRUE(perl_get_sv("Storable::Deparse", GV_ADD)) ? 1 : 0))
2651 return store_other(aTHX_ cxt, (SV*)cv);
2655 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2656 * blessed code references.
2658 /* Ownership of both SVs is passed to load_module, which frees them. */
2659 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2666 * create the B::Deparse object
2670 XPUSHs(newSVpvs_flags("B::Deparse", SVs_TEMP));
2672 count = call_method("new", G_SCALAR);
2675 CROAK(("Unexpected return value from B::Deparse::new\n"));
2679 * call the coderef2text method
2683 XPUSHs(bdeparse); /* XXX is this already mortal? */
2684 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2686 count = call_method("coderef2text", G_SCALAR);
2689 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2693 reallen = strlen(SvPV_nolen(text));
2696 * Empty code references or XS functions are deparsed as
2697 * "(prototype) ;" or ";".
2700 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2701 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2705 * Signal code by emitting SX_CODE.
2709 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2710 TRACEME(("size = %d", len));
2711 TRACEME(("code = %s", SvPV_nolen(text)));
2714 * Now store the source code.
2718 STORE_UTF8STR(SvPV_nolen(text), len);
2720 STORE_SCALAR(SvPV_nolen(text), len);
2725 TRACEME(("ok (code)"));
2734 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2735 * a special mark, followed by the underlying tied object. For instance, when
2736 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2737 * <hash object> stands for the serialization of the tied hash.
2739 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2744 int svt = SvTYPE(sv);
2747 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2750 * We have a small run-time penalty here because we chose to factorise
2751 * all tieds objects into the same routine, and not have a store_tied_hash,
2752 * a store_tied_array, etc...
2754 * Don't use a switch() statement, as most compilers don't optimize that
2755 * well for 2/3 values. An if() else if() cascade is just fine. We put
2756 * tied hashes first, as they are the most likely beasts.
2759 if (svt == SVt_PVHV) {
2760 TRACEME(("tied hash"));
2761 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2762 } else if (svt == SVt_PVAV) {
2763 TRACEME(("tied array"));
2764 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2766 TRACEME(("tied scalar"));
2767 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2771 if (!(mg = mg_find(sv, mtype)))
2772 CROAK(("No magic '%c' found while storing tied %s", mtype,
2773 (svt == SVt_PVHV) ? "hash" :
2774 (svt == SVt_PVAV) ? "array" : "scalar"));
2777 * The mg->mg_obj found by mg_find() above actually points to the
2778 * underlying tied Perl object implementation. For instance, if the
2779 * original SV was that of a tied array, then mg->mg_obj is an AV.
2781 * Note that we store the Perl object as-is. We don't call its FETCH
2782 * method along the way. At retrieval time, we won't call its STORE
2783 * method either, but the tieing magic will be re-installed. In itself,
2784 * that ensures that the tieing semantics are preserved since further
2785 * accesses on the retrieved object will indeed call the magic methods...
2788 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2789 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2790 if ((ret = store(aTHX_ cxt, obj)))
2793 TRACEME(("ok (tied)"));
2801 * Stores a reference to an item within a tied structure:
2803 * . \$h{key}, stores both the (tied %h) object and 'key'.
2804 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2806 * Layout is therefore either:
2807 * SX_TIED_KEY <object> <key>
2808 * SX_TIED_IDX <object> <index>
2810 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2815 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2817 if (!(mg = mg_find(sv, 'p')))
2818 CROAK(("No magic 'p' found while storing reference to tied item"));
2821 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2825 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2826 PUTMARK(SX_TIED_KEY);
2827 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2829 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2832 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2834 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2837 I32 idx = mg->mg_len;
2839 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2840 PUTMARK(SX_TIED_IDX);
2841 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2843 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2846 TRACEME(("store_tied_item: storing IDX %d", idx));
2851 TRACEME(("ok (tied item)"));
2857 * store_hook -- dispatched manually, not via sv_store[]
2859 * The blessed SV is serialized by a hook.
2863 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2865 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2866 * the trailing part [] is present, the type of object (scalar, array or hash).
2867 * There is also a bit which says how the classname is stored between:
2872 * and when the <index> form is used (classname already seen), the "large
2873 * classname" bit in <flags> indicates how large the <index> is.
2875 * The serialized string returned by the hook is of length <len2> and comes
2876 * next. It is an opaque string for us.
2878 * Those <len3> object IDs which are listed last represent the extra references
2879 * not directly serialized by the hook, but which are linked to the object.
2881 * When recursion is mandated to resolve object-IDs not yet seen, we have
2882 * instead, with <header> being flags with bits set to indicate the object type
2883 * and that recursion was indeed needed:
2885 * SX_HOOK <header> <object> <header> <object> <flags>
2887 * that same header being repeated between serialized objects obtained through
2888 * recursion, until we reach flags indicating no recursion, at which point
2889 * we know we've resynchronized with a single layout, after <flags>.
2891 * When storing a blessed ref to a tied variable, the following format is
2894 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2896 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2897 * real object type is held in the <extra> flag. At the very end of the
2898 * serialization stream, the underlying magic object is serialized, just like
2899 * any other tied variable.
2901 static int store_hook(
2915 int count; /* really len3 + 1 */
2916 unsigned char flags;
2919 int recursed = 0; /* counts recursion */
2920 int obj_type; /* object type, on 2 bits */
2923 int clone = cxt->optype & ST_CLONE;
2924 char mtype = '\0'; /* for blessed ref to tied structures */
2925 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2927 TRACEME(("store_hook, classname \"%s\", tagged #%d", HvNAME_get(pkg), cxt->tagnum));
2930 * Determine object type on 2 bits.
2936 obj_type = SHT_SCALAR;
2939 obj_type = SHT_ARRAY;
2942 obj_type = SHT_HASH;
2946 * Produced by a blessed ref to a tied data structure, $o in the
2947 * following Perl code.
2951 * my $o = bless \%h, 'BAR';
2953 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2954 * (since we have only 2 bits in <flags> to store the type), and an
2955 * <extra> byte flag will be emitted after the FIRST <flags> in the
2956 * stream, carrying what we put in 'eflags'.
2958 obj_type = SHT_EXTRA;
2959 switch (SvTYPE(sv)) {
2961 eflags = (unsigned char) SHT_THASH;
2965 eflags = (unsigned char) SHT_TARRAY;
2969 eflags = (unsigned char) SHT_TSCALAR;
2975 CROAK(("Unexpected object type (%d) in store_hook()", type));
2977 flags = SHF_NEED_RECURSE | obj_type;
2979 classname = HvNAME_get(pkg);
2980 len = strlen(classname);
2983 * To call the hook, we need to fake a call like:
2985 * $object->STORABLE_freeze($cloning);
2987 * but we don't have the $object here. For instance, if $object is
2988 * a blessed array, what we have in 'sv' is the array, and we can't
2989 * call a method on those.
2991 * Therefore, we need to create a temporary reference to the object and
2992 * make the call on that reference.
2995 TRACEME(("about to call STORABLE_freeze on class %s", classname));
2997 ref = newRV_inc(sv); /* Temporary reference */
2998 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2999 SvREFCNT_dec(ref); /* Reclaim temporary reference */
3001 count = AvFILLp(av) + 1;
3002 TRACEME(("store_hook, array holds %d items", count));
3005 * If they return an empty list, it means they wish to ignore the
3006 * hook for this class (and not just this instance -- that's for them
3007 * to handle if they so wish).
3009 * Simply disable the cached entry for the hook (it won't be recomputed
3010 * since it's present in the cache) and recurse to store_blessed().
3015 * They must not change their mind in the middle of a serialization.
3018 if (hv_fetch(cxt->hclass, classname, len, FALSE))
3019 CROAK(("Too late to ignore hooks for %s class \"%s\"",
3020 (cxt->optype & ST_CLONE) ? "cloning" : "storing", classname));
3022 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3024 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
3025 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", classname));
3027 return store_blessed(aTHX_ cxt, sv, type, pkg);
3031 * Get frozen string.
3035 pv = SvPV(ary[0], len2);
3036 /* We can't use pkg_can here because it only caches one method per
3039 GV* gv = gv_fetchmethod_autoload(pkg, "STORABLE_attach", FALSE);
3040 if (gv && isGV(gv)) {
3042 CROAK(("Freeze cannot return references if %s class is using STORABLE_attach", classname));
3048 * If they returned more than one item, we need to serialize some
3049 * extra references if not already done.
3051 * Loop over the array, starting at position #1, and for each item,
3052 * ensure it is a reference, serialize it if not already done, and
3053 * replace the entry with the tag ID of the corresponding serialized
3056 * We CHEAT by not calling av_fetch() and read directly within the
3060 for (i = 1; i < count; i++) {
3061 #ifdef USE_PTR_TABLE
3069 AV *av_hook = cxt->hook_seen;
3072 CROAK(("Item #%d returned by STORABLE_freeze "
3073 "for %s is not a reference", i, classname));
3074 xsv = SvRV(rsv); /* Follow ref to know what to look for */
3077 * Look in hseen and see if we have a tag already.
3078 * Serialize entry if not done already, and get its tag.
3081 #ifdef USE_PTR_TABLE
3082 /* Fakery needed because ptr_table_fetch returns zero for a
3083 failure, whereas the existing code assumes that it can
3084 safely store a tag zero. So for ptr_tables we store tag+1
3086 if ((fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv)))
3087 goto sv_seen; /* Avoid moving code too far to the right */
3089 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
3090 goto sv_seen; /* Avoid moving code too far to the right */
3093 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
3096 * We need to recurse to store that object and get it to be known
3097 * so that we can resolve the list of object-IDs at retrieve time.
3099 * The first time we do this, we need to emit the proper header
3100 * indicating that we recursed, and what the type of object is (the
3101 * object we're storing via a user-hook). Indeed, during retrieval,
3102 * we'll have to create the object before recursing to retrieve the
3103 * others, in case those would point back at that object.
3106 /* [SX_HOOK] <flags> [<extra>] <object>*/
3110 if (obj_type == SHT_EXTRA)
3115 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
3118 #ifdef USE_PTR_TABLE
3119 fake_tag = (char *)ptr_table_fetch(cxt->pseen, xsv);
3121 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3123 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
3125 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3128 * It was the first time we serialized 'xsv'.
3130 * Keep this SV alive until the end of the serialization: if we
3131 * disposed of it right now by decrementing its refcount, and it was
3132 * a temporary value, some next temporary value allocated during
3133 * another STORABLE_freeze might take its place, and we'd wrongly
3134 * assume that new SV was already serialized, based on its presence
3137 * Therefore, push it away in cxt->hook_seen.
3140 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
3144 * Dispose of the REF they returned. If we saved the 'xsv' away
3145 * in the array of returned SVs, that will not cause the underlying
3146 * referenced SV to be reclaimed.
3149 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
3150 SvREFCNT_dec(rsv); /* Dispose of reference */
3153 * Replace entry with its tag (not a real SV, so no refcnt increment)
3156 #ifdef USE_PTR_TABLE
3157 tag = (SV *)--fake_tag;
3162 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
3163 i-1, PTR2UV(xsv), PTR2UV(tag)));
3167 * Allocate a class ID if not already done.
3169 * This needs to be done after the recursion above, since at retrieval
3170 * time, we'll see the inner objects first. Many thanks to
3171 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
3172 * proposed the right fix. -- RAM, 15/09/2000
3176 if (!known_class(aTHX_ cxt, classname, len, &classnum)) {
3177 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3178 classnum = -1; /* Mark: we must store classname */
3180 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3184 * Compute leading flags.
3188 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3189 flags |= SHF_LARGE_CLASSLEN;
3191 flags |= SHF_IDX_CLASSNAME;
3192 if (len2 > LG_SCALAR)
3193 flags |= SHF_LARGE_STRLEN;
3195 flags |= SHF_HAS_LIST;
3196 if (count > (LG_SCALAR + 1))
3197 flags |= SHF_LARGE_LISTLEN;
3200 * We're ready to emit either serialized form:
3202 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3203 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3205 * If we recursed, the SX_HOOK has already been emitted.
3208 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3209 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3210 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3212 /* SX_HOOK <flags> [<extra>] */
3216 if (obj_type == SHT_EXTRA)
3221 /* <len> <classname> or <index> */
3222 if (flags & SHF_IDX_CLASSNAME) {
3223 if (flags & SHF_LARGE_CLASSLEN)
3226 unsigned char cnum = (unsigned char) classnum;
3230 if (flags & SHF_LARGE_CLASSLEN)
3233 unsigned char clen = (unsigned char) len;
3236 WRITE(classname, len); /* Final \0 is omitted */
3239 /* <len2> <frozen-str> */
3240 if (flags & SHF_LARGE_STRLEN) {
3241 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3242 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3244 unsigned char clen = (unsigned char) len2;
3248 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3250 /* [<len3> <object-IDs>] */
3251 if (flags & SHF_HAS_LIST) {
3252 int len3 = count - 1;
3253 if (flags & SHF_LARGE_LISTLEN)
3256 unsigned char clen = (unsigned char) len3;
3261 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3262 * real pointer, rather a tag number, well under the 32-bit limit.
3265 for (i = 1; i < count; i++) {
3266 I32 tagval = htonl(LOW_32BITS(ary[i]));
3268 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3273 * Free the array. We need extra care for indices after 0, since they
3274 * don't hold real SVs but integers cast.
3278 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3283 * If object was tied, need to insert serialization of the magic object.
3286 if (obj_type == SHT_EXTRA) {
3289 if (!(mg = mg_find(sv, mtype))) {
3290 int svt = SvTYPE(sv);
3291 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3292 mtype, (svt == SVt_PVHV) ? "hash" :
3293 (svt == SVt_PVAV) ? "array" : "scalar"));
3296 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3297 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3303 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3311 * store_blessed -- dispatched manually, not via sv_store[]
3313 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3314 * of its ancestors. If there is, then redispatch to store_hook();
3316 * Otherwise, the blessed SV is stored using the following layout:
3318 * SX_BLESS <flag> <len> <classname> <object>
3320 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3321 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3322 * Otherwise, the low order bits give the length, thereby giving a compact
3323 * representation for class names less than 127 chars long.
3325 * Each <classname> seen is remembered and indexed, so that the next time
3326 * an object in the blessed in the same <classname> is stored, the following
3329 * SX_IX_BLESS <flag> <index> <object>
3331 * where <index> is the classname index, stored on 0 or 4 bytes depending
3332 * on the high-order bit in flag (same encoding as above for <len>).
3334 static int store_blessed(
3346 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME_get(pkg)));
3349 * Look for a hook for this blessed SV and redirect to store_hook()
3353 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3355 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3358 * This is a blessed SV without any serialization hook.
3361 classname = HvNAME_get(pkg);
3362 len = strlen(classname);
3364 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3365 PTR2UV(sv), classname, cxt->tagnum));
3368 * Determine whether it is the first time we see that class name (in which
3369 * case it will be stored in the SX_BLESS form), or whether we already
3370 * saw that class name before (in which case the SX_IX_BLESS form will be
3374 if (known_class(aTHX_ cxt, classname, len, &classnum)) {
3375 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3376 PUTMARK(SX_IX_BLESS);
3377 if (classnum <= LG_BLESS) {
3378 unsigned char cnum = (unsigned char) classnum;
3381 unsigned char flag = (unsigned char) 0x80;
3386 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3388 if (len <= LG_BLESS) {
3389 unsigned char clen = (unsigned char) len;
3392 unsigned char flag = (unsigned char) 0x80;
3394 WLEN(len); /* Don't BER-encode, this should be rare */
3396 WRITE(classname, len); /* Final \0 is omitted */
3400 * Now emit the <object> part.
3403 return SV_STORE(type)(aTHX_ cxt, sv);
3409 * We don't know how to store the item we reached, so return an error condition.
3410 * (it's probably a GLOB, some CODE reference, etc...)
3412 * If they defined the 'forgive_me' variable at the Perl level to some
3413 * true value, then don't croak, just warn, and store a placeholder string
3416 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3421 TRACEME(("store_other"));
3424 * Fetch the value from perl only once per store() operation.
3428 cxt->forgive_me == 0 ||
3429 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3430 SvTRUE(perl_get_sv("Storable::forgive_me", GV_ADD)) ? 1 : 0))
3432 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3434 warn("Can't store item %s(0x%"UVxf")",
3435 sv_reftype(sv, FALSE), PTR2UV(sv));
3438 * Store placeholder string as a scalar instead...
3441 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3442 PTR2UV(sv), (char) 0);
3445 STORE_SCALAR(buf, len);
3446 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3452 *** Store driving routines
3458 * WARNING: partially duplicates Perl's sv_reftype for speed.
3460 * Returns the type of the SV, identified by an integer. That integer
3461 * may then be used to index the dynamic routine dispatch table.
3463 static int sv_type(pTHX_ SV *sv)
3465 switch (SvTYPE(sv)) {
3467 #if PERL_VERSION <= 10
3472 * No need to check for ROK, that can't be set here since there
3473 * is no field capable of hodling the xrv_rv reference.
3477 #if PERL_VERSION <= 10
3485 * Starting from SVt_PV, it is possible to have the ROK flag
3486 * set, the pointer to the other SV being either stored in
3487 * the xrv_rv (in the case of a pure SVt_RV), or as the
3488 * xpv_pv field of an SVt_PV and its heirs.
3490 * However, those SV cannot be magical or they would be an
3491 * SVt_PVMG at least.
3493 return SvROK(sv) ? svis_REF : svis_SCALAR;
3495 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3496 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3497 return svis_TIED_ITEM;
3499 #if PERL_VERSION < 9
3502 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3504 return SvROK(sv) ? svis_REF : svis_SCALAR;
3506 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3510 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3515 #if PERL_VERSION > 8
3516 /* case SVt_DUMMY: */
3528 * Recursively store objects pointed to by the sv to the specified file.
3530 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3531 * object (one for which storage has started -- it may not be over if we have
3532 * a self-referenced structure). This data set forms a stored <object>.
3534 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3539 #ifdef USE_PTR_TABLE
3540 struct ptr_tbl *pseen = cxt->pseen;
3542 HV *hseen = cxt->hseen;
3545 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3548 * If object has already been stored, do not duplicate data.
3549 * Simply emit the SX_OBJECT marker followed by its tag data.
3550 * The tag is always written in network order.
3552 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3553 * real pointer, rather a tag number (watch the insertion code below).
3554 * That means it probably safe to assume it is well under the 32-bit limit,
3555 * and makes the truncation safe.
3556 * -- RAM, 14/09/1999
3559 #ifdef USE_PTR_TABLE
3560 svh = (SV **)ptr_table_fetch(pseen, sv);
3562 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3567 if (sv == &PL_sv_undef) {
3568 /* We have seen PL_sv_undef before, but fake it as
3571 Not the simplest solution to making restricted
3572 hashes work on 5.8.0, but it does mean that
3573 repeated references to the one true undef will
3574 take up less space in the output file.
3576 /* Need to jump past the next hv_store, because on the
3577 second store of undef the old hash value will be
3578 SvREFCNT_dec()ed, and as Storable cheats horribly
3579 by storing non-SVs in the hash a SEGV will ensure.
3580 Need to increase the tag number so that the
3581 receiver has no idea what games we're up to. This
3582 special casing doesn't affect hooks that store
3583 undef, as the hook routine does its own lookup into
3584 hseen. Also this means that any references back
3585 to PL_sv_undef (from the pathological case of hooks
3586 storing references to it) will find the seen hash
3587 entry for the first time, as if we didn't have this
3588 hackery here. (That hseen lookup works even on 5.8.0
3589 because it's a key of &PL_sv_undef and a value
3590 which is a tag number, not a value which is
3594 goto undef_special_case;
3597 #ifdef USE_PTR_TABLE
3598 tagval = htonl(LOW_32BITS(((char *)svh)-1));
3600 tagval = htonl(LOW_32BITS(*svh));
3603 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3611 * Allocate a new tag and associate it with the address of the sv being
3612 * stored, before recursing...
3614 * In order to avoid creating new SvIVs to hold the tagnum we just
3615 * cast the tagnum to an SV pointer and store that in the hash. This
3616 * means that we must clean up the hash manually afterwards, but gives
3617 * us a 15% throughput increase.
3622 #ifdef USE_PTR_TABLE
3623 ptr_table_store(pseen, sv, INT2PTR(SV*, 1 + cxt->tagnum));
3625 if (!hv_store(hseen,
3626 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3631 * Store 'sv' and everything beneath it, using appropriate routine.
3632 * Abort immediately if we get a non-zero status back.
3635 type = sv_type(aTHX_ sv);
3638 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3639 PTR2UV(sv), cxt->tagnum, type));
3642 HV *pkg = SvSTASH(sv);
3643 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3645 ret = SV_STORE(type)(aTHX_ cxt, sv);
3647 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3648 ret ? "FAILED" : "ok", PTR2UV(sv),
3649 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3657 * Write magic number and system information into the file.
3658 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3659 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3660 * All size and lenghts are written as single characters here.
3662 * Note that no byte ordering info is emitted when <network> is true, since
3663 * integers will be emitted in network order in that case.
3665 static int magic_write(pTHX_ stcxt_t *cxt)
3668 * Starting with 0.6, the "use_network_order" byte flag is also used to
3669 * indicate the version number of the binary image, encoded in the upper
3670 * bits. The bit 0 is always used to indicate network order.
3673 * Starting with 0.7, a full byte is dedicated to the minor version of
3674 * the binary format, which is incremented only when new markers are
3675 * introduced, for instance, but when backward compatibility is preserved.
3678 /* Make these at compile time. The WRITE() macro is sufficiently complex
3679 that it saves about 200 bytes doing it this way and only using it
3681 static const unsigned char network_file_header[] = {
3683 (STORABLE_BIN_MAJOR << 1) | 1,
3684 STORABLE_BIN_WRITE_MINOR
3686 static const unsigned char file_header[] = {
3688 (STORABLE_BIN_MAJOR << 1) | 0,
3689 STORABLE_BIN_WRITE_MINOR,
3690 /* sizeof the array includes the 0 byte at the end: */
3691 (char) sizeof (byteorderstr) - 1,
3693 (unsigned char) sizeof(int),
3694 (unsigned char) sizeof(long),
3695 (unsigned char) sizeof(char *),
3696 (unsigned char) sizeof(NV)
3698 #ifdef USE_56_INTERWORK_KLUDGE
3699 static const unsigned char file_header_56[] = {
3701 (STORABLE_BIN_MAJOR << 1) | 0,
3702 STORABLE_BIN_WRITE_MINOR,
3703 /* sizeof the array includes the 0 byte at the end: */
3704 (char) sizeof (byteorderstr_56) - 1,
3706 (unsigned char) sizeof(int),
3707 (unsigned char) sizeof(long),
3708 (unsigned char) sizeof(char *),
3709 (unsigned char) sizeof(NV)
3712 const unsigned char *header;
3715 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3717 if (cxt->netorder) {
3718 header = network_file_header;
3719 length = sizeof (network_file_header);
3721 #ifdef USE_56_INTERWORK_KLUDGE
3722 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", GV_ADD))) {
3723 header = file_header_56;
3724 length = sizeof (file_header_56);
3728 header = file_header;
3729 length = sizeof (file_header);
3734 /* sizeof the array includes the 0 byte at the end. */
3735 header += sizeof (magicstr) - 1;
3736 length -= sizeof (magicstr) - 1;
3739 WRITE( (unsigned char*) header, length);
3741 if (!cxt->netorder) {
3742 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3743 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3744 (int) sizeof(int), (int) sizeof(long),
3745 (int) sizeof(char *), (int) sizeof(NV)));
3753 * Common code for store operations.
3755 * When memory store is requested (f = NULL) and a non null SV* is given in
3756 * 'res', it is filled with a new SV created out of the memory buffer.
3758 * It is required to provide a non-null 'res' when the operation type is not
3759 * dclone() and store() is performed to memory.
3761 static int do_store(
3772 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3773 ("must supply result SV pointer for real recursion to memory"));
3775 TRACEME(("do_store (optype=%d, netorder=%d)",
3776 optype, network_order));
3781 * Workaround for CROAK leak: if they enter with a "dirty" context,
3782 * free up memory for them now.
3786 clean_context(aTHX_ cxt);
3789 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3790 * re-enter store() via the hooks. We need to stack contexts.
3794 cxt = allocate_context(aTHX_ cxt);
3798 ASSERT(cxt->entry == 1, ("starting new recursion"));
3799 ASSERT(!cxt->s_dirty, ("clean context"));
3802 * Ensure sv is actually a reference. From perl, we called something
3804 * pstore(aTHX_ FILE, \@array);
3805 * so we must get the scalar value behind that reference.
3809 CROAK(("Not a reference"));
3810 sv = SvRV(sv); /* So follow it to know what to store */
3813 * If we're going to store to memory, reset the buffer.
3820 * Prepare context and emit headers.
3823 init_store_context(aTHX_ cxt, f, optype, network_order);
3825 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3826 return 0; /* Error */
3829 * Recursively store object...
3832 ASSERT(is_storing(aTHX), ("within store operation"));
3834 status = store(aTHX_ cxt, sv); /* Just do it! */
3837 * If they asked for a memory store and they provided an SV pointer,
3838 * make an SV string out of the buffer and fill their pointer.
3840 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3841 * an SV, since context cleanup might free the buffer if we did recurse.
3842 * (unless caller is dclone(), which is aware of that).
3845 if (!cxt->fio && res)
3846 *res = mbuf2sv(aTHX);
3851 * The "root" context is never freed, since it is meant to be always
3852 * handy for the common case where no recursion occurs at all (i.e.
3853 * we enter store() outside of any Storable code and leave it, period).
3854 * We know it's the "root" context because there's nothing stacked
3859 * When deep cloning, we don't free the context: doing so would force
3860 * us to copy the data in the memory buffer. Sicne we know we're
3861 * about to enter do_retrieve...
3864 clean_store_context(aTHX_ cxt);
3865 if (cxt->prev && !(cxt->optype & ST_CLONE))
3866 free_context(aTHX_ cxt);
3868 TRACEME(("do_store returns %d", status));
3880 * Build a new SV out of the content of the internal memory buffer.
3882 static SV *mbuf2sv(pTHX)
3886 return newSVpv(mbase, MBUF_SIZE());
3890 *** Specific retrieve callbacks.
3896 * Return an error via croak, since it is not possible that we get here
3897 * under normal conditions, when facing a file produced via pstore().
3899 static SV *retrieve_other(pTHX_ stcxt_t *cxt, const char *cname)
3901 PERL_UNUSED_ARG(cname);
3903 cxt->ver_major != STORABLE_BIN_MAJOR &&
3904 cxt->ver_minor != STORABLE_BIN_MINOR
3906 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3907 cxt->fio ? "file" : "string",
3908 cxt->ver_major, cxt->ver_minor,
3909 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3911 CROAK(("Corrupted storable %s (binary v%d.%d)",
3912 cxt->fio ? "file" : "string",
3913 cxt->ver_major, cxt->ver_minor));
3916 return (SV *) 0; /* Just in case */
3920 * retrieve_idx_blessed
3922 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3923 * <index> can be coded on either 1 or 5 bytes.
3925 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, const char *cname)
3928 const char *classname;
3932 PERL_UNUSED_ARG(cname);
3933 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3934 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3936 GETMARK(idx); /* Index coded on a single char? */
3941 * Fetch classname in 'aclass'
3944 sva = av_fetch(cxt->aclass, idx, FALSE);
3946 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3948 classname = SvPVX(*sva); /* We know it's a PV, by construction */
3950 TRACEME(("class ID %d => %s", idx, classname));
3953 * Retrieve object and bless it.
3956 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3964 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3965 * <len> can be coded on either 1 or 5 bytes.
3967 static SV *retrieve_blessed(pT
https://perl5.git.perl.org / perl5.git / blob