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 */
18 # if !(defined(PERL_VERSION) || (SUBVERSION > 0 && defined(PATCHLEVEL)))
19 # include <could_not_find_Perl_patchlevel.h>
24 #include "ppport.h" /* handle old perls */
29 #define DEBUGME /* Debug mode, turns assertions on as well */
30 #define DASSERT /* Assertion mode */
33 #if 0 /* On NetWare USE_PERLIO is not used */
34 #define DEBUGME /* Debug mode, turns assertions on as well */
35 #define DASSERT /* Assertion mode */
40 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
41 * Provide them with the necessary defines so they can build with pre-5.004.
44 #ifndef PERLIO_IS_STDIO
46 #define PerlIO_getc(x) getc(x)
47 #define PerlIO_putc(f,x) putc(x,f)
48 #define PerlIO_read(x,y,z) fread(y,1,z,x)
49 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
50 #define PerlIO_stdoutf printf
51 #endif /* PERLIO_IS_STDIO */
52 #endif /* USE_PERLIO */
55 * Earlier versions of perl might be used, we can't assume they have the latest!
58 #ifndef PERL_VERSION /* For perls < 5.6 */
59 #define PERL_VERSION PATCHLEVEL
61 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
63 #if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
64 #define PL_sv_yes sv_yes
65 #define PL_sv_no sv_no
66 #define PL_sv_undef sv_undef
67 #if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
68 #define newSVpvn newSVpv
70 #endif /* PATCHLEVEL <= 4 */
71 #ifndef HvSHAREKEYS_off
72 #define HvSHAREKEYS_off(hv) /* Ignore */
74 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
75 #define AvFILLp AvFILL
77 typedef double NV; /* Older perls lack the NV type */
78 #define IVdf "ld" /* Various printf formats for Perl types */
82 #define INT2PTR(t,v) (t)(IV)(v)
83 #define PTR2UV(v) (unsigned long)(v)
84 #endif /* PERL_VERSION -- perls < 5.6 */
86 #ifndef NVef /* The following were not part of perl 5.6 */
87 #if defined(USE_LONG_DOUBLE) && \
88 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
89 #define NVef PERL_PRIeldbl
90 #define NVff PERL_PRIfldbl
91 #define NVgf PERL_PRIgldbl
100 #ifndef PERL_UNUSED_DECL
102 # if (defined(__GNUC__) && defined(__cplusplus)) || defined(__INTEL_COMPILER)
103 # define PERL_UNUSED_DECL
105 # define PERL_UNUSED_DECL __attribute__((unused))
108 # define PERL_UNUSED_DECL
113 #define dNOOP extern int Perl___notused PERL_UNUSED_DECL
127 * TRACEME() will only output things when the $Storable::DEBUGME is true.
132 if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
133 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
140 #define ASSERT(x,y) \
143 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
144 __FILE__, __LINE__); \
145 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
156 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
158 #define SX_OBJECT C(0) /* Already stored object */
159 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
160 #define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
161 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
162 #define SX_REF C(4) /* Reference to object forthcoming */
163 #define SX_UNDEF C(5) /* Undefined scalar */
164 #define SX_INTEGER C(6) /* Integer forthcoming */
165 #define SX_DOUBLE C(7) /* Double forthcoming */
166 #define SX_BYTE C(8) /* (signed) byte forthcoming */
167 #define SX_NETINT C(9) /* Integer in network order forthcoming */
168 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
169 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
170 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
171 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
172 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
173 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
174 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
175 #define SX_BLESS C(17) /* Object is blessed */
176 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
177 #define SX_HOOK C(19) /* Stored via hook, user-defined */
178 #define SX_OVERLOAD C(20) /* Overloaded reference */
179 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
180 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
181 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
182 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
183 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
184 #define SX_CODE C(26) /* Code references as perl source code */
185 #define SX_ERROR C(27) /* Error */
188 * Those are only used to retrieve "old" pre-0.6 binary images.
190 #define SX_ITEM 'i' /* An array item introducer */
191 #define SX_IT_UNDEF 'I' /* Undefined array item */
192 #define SX_KEY 'k' /* A hash key introducer */
193 #define SX_VALUE 'v' /* A hash value introducer */
194 #define SX_VL_UNDEF 'V' /* Undefined hash value */
197 * Those are only used to retrieve "old" pre-0.7 binary images
200 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
201 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
202 #define SX_STORED 'X' /* End of object */
205 * Limits between short/long length representation.
208 #define LG_SCALAR 255 /* Large scalar length limit */
209 #define LG_BLESS 127 /* Large classname bless limit */
215 #define ST_STORE 0x1 /* Store operation */
216 #define ST_RETRIEVE 0x2 /* Retrieval operation */
217 #define ST_CLONE 0x4 /* Deep cloning operation */
220 * The following structure is used for hash table key retrieval. Since, when
221 * retrieving objects, we'll be facing blessed hash references, it's best
222 * to pre-allocate that buffer once and resize it as the need arises, never
223 * freeing it (keys will be saved away someplace else anyway, so even large
224 * keys are not enough a motivation to reclaim that space).
226 * This structure is also used for memory store/retrieve operations which
227 * happen in a fixed place before being malloc'ed elsewhere if persistency
228 * is required. Hence the aptr pointer.
231 char *arena; /* Will hold hash key strings, resized as needed */
232 STRLEN asiz; /* Size of aforementionned buffer */
233 char *aptr; /* Arena pointer, for in-place read/write ops */
234 char *aend; /* First invalid address */
239 * A hash table records the objects which have already been stored.
240 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
241 * an arbitrary sequence number) is used to identify them.
244 * An array table records the objects which have already been retrieved,
245 * as seen by the tag determind by counting the objects themselves. The
246 * reference to that retrieved object is kept in the table, and is returned
247 * when an SX_OBJECT is found bearing that same tag.
249 * The same processing is used to record "classname" for blessed objects:
250 * indexing by a hash at store time, and via an array at retrieve time.
253 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
256 * The following "thread-safe" related defines were contributed by
257 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
258 * only renamed things a little bit to ensure consistency with surrounding
259 * code. -- RAM, 14/09/1999
261 * The original patch suffered from the fact that the stcxt_t structure
262 * was global. Murray tried to minimize the impact on the code as much as
265 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
266 * on objects. Therefore, the notion of context needs to be generalized,
270 #define MY_VERSION "Storable(" XS_VERSION ")"
274 * Conditional UTF8 support.
278 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
279 #define HAS_UTF8_SCALARS
281 #define HAS_UTF8_HASHES
284 /* 5.6 perl has utf8 scalars but not hashes */
288 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
291 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
294 #ifdef HvPLACEHOLDERS
295 #define HAS_RESTRICTED_HASHES
297 #define HVhek_PLACEHOLD 0x200
298 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
302 #define HAS_HASH_KEY_FLAGS
306 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
307 * files remap tainted and dirty when threading is enabled. That's bad for
308 * perl to remap such common words. -- RAM, 29/09/00
312 typedef struct stcxt {
313 int entry; /* flags recursion */
314 int optype; /* type of traversal operation */
315 HV *hseen; /* which objects have been seen, store time */
316 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
317 AV *aseen; /* which objects have been seen, retrieve time */
318 IV where_is_undef; /* index in aseen of PL_sv_undef */
319 HV *hclass; /* which classnames have been seen, store time */
320 AV *aclass; /* which classnames have been seen, retrieve time */
321 HV *hook; /* cache for hook methods per class name */
322 IV tagnum; /* incremented at store time for each seen object */
323 IV classnum; /* incremented at store time for each seen classname */
324 int netorder; /* true if network order used */
325 int s_tainted; /* true if input source is tainted, at retrieve time */
326 int forgive_me; /* whether to be forgiving... */
327 int deparse; /* whether to deparse code refs */
328 SV *eval; /* whether to eval source code */
329 int canonical; /* whether to store hashes sorted by key */
330 #ifndef HAS_RESTRICTED_HASHES
331 int derestrict; /* whether to downgrade restrcted hashes */
334 int use_bytes; /* whether to bytes-ify utf8 */
336 int accept_future_minor; /* croak immediately on future minor versions? */
337 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
338 int membuf_ro; /* true means membuf is read-only and msaved is rw */
339 struct extendable keybuf; /* for hash key retrieval */
340 struct extendable membuf; /* for memory store/retrieve operations */
341 struct extendable msaved; /* where potentially valid mbuf is saved */
342 PerlIO *fio; /* where I/O are performed, NULL for memory */
343 int ver_major; /* major of version for retrieved object */
344 int ver_minor; /* minor of version for retrieved object */
345 SV *(**retrieve_vtbl)(pTHX_ struct stcxt *, char *); /* retrieve dispatch table */
346 SV *prev; /* contexts chained backwards in real recursion */
347 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
350 #define NEW_STORABLE_CXT_OBJ(cxt) \
352 SV *self = newSV(sizeof(stcxt_t) - 1); \
353 SV *my_sv = newRV_noinc(self); \
354 sv_bless(my_sv, gv_stashpv("Storable::Cxt", TRUE)); \
355 cxt = (stcxt_t *)SvPVX(self); \
356 Zero(cxt, 1, stcxt_t); \
357 cxt->my_sv = my_sv; \
360 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
362 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
364 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
365 #else /* >= perl5.004_68 */
367 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
368 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
369 #endif /* < perl5.004_68 */
371 #define dSTCXT_PTR(T,name) \
372 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
373 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
376 dSTCXT_PTR(stcxt_t *, cxt)
380 NEW_STORABLE_CXT_OBJ(cxt); \
381 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
383 #define SET_STCXT(x) \
386 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
389 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
391 static stcxt_t *Context_ptr = NULL;
392 #define dSTCXT stcxt_t *cxt = Context_ptr
393 #define SET_STCXT(x) Context_ptr = x
396 NEW_STORABLE_CXT_OBJ(cxt); \
400 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
404 * Croaking implies a memory leak, since we don't use setjmp/longjmp
405 * to catch the exit and free memory used during store or retrieve
406 * operations. This is not too difficult to fix, but I need to understand
407 * how Perl does it, and croaking is exceptional anyway, so I lack the
408 * motivation to do it.
410 * The current workaround is to mark the context as dirty when croaking,
411 * so that data structures can be freed whenever we renter Storable code
412 * (but only *then*: it's a workaround, not a fix).
414 * This is also imperfect, because we don't really know how far they trapped
415 * the croak(), and when we were recursing, we won't be able to clean anything
416 * but the topmost context stacked.
419 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
422 * End of "thread-safe" related definitions.
428 * Keep only the low 32 bits of a pointer (used for tags, which are not
433 #define LOW_32BITS(x) ((I32) (x))
435 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
441 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
442 * Used in the WLEN and RLEN macros.
446 #define oI(x) ((I32 *) ((char *) (x) + 4))
447 #define oS(x) ((x) - 4)
448 #define oC(x) (x = 0)
457 * key buffer handling
459 #define kbuf (cxt->keybuf).arena
460 #define ksiz (cxt->keybuf).asiz
464 TRACEME(("** allocating kbuf of 128 bytes")); \
465 New(10003, kbuf, 128, char); \
472 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
473 Renew(kbuf, x+1, char); \
479 * memory buffer handling
481 #define mbase (cxt->membuf).arena
482 #define msiz (cxt->membuf).asiz
483 #define mptr (cxt->membuf).aptr
484 #define mend (cxt->membuf).aend
486 #define MGROW (1 << 13)
487 #define MMASK (MGROW - 1)
489 #define round_mgrow(x) \
490 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
491 #define trunc_int(x) \
492 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
493 #define int_aligned(x) \
494 ((unsigned long) (x) == trunc_int(x))
496 #define MBUF_INIT(x) \
499 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
500 New(10003, mbase, MGROW, char); \
501 msiz = (STRLEN)MGROW; \
507 mend = mbase + msiz; \
510 #define MBUF_TRUNC(x) mptr = mbase + x
511 #define MBUF_SIZE() (mptr - mbase)
517 * Those macros are used in do_retrieve() to save the current memory
518 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
519 * data from a string.
521 #define MBUF_SAVE_AND_LOAD(in) \
523 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
524 cxt->membuf_ro = 1; \
525 TRACEME(("saving mbuf")); \
526 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
530 #define MBUF_RESTORE() \
532 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
533 cxt->membuf_ro = 0; \
534 TRACEME(("restoring mbuf")); \
535 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
539 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
540 * See store_scalar() for other usage of this workaround.
542 #define MBUF_LOAD(v) \
544 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
546 CROAK(("Not a scalar string")); \
547 mptr = mbase = SvPV(v, msiz); \
548 mend = mbase + msiz; \
551 #define MBUF_XTEND(x) \
553 int nsz = (int) round_mgrow((x)+msiz); \
554 int offset = mptr - mbase; \
555 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
556 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
558 Renew(mbase, nsz, char); \
560 mptr = mbase + offset; \
561 mend = mbase + nsz; \
564 #define MBUF_CHK(x) \
566 if ((mptr + (x)) > mend) \
570 #define MBUF_GETC(x) \
573 x = (int) (unsigned char) *mptr++; \
579 #define MBUF_GETINT(x) \
582 if ((mptr + 4) <= mend) { \
583 memcpy(oI(&x), mptr, 4); \
589 #define MBUF_GETINT(x) \
591 if ((mptr + sizeof(int)) <= mend) { \
592 if (int_aligned(mptr)) \
595 memcpy(&x, mptr, sizeof(int)); \
596 mptr += sizeof(int); \
602 #define MBUF_READ(x,s) \
604 if ((mptr + (s)) <= mend) { \
605 memcpy(x, mptr, s); \
611 #define MBUF_SAFEREAD(x,s,z) \
613 if ((mptr + (s)) <= mend) { \
614 memcpy(x, mptr, s); \
622 #define MBUF_PUTC(c) \
625 *mptr++ = (char) c; \
628 *mptr++ = (char) c; \
633 #define MBUF_PUTINT(i) \
636 memcpy(mptr, oI(&i), 4); \
640 #define MBUF_PUTINT(i) \
642 MBUF_CHK(sizeof(int)); \
643 if (int_aligned(mptr)) \
646 memcpy(mptr, &i, sizeof(int)); \
647 mptr += sizeof(int); \
651 #define MBUF_WRITE(x,s) \
654 memcpy(mptr, x, s); \
659 * Possible return values for sv_type().
663 #define svis_SCALAR 1
667 #define svis_TIED_ITEM 5
675 #define SHF_TYPE_MASK 0x03
676 #define SHF_LARGE_CLASSLEN 0x04
677 #define SHF_LARGE_STRLEN 0x08
678 #define SHF_LARGE_LISTLEN 0x10
679 #define SHF_IDX_CLASSNAME 0x20
680 #define SHF_NEED_RECURSE 0x40
681 #define SHF_HAS_LIST 0x80
684 * Types for SX_HOOK (last 2 bits in flags).
690 #define SHT_EXTRA 3 /* Read extra byte for type */
693 * The following are held in the "extra byte"...
696 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
697 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
698 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
701 * per hash flags for flagged hashes
704 #define SHV_RESTRICTED 0x01
707 * per key flags for flagged hashes
710 #define SHV_K_UTF8 0x01
711 #define SHV_K_WASUTF8 0x02
712 #define SHV_K_LOCKED 0x04
713 #define SHV_K_ISSV 0x08
714 #define SHV_K_PLACEHOLDER 0x10
717 * Before 0.6, the magic string was "perl-store" (binary version number 0).
719 * Since 0.6 introduced many binary incompatibilities, the magic string has
720 * been changed to "pst0" to allow an old image to be properly retrieved by
721 * a newer Storable, but ensure a newer image cannot be retrieved with an
724 * At 0.7, objects are given the ability to serialize themselves, and the
725 * set of markers is extended, backward compatibility is not jeopardized,
726 * so the binary version number could have remained unchanged. To correctly
727 * spot errors if a file making use of 0.7-specific extensions is given to
728 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
729 * a "minor" version, to better track this kind of evolution from now on.
732 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
733 static const char magicstr[] = "pst0"; /* Used as a magic number */
735 #define MAGICSTR_BYTES 'p','s','t','0'
736 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
738 /* 5.6.x introduced the ability to have IVs as long long.
739 However, Configure still defined BYTEORDER based on the size of a long.
740 Storable uses the BYTEORDER value as part of the header, but doesn't
741 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
742 with IV as long long on a platform that uses Configure (ie most things
743 except VMS and Windows) headers are identical for the different IV sizes,
744 despite the files containing some fields based on sizeof(IV)
746 5.8 is consistent - the following redifinition kludge is only needed on
747 5.6.x, but the interwork is needed on 5.8 while data survives in files
752 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
753 #ifndef NO_56_INTERWORK_KLUDGE
754 #define USE_56_INTERWORK_KLUDGE
756 #if BYTEORDER == 0x1234
758 #define BYTEORDER 0x12345678
760 #if BYTEORDER == 0x4321
762 #define BYTEORDER 0x87654321
767 #if BYTEORDER == 0x1234
768 #define BYTEORDER_BYTES '1','2','3','4'
770 #if BYTEORDER == 0x12345678
771 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
772 #ifdef USE_56_INTERWORK_KLUDGE
773 #define BYTEORDER_BYTES_56 '1','2','3','4'
776 #if BYTEORDER == 0x87654321
777 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
778 #ifdef USE_56_INTERWORK_KLUDGE
779 #define BYTEORDER_BYTES_56 '4','3','2','1'
782 #if BYTEORDER == 0x4321
783 #define BYTEORDER_BYTES '4','3','2','1'
785 #error Unknown byteoder. Please append your byteorder to Storable.xs
791 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
792 #ifdef USE_56_INTERWORK_KLUDGE
793 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
796 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
797 #define STORABLE_BIN_MINOR 6 /* Binary minor "version" */
799 /* If we aren't 5.7.3 or later, we won't be writing out files that use the
800 * new flagged hash introdued in 2.5, so put 2.4 in the binary header to
801 * maximise ease of interoperation with older Storables.
802 * Could we write 2.3s if we're on 5.005_03? NWC
804 #if (PATCHLEVEL <= 6)
805 #define STORABLE_BIN_WRITE_MINOR 4
808 * As of perl 5.7.3, utf8 hash key is introduced.
809 * So this must change -- dankogai
811 #define STORABLE_BIN_WRITE_MINOR 6
812 #endif /* (PATCHLEVEL <= 6) */
814 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
815 #define PL_sv_placeholder PL_sv_undef
819 * Useful store shortcuts...
823 * Note that if you put more than one mark for storing a particular
824 * type of thing, *and* in the retrieve_foo() function you mark both
825 * the thingy's you get off with SEEN(), you *must* increase the
826 * tagnum with cxt->tagnum++ along with this macro!
833 else if (PerlIO_putc(cxt->fio, x) == EOF) \
837 #define WRITE_I32(x) \
839 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
842 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
849 if (cxt->netorder) { \
850 int y = (int) htonl(x); \
853 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
858 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
863 #define WLEN(x) WRITE_I32(x)
870 else if (PerlIO_write(cxt->fio, x, y) != y) \
874 #define STORE_PV_LEN(pv, len, small, large) \
876 if (len <= LG_SCALAR) { \
877 unsigned char clen = (unsigned char) len; \
889 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
892 * Store &PL_sv_undef in arrays without recursing through store().
894 #define STORE_SV_UNDEF() \
897 PUTMARK(SX_SV_UNDEF); \
901 * Useful retrieve shortcuts...
905 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
911 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
915 #define READ_I32(x) \
917 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
921 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
931 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
934 x = (int) ntohl(x); \
937 #define RLEN(x) READ_I32(x)
944 else if (PerlIO_read(cxt->fio, x, y) != y) \
948 #define SAFEREAD(x,y,z) \
951 MBUF_SAFEREAD(x,y,z); \
952 else if (PerlIO_read(cxt->fio, x, y) != y) { \
959 * This macro is used at retrieve time, to remember where object 'y', bearing a
960 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
961 * we'll therefore know where it has been retrieved and will be able to
962 * share the same reference, as in the original stored memory image.
964 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
965 * on the objects given to STORABLE_thaw and expect that to be defined), and
966 * also for overloaded objects (for which we might not find the stash if the
967 * object is not blessed yet--this might occur for overloaded objects that
968 * refer to themselves indirectly: if we blessed upon return from a sub
969 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
970 * restored on it because the underlying object would not be blessed yet!).
972 * To achieve that, the class name of the last retrieved object is passed down
973 * recursively, and the first SEEN() call for which the class name is not NULL
974 * will bless the object.
976 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
978 #define SEEN(y,c,i) \
982 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
984 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
985 PTR2UV(y), SvREFCNT(y)-1)); \
987 BLESS((SV *) (y), c); \
991 * Bless `s' in `p', via a temporary reference, required by sv_bless().
997 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
998 stash = gv_stashpv((p), TRUE); \
999 ref = newRV_noinc(s); \
1000 (void) sv_bless(ref, stash); \
1001 SvRV_set(ref, NULL); \
1002 SvREFCNT_dec(ref); \
1005 * sort (used in store_hash) - conditionally use qsort when
1006 * sortsv is not available ( <= 5.6.1 ).
1009 #if (PATCHLEVEL <= 6)
1011 #if defined(USE_ITHREADS)
1013 #define STORE_HASH_SORT \
1015 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
1016 SAVESPTR(orig_perl); \
1017 PERL_SET_CONTEXT(aTHX); \
1018 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
1021 #else /* ! USE_ITHREADS */
1023 #define STORE_HASH_SORT \
1024 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1026 #endif /* USE_ITHREADS */
1028 #else /* PATCHLEVEL > 6 */
1030 #define STORE_HASH_SORT \
1031 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1033 #endif /* PATCHLEVEL <= 6 */
1035 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1036 static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname);
1039 * Dynamic dispatching table for SV store.
1042 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1043 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1044 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1045 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1046 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1047 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1048 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1049 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1050 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1052 static int (*sv_store[])(pTHX_ stcxt_t *cxt, SV *sv) = {
1053 store_ref, /* svis_REF */
1054 store_scalar, /* svis_SCALAR */
1055 (int (*)(pTHX_ stcxt_t *cxt, SV *sv)) store_array, /* svis_ARRAY */
1056 (int (*)(pTHX_ stcxt_t *cxt, SV *sv)) store_hash, /* svis_HASH */
1057 store_tied, /* svis_TIED */
1058 store_tied_item, /* svis_TIED_ITEM */
1059 (int (*)(pTHX_ stcxt_t *cxt, SV *sv)) store_code, /* svis_CODE */
1060 store_other, /* svis_OTHER */
1063 #define SV_STORE(x) (*sv_store[x])
1066 * Dynamic dispatching tables for SV retrieval.
1069 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname);
1070 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname);
1071 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
1072 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
1073 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname);
1074 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname);
1075 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname);
1076 static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname);
1077 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname);
1078 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname);
1079 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname);
1080 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname);
1081 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname);
1082 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname);
1083 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname);
1084 static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname);
1086 static SV *(*sv_old_retrieve[])(pTHX_ stcxt_t *cxt, char *cname) = {
1087 0, /* SX_OBJECT -- entry unused dynamically */
1088 retrieve_lscalar, /* SX_LSCALAR */
1089 old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1090 old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1091 retrieve_ref, /* SX_REF */
1092 retrieve_undef, /* SX_UNDEF */
1093 retrieve_integer, /* SX_INTEGER */
1094 retrieve_double, /* SX_DOUBLE */
1095 retrieve_byte, /* SX_BYTE */
1096 retrieve_netint, /* SX_NETINT */
1097 retrieve_scalar, /* SX_SCALAR */
1098 retrieve_tied_array, /* SX_ARRAY */
1099 retrieve_tied_hash, /* SX_HASH */
1100 retrieve_tied_scalar, /* SX_SCALAR */
1101 retrieve_other, /* SX_SV_UNDEF not supported */
1102 retrieve_other, /* SX_SV_YES not supported */
1103 retrieve_other, /* SX_SV_NO not supported */
1104 retrieve_other, /* SX_BLESS not supported */
1105 retrieve_other, /* SX_IX_BLESS not supported */
1106 retrieve_other, /* SX_HOOK not supported */
1107 retrieve_other, /* SX_OVERLOADED not supported */
1108 retrieve_other, /* SX_TIED_KEY not supported */
1109 retrieve_other, /* SX_TIED_IDX not supported */
1110 retrieve_other, /* SX_UTF8STR not supported */
1111 retrieve_other, /* SX_LUTF8STR not supported */
1112 retrieve_other, /* SX_FLAG_HASH not supported */
1113 retrieve_other, /* SX_CODE not supported */
1114 retrieve_other, /* SX_ERROR */
1117 static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
1118 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
1119 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname);
1120 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname);
1121 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname);
1122 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname);
1123 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname);
1124 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname);
1125 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname);
1126 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname);
1127 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname);
1128 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname);
1129 static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname);
1131 static SV *(*sv_retrieve[])(pTHX_ stcxt_t *cxt, char *cname) = {
1132 0, /* SX_OBJECT -- entry unused dynamically */
1133 retrieve_lscalar, /* SX_LSCALAR */
1134 retrieve_array, /* SX_ARRAY */
1135 retrieve_hash, /* SX_HASH */
1136 retrieve_ref, /* SX_REF */
1137 retrieve_undef, /* SX_UNDEF */
1138 retrieve_integer, /* SX_INTEGER */
1139 retrieve_double, /* SX_DOUBLE */
1140 retrieve_byte, /* SX_BYTE */
1141 retrieve_netint, /* SX_NETINT */
1142 retrieve_scalar, /* SX_SCALAR */
1143 retrieve_tied_array, /* SX_ARRAY */
1144 retrieve_tied_hash, /* SX_HASH */
1145 retrieve_tied_scalar, /* SX_SCALAR */
1146 retrieve_sv_undef, /* SX_SV_UNDEF */
1147 retrieve_sv_yes, /* SX_SV_YES */
1148 retrieve_sv_no, /* SX_SV_NO */
1149 retrieve_blessed, /* SX_BLESS */
1150 retrieve_idx_blessed, /* SX_IX_BLESS */
1151 retrieve_hook, /* SX_HOOK */
1152 retrieve_overloaded, /* SX_OVERLOAD */
1153 retrieve_tied_key, /* SX_TIED_KEY */
1154 retrieve_tied_idx, /* SX_TIED_IDX */
1155 retrieve_utf8str, /* SX_UTF8STR */
1156 retrieve_lutf8str, /* SX_LUTF8STR */
1157 retrieve_flag_hash, /* SX_HASH */
1158 retrieve_code, /* SX_CODE */
1159 retrieve_other, /* SX_ERROR */
1162 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1164 static SV *mbuf2sv(pTHX);
1167 *** Context management.
1173 * Called once per "thread" (interpreter) to initialize some global context.
1175 static void init_perinterp(pTHX)
1179 cxt->netorder = 0; /* true if network order used */
1180 cxt->forgive_me = -1; /* whether to be forgiving... */
1186 * Called at the end of every context cleaning, to perform common reset
1189 static void reset_context(stcxt_t *cxt)
1193 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1197 * init_store_context
1199 * Initialize a new store context for real recursion.
1201 static void init_store_context(
1208 TRACEME(("init_store_context"));
1210 cxt->netorder = network_order;
1211 cxt->forgive_me = -1; /* Fetched from perl if needed */
1212 cxt->deparse = -1; /* Idem */
1213 cxt->eval = NULL; /* Idem */
1214 cxt->canonical = -1; /* Idem */
1215 cxt->tagnum = -1; /* Reset tag numbers */
1216 cxt->classnum = -1; /* Reset class numbers */
1217 cxt->fio = f; /* Where I/O are performed */
1218 cxt->optype = optype; /* A store, or a deep clone */
1219 cxt->entry = 1; /* No recursion yet */
1222 * The `hseen' table is used to keep track of each SV stored and their
1223 * associated tag numbers is special. It is "abused" because the
1224 * values stored are not real SV, just integers cast to (SV *),
1225 * which explains the freeing below.
1227 * It is also one possible bottlneck to achieve good storing speed,
1228 * so the "shared keys" optimization is turned off (unlikely to be
1229 * of any use here), and the hash table is "pre-extended". Together,
1230 * those optimizations increase the throughput by 12%.
1233 cxt->hseen = newHV(); /* Table where seen objects are stored */
1234 HvSHAREKEYS_off(cxt->hseen);
1237 * The following does not work well with perl5.004_04, and causes
1238 * a core dump later on, in a completely unrelated spot, which
1239 * makes me think there is a memory corruption going on.
1241 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1242 * it below does not make any difference. It seems to work fine
1243 * with perl5.004_68 but given the probable nature of the bug,
1244 * that does not prove anything.
1246 * It's a shame because increasing the amount of buckets raises
1247 * store() throughput by 5%, but until I figure this out, I can't
1248 * allow for this to go into production.
1250 * It is reported fixed in 5.005, hence the #if.
1252 #if PERL_VERSION >= 5
1253 #define HBUCKETS 4096 /* Buckets for %hseen */
1254 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1258 * The `hclass' hash uses the same settings as `hseen' above, but it is
1259 * used to assign sequential tags (numbers) to class names for blessed
1262 * We turn the shared key optimization on.
1265 cxt->hclass = newHV(); /* Where seen classnames are stored */
1267 #if PERL_VERSION >= 5
1268 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1272 * The `hook' hash table is used to keep track of the references on
1273 * the STORABLE_freeze hook routines, when found in some class name.
1275 * It is assumed that the inheritance tree will not be changed during
1276 * storing, and that no new method will be dynamically created by the
1280 cxt->hook = newHV(); /* Table where hooks are cached */
1283 * The `hook_seen' array keeps track of all the SVs returned by
1284 * STORABLE_freeze hooks for us to serialize, so that they are not
1285 * reclaimed until the end of the serialization process. Each SV is
1286 * only stored once, the first time it is seen.
1289 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1293 * clean_store_context
1295 * Clean store context by
1297 static void clean_store_context(pTHX_ stcxt_t *cxt)
1301 TRACEME(("clean_store_context"));
1303 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1306 * Insert real values into hashes where we stored faked pointers.
1310 hv_iterinit(cxt->hseen);
1311 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1312 HeVAL(he) = &PL_sv_undef;
1316 hv_iterinit(cxt->hclass);
1317 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1318 HeVAL(he) = &PL_sv_undef;
1322 * And now dispose of them...
1324 * The surrounding if() protection has been added because there might be
1325 * some cases where this routine is called more than once, during
1326 * exceptionnal events. This was reported by Marc Lehmann when Storable
1327 * is executed from mod_perl, and the fix was suggested by him.
1328 * -- RAM, 20/12/2000
1332 HV *hseen = cxt->hseen;
1335 sv_free((SV *) hseen);
1339 HV *hclass = cxt->hclass;
1342 sv_free((SV *) hclass);
1346 HV *hook = cxt->hook;
1349 sv_free((SV *) hook);
1352 if (cxt->hook_seen) {
1353 AV *hook_seen = cxt->hook_seen;
1355 av_undef(hook_seen);
1356 sv_free((SV *) hook_seen);
1359 cxt->forgive_me = -1; /* Fetched from perl if needed */
1360 cxt->deparse = -1; /* Idem */
1362 SvREFCNT_dec(cxt->eval);
1364 cxt->eval = NULL; /* Idem */
1365 cxt->canonical = -1; /* Idem */
1371 * init_retrieve_context
1373 * Initialize a new retrieve context for real recursion.
1375 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1377 TRACEME(("init_retrieve_context"));
1380 * The hook hash table is used to keep track of the references on
1381 * the STORABLE_thaw hook routines, when found in some class name.
1383 * It is assumed that the inheritance tree will not be changed during
1384 * storing, and that no new method will be dynamically created by the
1388 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1391 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1392 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1393 * the correspondance between the tags and the tag number used by the
1394 * new retrieve routines.
1397 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1400 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1401 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1402 cxt->aclass = newAV(); /* Where seen classnames are kept */
1403 cxt->tagnum = 0; /* Have to count objects... */
1404 cxt->classnum = 0; /* ...and class names as well */
1405 cxt->optype = optype;
1406 cxt->s_tainted = is_tainted;
1407 cxt->entry = 1; /* No recursion yet */
1408 #ifndef HAS_RESTRICTED_HASHES
1409 cxt->derestrict = -1; /* Fetched from perl if needed */
1411 #ifndef HAS_UTF8_ALL
1412 cxt->use_bytes = -1; /* Fetched from perl if needed */
1414 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1418 * clean_retrieve_context
1420 * Clean retrieve context by
1422 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1424 TRACEME(("clean_retrieve_context"));
1426 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1429 AV *aseen = cxt->aseen;
1432 sv_free((SV *) aseen);
1434 cxt->where_is_undef = -1;
1437 AV *aclass = cxt->aclass;
1440 sv_free((SV *) aclass);
1444 HV *hook = cxt->hook;
1447 sv_free((SV *) hook);
1451 HV *hseen = cxt->hseen;
1454 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1457 #ifndef HAS_RESTRICTED_HASHES
1458 cxt->derestrict = -1; /* Fetched from perl if needed */
1460 #ifndef HAS_UTF8_ALL
1461 cxt->use_bytes = -1; /* Fetched from perl if needed */
1463 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1471 * A workaround for the CROAK bug: cleanup the last context.
1473 static void clean_context(pTHX_ stcxt_t *cxt)
1475 TRACEME(("clean_context"));
1477 ASSERT(cxt->s_dirty, ("dirty context"));
1482 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1484 if (cxt->optype & ST_RETRIEVE)
1485 clean_retrieve_context(aTHX_ cxt);
1486 else if (cxt->optype & ST_STORE)
1487 clean_store_context(aTHX_ cxt);
1491 ASSERT(!cxt->s_dirty, ("context is clean"));
1492 ASSERT(cxt->entry == 0, ("context is reset"));
1498 * Allocate a new context and push it on top of the parent one.
1499 * This new context is made globally visible via SET_STCXT().
1501 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1505 TRACEME(("allocate_context"));
1507 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1509 NEW_STORABLE_CXT_OBJ(cxt);
1510 cxt->prev = parent_cxt->my_sv;
1513 ASSERT(!cxt->s_dirty, ("clean context"));
1521 * Free current context, which cannot be the "root" one.
1522 * Make the context underneath globally visible via SET_STCXT().
1524 static void free_context(pTHX_ stcxt_t *cxt)
1526 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1528 TRACEME(("free_context"));
1530 ASSERT(!cxt->s_dirty, ("clean context"));
1531 ASSERT(prev, ("not freeing root context"));
1533 SvREFCNT_dec(cxt->my_sv);
1536 ASSERT(cxt, ("context not void"));
1546 * Tells whether we're in the middle of a store operation.
1548 int is_storing(pTHX)
1552 return cxt->entry && (cxt->optype & ST_STORE);
1558 * Tells whether we're in the middle of a retrieve operation.
1560 int is_retrieving(pTHX)
1564 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1568 * last_op_in_netorder
1570 * Returns whether last operation was made using network order.
1572 * This is typically out-of-band information that might prove useful
1573 * to people wishing to convert native to network order data when used.
1575 int last_op_in_netorder(pTHX)
1579 return cxt->netorder;
1583 *** Hook lookup and calling routines.
1589 * A wrapper on gv_fetchmethod_autoload() which caches results.
1591 * Returns the routine reference as an SV*, or null if neither the package
1592 * nor its ancestors know about the method.
1594 static SV *pkg_fetchmeth(
1604 * The following code is the same as the one performed by UNIVERSAL::can
1608 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1609 if (gv && isGV(gv)) {
1610 sv = newRV((SV*) GvCV(gv));
1611 TRACEME(("%s->%s: 0x%"UVxf, HvNAME(pkg), method, PTR2UV(sv)));
1613 sv = newSVsv(&PL_sv_undef);
1614 TRACEME(("%s->%s: not found", HvNAME(pkg), method));
1618 * Cache the result, ignoring failure: if we can't store the value,
1619 * it just won't be cached.
1622 (void) hv_store(cache, HvNAME(pkg), strlen(HvNAME(pkg)), sv, 0);
1624 return SvOK(sv) ? sv : (SV *) 0;
1630 * Force cached value to be undef: hook ignored even if present.
1632 static void pkg_hide(
1638 (void) hv_store(cache,
1639 HvNAME(pkg), strlen(HvNAME(pkg)), newSVsv(&PL_sv_undef), 0);
1645 * Discard cached value: a whole fetch loop will be retried at next lookup.
1647 static void pkg_uncache(
1653 (void) hv_delete(cache, HvNAME(pkg), strlen(HvNAME(pkg)), G_DISCARD);
1659 * Our own "UNIVERSAL::can", which caches results.
1661 * Returns the routine reference as an SV*, or null if the object does not
1662 * know about the method.
1673 TRACEME(("pkg_can for %s->%s", HvNAME(pkg), method));
1676 * Look into the cache to see whether we already have determined
1677 * where the routine was, if any.
1679 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1680 * that only one hook (i.e. always the same) is cached in a given cache.
1683 svh = hv_fetch(cache, HvNAME(pkg), strlen(HvNAME(pkg)), FALSE);
1687 TRACEME(("cached %s->%s: not found", HvNAME(pkg), method));
1690 TRACEME(("cached %s->%s: 0x%"UVxf,
1691 HvNAME(pkg), method, PTR2UV(sv)));
1696 TRACEME(("not cached yet"));
1697 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1703 * Call routine as obj->hook(av) in scalar context.
1704 * Propagates the single returned value if not called in void context.
1706 static SV *scalar_call(
1718 TRACEME(("scalar_call (cloning=%d)", cloning));
1725 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1727 SV **ary = AvARRAY(av);
1728 int cnt = AvFILLp(av) + 1;
1730 XPUSHs(ary[0]); /* Frozen string */
1731 for (i = 1; i < cnt; i++) {
1732 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1733 i, PTR2UV(ary[i])));
1734 XPUSHs(sv_2mortal(newRV(ary[i])));
1739 TRACEME(("calling..."));
1740 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1741 TRACEME(("count = %d", count));
1747 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1760 * Call routine obj->hook(cloning) in list context.
1761 * Returns the list of returned values in an array.
1763 static AV *array_call(
1774 TRACEME(("array_call (cloning=%d)", cloning));
1780 XPUSHs(obj); /* Target object */
1781 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1784 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1789 for (i = count - 1; i >= 0; i--) {
1791 av_store(av, i, SvREFCNT_inc(sv));
1804 * Lookup the class name in the `hclass' table and either assign it a new ID
1805 * or return the existing one, by filling in `classnum'.
1807 * Return true if the class was known, false if the ID was just generated.
1809 static int known_class(
1812 char *name, /* Class name */
1813 int len, /* Name length */
1817 HV *hclass = cxt->hclass;
1819 TRACEME(("known_class (%s)", name));
1822 * Recall that we don't store pointers in this hash table, but tags.
1823 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1826 svh = hv_fetch(hclass, name, len, FALSE);
1828 *classnum = LOW_32BITS(*svh);
1833 * Unknown classname, we need to record it.
1837 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1838 CROAK(("Unable to record new classname"));
1840 *classnum = cxt->classnum;
1845 *** Sepcific store routines.
1851 * Store a reference.
1852 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1854 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1856 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1859 * Follow reference, and check if target is overloaded.
1865 HV *stash = (HV *) SvSTASH(sv);
1866 if (stash && Gv_AMG(stash)) {
1867 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1868 PUTMARK(SX_OVERLOAD);
1874 return store(aTHX_ cxt, sv);
1882 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1883 * The <data> section is omitted if <length> is 0.
1885 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1886 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1888 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
1893 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1895 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1898 * For efficiency, break the SV encapsulation by peaking at the flags
1899 * directly without using the Perl macros to avoid dereferencing
1900 * sv->sv_flags each time we wish to check the flags.
1903 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1904 if (sv == &PL_sv_undef) {
1905 TRACEME(("immortal undef"));
1906 PUTMARK(SX_SV_UNDEF);
1908 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
1915 * Always store the string representation of a scalar if it exists.
1916 * Gisle Aas provided me with this test case, better than a long speach:
1918 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1919 * SV = PVNV(0x80c8520)
1921 * FLAGS = (NOK,POK,pNOK,pPOK)
1924 * PV = 0x80c83d0 "abc"\0
1928 * Write SX_SCALAR, length, followed by the actual data.
1930 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
1931 * appropriate, followed by the actual (binary) data. A double
1932 * is written as a string if network order, for portability.
1934 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
1935 * The reason is that when the scalar value is tainted, the SvNOK(sv)
1938 * The test for a read-only scalar with both POK and NOK set is meant
1939 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
1940 * address comparison for each scalar we store.
1943 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
1945 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
1946 if (sv == &PL_sv_yes) {
1947 TRACEME(("immortal yes"));
1949 } else if (sv == &PL_sv_no) {
1950 TRACEME(("immortal no"));
1953 pv = SvPV(sv, len); /* We know it's SvPOK */
1954 goto string; /* Share code below */
1956 } else if (flags & SVf_POK) {
1957 /* public string - go direct to string read. */
1958 goto string_readlen;
1960 #if (PATCHLEVEL <= 6)
1961 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
1962 direct if NV flag is off. */
1963 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
1965 /* 5.7 rules are that if IV public flag is set, IV value is as
1966 good, if not better, than NV value. */
1972 * Will come here from below with iv set if double is an integer.
1976 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1978 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
1979 * (for example) and that ends up in the optimised small integer
1982 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
1983 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
1984 goto string_readlen;
1988 * Optimize small integers into a single byte, otherwise store as
1989 * a real integer (converted into network order if they asked).
1992 if (iv >= -128 && iv <= 127) {
1993 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
1996 TRACEME(("small integer stored as %d", siv));
1997 } else if (cxt->netorder) {
1999 TRACEME(("no htonl, fall back to string for integer"));
2000 goto string_readlen;
2008 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2009 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
2011 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
2012 /* Bigger than 32 bits. */
2013 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2014 goto string_readlen;
2018 niv = (I32) htonl((I32) iv);
2019 TRACEME(("using network order"));
2024 PUTMARK(SX_INTEGER);
2025 WRITE(&iv, sizeof(iv));
2028 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2029 } else if (flags & SVf_NOK) {
2031 #if (PATCHLEVEL <= 6)
2034 * Watch for number being an integer in disguise.
2036 if (nv == (NV) (iv = I_V(nv))) {
2037 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2038 goto integer; /* Share code above */
2043 if (SvIOK_notUV(sv)) {
2045 goto integer; /* Share code above */
2050 if (cxt->netorder) {
2051 TRACEME(("double %"NVff" stored as string", nv));
2052 goto string_readlen; /* Share code below */
2056 WRITE(&nv, sizeof(nv));
2058 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2060 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2061 I32 wlen; /* For 64-bit machines */
2067 * Will come here from above if it was readonly, POK and NOK but
2068 * neither &PL_sv_yes nor &PL_sv_no.
2072 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2074 STORE_UTF8STR(pv, wlen);
2076 STORE_SCALAR(pv, wlen);
2077 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2078 PTR2UV(sv), SvPVX(sv), (IV)len));
2080 CROAK(("Can't determine type of %s(0x%"UVxf")",
2081 sv_reftype(sv, FALSE),
2083 return 0; /* Ok, no recursion on scalars */
2091 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2092 * Each item is stored as <object>.
2094 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2097 I32 len = av_len(av) + 1;
2101 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2104 * Signal array by emitting SX_ARRAY, followed by the array length.
2109 TRACEME(("size = %d", len));
2112 * Now store each item recursively.
2115 for (i = 0; i < len; i++) {
2116 sav = av_fetch(av, i, 0);
2118 TRACEME(("(#%d) undef item", i));
2122 TRACEME(("(#%d) item", i));
2123 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2127 TRACEME(("ok (array)"));
2133 #if (PATCHLEVEL <= 6)
2139 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2142 sortcmp(const void *a, const void *b)
2144 #if defined(USE_ITHREADS)
2146 #endif /* USE_ITHREADS */
2147 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2150 #endif /* PATCHLEVEL <= 6 */
2155 * Store a hash table.
2157 * For a "normal" hash (not restricted, no utf8 keys):
2159 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2160 * Values are stored as <object>.
2161 * Keys are stored as <length> <data>, the <data> section being omitted
2164 * For a "fancy" hash (restricted or utf8 keys):
2166 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2168 * Values are stored as <object>.
2169 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2171 * Currently the only hash flag is "restriced"
2172 * Key flags are as for hv.h
2174 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2177 #ifdef HAS_RESTRICTED_HASHES
2186 int flagged_hash = ((SvREADONLY(hv)
2187 #ifdef HAS_HASH_KEY_FLAGS
2191 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2194 /* needs int cast for C++ compilers, doesn't it? */
2195 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2198 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2202 * Signal hash by emitting SX_HASH, followed by the table length.
2206 PUTMARK(SX_FLAG_HASH);
2207 PUTMARK(hash_flags);
2212 TRACEME(("size = %d", len));
2215 * Save possible iteration state via each() on that table.
2218 riter = HvRITER(hv);
2219 eiter = HvEITER(hv);
2223 * Now store each item recursively.
2225 * If canonical is defined to some true value then store each
2226 * key/value pair in sorted order otherwise the order is random.
2227 * Canonical order is irrelevant when a deep clone operation is performed.
2229 * Fetch the value from perl only once per store() operation, and only
2234 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2235 (cxt->canonical < 0 && (cxt->canonical =
2236 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2239 * Storing in order, sorted by key.
2240 * Run through the hash, building up an array of keys in a
2241 * mortal array, sort the array and then run through the
2247 /*av_extend (av, len);*/
2249 TRACEME(("using canonical order"));
2251 for (i = 0; i < len; i++) {
2252 #ifdef HAS_RESTRICTED_HASHES
2253 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2255 HE *he = hv_iternext(hv);
2257 SV *key = hv_iterkeysv(he);
2258 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2263 for (i = 0; i < len; i++) {
2264 #ifdef HAS_RESTRICTED_HASHES
2265 int placeholders = HvPLACEHOLDERS(hv);
2267 unsigned char flags = 0;
2271 SV *key = av_shift(av);
2272 /* This will fail if key is a placeholder.
2273 Track how many placeholders we have, and error if we
2275 HE *he = hv_fetch_ent(hv, key, 0, 0);
2279 if (!(val = HeVAL(he))) {
2280 /* Internal error, not I/O error */
2284 #ifdef HAS_RESTRICTED_HASHES
2285 /* Should be a placeholder. */
2286 if (placeholders-- < 0) {
2287 /* This should not happen - number of
2288 retrieves should be identical to
2289 number of placeholders. */
2292 /* Value is never needed, and PL_sv_undef is
2293 more space efficient to store. */
2296 ("Flags not 0 but %d", flags));
2297 flags = SHV_K_PLACEHOLDER;
2304 * Store value first.
2307 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2309 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2314 * Keys are written after values to make sure retrieval
2315 * can be optimal in terms of memory usage, where keys are
2316 * read into a fixed unique buffer called kbuf.
2317 * See retrieve_hash() for details.
2320 /* Implementation of restricted hashes isn't nicely
2322 if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
2323 flags |= SHV_K_LOCKED;
2326 keyval = SvPV(key, keylen_tmp);
2327 keylen = keylen_tmp;
2328 #ifdef HAS_UTF8_HASHES
2329 /* If you build without optimisation on pre 5.6
2330 then nothing spots that SvUTF8(key) is always 0,
2331 so the block isn't optimised away, at which point
2332 the linker dislikes the reference to
2335 const char *keysave = keyval;
2336 bool is_utf8 = TRUE;
2338 /* Just casting the &klen to (STRLEN) won't work
2339 well if STRLEN and I32 are of different widths.
2341 keyval = (char*)bytes_from_utf8((U8*)keyval,
2345 /* If we were able to downgrade here, then than
2346 means that we have a key which only had chars
2347 0-255, but was utf8 encoded. */
2349 if (keyval != keysave) {
2350 keylen = keylen_tmp;
2351 flags |= SHV_K_WASUTF8;
2353 /* keylen_tmp can't have changed, so no need
2354 to assign back to keylen. */
2355 flags |= SHV_K_UTF8;
2362 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2364 /* This is a workaround for a bug in 5.8.0
2365 that causes the HEK_WASUTF8 flag to be
2366 set on an HEK without the hash being
2367 marked as having key flags. We just
2368 cross our fingers and drop the flag.
2370 assert (flags == 0 || flags == SHV_K_WASUTF8);
2371 TRACEME(("(#%d) key '%s'", i, keyval));
2375 WRITE(keyval, keylen);
2376 if (flags & SHV_K_WASUTF8)
2381 * Free up the temporary array
2390 * Storing in "random" order (in the order the keys are stored
2391 * within the hash). This is the default and will be faster!
2394 for (i = 0; i < len; i++) {
2397 unsigned char flags;
2398 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2399 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2401 HE *he = hv_iternext(hv);
2403 SV *val = (he ? hv_iterval(hv, he) : 0);
2408 return 1; /* Internal error, not I/O error */
2410 /* Implementation of restricted hashes isn't nicely
2413 = (((hash_flags & SHV_RESTRICTED)
2415 ? SHV_K_LOCKED : 0);
2417 if (val == &PL_sv_placeholder) {
2418 flags |= SHV_K_PLACEHOLDER;
2423 * Store value first.
2426 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2428 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2432 hek = HeKEY_hek(he);
2434 if (len == HEf_SVKEY) {
2435 /* This is somewhat sick, but the internal APIs are
2436 * such that XS code could put one of these in in
2438 * Maybe we should be capable of storing one if
2441 key_sv = HeKEY_sv(he);
2442 flags |= SHV_K_ISSV;
2444 /* Regular string key. */
2445 #ifdef HAS_HASH_KEY_FLAGS
2447 flags |= SHV_K_UTF8;
2448 if (HEK_WASUTF8(hek))
2449 flags |= SHV_K_WASUTF8;
2455 * Keys are written after values to make sure retrieval
2456 * can be optimal in terms of memory usage, where keys are
2457 * read into a fixed unique buffer called kbuf.
2458 * See retrieve_hash() for details.
2463 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2465 /* This is a workaround for a bug in 5.8.0
2466 that causes the HEK_WASUTF8 flag to be
2467 set on an HEK without the hash being
2468 marked as having key flags. We just
2469 cross our fingers and drop the flag.
2471 assert (flags == 0 || flags == SHV_K_WASUTF8);
2472 TRACEME(("(#%d) key '%s'", i, key));
2474 if (flags & SHV_K_ISSV) {
2475 store(aTHX_ cxt, key_sv);
2484 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2487 HvRITER(hv) = riter; /* Restore hash iterator state */
2488 HvEITER(hv) = eiter;
2496 * Store a code reference.
2498 * Layout is SX_CODE <length> followed by a scalar containing the perl
2499 * source code of the code reference.
2501 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2503 #if PERL_VERSION < 6
2505 * retrieve_code does not work with perl 5.005 or less
2507 return store_other(aTHX_ cxt, (SV*)cv);
2512 SV *text, *bdeparse;
2514 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2517 cxt->deparse == 0 ||
2518 (cxt->deparse < 0 && !(cxt->deparse =
2519 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2521 return store_other(aTHX_ cxt, (SV*)cv);
2525 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2526 * blessed code references.
2528 /* Ownership of both SVs is passed to load_module, which frees them. */
2529 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2535 * create the B::Deparse object
2539 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2541 count = call_method("new", G_SCALAR);
2544 CROAK(("Unexpected return value from B::Deparse::new\n"));
2548 * call the coderef2text method
2552 XPUSHs(bdeparse); /* XXX is this already mortal? */
2553 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2555 count = call_method("coderef2text", G_SCALAR);
2558 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2562 reallen = strlen(SvPV_nolen(text));
2565 * Empty code references or XS functions are deparsed as
2566 * "(prototype) ;" or ";".
2569 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2570 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2574 * Signal code by emitting SX_CODE.
2578 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2579 TRACEME(("size = %d", len));
2580 TRACEME(("code = %s", SvPV_nolen(text)));
2583 * Now store the source code.
2586 STORE_SCALAR(SvPV_nolen(text), len);
2591 TRACEME(("ok (code)"));
2600 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2601 * a special mark, followed by the underlying tied object. For instance, when
2602 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2603 * <hash object> stands for the serialization of the tied hash.
2605 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2610 int svt = SvTYPE(sv);
2613 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2616 * We have a small run-time penalty here because we chose to factorise
2617 * all tieds objects into the same routine, and not have a store_tied_hash,
2618 * a store_tied_array, etc...
2620 * Don't use a switch() statement, as most compilers don't optimize that
2621 * well for 2/3 values. An if() else if() cascade is just fine. We put
2622 * tied hashes first, as they are the most likely beasts.
2625 if (svt == SVt_PVHV) {
2626 TRACEME(("tied hash"));
2627 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2628 } else if (svt == SVt_PVAV) {
2629 TRACEME(("tied array"));
2630 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2632 TRACEME(("tied scalar"));
2633 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2637 if (!(mg = mg_find(sv, mtype)))
2638 CROAK(("No magic '%c' found while storing tied %s", mtype,
2639 (svt == SVt_PVHV) ? "hash" :
2640 (svt == SVt_PVAV) ? "array" : "scalar"));
2643 * The mg->mg_obj found by mg_find() above actually points to the
2644 * underlying tied Perl object implementation. For instance, if the
2645 * original SV was that of a tied array, then mg->mg_obj is an AV.
2647 * Note that we store the Perl object as-is. We don't call its FETCH
2648 * method along the way. At retrieval time, we won't call its STORE
2649 * method either, but the tieing magic will be re-installed. In itself,
2650 * that ensures that the tieing semantics are preserved since futher
2651 * accesses on the retrieved object will indeed call the magic methods...
2654 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2655 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2656 if ((ret = store(aTHX_ cxt, obj)))
2659 TRACEME(("ok (tied)"));
2667 * Stores a reference to an item within a tied structure:
2669 * . \$h{key}, stores both the (tied %h) object and 'key'.
2670 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2672 * Layout is therefore either:
2673 * SX_TIED_KEY <object> <key>
2674 * SX_TIED_IDX <object> <index>
2676 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2681 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2683 if (!(mg = mg_find(sv, 'p')))
2684 CROAK(("No magic 'p' found while storing reference to tied item"));
2687 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2691 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2692 PUTMARK(SX_TIED_KEY);
2693 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2695 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2698 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2700 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2703 I32 idx = mg->mg_len;
2705 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2706 PUTMARK(SX_TIED_IDX);
2707 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2709 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2712 TRACEME(("store_tied_item: storing IDX %d", idx));
2717 TRACEME(("ok (tied item)"));
2723 * store_hook -- dispatched manually, not via sv_store[]
2725 * The blessed SV is serialized by a hook.
2729 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2731 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2732 * the trailing part [] is present, the type of object (scalar, array or hash).
2733 * There is also a bit which says how the classname is stored between:
2738 * and when the <index> form is used (classname already seen), the "large
2739 * classname" bit in <flags> indicates how large the <index> is.
2741 * The serialized string returned by the hook is of length <len2> and comes
2742 * next. It is an opaque string for us.
2744 * Those <len3> object IDs which are listed last represent the extra references
2745 * not directly serialized by the hook, but which are linked to the object.
2747 * When recursion is mandated to resolve object-IDs not yet seen, we have
2748 * instead, with <header> being flags with bits set to indicate the object type
2749 * and that recursion was indeed needed:
2751 * SX_HOOK <header> <object> <header> <object> <flags>
2753 * that same header being repeated between serialized objects obtained through
2754 * recursion, until we reach flags indicating no recursion, at which point
2755 * we know we've resynchronized with a single layout, after <flags>.
2757 * When storing a blessed ref to a tied variable, the following format is
2760 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2762 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2763 * real object type is held in the <extra> flag. At the very end of the
2764 * serialization stream, the underlying magic object is serialized, just like
2765 * any other tied variable.
2767 static int store_hook(
2781 int count; /* really len3 + 1 */
2782 unsigned char flags;
2785 int recursed = 0; /* counts recursion */
2786 int obj_type; /* object type, on 2 bits */
2789 int clone = cxt->optype & ST_CLONE;
2790 char mtype = '\0'; /* for blessed ref to tied structures */
2791 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2793 TRACEME(("store_hook, classname \"%s\", tagged #%d", HvNAME(pkg), cxt->tagnum));
2796 * Determine object type on 2 bits.
2801 obj_type = SHT_SCALAR;
2804 obj_type = SHT_ARRAY;
2807 obj_type = SHT_HASH;
2811 * Produced by a blessed ref to a tied data structure, $o in the
2812 * following Perl code.
2816 * my $o = bless \%h, 'BAR';
2818 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2819 * (since we have only 2 bits in <flags> to store the type), and an
2820 * <extra> byte flag will be emitted after the FIRST <flags> in the
2821 * stream, carrying what we put in `eflags'.
2823 obj_type = SHT_EXTRA;
2824 switch (SvTYPE(sv)) {
2826 eflags = (unsigned char) SHT_THASH;
2830 eflags = (unsigned char) SHT_TARRAY;
2834 eflags = (unsigned char) SHT_TSCALAR;
2840 CROAK(("Unexpected object type (%d) in store_hook()", type));
2842 flags = SHF_NEED_RECURSE | obj_type;
2844 classname = HvNAME(pkg);
2845 len = strlen(classname);
2848 * To call the hook, we need to fake a call like:
2850 * $object->STORABLE_freeze($cloning);
2852 * but we don't have the $object here. For instance, if $object is
2853 * a blessed array, what we have in `sv' is the array, and we can't
2854 * call a method on those.
2856 * Therefore, we need to create a temporary reference to the object and
2857 * make the call on that reference.
2860 TRACEME(("about to call STORABLE_freeze on class %s", classname));
2862 ref = newRV_noinc(sv); /* Temporary reference */
2863 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2864 SvRV_set(ref, NULL);
2865 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2867 count = AvFILLp(av) + 1;
2868 TRACEME(("store_hook, array holds %d items", count));
2871 * If they return an empty list, it means they wish to ignore the
2872 * hook for this class (and not just this instance -- that's for them
2873 * to handle if they so wish).
2875 * Simply disable the cached entry for the hook (it won't be recomputed
2876 * since it's present in the cache) and recurse to store_blessed().
2881 * They must not change their mind in the middle of a serialization.
2884 if (hv_fetch(cxt->hclass, classname, len, FALSE))
2885 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2886 (cxt->optype & ST_CLONE) ? "cloning" : "storing", classname));
2888 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
2890 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2891 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", classname));
2893 return store_blessed(aTHX_ cxt, sv, type, pkg);
2897 * Get frozen string.
2901 pv = SvPV(ary[0], len2);
2904 * If they returned more than one item, we need to serialize some
2905 * extra references if not already done.
2907 * Loop over the array, starting at position #1, and for each item,
2908 * ensure it is a reference, serialize it if not already done, and
2909 * replace the entry with the tag ID of the corresponding serialized
2912 * We CHEAT by not calling av_fetch() and read directly within the
2916 for (i = 1; i < count; i++) {
2920 AV *av_hook = cxt->hook_seen;
2923 CROAK(("Item #%d returned by STORABLE_freeze "
2924 "for %s is not a reference", i, classname));
2925 xsv = SvRV(rsv); /* Follow ref to know what to look for */
2928 * Look in hseen and see if we have a tag already.
2929 * Serialize entry if not done already, and get its tag.
2932 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
2933 goto sv_seen; /* Avoid moving code too far to the right */
2935 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
2938 * We need to recurse to store that object and get it to be known
2939 * so that we can resolve the list of object-IDs at retrieve time.
2941 * The first time we do this, we need to emit the proper header
2942 * indicating that we recursed, and what the type of object is (the
2943 * object we're storing via a user-hook). Indeed, during retrieval,
2944 * we'll have to create the object before recursing to retrieve the
2945 * others, in case those would point back at that object.
2948 /* [SX_HOOK] <flags> [<extra>] <object>*/
2952 if (obj_type == SHT_EXTRA)
2957 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
2960 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
2962 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
2965 * It was the first time we serialized `xsv'.
2967 * Keep this SV alive until the end of the serialization: if we
2968 * disposed of it right now by decrementing its refcount, and it was
2969 * a temporary value, some next temporary value allocated during
2970 * another STORABLE_freeze might take its place, and we'd wrongly
2971 * assume that new SV was already serialized, based on its presence
2974 * Therefore, push it away in cxt->hook_seen.
2977 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
2981 * Dispose of the REF they returned. If we saved the `xsv' away
2982 * in the array of returned SVs, that will not cause the underlying
2983 * referenced SV to be reclaimed.
2986 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
2987 SvREFCNT_dec(rsv); /* Dispose of reference */
2990 * Replace entry with its tag (not a real SV, so no refcnt increment)
2994 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
2995 i-1, PTR2UV(xsv), PTR2UV(*svh)));
2999 * Allocate a class ID if not already done.
3001 * This needs to be done after the recursion above, since at retrieval
3002 * time, we'll see the inner objects first. Many thanks to
3003 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
3004 * proposed the right fix. -- RAM, 15/09/2000
3007 if (!known_class(aTHX_ cxt, classname, len, &classnum)) {
3008 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3009 classnum = -1; /* Mark: we must store classname */
3011 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3015 * Compute leading flags.
3019 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3020 flags |= SHF_LARGE_CLASSLEN;
3022 flags |= SHF_IDX_CLASSNAME;
3023 if (len2 > LG_SCALAR)
3024 flags |= SHF_LARGE_STRLEN;
3026 flags |= SHF_HAS_LIST;
3027 if (count > (LG_SCALAR + 1))
3028 flags |= SHF_LARGE_LISTLEN;
3031 * We're ready to emit either serialized form:
3033 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3034 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3036 * If we recursed, the SX_HOOK has already been emitted.
3039 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3040 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3041 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3043 /* SX_HOOK <flags> [<extra>] */
3047 if (obj_type == SHT_EXTRA)
3052 /* <len> <classname> or <index> */
3053 if (flags & SHF_IDX_CLASSNAME) {
3054 if (flags & SHF_LARGE_CLASSLEN)
3057 unsigned char cnum = (unsigned char) classnum;
3061 if (flags & SHF_LARGE_CLASSLEN)
3064 unsigned char clen = (unsigned char) len;
3067 WRITE(classname, len); /* Final \0 is omitted */
3070 /* <len2> <frozen-str> */
3071 if (flags & SHF_LARGE_STRLEN) {
3072 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3073 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3075 unsigned char clen = (unsigned char) len2;
3079 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3081 /* [<len3> <object-IDs>] */
3082 if (flags & SHF_HAS_LIST) {
3083 int len3 = count - 1;
3084 if (flags & SHF_LARGE_LISTLEN)
3087 unsigned char clen = (unsigned char) len3;
3092 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3093 * real pointer, rather a tag number, well under the 32-bit limit.
3096 for (i = 1; i < count; i++) {
3097 I32 tagval = htonl(LOW_32BITS(ary[i]));
3099 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3104 * Free the array. We need extra care for indices after 0, since they
3105 * don't hold real SVs but integers cast.
3109 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3114 * If object was tied, need to insert serialization of the magic object.
3117 if (obj_type == SHT_EXTRA) {
3120 if (!(mg = mg_find(sv, mtype))) {
3121 int svt = SvTYPE(sv);
3122 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3123 mtype, (svt == SVt_PVHV) ? "hash" :
3124 (svt == SVt_PVAV) ? "array" : "scalar"));
3127 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3128 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3134 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3142 * store_blessed -- dispatched manually, not via sv_store[]
3144 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3145 * of its ancestors. If there is, then redispatch to store_hook();
3147 * Otherwise, the blessed SV is stored using the following layout:
3149 * SX_BLESS <flag> <len> <classname> <object>
3151 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3152 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3153 * Otherwise, the low order bits give the length, thereby giving a compact
3154 * representation for class names less than 127 chars long.
3156 * Each <classname> seen is remembered and indexed, so that the next time
3157 * an object in the blessed in the same <classname> is stored, the following
3160 * SX_IX_BLESS <flag> <index> <object>
3162 * where <index> is the classname index, stored on 0 or 4 bytes depending
3163 * on the high-order bit in flag (same encoding as above for <len>).
3165 static int store_blessed(
3177 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME(pkg)));
3180 * Look for a hook for this blessed SV and redirect to store_hook()
3184 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3186 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3189 * This is a blessed SV without any serialization hook.
3192 classname = HvNAME(pkg);
3193 len = strlen(classname);
3195 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3196 PTR2UV(sv), class, cxt->tagnum));
3199 * Determine whether it is the first time we see that class name (in which
3200 * case it will be stored in the SX_BLESS form), or whether we already
3201 * saw that class name before (in which case the SX_IX_BLESS form will be
3205 if (known_class(aTHX_ cxt, classname, len, &classnum)) {
3206 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3207 PUTMARK(SX_IX_BLESS);
3208 if (classnum <= LG_BLESS) {
3209 unsigned char cnum = (unsigned char) classnum;
3212 unsigned char flag = (unsigned char) 0x80;
3217 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3219 if (len <= LG_BLESS) {
3220 unsigned char clen = (unsigned char) len;
3223 unsigned char flag = (unsigned char) 0x80;
3225 WLEN(len); /* Don't BER-encode, this should be rare */
3227 WRITE(classname, len); /* Final \0 is omitted */
3231 * Now emit the <object> part.
3234 return SV_STORE(type)(aTHX_ cxt, sv);
3240 * We don't know how to store the item we reached, so return an error condition.
3241 * (it's probably a GLOB, some CODE reference, etc...)
3243 * If they defined the `forgive_me' variable at the Perl level to some
3244 * true value, then don't croak, just warn, and store a placeholder string
3247 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3250 static char buf[80];
3252 TRACEME(("store_other"));
3255 * Fetch the value from perl only once per store() operation.
3259 cxt->forgive_me == 0 ||
3260 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3261 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3263 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3265 warn("Can't store item %s(0x%"UVxf")",
3266 sv_reftype(sv, FALSE), PTR2UV(sv));
3269 * Store placeholder string as a scalar instead...
3272 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3273 PTR2UV(sv), (char) 0);
3276 STORE_SCALAR(buf, len);
3277 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3283 *** Store driving routines
3289 * WARNING: partially duplicates Perl's sv_reftype for speed.
3291 * Returns the type of the SV, identified by an integer. That integer
3292 * may then be used to index the dynamic routine dispatch table.
3294 static int sv_type(pTHX_ SV *sv)
3296 switch (SvTYPE(sv)) {
3301 * No need to check for ROK, that can't be set here since there
3302 * is no field capable of hodling the xrv_rv reference.
3310 * Starting from SVt_PV, it is possible to have the ROK flag
3311 * set, the pointer to the other SV being either stored in
3312 * the xrv_rv (in the case of a pure SVt_RV), or as the
3313 * xpv_pv field of an SVt_PV and its heirs.
3315 * However, those SV cannot be magical or they would be an
3316 * SVt_PVMG at least.
3318 return SvROK(sv) ? svis_REF : svis_SCALAR;
3320 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3321 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3322 return svis_TIED_ITEM;
3325 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3327 return SvROK(sv) ? svis_REF : svis_SCALAR;
3329 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3333 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3348 * Recursively store objects pointed to by the sv to the specified file.
3350 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3351 * object (one for which storage has started -- it may not be over if we have
3352 * a self-referenced structure). This data set forms a stored <object>.
3354 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3359 HV *hseen = cxt->hseen;
3361 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3364 * If object has already been stored, do not duplicate data.
3365 * Simply emit the SX_OBJECT marker followed by its tag data.
3366 * The tag is always written in network order.
3368 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3369 * real pointer, rather a tag number (watch the insertion code below).
3370 * That means it probably safe to assume it is well under the 32-bit limit,
3371 * and makes the truncation safe.
3372 * -- RAM, 14/09/1999
3375 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3379 if (sv == &PL_sv_undef) {
3380 /* We have seen PL_sv_undef before, but fake it as
3383 Not the simplest solution to making restricted
3384 hashes work on 5.8.0, but it does mean that
3385 repeated references to the one true undef will
3386 take up less space in the output file.
3388 /* Need to jump past the next hv_store, because on the
3389 second store of undef the old hash value will be
3390 SvREFCNT_dec()ed, and as Storable cheats horribly
3391 by storing non-SVs in the hash a SEGV will ensure.
3392 Need to increase the tag number so that the
3393 receiver has no idea what games we're up to. This
3394 special casing doesn't affect hooks that store
3395 undef, as the hook routine does its own lookup into
3396 hseen. Also this means that any references back
3397 to PL_sv_undef (from the pathological case of hooks
3398 storing references to it) will find the seen hash
3399 entry for the first time, as if we didn't have this
3400 hackery here. (That hseen lookup works even on 5.8.0
3401 because it's a key of &PL_sv_undef and a value
3402 which is a tag number, not a value which is
3406 goto undef_special_case;
3409 tagval = htonl(LOW_32BITS(*svh));
3411 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3419 * Allocate a new tag and associate it with the address of the sv being
3420 * stored, before recursing...
3422 * In order to avoid creating new SvIVs to hold the tagnum we just
3423 * cast the tagnum to an SV pointer and store that in the hash. This
3424 * means that we must clean up the hash manually afterwards, but gives
3425 * us a 15% throughput increase.
3430 if (!hv_store(hseen,
3431 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3435 * Store `sv' and everything beneath it, using appropriate routine.
3436 * Abort immediately if we get a non-zero status back.
3439 type = sv_type(aTHX_ sv);
3442 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3443 PTR2UV(sv), cxt->tagnum, type));
3446 HV *pkg = SvSTASH(sv);
3447 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3449 ret = SV_STORE(type)(aTHX_ cxt, sv);
3451 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3452 ret ? "FAILED" : "ok", PTR2UV(sv),
3453 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3461 * Write magic number and system information into the file.
3462 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3463 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3464 * All size and lenghts are written as single characters here.
3466 * Note that no byte ordering info is emitted when <network> is true, since
3467 * integers will be emitted in network order in that case.
3469 static int magic_write(pTHX_ stcxt_t *cxt)
3472 * Starting with 0.6, the "use_network_order" byte flag is also used to
3473 * indicate the version number of the binary image, encoded in the upper
3474 * bits. The bit 0 is always used to indicate network order.
3477 * Starting with 0.7, a full byte is dedicated to the minor version of
3478 * the binary format, which is incremented only when new markers are
3479 * introduced, for instance, but when backward compatibility is preserved.
3482 /* Make these at compile time. The WRITE() macro is sufficiently complex
3483 that it saves about 200 bytes doing it this way and only using it
3485 static const unsigned char network_file_header[] = {
3487 (STORABLE_BIN_MAJOR << 1) | 1,
3488 STORABLE_BIN_WRITE_MINOR
3490 static const unsigned char file_header[] = {
3492 (STORABLE_BIN_MAJOR << 1) | 0,
3493 STORABLE_BIN_WRITE_MINOR,
3494 /* sizeof the array includes the 0 byte at the end: */
3495 (char) sizeof (byteorderstr) - 1,
3497 (unsigned char) sizeof(int),
3498 (unsigned char) sizeof(long),
3499 (unsigned char) sizeof(char *),
3500 (unsigned char) sizeof(NV)
3502 #ifdef USE_56_INTERWORK_KLUDGE
3503 static const unsigned char file_header_56[] = {
3505 (STORABLE_BIN_MAJOR << 1) | 0,
3506 STORABLE_BIN_WRITE_MINOR,
3507 /* sizeof the array includes the 0 byte at the end: */
3508 (char) sizeof (byteorderstr_56) - 1,
3510 (unsigned char) sizeof(int),
3511 (unsigned char) sizeof(long),
3512 (unsigned char) sizeof(char *),
3513 (unsigned char) sizeof(NV)
3516 const unsigned char *header;
3519 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3521 if (cxt->netorder) {
3522 header = network_file_header;
3523 length = sizeof (network_file_header);
3525 #ifdef USE_56_INTERWORK_KLUDGE
3526 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3527 header = file_header_56;
3528 length = sizeof (file_header_56);
3532 header = file_header;
3533 length = sizeof (file_header);
3538 /* sizeof the array includes the 0 byte at the end. */
3539 header += sizeof (magicstr) - 1;
3540 length -= sizeof (magicstr) - 1;
3543 WRITE( (unsigned char*) header, length);
3545 if (!cxt->netorder) {
3546 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3547 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3548 (int) sizeof(int), (int) sizeof(long),
3549 (int) sizeof(char *), (int) sizeof(NV)));
3557 * Common code for store operations.
3559 * When memory store is requested (f = NULL) and a non null SV* is given in
3560 * `res', it is filled with a new SV created out of the memory buffer.
3562 * It is required to provide a non-null `res' when the operation type is not
3563 * dclone() and store() is performed to memory.
3565 static int do_store(
3576 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3577 ("must supply result SV pointer for real recursion to memory"));
3579 TRACEME(("do_store (optype=%d, netorder=%d)",
3580 optype, network_order));
3585 * Workaround for CROAK leak: if they enter with a "dirty" context,
3586 * free up memory for them now.
3590 clean_context(aTHX_ cxt);
3593 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3594 * re-enter store() via the hooks. We need to stack contexts.
3598 cxt = allocate_context(aTHX_ cxt);
3602 ASSERT(cxt->entry == 1, ("starting new recursion"));
3603 ASSERT(!cxt->s_dirty, ("clean context"));
3606 * Ensure sv is actually a reference. From perl, we called something
3608 * pstore(aTHX_ FILE, \@array);
3609 * so we must get the scalar value behing that reference.
3613 CROAK(("Not a reference"));
3614 sv = SvRV(sv); /* So follow it to know what to store */
3617 * If we're going to store to memory, reset the buffer.
3624 * Prepare context and emit headers.
3627 init_store_context(aTHX_ cxt, f, optype, network_order);
3629 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3630 return 0; /* Error */
3633 * Recursively store object...
3636 ASSERT(is_storing(), ("within store operation"));
3638 status = store(aTHX_ cxt, sv); /* Just do it! */
3641 * If they asked for a memory store and they provided an SV pointer,
3642 * make an SV string out of the buffer and fill their pointer.
3644 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3645 * an SV, since context cleanup might free the buffer if we did recurse.
3646 * (unless caller is dclone(), which is aware of that).
3649 if (!cxt->fio && res)
3650 *res = mbuf2sv(aTHX);
3655 * The "root" context is never freed, since it is meant to be always
3656 * handy for the common case where no recursion occurs at all (i.e.
3657 * we enter store() outside of any Storable code and leave it, period).
3658 * We know it's the "root" context because there's nothing stacked
3663 * When deep cloning, we don't free the context: doing so would force
3664 * us to copy the data in the memory buffer. Sicne we know we're
3665 * about to enter do_retrieve...
3668 clean_store_context(aTHX_ cxt);
3669 if (cxt->prev && !(cxt->optype & ST_CLONE))
3670 free_context(aTHX_ cxt);
3672 TRACEME(("do_store returns %d", status));
3680 * Store the transitive data closure of given object to disk.
3681 * Returns 0 on error, a true value otherwise.
3683 int pstore(pTHX_ PerlIO *f, SV *sv)
3685 TRACEME(("pstore"));
3686 return do_store(aTHX_ f, sv, 0, FALSE, (SV**) 0);
3693 * Same as pstore(), but network order is used for integers and doubles are
3694 * emitted as strings.
3696 int net_pstore(pTHX_ PerlIO *f, SV *sv)
3698 TRACEME(("net_pstore"));
3699 return do_store(aTHX_ f, sv, 0, TRUE, (SV**) 0);
3709 * Build a new SV out of the content of the internal memory buffer.
3711 static SV *mbuf2sv(pTHX)
3715 return newSVpv(mbase, MBUF_SIZE());
3721 * Store the transitive data closure of given object to memory.
3722 * Returns undef on error, a scalar value containing the data otherwise.
3724 SV *mstore(pTHX_ SV *sv)
3728 TRACEME(("mstore"));
3730 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, FALSE, &out))
3731 return &PL_sv_undef;
3739 * Same as mstore(), but network order is used for integers and doubles are
3740 * emitted as strings.
3742 SV *net_mstore(pTHX_ SV *sv)
3746 TRACEME(("net_mstore"));
3748 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, TRUE, &out))
3749 return &PL_sv_undef;
3755 *** Specific retrieve callbacks.
3761 * Return an error via croak, since it is not possible that we get here
3762 * under normal conditions, when facing a file produced via pstore().
3764 static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname)
3767 cxt->ver_major != STORABLE_BIN_MAJOR &&
3768 cxt->ver_minor != STORABLE_BIN_MINOR
3770 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3771 cxt->fio ? "file" : "string",
3772 cxt->ver_major, cxt->ver_minor,
3773 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3775 CROAK(("Corrupted storable %s (binary v%d.%d)",
3776 cxt->fio ? "file" : "string",
3777 cxt->ver_major, cxt->ver_minor));
3780 return (SV *) 0; /* Just in case */
3784 * retrieve_idx_blessed
3786 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3787 * <index> can be coded on either 1 or 5 bytes.
3789 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname)
3796 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3797 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3799 GETMARK(idx); /* Index coded on a single char? */
3804 * Fetch classname in `aclass'
3807 sva = av_fetch(cxt->aclass, idx, FALSE);
3809 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3811 classname = SvPVX(*sva); /* We know it's a PV, by construction */
3813 TRACEME(("class ID %d => %s", idx, classname));
3816 * Retrieve object and bless it.
3819 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3827 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3828 * <len> can be coded on either 1 or 5 bytes.
3830 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname)
3834 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3835 char *classname = buf;
3837 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3838 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3841 * Decode class name length and read that name.
3843 * Short classnames have two advantages: their length is stored on one
3844 * single byte, and the string can be read on the stack.
3847 GETMARK(len); /* Length coded on a single char? */
3850 TRACEME(("** allocating %d bytes for class name", len+1));
3851 New(10003, classname, len+1, char);
3853 READ(classname, len);
3854 classname[len] = '\0'; /* Mark string end */
3857 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3860 TRACEME(("new class name \"%s\" will bear ID = %d", classname, cxt->classnum));
3862 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len)))
3866 * Retrieve object and bless it.
3869 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3870 if (classname != buf)
3871 Safefree(classname);
3879 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3880 * with leading mark already read, as usual.
3882 * When recursion was involved during serialization of the object, there
3883 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
3884 * we reach a <flags> marker with the recursion bit cleared.
3886 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
3887 * is held in the <extra> byte, and if the object is tied, the serialized
3888 * magic object comes at the very end:
3890 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
3892 * This means the STORABLE_thaw hook will NOT get a tied variable during its
3893 * processing (since we won't have seen the magic object by the time the hook
3894 * is called). See comments below for why it was done that way.
3896 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname)
3899 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3900 char *classname = buf;
3910 int clone = cxt->optype & ST_CLONE;
3912 unsigned int extra_type = 0;
3914 TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
3915 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3918 * Read flags, which tell us about the type, and whether we need to recurse.
3924 * Create the (empty) object, and mark it as seen.
3926 * This must be done now, because tags are incremented, and during
3927 * serialization, the object tag was affected before recursion could
3931 obj_type = flags & SHF_TYPE_MASK;
3937 sv = (SV *) newAV();
3940 sv = (SV *) newHV();
3944 * Read <extra> flag to know the type of the object.
3945 * Record associated magic type for later.
3947 GETMARK(extra_type);
3948 switch (extra_type) {
3954 sv = (SV *) newAV();
3958 sv = (SV *) newHV();
3962 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
3966 return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
3968 SEEN(sv, 0, 0); /* Don't bless yet */
3971 * Whilst flags tell us to recurse, do so.
3973 * We don't need to remember the addresses returned by retrieval, because
3974 * all the references will be obtained through indirection via the object
3975 * tags in the object-ID list.
3977 * We need to decrement the reference count for these objects
3978 * because, if the user doesn't save a reference to them in the hook,
3979 * they must be freed when this context is cleaned.
3982 while (flags & SHF_NEED_RECURSE) {
3983 TRACEME(("retrieve_hook recursing..."));
3984 rv = retrieve(aTHX_ cxt, 0);
3988 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
3993 if (flags & SHF_IDX_CLASSNAME) {
3998 * Fetch index from `aclass'
4001 if (flags & SHF_LARGE_CLASSLEN)
4006 sva = av_fetch(cxt->aclass, idx, FALSE);
4008 CROAK(("Class name #%"IVdf" should have been seen already",
4011 classname = SvPVX(*sva); /* We know it's a PV, by construction */
4012 TRACEME(("class ID %d => %s", idx, classname));
4016 * Decode class name length and read that name.
4018 * NOTA BENE: even if the length is stored on one byte, we don't read
4019 * on the stack. Just like retrieve_blessed(), we limit the name to
4020 * LG_BLESS bytes. This is an arbitrary decision.
4023 if (flags & SHF_LARGE_CLASSLEN)
4028 if (len > LG_BLESS) {
4029 TRACEME(("** allocating %d bytes for class name", len+1));
4030 New(10003, classname, len+1, char);
4033 READ(classname, len);
4034 classname[len] = '\0'; /* Mark string end */
4037 * Record new classname.
4040 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len)))
4044 TRACEME(("class name: %s", classname));
4047 * Decode user-frozen string length and read it in an SV.
4049 * For efficiency reasons, we read data directly into the SV buffer.
4050 * To understand that code, read retrieve_scalar()
4053 if (flags & SHF_LARGE_STRLEN)
4058 frozen = NEWSV(10002, len2);
4060 SAFEREAD(SvPVX(frozen), len2, frozen);
4061 SvCUR_set(frozen, len2);
4062 *SvEND(frozen) = '\0';
4064 (void) SvPOK_only(frozen); /* Validates string pointer */
4065 if (cxt->s_tainted) /* Is input source tainted? */
4068 TRACEME(("frozen string: %d bytes", len2));
4071 * Decode object-ID list length, if present.
4074 if (flags & SHF_HAS_LIST) {
4075 if (flags & SHF_LARGE_LISTLEN)
4081 av_extend(av, len3 + 1); /* Leave room for [0] */
4082 AvFILLp(av) = len3; /* About to be filled anyway */
4086 TRACEME(("has %d object IDs to link", len3));
4089 * Read object-ID list into array.
4090 * Because we pre-extended it, we can cheat and fill it manually.
4092 * We read object tags and we can convert them into SV* on the fly
4093 * because we know all the references listed in there (as tags)
4094 * have been already serialized, hence we have a valid correspondance
4095 * between each of those tags and the recreated SV.
4099 SV **ary = AvARRAY(av);
4101 for (i = 1; i <= len3; i++) { /* We leave [0] alone */
4108 svh = av_fetch(cxt->aseen, tag, FALSE);
4110 if (tag == cxt->where_is_undef) {
4111 /* av_fetch uses PL_sv_undef internally, hence this
4112 somewhat gruesome hack. */
4116 CROAK(("Object #%"IVdf" should have been retrieved already",
4121 ary[i] = SvREFCNT_inc(xsv);
4126 * Bless the object and look up the STORABLE_thaw hook.
4129 BLESS(sv, classname);
4130 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4133 * Hook not found. Maybe they did not require the module where this
4134 * hook is defined yet?
4136 * If the require below succeeds, we'll be able to find the hook.
4137 * Still, it only works reliably when each class is defined in a
4141 SV *psv = newSVpvn("require ", 8);
4142 sv_catpv(psv, classname);
4144 TRACEME(("No STORABLE_thaw defined for objects of class %s", classname));
4145 TRACEME(("Going to require module '%s' with '%s'", classname, SvPVX(psv)));
4147 perl_eval_sv(psv, G_DISCARD);
4151 * We cache results of pkg_can, so we need to uncache before attempting
4155 pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4156 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4159 CROAK(("No STORABLE_thaw defined for objects of class %s "
4160 "(even after a \"require %s;\")", classname, classname));
4164 * If we don't have an `av' yet, prepare one.
4165 * Then insert the frozen string as item [0].
4173 AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4178 * $object->STORABLE_thaw($cloning, $frozen, @refs);
4180 * where $object is our blessed (empty) object, $cloning is a boolean
4181 * telling whether we're running a deep clone, $frozen is the frozen
4182 * string the user gave us in his serializing hook, and @refs, which may
4183 * be empty, is the list of extra references he returned along for us
4186 * In effect, the hook is an alternate creation routine for the class,
4187 * the object itself being already created by the runtime.
4190 TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4191 classname, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4194 (void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
4201 SvREFCNT_dec(frozen);
4204 if (!(flags & SHF_IDX_CLASSNAME) && classname != buf)
4205 Safefree(classname);
4208 * If we had an <extra> type, then the object was not as simple, and
4209 * we need to restore extra magic now.
4215 TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4217 rv = retrieve(aTHX_ cxt, 0); /* Retrieve <magic object> */
4219 TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4220 PTR2UV(rv), PTR2UV(sv)));
4222 switch (extra_type) {
4224 sv_upgrade(sv, SVt_PVMG);
4227 sv_upgrade(sv, SVt_PVAV);
4228 AvREAL_off((AV *)sv);
4231 sv_upgrade(sv, SVt_PVHV);
4234 CROAK(("Forgot to deal with extra type %d", extra_type));
4239 * Adding the magic only now, well after the STORABLE_thaw hook was called
4240 * means the hook cannot know it deals with an object whose variable is
4241 * tied. But this is happening when retrieving $o in the following case:
4245 * my $o = bless \%h, 'BAR';
4247 * The 'BAR' class is NOT the one where %h is tied into. Therefore, as
4248 * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4249 * hash but a tied one should not matter at all, and remain transparent.
4250 * This means the magic must be restored by Storable AFTER the hook is
4253 * That looks very reasonable to me, but then I've come up with this
4254 * after a bug report from David Nesting, who was trying to store such
4255 * an object and caused Storable to fail. And unfortunately, it was
4256 * also the easiest way to retrofit support for blessed ref to tied objects
4257 * into the existing design. -- RAM, 17/02/2001
4260 sv_magic(sv, rv, mtype, Nullch, 0);
4261 SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
4269 * Retrieve reference to some other scalar.
4270 * Layout is SX_REF <object>, with SX_REF already read.
4272 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname)
4277 TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4280 * We need to create the SV that holds the reference to the yet-to-retrieve
4281 * object now, so that we may record the address in the seen table.
4282 * Otherwise, if the object to retrieve references us, we won't be able
4283 * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4284 * do the retrieve first and use rv = newRV(sv) since it will be too late
4285 * for SEEN() recording.
4288 rv = NEWSV(10002, 0);
4289 SEEN(rv, cname, 0); /* Will return if rv is null */
4290 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4292 return (SV *) 0; /* Failed */
4295 * WARNING: breaks RV encapsulation.
4297 * Now for the tricky part. We have to upgrade our existing SV, so that
4298 * it is now an RV on sv... Again, we cheat by duplicating the code
4299 * held in newSVrv(), since we already got our SV from retrieve().
4303 * SvRV(rv) = SvREFCNT_inc(sv);
4305 * here because the reference count we got from retrieve() above is
4306 * already correct: if the object was retrieved from the file, then
4307 * its reference count is one. Otherwise, if it was retrieved via
4308 * an SX_OBJECT indication, a ref count increment was done.
4312 /* No need to do anything, as rv will already be PVMG. */
4313 assert (SvTYPE(rv) >= SVt_RV);
4315 sv_upgrade(rv, SVt_RV);
4318 SvRV_set(rv, sv); /* $rv = \$sv */
4321 TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4327 * retrieve_overloaded
4329 * Retrieve reference to some other scalar with overloading.
4330 * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4332 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname)
4338 TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4341 * Same code as retrieve_ref(), duplicated to avoid extra call.
4344 rv = NEWSV(10002, 0);
4345 SEEN(rv, cname, 0); /* Will return if rv is null */
4346 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4348 return (SV *) 0; /* Failed */
4351 * WARNING: breaks RV encapsulation.
4354 sv_upgrade(rv, SVt_RV);
4355 SvRV_set(rv, sv); /* $rv = \$sv */
4359 * Restore overloading magic.
4362 stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
4364 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4365 ") (package <unknown>)",
4366 sv_reftype(sv, FALSE),
4369 if (!Gv_AMG(stash)) {
4370 SV *psv = newSVpvn("require ", 8);
4371 const char *package = HvNAME(stash);
4372 sv_catpv(psv, package);
4374 TRACEME(("No overloading defined for package %s", package));
4375 TRACEME(("Going to require module '%s' with '%s'", package, SvPVX(psv)));
4377 perl_eval_sv(psv, G_DISCARD);
4379 if (!Gv_AMG(stash)) {
4380 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4381 ") (package %s) (even after a \"require %s;\")",
4382 sv_reftype(sv, FALSE),
4390 TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4396 * retrieve_tied_array
4398 * Retrieve tied array
4399 * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4401 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname)
4406 TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4408 tv = NEWSV(10002, 0);
4409 SEEN(tv, cname, 0); /* Will return if tv is null */
4410 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4412 return (SV *) 0; /* Failed */
4414 sv_upgrade(tv, SVt_PVAV);
4415 AvREAL_off((AV *)tv);
4416 sv_magic(tv, sv, 'P', Nullch, 0);
4417 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4419 TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4425 * retrieve_tied_hash
4427 * Retrieve tied hash
4428 * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4430 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname)
4435 TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4437 tv = NEWSV(10002, 0);
4438 SEEN(tv, cname, 0); /* Will return if tv is null */
4439 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4441 return (SV *) 0; /* Failed */
4443 sv_upgrade(tv, SVt_PVHV);
4444 sv_magic(tv, sv, 'P', Nullch, 0);
4445 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4447 TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4453 * retrieve_tied_scalar
4455 * Retrieve tied scalar
4456 * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4458 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname)
4461 SV *sv, *obj = NULL;
4463 TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4465 tv = NEWSV(10002, 0);
4466 SEEN(tv, cname, 0); /* Will return if rv is null */
4467 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4469 return (SV *) 0; /* Failed */
4471 else if (SvTYPE(sv) != SVt_NULL) {
4475 sv_upgrade(tv, SVt_PVMG);
4476 sv_magic(tv, obj, 'q', Nullch, 0);
4479 /* Undo refcnt inc from sv_magic() */
4483 TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4491 * Retrieve reference to value in a tied hash.
4492 * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4494 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname)
4500 TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4502 tv = NEWSV(10002, 0);
4503 SEEN(tv, cname, 0); /* Will return if tv is null */
4504 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4506 return (SV *) 0; /* Failed */
4508 key = retrieve(aTHX_ cxt, 0); /* Retrieve <key> */
4510 return (SV *) 0; /* Failed */
4512 sv_upgrade(tv, SVt_PVMG);
4513 sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4514 SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
4515 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4523 * Retrieve reference to value in a tied array.
4524 * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4526 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname)
4532 TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4534 tv = NEWSV(10002, 0);
4535 SEEN(tv, cname, 0); /* Will return if tv is null */
4536 sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
4538 return (SV *) 0; /* Failed */
4540 RLEN(idx); /* Retrieve <idx> */
4542 sv_upgrade(tv, SVt_PVMG);
4543 sv_magic(tv, sv, 'p', Nullch, idx);
4544 SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
4553 * Retrieve defined long (string) scalar.
4555 * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4556 * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4557 * was not stored on a single byte.
4559 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname)
4565 TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4568 * Allocate an empty scalar of the suitable length.
4571 sv = NEWSV(10002, len);
4572 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4575 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4577 * Now, for efficiency reasons, read data directly inside the SV buffer,
4578 * and perform the SV final settings directly by duplicating the final
4579 * work done by sv_setpv. Since we're going to allocate lots of scalars
4580 * this way, it's worth the hassle and risk.
4583 SAFEREAD(SvPVX(sv), len, sv);
4584 SvCUR_set(sv, len); /* Record C string length */
4585 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4586 (void) SvPOK_only(sv); /* Validate string pointer */
4587 if (cxt->s_tainted) /* Is input source tainted? */
4588 SvTAINT(sv); /* External data cannot be trusted */
4590 TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4591 TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4599 * Retrieve defined short (string) scalar.
4601 * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4602 * The scalar is "short" so <length> is single byte. If it is 0, there
4603 * is no <data> section.
4605 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname)
4611 TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4614 * Allocate an empty scalar of the suitable length.
4617 sv = NEWSV(10002, len);
4618 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4621 * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4626 * newSV did not upgrade to SVt_PV so the scalar is undefined.
4627 * To make it defined with an empty length, upgrade it now...
4628 * Don't upgrade to a PV if the original type contains more
4629 * information than a scalar.
4631 if (SvTYPE(sv) <= SVt_PV) {
4632 sv_upgrade(sv, SVt_PV);
4635 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4636 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4639 * Now, for efficiency reasons, read data directly inside the SV buffer,
4640 * and perform the SV final settings directly by duplicating the final
4641 * work done by sv_setpv. Since we're going to allocate lots of scalars
4642 * this way, it's worth the hassle and risk.
4644 SAFEREAD(SvPVX(sv), len, sv);
4645 SvCUR_set(sv, len); /* Record C string length */
4646 *SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
4647 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4650 (void) SvPOK_only(sv); /* Validate string pointer */
4651 if (cxt->s_tainted) /* Is input source tainted? */
4652 SvTAINT(sv); /* External data cannot be trusted */
4654 TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4661 * Like retrieve_scalar(), but tag result as utf8.
4662 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4664 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname)
4668 TRACEME(("retrieve_utf8str"));
4670 sv = retrieve_scalar(aTHX_ cxt, cname);
4672 #ifdef HAS_UTF8_SCALARS
4675 if (cxt->use_bytes < 0)
4677 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4679 if (cxt->use_bytes == 0)
4690 * Like retrieve_lscalar(), but tag result as utf8.
4691 * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4693 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname)
4697 TRACEME(("retrieve_lutf8str"));
4699 sv = retrieve_lscalar(aTHX_ cxt, cname);
4701 #ifdef HAS_UTF8_SCALARS
4704 if (cxt->use_bytes < 0)
4706 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4708 if (cxt->use_bytes == 0)
4718 * Retrieve defined integer.
4719 * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4721 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname)
4726 TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4728 READ(&iv, sizeof(iv));
4730 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4732 TRACEME(("integer %"IVdf, iv));
4733 TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4741 * Retrieve defined integer in network order.
4742 * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4744 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname)
4749 TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4753 sv = newSViv((int) ntohl(iv));
4754 TRACEME(("network integer %d", (int) ntohl(iv)));
4757 TRACEME(("network integer (as-is) %d", iv));
4759 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4761 TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
4769 * Retrieve defined double.
4770 * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
4772 static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname)
4777 TRACEME(("retrieve_double (#%d)", cxt->tagnum));
4779 READ(&nv, sizeof(nv));
4781 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4783 TRACEME(("double %"NVff, nv));
4784 TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
4792 * Retrieve defined byte (small integer within the [-128, +127] range).
4793 * Layout is SX_BYTE <data>, whith SX_BYTE already read.
4795 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname)
4799 signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
4801 TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
4804 TRACEME(("small integer read as %d", (unsigned char) siv));
4805 tmp = (unsigned char) siv - 128;
4807 SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
4809 TRACEME(("byte %d", tmp));
4810 TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
4818 * Return the undefined value.
4820 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname)
4824 TRACEME(("retrieve_undef"));
4835 * Return the immortal undefined value.
4837 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname)
4839 SV *sv = &PL_sv_undef;
4841 TRACEME(("retrieve_sv_undef"));
4843 /* Special case PL_sv_undef, as av_fetch uses it internally to mark
4844 deleted elements, and will return NULL (fetch failed) whenever it
4846 if (cxt->where_is_undef == -1) {
4847 cxt->where_is_undef = cxt->tagnum;
4856 * Return the immortal yes value.
4858 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname)
4860 SV *sv = &PL_sv_yes;
4862 TRACEME(("retrieve_sv_yes"));
4871 * Return the immortal no value.
4873 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname)
4877 TRACEME(("retrieve_sv_no"));
4886 * Retrieve a whole array.
4887 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
4888 * Each item is stored as <object>.
4890 * When we come here, SX_ARRAY has been read already.
4892 static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname)
4899 TRACEME(("retrieve_array (#%d)", cxt->tagnum));
4902 * Read length, and allocate array, then pre-extend it.
4906 TRACEME(("size = %d", len));
4908 SEEN(av, cname, 0); /* Will return if array not allocated nicely */
4912 return (SV *) av; /* No data follow if array is empty */
4915 * Now get each item in turn...
4918 for (i = 0; i < len; i++) {
4919 TRACEME(("(#%d) item", i));
4920 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
4923 if (av_store(av, i, sv) == 0)
4927 TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
4935 * Retrieve a whole hash table.
4936 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4937 * Keys are stored as <length> <data>, the <data> section being omitted
4939 * Values are stored as <object>.
4941 * When we come here, SX_HASH has been read already.
4943 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname)
4951 TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
4954 * Read length, allocate table.
4958 TRACEME(("size = %d", len));
4960 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
4962 return (SV *) hv; /* No data follow if table empty */
4963 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
4966 * Now get each key/value pair in turn...
4969 for (i = 0; i < len; i++) {
4974 TRACEME(("(#%d) value", i));
4975 sv = retrieve(aTHX_ cxt, 0);
4981 * Since we're reading into kbuf, we must ensure we're not
4982 * recursing between the read and the hv_store() where it's used.
4983 * Hence the key comes after the value.
4986 RLEN(size); /* Get key size */
4987 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
4990 kbuf[size] = '\0'; /* Mark string end, just in case */
4991 TRACEME(("(#%d) key '%s'", i, kbuf));
4994 * Enter key/value pair into hash table.
4997 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5001 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5009 * Retrieve a whole hash table.
5010 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5011 * Keys are stored as <length> <data>, the <data> section being omitted
5013 * Values are stored as <object>.
5015 * When we come here, SX_HASH has been read already.
5017 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname)
5026 GETMARK(hash_flags);
5027 TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
5029 * Read length, allocate table.
5032 #ifndef HAS_RESTRICTED_HASHES
5033 if (hash_flags & SHV_RESTRICTED) {
5034 if (cxt->derestrict < 0)
5036 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
5038 if (cxt->derestrict == 0)
5039 RESTRICTED_HASH_CROAK();
5044 TRACEME(("size = %d, flags = %d", len, hash_flags));
5046 SEEN(hv, cname, 0); /* Will return if table not allocated properly */
5048 return (SV *) hv; /* No data follow if table empty */
5049 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5052 * Now get each key/value pair in turn...
5055 for (i = 0; i < len; i++) {
5057 int store_flags = 0;
5062 TRACEME(("(#%d) value", i));
5063 sv = retrieve(aTHX_ cxt, 0);
5068 #ifdef HAS_RESTRICTED_HASHES
5069 if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
5073 if (flags & SHV_K_ISSV) {
5074 /* XXX you can't set a placeholder with an SV key.
5075 Then again, you can't get an SV key.
5076 Without messing around beyond what the API is supposed to do.
5079 TRACEME(("(#%d) keysv, flags=%d", i, flags));
5080 keysv = retrieve(aTHX_ cxt, 0);
5084 if (!hv_store_ent(hv, keysv, sv, 0))
5089 * Since we're reading into kbuf, we must ensure we're not
5090 * recursing between the read and the hv_store() where it's used.
5091 * Hence the key comes after the value.
5094 if (flags & SHV_K_PLACEHOLDER) {
5096 sv = &PL_sv_placeholder;
5097 store_flags |= HVhek_PLACEHOLD;
5099 if (flags & SHV_K_UTF8) {
5100 #ifdef HAS_UTF8_HASHES
5101 store_flags |= HVhek_UTF8;
5103 if (cxt->use_bytes < 0)
5105 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
5107 if (cxt->use_bytes == 0)
5111 #ifdef HAS_UTF8_HASHES
5112 if (flags & SHV_K_WASUTF8)
5113 store_flags |= HVhek_WASUTF8;
5116 RLEN(size); /* Get key size */
5117 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5120 kbuf[size] = '\0'; /* Mark string end, just in case */
5121 TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5122 flags, store_flags));
5125 * Enter key/value pair into hash table.
5128 #ifdef HAS_RESTRICTED_HASHES
5129 if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5132 if (!(store_flags & HVhek_PLACEHOLD))
5133 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5138 #ifdef HAS_RESTRICTED_HASHES
5139 if (hash_flags & SHV_RESTRICTED)
5143 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5151 * Return a code reference.
5153 static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname)
5155 #if PERL_VERSION < 6
5156 CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5159 int type, count, tagnum;
5161 SV *sv, *text, *sub;
5163 TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5166 * Insert dummy SV in the aseen array so that we don't screw
5167 * up the tag numbers. We would just make the internal
5168 * scalar an untagged item in the stream, but
5169 * retrieve_scalar() calls SEEN(). So we just increase the
5172 tagnum = cxt->tagnum;
5177 * Retrieve the source of the code reference
5178 * as a small or large scalar
5184 text = retrieve_scalar(aTHX_ cxt, cname);
5187 text = retrieve_lscalar(aTHX_ cxt, cname);
5190 CROAK(("Unexpected type %d in retrieve_code\n", type));
5194 * prepend "sub " to the source
5197 sub = newSVpvn("sub ", 4);
5198 sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5202 * evaluate the source to a code reference and use the CV value
5205 if (cxt->eval == NULL) {
5206 cxt->eval = perl_get_sv("Storable::Eval", TRUE);
5207 SvREFCNT_inc(cxt->eval);
5209 if (!SvTRUE(cxt->eval)) {
5211 cxt->forgive_me == 0 ||
5212 (cxt->forgive_me < 0 && !(cxt->forgive_me =
5213 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
5215 CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5218 /* fix up the dummy entry... */
5219 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5227 if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5228 SV* errsv = get_sv("@", TRUE);
5229 sv_setpvn(errsv, "", 0); /* clear $@ */
5231 XPUSHs(sv_2mortal(newSVsv(sub)));
5233 count = call_sv(cxt->eval, G_SCALAR);
5236 CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5238 if (SvTRUE(errsv)) {
5239 CROAK(("code %s caused an error: %s",
5240 SvPV_nolen(sub), SvPV_nolen(errsv)));
5244 cv = eval_pv(SvPV_nolen(sub), TRUE);
5246 if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5249 CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5252 SvREFCNT_inc(sv); /* XXX seems to be necessary */
5257 /* fix up the dummy entry... */
5258 av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5265 * old_retrieve_array
5267 * Retrieve a whole array in pre-0.6 binary format.
5269 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5270 * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5272 * When we come here, SX_ARRAY has been read already.
5274 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname)
5282 TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5285 * Read length, and allocate array, then pre-extend it.
5289 TRACEME(("size = %d", len));
5291 SEEN(av, 0, 0); /* Will return if array not allocated nicely */
5295 return (SV *) av; /* No data follow if array is empty */
5298 * Now get each item in turn...
5301 for (i = 0; i < len; i++) {
5303 if (c == SX_IT_UNDEF) {
5304 TRACEME(("(#%d) undef item", i));
5305 continue; /* av_extend() already filled us with undef */
5308 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5309 TRACEME(("(#%d) item", i));
5310 sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
5313 if (av_store(av, i, sv) == 0)
5317 TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5325 * Retrieve a whole hash table in pre-0.6 binary format.
5327 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5328 * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5330 * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5332 * When we come here, SX_HASH has been read already.
5334 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname)
5342 static SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
5344 TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5347 * Read length, allocate table.
5351 TRACEME(("size = %d", len));
5353 SEEN(hv, 0, 0); /* Will return if table not allocated properly */
5355 return (SV *) hv; /* No data follow if table empty */
5356 hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
5359 * Now get each key/value pair in turn...
5362 for (i = 0; i < len; i++) {
5368 if (c == SX_VL_UNDEF) {
5369 TRACEME(("(#%d) undef value", i));
5371 * Due to a bug in hv_store(), it's not possible to pass
5372 * &PL_sv_undef to hv_store() as a value, otherwise the
5373 * associated key will not be creatable any more. -- RAM, 14/01/97
5376 sv_h_undef = newSVsv(&PL_sv_undef);
5377 sv = SvREFCNT_inc(sv_h_undef);
5378 } else if (c == SX_VALUE) {
5379 TRACEME(("(#%d) value", i));
5380 sv = retrieve(aTHX_ cxt, 0);
5384 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5388 * Since we're reading into kbuf, we must ensure we're not
5389 * recursing between the read and the hv_store() where it's used.
5390 * Hence the key comes after the value.
5395 (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
5396 RLEN(size); /* Get key size */
5397 KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
5400 kbuf[size] = '\0'; /* Mark string end, just in case */
5401 TRACEME(("(#%d) key '%s'", i, kbuf));
5404 * Enter key/value pair into hash table.
5407 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5411 TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5417 *** Retrieval engine.
5423 * Make sure the stored data we're trying to retrieve has been produced
5424 * on an ILP compatible system with the same byteorder. It croaks out in
5425 * case an error is detected. [ILP = integer-long-pointer sizes]
5426 * Returns null if error is detected, &PL_sv_undef otherwise.
5428 * Note that there's no byte ordering info emitted when network order was
5429 * used at store time.
5431 static SV *magic_check(pTHX_ stcxt_t *cxt)
5433 /* The worst case for a malicious header would be old magic (which is
5434 longer), major, minor, byteorder length byte of 255, 255 bytes of
5435 garbage, sizeof int, long, pointer, NV.
5436 So the worse of that we can read is 255 bytes of garbage plus 4.
5437 Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5438 compiling perl on a system with chars that are larger than 8 bits.
5439 (Even Crays aren't *that* perverse).
5441 unsigned char buf[4 + 255];
5442 unsigned char *current;
5445 int use_network_order;
5448 int version_minor = 0;
5450 TRACEME(("magic_check"));
5453 * The "magic number" is only for files, not when freezing in memory.
5457 /* This includes the '\0' at the end. I want to read the extra byte,
5458 which is usually going to be the major version number. */
5459 STRLEN len = sizeof(magicstr);
5462 READ(buf, (SSize_t)(len)); /* Not null-terminated */
5464 /* Point at the byte after the byte we read. */
5465 current = buf + --len; /* Do the -- outside of macros. */
5467 if (memNE(buf, magicstr, len)) {
5469 * Try to read more bytes to check for the old magic number, which
5473 TRACEME(("trying for old magic number"));
5475 old_len = sizeof(old_magicstr) - 1;
5476 READ(current + 1, (SSize_t)(old_len - len));
5478 if (memNE(buf, old_magicstr, old_len))
5479 CROAK(("File is not a perl storable"));
5480 current = buf + old_len;
5482 use_network_order = *current;
5484 GETMARK(use_network_order);
5487 * Starting with 0.6, the "use_network_order" byte flag is also used to
5488 * indicate the version number of the binary, and therefore governs the
5489 * setting of sv_retrieve_vtbl. See magic_write().
5492 version_major = use_network_order >> 1;
5493 cxt->retrieve_vtbl = version_major ? sv_retrieve : sv_old_retrieve;
5495 TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5499 * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5500 * minor version of the protocol. See magic_write().
5503 if (version_major > 1)
5504 GETMARK(version_minor);
5506 cxt->ver_major = version_major;
5507 cxt->ver_minor = version_minor;
5509 TRACEME(("binary image version is %d.%d", version_major, version_minor));
5512 * Inter-operability sanity check: we can't retrieve something stored
5513 * using a format more recent than ours, because we have no way to
5514 * know what has changed, and letting retrieval go would mean a probable
5515 * failure reporting a "corrupted" storable file.
5519 version_major > STORABLE_BIN_MAJOR ||
5520 (version_major == STORABLE_BIN_MAJOR &&
5521 version_minor > STORABLE_BIN_MINOR)
5524 TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5525 STORABLE_BIN_MINOR));
5527 if (version_major == STORABLE_BIN_MAJOR) {
5528 TRACEME(("cxt->accept_future_minor is %d",
5529 cxt->accept_future_minor));
5530 if (cxt->accept_future_minor < 0)
5531 cxt->accept_future_minor
5532 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5535 if (cxt->accept_future_minor == 1)
5536 croak_now = 0; /* Don't croak yet. */
5539 CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5540 version_major, version_minor,
5541 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5546 * If they stored using network order, there's no byte ordering
5547 * information to check.
5550 if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
5551 return &PL_sv_undef; /* No byte ordering info */
5553 /* In C truth is 1, falsehood is 0. Very convienient. */
5554 use_NV_size = version_major >= 2 && version_minor >= 2;
5557 length = c + 3 + use_NV_size;
5558 READ(buf, length); /* Not null-terminated */
5560 TRACEME(("byte order '%.*s' %d", c, buf, c));
5562 #ifdef USE_56_INTERWORK_KLUDGE
5563 /* No point in caching this in the context as we only need it once per
5564 retrieve, and we need to recheck it each read. */
5565 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5566 if ((c != (sizeof (byteorderstr_56) - 1))
5567 || memNE(buf, byteorderstr_56, c))
5568 CROAK(("Byte order is not compatible"));
5572 if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5573 CROAK(("Byte order is not compatible"));
5579 if ((int) *current++ != sizeof(int))
5580 CROAK(("Integer size is not compatible"));
5583 if ((int) *current++ != sizeof(long))
5584 CROAK(("Long integer size is not compatible"));
5586 /* sizeof(char *) */
5587 if ((int) *current != sizeof(char *))
5588 CROAK(("Pointer size is not compatible"));
5592 if ((int) *++current != sizeof(NV))
5593 CROAK(("Double size is not compatible"));
5596 return &PL_sv_undef; /* OK */
5602 * Recursively retrieve objects from the specified file and return their
5603 * root SV (which may be an AV or an HV for what we care).
5604 * Returns null if there is a problem.
5606 static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname)
5612 TRACEME(("retrieve"));
5615 * Grab address tag which identifies the object if we are retrieving
5616 * an older format. Since the new binary format counts objects and no
5617 * longer explicitely tags them, we must keep track of the correspondance
5620 * The following section will disappear one day when the old format is
5621 * no longer supported, hence the final "goto" in the "if" block.
5624 if (cxt->hseen) { /* Retrieving old binary */
5626 if (cxt->netorder) {
5628 READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
5629 tag = (stag_t) nettag;
5631 READ(&tag, sizeof(stag_t)); /* Original address of the SV */
5634 if (type == SX_OBJECT) {
5636 svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5638 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5640 tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
5643 * The following code is common with the SX_OBJECT case below.
5646 svh = av_fetch(cxt->aseen, tagn, FALSE);
5648 CROAK(("Object #%"IVdf" should have been retrieved already",
5651 TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5652 SvREFCNT_inc(sv); /* One more reference to this same sv */
5653 return sv; /* The SV pointer where object was retrieved */
5657 * Map new object, but don't increase tagnum. This will be done
5658 * by each of the retrieve_* functions when they call SEEN().
5660 * The mapping associates the "tag" initially present with a unique
5661 * tag number. See test for SX_OBJECT above to see how this is perused.
5664 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5665 newSViv(cxt->tagnum), 0))
5672 * Regular post-0.6 binary format.
5677 TRACEME(("retrieve type = %d", type));
5680 * Are we dealing with an object we should have already retrieved?
5683 if (type == SX_OBJECT) {
5687 svh = av_fetch(cxt->aseen, tag, FALSE);
5689 CROAK(("Object #%"IVdf" should have been retrieved already",
5692 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5693 SvREFCNT_inc(sv); /* One more reference to this same sv */
5694 return sv; /* The SV pointer where object was retrieved */
5695 } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5696 if (cxt->accept_future_minor < 0)
5697 cxt->accept_future_minor
5698 = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5701 if (cxt->accept_future_minor == 1) {
5702 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5703 "This Storable is v%d.%d and can only handle data types up to %d",
5704 cxt->ver_major, cxt->ver_minor, type,
5705 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5709 first_time: /* Will disappear when support for old format is dropped */
5712 * Okay, first time through for this one.
5715 sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
5717 return (SV *) 0; /* Failed */
5720 * Old binary formats (pre-0.7).
5722 * Final notifications, ended by SX_STORED may now follow.
5723 * Currently, the only pertinent notification to apply on the
5724 * freshly retrieved object is either:
5725 * SX_CLASS <char-len> <classname> for short classnames.
5726 * SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5727 * Class name is then read into the key buffer pool used by
5728 * hash table key retrieval.
5731 if (cxt->ver_major < 2) {
5732 while ((type = GETCHAR()) != SX_STORED) {
5736 GETMARK(len); /* Length coded on a single char */
5738 case SX_LG_CLASS: /* Length coded on a regular integer */
5743 return (SV *) 0; /* Failed */
5745 KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
5748 kbuf[len] = '\0'; /* Mark string end */
5753 TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5754 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
5762 * Retrieve data held in file and return the root object.
5763 * Common routine for pretrieve and mretrieve.
5765 static SV *do_retrieve(
5773 int is_tainted; /* Is input source tainted? */
5774 int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
5776 TRACEME(("do_retrieve (optype = 0x%x)", optype));
5778 optype |= ST_RETRIEVE;
5781 * Sanity assertions for retrieve dispatch tables.
5784 ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
5785 ("old and new retrieve dispatch table have same size"));
5786 ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
5787 ("SX_ERROR entry correctly initialized in old dispatch table"));
5788 ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
5789 ("SX_ERROR entry correctly initialized in new dispatch table"));
5792 * Workaround for CROAK leak: if they enter with a "dirty" context,
5793 * free up memory for them now.
5797 clean_context(aTHX_ cxt);
5800 * Now that STORABLE_xxx hooks exist, it is possible that they try to
5801 * re-enter retrieve() via the hooks.
5805 cxt = allocate_context(aTHX_ cxt);
5809 ASSERT(cxt->entry == 1, ("starting new recursion"));
5810 ASSERT(!cxt->s_dirty, ("clean context"));
5815 * Data is loaded into the memory buffer when f is NULL, unless `in' is
5816 * also NULL, in which case we're expecting the data to already lie
5817 * in the buffer (dclone case).
5820 KBUFINIT(); /* Allocate hash key reading pool once */
5826 const char *orig = SvPV(in, length);
5828 /* This is quite deliberate. I want the UTF8 routines
5829 to encounter the '\0' which perl adds at the end
5830 of all scalars, so that any new string also has
5833 STRLEN klen_tmp = length + 1;
5834 bool is_utf8 = TRUE;
5836 /* Just casting the &klen to (STRLEN) won't work
5837 well if STRLEN and I32 are of different widths.
5839 asbytes = (char*)bytes_from_utf8((U8*)orig,
5843 CROAK(("Frozen string corrupt - contains characters outside 0-255"));
5845 if (asbytes != orig) {
5846 /* String has been converted.
5847 There is no need to keep any reference to
5849 in = sv_newmortal();
5850 /* We donate the SV the malloc()ed string
5851 bytes_from_utf8 returned us. */
5852 SvUPGRADE(in, SVt_PV);
5854 SvPV_set(in, asbytes);
5855 SvLEN_set(in, klen_tmp);
5856 SvCUR_set(in, klen_tmp - 1);
5860 MBUF_SAVE_AND_LOAD(in);
5864 * Magic number verifications.
5866 * This needs to be done before calling init_retrieve_context()
5867 * since the format indication in the file are necessary to conduct
5868 * some of the initializations.
5871 cxt->fio = f; /* Where I/O are performed */
5873 if (!magic_check(aTHX_ cxt))
5874 CROAK(("Magic number checking on storable %s failed",
5875 cxt->fio ? "file" : "string"));
5877 TRACEME(("data stored in %s format",
5878 cxt->netorder ? "net order" : "native"));
5881 * Check whether input source is tainted, so that we don't wrongly
5882 * taint perfectly good values...
5884 * We assume file input is always tainted. If both `f' and `in' are
5885 * NULL, then we come from dclone, and tainted is already filled in
5886 * the context. That's a kludge, but the whole dclone() thing is
5887 * already quite a kludge anyway! -- RAM, 15/09/2000.
5890 is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
5891 TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
5892 init_retrieve_context(aTHX_ cxt, optype, is_tainted);
5894 ASSERT(is_retrieving(), ("within retrieve operation"));
5896 sv = retrieve(aTHX_ cxt, 0); /* Recursively retrieve object, get root SV */
5905 pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
5908 * The "root" context is never freed.
5911 clean_retrieve_context(aTHX_ cxt);
5912 if (cxt->prev) /* This context was stacked */
5913 free_context(aTHX_ cxt); /* It was not the "root" context */
5916 * Prepare returned value.
5920 TRACEME(("retrieve ERROR"));
5921 #if (PATCHLEVEL <= 4)
5922 /* perl 5.00405 seems to screw up at this point with an
5923 'attempt to modify a read only value' error reported in the
5924 eval { $self = pretrieve(*FILE) } in _retrieve.
5925 I can't see what the cause of this error is, but I suspect a
5926 bug in 5.004, as it seems to be capable of issuing spurious
5927 errors or core dumping with matches on $@. I'm not going to
5928 spend time on what could be a fruitless search for the cause,
5929 so here's a bodge. If you're running 5.004 and don't like
5930 this inefficiency, either upgrade to a newer perl, or you are
5931 welcome to find the problem and send in a patch.
5935 return &PL_sv_undef; /* Something went wrong, return undef */
5939 TRACEME(("retrieve got %s(0x%"UVxf")",
5940 sv_reftype(sv, FALSE), PTR2UV(sv)));
5943 * Backward compatibility with Storable-0.5@9 (which we know we
5944 * are retrieving if hseen is non-null): don't create an extra RV
5945 * for objects since we special-cased it at store time.
5947 * Build a reference to the SV returned by pretrieve even if it is
5948 * already one and not a scalar, for consistency reasons.
5951 if (pre_06_fmt) { /* Was not handling overloading by then */
5953 TRACEME(("fixing for old formats -- pre 0.6"));
5954 if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
5955 TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
5961 * If reference is overloaded, restore behaviour.
5963 * NB: minor glitch here: normally, overloaded refs are stored specially
5964 * so that we can croak when behaviour cannot be re-installed, and also
5965 * avoid testing for overloading magic at each reference retrieval.
5967 * Unfortunately, the root reference is implicitely stored, so we must
5968 * check for possible overloading now. Furthermore, if we don't restore
5969 * overloading, we cannot croak as if the original ref was, because we
5970 * have no way to determine whether it was an overloaded ref or not in
5973 * It's a pity that overloading magic is attached to the rv, and not to
5974 * the underlying sv as blessing is.
5978 HV *stash = (HV *) SvSTASH(sv);
5979 SV *rv = newRV_noinc(sv);
5980 if (stash && Gv_AMG(stash)) {
5982 TRACEME(("restored overloading on root reference"));
5984 TRACEME(("ended do_retrieve() with an object"));
5988 TRACEME(("regular do_retrieve() end"));
5990 return newRV_noinc(sv);
5996 * Retrieve data held in file and return the root object, undef on error.
5998 SV *pretrieve(pTHX_ PerlIO *f)
6000 TRACEME(("pretrieve"));
6001 return do_retrieve(aTHX_ f, Nullsv, 0);
6007 * Retrieve data held in scalar and return the root object, undef on error.
6009 SV *mretrieve(pTHX_ SV *sv)
6011 TRACEME(("mretrieve"));
6012 return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
6022 * Deep clone: returns a fresh copy of the original referenced SV tree.
6024 * This is achieved by storing the object in memory and restoring from
6025 * there. Not that efficient, but it should be faster than doing it from
6028 SV *dclone(pTHX_ SV *sv)
6032 stcxt_t *real_context;
6035 TRACEME(("dclone"));
6038 * Workaround for CROAK leak: if they enter with a "dirty" context,
6039 * free up memory for them now.
6043 clean_context(aTHX_ cxt);
6046 * do_store() optimizes for dclone by not freeing its context, should
6047 * we need to allocate one because we're deep cloning from a hook.
6050 if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
6051 return &PL_sv_undef; /* Error during store */
6054 * Because of the above optimization, we have to refresh the context,
6055 * since a new one could have been allocated and stacked by do_store().
6058 { dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
6059 cxt = real_context; /* And we need this temporary... */
6062 * Now, `cxt' may refer to a new context.
6065 ASSERT(!cxt->s_dirty, ("clean context"));
6066 ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
6069 TRACEME(("dclone stored %d bytes", size));
6073 * Since we're passing do_retrieve() both a NULL file and sv, we need
6074 * to pre-compute the taintedness of the input by setting cxt->tainted
6075 * to whatever state our own input string was. -- RAM, 15/09/2000
6077 * do_retrieve() will free non-root context.
6080 cxt->s_tainted = SvTAINTED(sv);
6081 out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
6083 TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
6093 * The Perl IO GV object distinguishes between input and output for sockets
6094 * but not for plain files. To allow Storable to transparently work on
6095 * plain files and sockets transparently, we have to ask xsubpp to fetch the
6096 * right object for us. Hence the OutputStream and InputStream declarations.
6098 * Before perl 5.004_05, those entries in the standard typemap are not
6099 * defined in perl include files, so we do that here.
6102 #ifndef OutputStream
6103 #define OutputStream PerlIO *
6104 #define InputStream PerlIO *
6105 #endif /* !OutputStream */
6107 MODULE = Storable PACKAGE = Storable::Cxt
6113 stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
6117 if (!cxt->membuf_ro && mbase)
6119 if (cxt->membuf_ro && (cxt->msaved).arena)
6120 Safefree((cxt->msaved).arena);
6123 MODULE = Storable PACKAGE = Storable
6128 init_perinterp(aTHX);
6129 gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
6131 /* Only disable the used only once warning if we are in debugging mode. */
6132 gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
6134 #ifdef USE_56_INTERWORK_KLUDGE
6135 gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
6141 init_perinterp(aTHX);
6148 RETVAL = pstore(aTHX_ f, obj);
6157 RETVAL = net_pstore(aTHX_ f, obj);
6165 RETVAL = mstore(aTHX_ obj);
6173 RETVAL = net_mstore(aTHX_ obj);
6181 RETVAL = pretrieve(aTHX_ f);
6189 RETVAL = mretrieve(aTHX_ sv);
6197 RETVAL = dclone(aTHX_ sv);
6202 last_op_in_netorder()
6204 RETVAL = last_op_in_netorder(aTHX);
6211 RETVAL = is_storing(aTHX);
6218 RETVAL = is_retrieving(aTHX);
https://perl5.git.perl.org / perl5.git / blob