2 * Store and retrieve mechanism.
4 * Copyright (c) 1995-2000, Raphael Manfredi
6 * You may redistribute only under the same terms as Perl 5, as specified
7 * in the README file that comes with the distribution.
11 #define PERL_NO_GET_CONTEXT /* we want efficiency */
17 #include <patchlevel.h> /* Perl's one, needed since 5.6 */
20 #if !defined(PERL_VERSION) || PERL_VERSION < 8
21 #include "ppport.h" /* handle old perls */
25 #define DEBUGME /* Debug mode, turns assertions on as well */
26 #define DASSERT /* Assertion mode */
30 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
31 * Provide them with the necessary defines so they can build with pre-5.004.
34 #ifndef PERLIO_IS_STDIO
36 #define PerlIO_getc(x) getc(x)
37 #define PerlIO_putc(f,x) putc(x,f)
38 #define PerlIO_read(x,y,z) fread(y,1,z,x)
39 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
40 #define PerlIO_stdoutf printf
41 #endif /* PERLIO_IS_STDIO */
42 #endif /* USE_PERLIO */
45 * Earlier versions of perl might be used, we can't assume they have the latest!
48 #ifndef PERL_VERSION /* For perls < 5.6 */
49 #define PERL_VERSION PATCHLEVEL
51 #define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
53 #if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
54 #define PL_sv_yes sv_yes
55 #define PL_sv_no sv_no
56 #define PL_sv_undef sv_undef
57 #if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
58 #define newSVpvn newSVpv
60 #endif /* PATCHLEVEL <= 4 */
61 #ifndef HvSHAREKEYS_off
62 #define HvSHAREKEYS_off(hv) /* Ignore */
64 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
65 #define AvFILLp AvFILL
67 typedef double NV; /* Older perls lack the NV type */
68 #define IVdf "ld" /* Various printf formats for Perl types */
72 #define INT2PTR(t,v) (t)(IV)(v)
73 #define PTR2UV(v) (unsigned long)(v)
74 #endif /* PERL_VERSION -- perls < 5.6 */
76 #ifndef NVef /* The following were not part of perl 5.6 */
77 #if defined(USE_LONG_DOUBLE) && \
78 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
79 #define NVef PERL_PRIeldbl
80 #define NVff PERL_PRIfldbl
81 #define NVgf PERL_PRIgldbl
90 #ifndef PERL_UNUSED_DECL
92 # if (defined(__GNUC__) && defined(__cplusplus)) || defined(__INTEL_COMPILER)
93 # define PERL_UNUSED_DECL
95 # define PERL_UNUSED_DECL __attribute__((unused))
98 # define PERL_UNUSED_DECL
103 #define dNOOP extern int Perl___notused PERL_UNUSED_DECL
110 #ifndef HvPLACEHOLDERS_get
111 # define HvPLACEHOLDERS_get HvPLACEHOLDERS
121 * TRACEME() will only output things when the $Storable::DEBUGME is true.
126 if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
127 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
134 #define ASSERT(x,y) \
137 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
138 __FILE__, __LINE__); \
139 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
150 #define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
152 #define SX_OBJECT C(0) /* Already stored object */
153 #define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
154 #define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
155 #define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
156 #define SX_REF C(4) /* Reference to object forthcoming */
157 #define SX_UNDEF C(5) /* Undefined scalar */
158 #define SX_INTEGER C(6) /* Integer forthcoming */
159 #define SX_DOUBLE C(7) /* Double forthcoming */
160 #define SX_BYTE C(8) /* (signed) byte forthcoming */
161 #define SX_NETINT C(9) /* Integer in network order forthcoming */
162 #define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
163 #define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
164 #define SX_TIED_HASH C(12) /* Tied hash forthcoming */
165 #define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
166 #define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
167 #define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
168 #define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
169 #define SX_BLESS C(17) /* Object is blessed */
170 #define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
171 #define SX_HOOK C(19) /* Stored via hook, user-defined */
172 #define SX_OVERLOAD C(20) /* Overloaded reference */
173 #define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
174 #define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
175 #define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
176 #define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
177 #define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
178 #define SX_CODE C(26) /* Code references as perl source code */
179 #define SX_WEAKREF C(27) /* Weak reference to object forthcoming */
180 #define SX_WEAKOVERLOAD C(28) /* Overloaded weak reference */
181 #define SX_ERROR C(29) /* Error */
184 * Those are only used to retrieve "old" pre-0.6 binary images.
186 #define SX_ITEM 'i' /* An array item introducer */
187 #define SX_IT_UNDEF 'I' /* Undefined array item */
188 #define SX_KEY 'k' /* A hash key introducer */
189 #define SX_VALUE 'v' /* A hash value introducer */
190 #define SX_VL_UNDEF 'V' /* Undefined hash value */
193 * Those are only used to retrieve "old" pre-0.7 binary images
196 #define SX_CLASS 'b' /* Object is blessed, class name length <255 */
197 #define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
198 #define SX_STORED 'X' /* End of object */
201 * Limits between short/long length representation.
204 #define LG_SCALAR 255 /* Large scalar length limit */
205 #define LG_BLESS 127 /* Large classname bless limit */
211 #define ST_STORE 0x1 /* Store operation */
212 #define ST_RETRIEVE 0x2 /* Retrieval operation */
213 #define ST_CLONE 0x4 /* Deep cloning operation */
216 * The following structure is used for hash table key retrieval. Since, when
217 * retrieving objects, we'll be facing blessed hash references, it's best
218 * to pre-allocate that buffer once and resize it as the need arises, never
219 * freeing it (keys will be saved away someplace else anyway, so even large
220 * keys are not enough a motivation to reclaim that space).
222 * This structure is also used for memory store/retrieve operations which
223 * happen in a fixed place before being malloc'ed elsewhere if persistency
224 * is required. Hence the aptr pointer.
227 char *arena; /* Will hold hash key strings, resized as needed */
228 STRLEN asiz; /* Size of aforementionned buffer */
229 char *aptr; /* Arena pointer, for in-place read/write ops */
230 char *aend; /* First invalid address */
235 * A hash table records the objects which have already been stored.
236 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
237 * an arbitrary sequence number) is used to identify them.
240 * An array table records the objects which have already been retrieved,
241 * as seen by the tag determind by counting the objects themselves. The
242 * reference to that retrieved object is kept in the table, and is returned
243 * when an SX_OBJECT is found bearing that same tag.
245 * The same processing is used to record "classname" for blessed objects:
246 * indexing by a hash at store time, and via an array at retrieve time.
249 typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
252 * The following "thread-safe" related defines were contributed by
253 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
254 * only renamed things a little bit to ensure consistency with surrounding
255 * code. -- RAM, 14/09/1999
257 * The original patch suffered from the fact that the stcxt_t structure
258 * was global. Murray tried to minimize the impact on the code as much as
261 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
262 * on objects. Therefore, the notion of context needs to be generalized,
266 #define MY_VERSION "Storable(" XS_VERSION ")"
270 * Conditional UTF8 support.
274 #define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
275 #define HAS_UTF8_SCALARS
277 #define HAS_UTF8_HASHES
280 /* 5.6 perl has utf8 scalars but not hashes */
284 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
287 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
290 #define WEAKREF_CROAK() CROAK(("Cannot retrieve weak references in this perl"))
293 #ifdef HvPLACEHOLDERS
294 #define HAS_RESTRICTED_HASHES
296 #define HVhek_PLACEHOLD 0x200
297 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
301 #define HAS_HASH_KEY_FLAGS
305 #define USE_PTR_TABLE
309 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
310 * files remap tainted and dirty when threading is enabled. That's bad for
311 * perl to remap such common words. -- RAM, 29/09/00
315 typedef struct stcxt {
316 int entry; /* flags recursion */
317 int optype; /* type of traversal operation */
318 /* which objects have been seen, store time.
319 tags are numbers, which are cast to (SV *) and stored directly */
321 /* use pseen if we have ptr_tables. We have to store tag+1, because
322 tag numbers start at 0, and we can't store (SV *) 0 in a ptr_table
323 without it being confused for a fetch lookup failure. */
324 struct ptr_tbl *pseen;
325 /* Still need hseen for the 0.6 file format code. */
328 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
329 AV *aseen; /* which objects have been seen, retrieve time */
330 IV where_is_undef; /* index in aseen of PL_sv_undef */
331 HV *hclass; /* which classnames have been seen, store time */
332 AV *aclass; /* which classnames have been seen, retrieve time */
333 HV *hook; /* cache for hook methods per class name */
334 IV tagnum; /* incremented at store time for each seen object */
335 IV classnum; /* incremented at store time for each seen classname */
336 int netorder; /* true if network order used */
337 int s_tainted; /* true if input source is tainted, at retrieve time */
338 int forgive_me; /* whether to be forgiving... */
339 int deparse; /* whether to deparse code refs */
340 SV *eval; /* whether to eval source code */
341 int canonical; /* whether to store hashes sorted by key */
342 #ifndef HAS_RESTRICTED_HASHES
343 int derestrict; /* whether to downgrade restrcted hashes */
346 int use_bytes; /* whether to bytes-ify utf8 */
348 int accept_future_minor; /* croak immediately on future minor versions? */
349 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
350 int membuf_ro; /* true means membuf is read-only and msaved is rw */
351 struct extendable keybuf; /* for hash key retrieval */
352 struct extendable membuf; /* for memory store/retrieve operations */
353 struct extendable msaved; /* where potentially valid mbuf is saved */
354 PerlIO *fio; /* where I/O are performed, NULL for memory */
355 int ver_major; /* major of version for retrieved object */
356 int ver_minor; /* minor of version for retrieved object */
357 SV *(**retrieve_vtbl)(pTHX_ struct stcxt *, char *); /* retrieve dispatch table */
358 SV *prev; /* contexts chained backwards in real recursion */
359 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
362 #define NEW_STORABLE_CXT_OBJ(cxt) \
364 SV *self = newSV(sizeof(stcxt_t) - 1); \
365 SV *my_sv = newRV_noinc(self); \
366 sv_bless(my_sv, gv_stashpv("Storable::Cxt", TRUE)); \
367 cxt = (stcxt_t *)SvPVX(self); \
368 Zero(cxt, 1, stcxt_t); \
369 cxt->my_sv = my_sv; \
372 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
374 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
376 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
377 #else /* >= perl5.004_68 */
379 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
380 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
381 #endif /* < perl5.004_68 */
383 #define dSTCXT_PTR(T,name) \
384 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
385 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
388 dSTCXT_PTR(stcxt_t *, cxt)
392 NEW_STORABLE_CXT_OBJ(cxt); \
393 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
395 #define SET_STCXT(x) \
398 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
401 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
403 static stcxt_t *Context_ptr = NULL;
404 #define dSTCXT stcxt_t *cxt = Context_ptr
405 #define SET_STCXT(x) Context_ptr = x
408 NEW_STORABLE_CXT_OBJ(cxt); \
412 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
416 * Croaking implies a memory leak, since we don't use setjmp/longjmp
417 * to catch the exit and free memory used during store or retrieve
418 * operations. This is not too difficult to fix, but I need to understand
419 * how Perl does it, and croaking is exceptional anyway, so I lack the
420 * motivation to do it.
422 * The current workaround is to mark the context as dirty when croaking,
423 * so that data structures can be freed whenever we renter Storable code
424 * (but only *then*: it's a workaround, not a fix).
426 * This is also imperfect, because we don't really know how far they trapped
427 * the croak(), and when we were recursing, we won't be able to clean anything
428 * but the topmost context stacked.
431 #define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
434 * End of "thread-safe" related definitions.
440 * Keep only the low 32 bits of a pointer (used for tags, which are not
445 #define LOW_32BITS(x) ((I32) (x))
447 #define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
453 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
454 * Used in the WLEN and RLEN macros.
458 #define oI(x) ((I32 *) ((char *) (x) + 4))
459 #define oS(x) ((x) - 4)
460 #define oC(x) (x = 0)
469 * key buffer handling
471 #define kbuf (cxt->keybuf).arena
472 #define ksiz (cxt->keybuf).asiz
476 TRACEME(("** allocating kbuf of 128 bytes")); \
477 New(10003, kbuf, 128, char); \
484 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
485 Renew(kbuf, x+1, char); \
491 * memory buffer handling
493 #define mbase (cxt->membuf).arena
494 #define msiz (cxt->membuf).asiz
495 #define mptr (cxt->membuf).aptr
496 #define mend (cxt->membuf).aend
498 #define MGROW (1 << 13)
499 #define MMASK (MGROW - 1)
501 #define round_mgrow(x) \
502 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
503 #define trunc_int(x) \
504 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
505 #define int_aligned(x) \
506 ((unsigned long) (x) == trunc_int(x))
508 #define MBUF_INIT(x) \
511 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
512 New(10003, mbase, MGROW, char); \
513 msiz = (STRLEN)MGROW; \
519 mend = mbase + msiz; \
522 #define MBUF_TRUNC(x) mptr = mbase + x
523 #define MBUF_SIZE() (mptr - mbase)
529 * Those macros are used in do_retrieve() to save the current memory
530 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
531 * data from a string.
533 #define MBUF_SAVE_AND_LOAD(in) \
535 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
536 cxt->membuf_ro = 1; \
537 TRACEME(("saving mbuf")); \
538 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
542 #define MBUF_RESTORE() \
544 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
545 cxt->membuf_ro = 0; \
546 TRACEME(("restoring mbuf")); \
547 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
551 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
552 * See store_scalar() for other usage of this workaround.
554 #define MBUF_LOAD(v) \
556 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
558 CROAK(("Not a scalar string")); \
559 mptr = mbase = SvPV(v, msiz); \
560 mend = mbase + msiz; \
563 #define MBUF_XTEND(x) \
565 int nsz = (int) round_mgrow((x)+msiz); \
566 int offset = mptr - mbase; \
567 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
568 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
570 Renew(mbase, nsz, char); \
572 mptr = mbase + offset; \
573 mend = mbase + nsz; \
576 #define MBUF_CHK(x) \
578 if ((mptr + (x)) > mend) \
582 #define MBUF_GETC(x) \
585 x = (int) (unsigned char) *mptr++; \
591 #define MBUF_GETINT(x) \
594 if ((mptr + 4) <= mend) { \
595 memcpy(oI(&x), mptr, 4); \
601 #define MBUF_GETINT(x) \
603 if ((mptr + sizeof(int)) <= mend) { \
604 if (int_aligned(mptr)) \
607 memcpy(&x, mptr, sizeof(int)); \
608 mptr += sizeof(int); \
614 #define MBUF_READ(x,s) \
616 if ((mptr + (s)) <= mend) { \
617 memcpy(x, mptr, s); \
623 #define MBUF_SAFEREAD(x,s,z) \
625 if ((mptr + (s)) <= mend) { \
626 memcpy(x, mptr, s); \
634 #define MBUF_PUTC(c) \
637 *mptr++ = (char) c; \
640 *mptr++ = (char) c; \
645 #define MBUF_PUTINT(i) \
648 memcpy(mptr, oI(&i), 4); \
652 #define MBUF_PUTINT(i) \
654 MBUF_CHK(sizeof(int)); \
655 if (int_aligned(mptr)) \
658 memcpy(mptr, &i, sizeof(int)); \
659 mptr += sizeof(int); \
663 #define MBUF_WRITE(x,s) \
666 memcpy(mptr, x, s); \
671 * Possible return values for sv_type().
675 #define svis_SCALAR 1
679 #define svis_TIED_ITEM 5
687 #define SHF_TYPE_MASK 0x03
688 #define SHF_LARGE_CLASSLEN 0x04
689 #define SHF_LARGE_STRLEN 0x08
690 #define SHF_LARGE_LISTLEN 0x10
691 #define SHF_IDX_CLASSNAME 0x20
692 #define SHF_NEED_RECURSE 0x40
693 #define SHF_HAS_LIST 0x80
696 * Types for SX_HOOK (last 2 bits in flags).
702 #define SHT_EXTRA 3 /* Read extra byte for type */
705 * The following are held in the "extra byte"...
708 #define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
709 #define SHT_TARRAY 5 /* 4 + 1 -- tied array */
710 #define SHT_THASH 6 /* 4 + 2 -- tied hash */
713 * per hash flags for flagged hashes
716 #define SHV_RESTRICTED 0x01
719 * per key flags for flagged hashes
722 #define SHV_K_UTF8 0x01
723 #define SHV_K_WASUTF8 0x02
724 #define SHV_K_LOCKED 0x04
725 #define SHV_K_ISSV 0x08
726 #define SHV_K_PLACEHOLDER 0x10
729 * Before 0.6, the magic string was "perl-store" (binary version number 0).
731 * Since 0.6 introduced many binary incompatibilities, the magic string has
732 * been changed to "pst0" to allow an old image to be properly retrieved by
733 * a newer Storable, but ensure a newer image cannot be retrieved with an
736 * At 0.7, objects are given the ability to serialize themselves, and the
737 * set of markers is extended, backward compatibility is not jeopardized,
738 * so the binary version number could have remained unchanged. To correctly
739 * spot errors if a file making use of 0.7-specific extensions is given to
740 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
741 * a "minor" version, to better track this kind of evolution from now on.
744 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
745 static const char magicstr[] = "pst0"; /* Used as a magic number */
747 #define MAGICSTR_BYTES 'p','s','t','0'
748 #define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
750 /* 5.6.x introduced the ability to have IVs as long long.
751 However, Configure still defined BYTEORDER based on the size of a long.
752 Storable uses the BYTEORDER value as part of the header, but doesn't
753 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
754 with IV as long long on a platform that uses Configure (ie most things
755 except VMS and Windows) headers are identical for the different IV sizes,
756 despite the files containing some fields based on sizeof(IV)
758 5.8 is consistent - the following redifinition kludge is only needed on
759 5.6.x, but the interwork is needed on 5.8 while data survives in files
764 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
765 #ifndef NO_56_INTERWORK_KLUDGE
766 #define USE_56_INTERWORK_KLUDGE
768 #if BYTEORDER == 0x1234
770 #define BYTEORDER 0x12345678
772 #if BYTEORDER == 0x4321
774 #define BYTEORDER 0x87654321
779 #if BYTEORDER == 0x1234
780 #define BYTEORDER_BYTES '1','2','3','4'
782 #if BYTEORDER == 0x12345678
783 #define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
784 #ifdef USE_56_INTERWORK_KLUDGE
785 #define BYTEORDER_BYTES_56 '1','2','3','4'
788 #if BYTEORDER == 0x87654321
789 #define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
790 #ifdef USE_56_INTERWORK_KLUDGE
791 #define BYTEORDER_BYTES_56 '4','3','2','1'
794 #if BYTEORDER == 0x4321
795 #define BYTEORDER_BYTES '4','3','2','1'
797 #error Unknown byteorder. Please append your byteorder to Storable.xs
803 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
804 #ifdef USE_56_INTERWORK_KLUDGE
805 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
808 #define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
809 #define STORABLE_BIN_MINOR 7 /* Binary minor "version" */
811 #if (PATCHLEVEL <= 5)
812 #define STORABLE_BIN_WRITE_MINOR 4
815 * Perl 5.6.0 onwards can do weak references.
817 #define STORABLE_BIN_WRITE_MINOR 7
818 #endif /* (PATCHLEVEL <= 5) */
820 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
821 #define PL_sv_placeholder PL_sv_undef
825 * Useful store shortcuts...
829 * Note that if you put more than one mark for storing a particular
830 * type of thing, *and* in the retrieve_foo() function you mark both
831 * the thingy's you get off with SEEN(), you *must* increase the
832 * tagnum with cxt->tagnum++ along with this macro!
839 else if (PerlIO_putc(cxt->fio, x) == EOF) \
843 #define WRITE_I32(x) \
845 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
848 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
855 if (cxt->netorder) { \
856 int y = (int) htonl(x); \
859 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
864 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
869 #define WLEN(x) WRITE_I32(x)
876 else if (PerlIO_write(cxt->fio, x, y) != y) \
880 #define STORE_PV_LEN(pv, len, small, large) \
882 if (len <= LG_SCALAR) { \
883 unsigned char clen = (unsigned char) len; \
895 #define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
898 * Store &PL_sv_undef in arrays without recursing through store().
900 #define STORE_SV_UNDEF() \
903 PUTMARK(SX_SV_UNDEF); \
907 * Useful retrieve shortcuts...
911 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
917 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
921 #define READ_I32(x) \
923 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
927 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
937 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
940 x = (int) ntohl(x); \
943 #define RLEN(x) READ_I32(x)
950 else if (PerlIO_read(cxt->fio, x, y) != y) \
954 #define SAFEREAD(x,y,z) \
957 MBUF_SAFEREAD(x,y,z); \
958 else if (PerlIO_read(cxt->fio, x, y) != y) { \
965 * This macro is used at retrieve time, to remember where object 'y', bearing a
966 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
967 * we'll therefore know where it has been retrieved and will be able to
968 * share the same reference, as in the original stored memory image.
970 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
971 * on the objects given to STORABLE_thaw and expect that to be defined), and
972 * also for overloaded objects (for which we might not find the stash if the
973 * object is not blessed yet--this might occur for overloaded objects that
974 * refer to themselves indirectly: if we blessed upon return from a sub
975 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
976 * restored on it because the underlying object would not be blessed yet!).
978 * To achieve that, the class name of the last retrieved object is passed down
979 * recursively, and the first SEEN() call for which the class name is not NULL
980 * will bless the object.
982 * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
984 #define SEEN(y,c,i) \
988 if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
990 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
991 PTR2UV(y), SvREFCNT(y)-1)); \
993 BLESS((SV *) (y), c); \
997 * Bless `s' in `p', via a temporary reference, required by sv_bless().
1003 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
1004 stash = gv_stashpv((p), TRUE); \
1005 ref = newRV_noinc(s); \
1006 (void) sv_bless(ref, stash); \
1007 SvRV_set(ref, NULL); \
1008 SvREFCNT_dec(ref); \
1011 * sort (used in store_hash) - conditionally use qsort when
1012 * sortsv is not available ( <= 5.6.1 ).
1015 #if (PATCHLEVEL <= 6)
1017 #if defined(USE_ITHREADS)
1019 #define STORE_HASH_SORT \
1021 PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
1022 SAVESPTR(orig_perl); \
1023 PERL_SET_CONTEXT(aTHX); \
1024 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
1027 #else /* ! USE_ITHREADS */
1029 #define STORE_HASH_SORT \
1030 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1032 #endif /* USE_ITHREADS */
1034 #else /* PATCHLEVEL > 6 */
1036 #define STORE_HASH_SORT \
1037 sortsv(AvARRAY(av), len, Perl_sv_cmp);
1039 #endif /* PATCHLEVEL <= 6 */
1041 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1042 static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname);
1045 * Dynamic dispatching table for SV store.
1048 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1049 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1050 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1051 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1052 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1053 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1054 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1055 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1056 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1058 typedef int (*sv_store_t)(pTHX_ stcxt_t *cxt, SV *sv);
1060 static const sv_store_t sv_store[] = {
1061 (sv_store_t)store_ref, /* svis_REF */
1062 (sv_store_t)store_scalar, /* svis_SCALAR */
1063 (sv_store_t)store_array, /* svis_ARRAY */
1064 (sv_store_t)store_hash, /* svis_HASH */
1065 (sv_store_t)store_tied, /* svis_TIED */
1066 (sv_store_t)store_tied_item, /* svis_TIED_ITEM */
1067 (sv_store_t)store_code, /* svis_CODE */
1068 (sv_store_t)store_other, /* svis_OTHER */
1071 #define SV_STORE(x) (*sv_store[x])
1074 * Dynamic dispatching tables for SV retrieval.
1077 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname);
1078 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname);
1079 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
1080 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
1081 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname);
1082 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname);
1083 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname);
1084 static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname);
1085 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname);
1086 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname);
1087 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname);
1088 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname);
1089 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname);
1090 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname);
1091 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname);
1092 static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname);
1094 typedef SV* (*sv_retrieve_t)(pTHX_ stcxt_t *cxt, char *name);
1096 static const sv_retrieve_t sv_old_retrieve[] = {
1097 0, /* SX_OBJECT -- entry unused dynamically */
1098 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1099 (sv_retrieve_t)old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1100 (sv_retrieve_t)old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1101 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1102 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1103 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1104 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1105 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1106 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1107 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1108 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1109 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1110 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1111 (sv_retrieve_t)retrieve_other, /* SX_SV_UNDEF not supported */
1112 (sv_retrieve_t)retrieve_other, /* SX_SV_YES not supported */
1113 (sv_retrieve_t)retrieve_other, /* SX_SV_NO not supported */
1114 (sv_retrieve_t)retrieve_other, /* SX_BLESS not supported */
1115 (sv_retrieve_t)retrieve_other, /* SX_IX_BLESS not supported */
1116 (sv_retrieve_t)retrieve_other, /* SX_HOOK not supported */
1117 (sv_retrieve_t)retrieve_other, /* SX_OVERLOADED not supported */
1118 (sv_retrieve_t)retrieve_other, /* SX_TIED_KEY not supported */
1119 (sv_retrieve_t)retrieve_other, /* SX_TIED_IDX not supported */
1120 (sv_retrieve_t)retrieve_other, /* SX_UTF8STR not supported */
1121 (sv_retrieve_t)retrieve_other, /* SX_LUTF8STR not supported */
1122 (sv_retrieve_t)retrieve_other, /* SX_FLAG_HASH not supported */
1123 (sv_retrieve_t)retrieve_other, /* SX_CODE not supported */
1124 (sv_retrieve_t)retrieve_other, /* SX_WEAKREF not supported */
1125 (sv_retrieve_t)retrieve_other, /* SX_WEAKOVERLOAD not supported */
1126 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1129 static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
1130 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
1131 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname);
1132 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname);
1133 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname);
1134 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname);
1135 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname);
1136 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname);
1137 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname);
1138 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname);
1139 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname);
1140 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname);
1141 static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname);
1142 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, char *cname);
1143 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, char *cname);
1145 static const sv_retrieve_t sv_retrieve[] = {
1146 0, /* SX_OBJECT -- entry unused dynamically */
1147 (sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
1148 (sv_retrieve_t)retrieve_array, /* SX_ARRAY */
1149 (sv_retrieve_t)retrieve_hash, /* SX_HASH */
1150 (sv_retrieve_t)retrieve_ref, /* SX_REF */
1151 (sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
1152 (sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
1153 (sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
1154 (sv_retrieve_t)retrieve_byte, /* SX_BYTE */
1155 (sv_retrieve_t)retrieve_netint, /* SX_NETINT */
1156 (sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
1157 (sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
1158 (sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
1159 (sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
1160 (sv_retrieve_t)retrieve_sv_undef, /* SX_SV_UNDEF */
1161 (sv_retrieve_t)retrieve_sv_yes, /* SX_SV_YES */
1162 (sv_retrieve_t)retrieve_sv_no, /* SX_SV_NO */
1163 (sv_retrieve_t)retrieve_blessed, /* SX_BLESS */
1164 (sv_retrieve_t)retrieve_idx_blessed, /* SX_IX_BLESS */
1165 (sv_retrieve_t)retrieve_hook, /* SX_HOOK */
1166 (sv_retrieve_t)retrieve_overloaded, /* SX_OVERLOAD */
1167 (sv_retrieve_t)retrieve_tied_key, /* SX_TIED_KEY */
1168 (sv_retrieve_t)retrieve_tied_idx, /* SX_TIED_IDX */
1169 (sv_retrieve_t)retrieve_utf8str, /* SX_UTF8STR */
1170 (sv_retrieve_t)retrieve_lutf8str, /* SX_LUTF8STR */
1171 (sv_retrieve_t)retrieve_flag_hash, /* SX_HASH */
1172 (sv_retrieve_t)retrieve_code, /* SX_CODE */
1173 (sv_retrieve_t)retrieve_weakref, /* SX_WEAKREF */
1174 (sv_retrieve_t)retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
1175 (sv_retrieve_t)retrieve_other, /* SX_ERROR */
1178 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1180 static SV *mbuf2sv(pTHX);
1183 *** Context management.
1189 * Called once per "thread" (interpreter) to initialize some global context.
1191 static void init_perinterp(pTHX)
1195 cxt->netorder = 0; /* true if network order used */
1196 cxt->forgive_me = -1; /* whether to be forgiving... */
1197 cxt->accept_future_minor = -1; /* would otherwise occur too late */
1203 * Called at the end of every context cleaning, to perform common reset
1206 static void reset_context(stcxt_t *cxt)
1210 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1214 * init_store_context
1216 * Initialize a new store context for real recursion.
1218 static void init_store_context(
1225 TRACEME(("init_store_context"));
1227 cxt->netorder = network_order;
1228 cxt->forgive_me = -1; /* Fetched from perl if needed */
1229 cxt->deparse = -1; /* Idem */
1230 cxt->eval = NULL; /* Idem */
1231 cxt->canonical = -1; /* Idem */
1232 cxt->tagnum = -1; /* Reset tag numbers */
1233 cxt->classnum = -1; /* Reset class numbers */
1234 cxt->fio = f; /* Where I/O are performed */
1235 cxt->optype = optype; /* A store, or a deep clone */
1236 cxt->entry = 1; /* No recursion yet */
1239 * The `hseen' table is used to keep track of each SV stored and their
1240 * associated tag numbers is special. It is "abused" because the
1241 * values stored are not real SV, just integers cast to (SV *),
1242 * which explains the freeing below.
1244 * It is also one possible bottlneck to achieve good storing speed,
1245 * so the "shared keys" optimization is turned off (unlikely to be
1246 * of any use here), and the hash table is "pre-extended". Together,
1247 * those optimizations increase the throughput by 12%.
1250 #ifdef USE_PTR_TABLE
1251 cxt->pseen = ptr_table_new();
1254 cxt->hseen = newHV(); /* Table where seen objects are stored */
1255 HvSHAREKEYS_off(cxt->hseen);
1258 * The following does not work well with perl5.004_04, and causes
1259 * a core dump later on, in a completely unrelated spot, which
1260 * makes me think there is a memory corruption going on.
1262 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1263 * it below does not make any difference. It seems to work fine
1264 * with perl5.004_68 but given the probable nature of the bug,
1265 * that does not prove anything.
1267 * It's a shame because increasing the amount of buckets raises
1268 * store() throughput by 5%, but until I figure this out, I can't
1269 * allow for this to go into production.
1271 * It is reported fixed in 5.005, hence the #if.
1273 #if PERL_VERSION >= 5
1274 #define HBUCKETS 4096 /* Buckets for %hseen */
1275 #ifndef USE_PTR_TABLE
1276 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1281 * The `hclass' hash uses the same settings as `hseen' above, but it is
1282 * used to assign sequential tags (numbers) to class names for blessed
1285 * We turn the shared key optimization on.
1288 cxt->hclass = newHV(); /* Where seen classnames are stored */
1290 #if PERL_VERSION >= 5
1291 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1295 * The `hook' hash table is used to keep track of the references on
1296 * the STORABLE_freeze hook routines, when found in some class name.
1298 * It is assumed that the inheritance tree will not be changed during
1299 * storing, and that no new method will be dynamically created by the
1303 cxt->hook = newHV(); /* Table where hooks are cached */
1306 * The `hook_seen' array keeps track of all the SVs returned by
1307 * STORABLE_freeze hooks for us to serialize, so that they are not
1308 * reclaimed until the end of the serialization process. Each SV is
1309 * only stored once, the first time it is seen.
1312 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
1316 * clean_store_context
1318 * Clean store context by
1320 static void clean_store_context(pTHX_ stcxt_t *cxt)
1324 TRACEME(("clean_store_context"));
1326 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1329 * Insert real values into hashes where we stored faked pointers.
1332 #ifndef USE_PTR_TABLE
1334 hv_iterinit(cxt->hseen);
1335 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
1336 HeVAL(he) = &PL_sv_undef;
1341 hv_iterinit(cxt->hclass);
1342 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1343 HeVAL(he) = &PL_sv_undef;
1347 * And now dispose of them...
1349 * The surrounding if() protection has been added because there might be
1350 * some cases where this routine is called more than once, during
1351 * exceptionnal events. This was reported by Marc Lehmann when Storable
1352 * is executed from mod_perl, and the fix was suggested by him.
1353 * -- RAM, 20/12/2000
1356 #ifdef USE_PTR_TABLE
1358 struct ptr_tbl *pseen = cxt->pseen;
1360 ptr_table_free(pseen);
1362 assert(!cxt->hseen);
1365 HV *hseen = cxt->hseen;
1368 sv_free((SV *) hseen);
1373 HV *hclass = cxt->hclass;
1376 sv_free((SV *) hclass);
1380 HV *hook = cxt->hook;
1383 sv_free((SV *) hook);
1386 if (cxt->hook_seen) {
1387 AV *hook_seen = cxt->hook_seen;
1389 av_undef(hook_seen);
1390 sv_free((SV *) hook_seen);
1393 cxt->forgive_me = -1; /* Fetched from perl if needed */
1394 cxt->deparse = -1; /* Idem */
1396 SvREFCNT_dec(cxt->eval);
1398 cxt->eval = NULL; /* Idem */
1399 cxt->canonical = -1; /* Idem */
1405 * init_retrieve_context
1407 * Initialize a new retrieve context for real recursion.
1409 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1411 TRACEME(("init_retrieve_context"));
1414 * The hook hash table is used to keep track of the references on
1415 * the STORABLE_thaw hook routines, when found in some class name.
1417 * It is assumed that the inheritance tree will not be changed during
1418 * storing, and that no new method will be dynamically created by the
1422 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1424 #ifdef USE_PTR_TABLE
1429 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1430 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1431 * the correspondance between the tags and the tag number used by the
1432 * new retrieve routines.
1435 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1438 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1439 cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
1440 cxt->aclass = newAV(); /* Where seen classnames are kept */
1441 cxt->tagnum = 0; /* Have to count objects... */
1442 cxt->classnum = 0; /* ...and class names as well */
1443 cxt->optype = optype;
1444 cxt->s_tainted = is_tainted;
1445 cxt->entry = 1; /* No recursion yet */
1446 #ifndef HAS_RESTRICTED_HASHES
1447 cxt->derestrict = -1; /* Fetched from perl if needed */
1449 #ifndef HAS_UTF8_ALL
1450 cxt->use_bytes = -1; /* Fetched from perl if needed */
1452 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1456 * clean_retrieve_context
1458 * Clean retrieve context by
1460 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1462 TRACEME(("clean_retrieve_context"));
1464 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1467 AV *aseen = cxt->aseen;
1470 sv_free((SV *) aseen);
1472 cxt->where_is_undef = -1;
1475 AV *aclass = cxt->aclass;
1478 sv_free((SV *) aclass);
1482 HV *hook = cxt->hook;
1485 sv_free((SV *) hook);
1489 HV *hseen = cxt->hseen;
1492 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1495 #ifndef HAS_RESTRICTED_HASHES
1496 cxt->derestrict = -1; /* Fetched from perl if needed */
1498 #ifndef HAS_UTF8_ALL
1499 cxt->use_bytes = -1; /* Fetched from perl if needed */
1501 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1509 * A workaround for the CROAK bug: cleanup the last context.
1511 static void clean_context(pTHX_ stcxt_t *cxt)
1513 TRACEME(("clean_context"));
1515 ASSERT(cxt->s_dirty, ("dirty context"));
1520 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1522 if (cxt->optype & ST_RETRIEVE)
1523 clean_retrieve_context(aTHX_ cxt);
1524 else if (cxt->optype & ST_STORE)
1525 clean_store_context(aTHX_ cxt);
1529 ASSERT(!cxt->s_dirty, ("context is clean"));
1530 ASSERT(cxt->entry == 0, ("context is reset"));
1536 * Allocate a new context and push it on top of the parent one.
1537 * This new context is made globally visible via SET_STCXT().
1539 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1543 TRACEME(("allocate_context"));
1545 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1547 NEW_STORABLE_CXT_OBJ(cxt);
1548 cxt->prev = parent_cxt->my_sv;
1551 ASSERT(!cxt->s_dirty, ("clean context"));
1559 * Free current context, which cannot be the "root" one.
1560 * Make the context underneath globally visible via SET_STCXT().
1562 static void free_context(pTHX_ stcxt_t *cxt)
1564 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1566 TRACEME(("free_context"));
1568 ASSERT(!cxt->s_dirty, ("clean context"));
1569 ASSERT(prev, ("not freeing root context"));
1571 SvREFCNT_dec(cxt->my_sv);
1574 ASSERT(cxt, ("context not void"));
1584 * Tells whether we're in the middle of a store operation.
1586 int is_storing(pTHX)
1590 return cxt->entry && (cxt->optype & ST_STORE);
1596 * Tells whether we're in the middle of a retrieve operation.
1598 int is_retrieving(pTHX)
1602 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1606 * last_op_in_netorder
1608 * Returns whether last operation was made using network order.
1610 * This is typically out-of-band information that might prove useful
1611 * to people wishing to convert native to network order data when used.
1613 int last_op_in_netorder(pTHX)
1617 return cxt->netorder;
1621 *** Hook lookup and calling routines.
1627 * A wrapper on gv_fetchmethod_autoload() which caches results.
1629 * Returns the routine reference as an SV*, or null if neither the package
1630 * nor its ancestors know about the method.
1632 static SV *pkg_fetchmeth(
1642 * The following code is the same as the one performed by UNIVERSAL::can
1646 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1647 if (gv && isGV(gv)) {
1648 sv = newRV((SV*) GvCV(gv));
1649 TRACEME(("%s->%s: 0x%"UVxf, HvNAME(pkg), method, PTR2UV(sv)));
1651 sv = newSVsv(&PL_sv_undef);
1652 TRACEME(("%s->%s: not found", HvNAME(pkg), method));
1656 * Cache the result, ignoring failure: if we can't store the value,
1657 * it just won't be cached.
1660 (void) hv_store(cache, HvNAME(pkg), strlen(HvNAME(pkg)), sv, 0);
1662 return SvOK(sv) ? sv : (SV *) 0;
1668 * Force cached value to be undef: hook ignored even if present.
1670 static void pkg_hide(
1676 (void) hv_store(cache,
1677 HvNAME(pkg), strlen(HvNAME(pkg)), newSVsv(&PL_sv_undef), 0);
1683 * Discard cached value: a whole fetch loop will be retried at next lookup.
1685 static void pkg_uncache(
1691 (void) hv_delete(cache, HvNAME(pkg), strlen(HvNAME(pkg)), G_DISCARD);
1697 * Our own "UNIVERSAL::can", which caches results.
1699 * Returns the routine reference as an SV*, or null if the object does not
1700 * know about the method.
1711 TRACEME(("pkg_can for %s->%s", HvNAME(pkg), method));
1714 * Look into the cache to see whether we already have determined
1715 * where the routine was, if any.
1717 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1718 * that only one hook (i.e. always the same) is cached in a given cache.
1721 svh = hv_fetch(cache, HvNAME(pkg), strlen(HvNAME(pkg)), FALSE);
1725 TRACEME(("cached %s->%s: not found", HvNAME(pkg), method));
1728 TRACEME(("cached %s->%s: 0x%"UVxf,
1729 HvNAME(pkg), method, PTR2UV(sv)));
1734 TRACEME(("not cached yet"));
1735 return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
1741 * Call routine as obj->hook(av) in scalar context.
1742 * Propagates the single returned value if not called in void context.
1744 static SV *scalar_call(
1756 TRACEME(("scalar_call (cloning=%d)", cloning));
1763 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1765 SV **ary = AvARRAY(av);
1766 int cnt = AvFILLp(av) + 1;
1768 XPUSHs(ary[0]); /* Frozen string */
1769 for (i = 1; i < cnt; i++) {
1770 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1771 i, PTR2UV(ary[i])));
1772 XPUSHs(sv_2mortal(newRV(ary[i])));
1777 TRACEME(("calling..."));
1778 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1779 TRACEME(("count = %d", count));
1785 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1798 * Call routine obj->hook(cloning) in list context.
1799 * Returns the list of returned values in an array.
1801 static AV *array_call(
1812 TRACEME(("array_call (cloning=%d)", cloning));
1818 XPUSHs(obj); /* Target object */
1819 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1822 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1827 for (i = count - 1; i >= 0; i--) {
1829 av_store(av, i, SvREFCNT_inc(sv));
1842 * Lookup the class name in the `hclass' table and either assign it a new ID
1843 * or return the existing one, by filling in `classnum'.
1845 * Return true if the class was known, false if the ID was just generated.
1847 static int known_class(
1850 char *name, /* Class name */
1851 int len, /* Name length */
1855 HV *hclass = cxt->hclass;
1857 TRACEME(("known_class (%s)", name));
1860 * Recall that we don't store pointers in this hash table, but tags.
1861 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1864 svh = hv_fetch(hclass, name, len, FALSE);
1866 *classnum = LOW_32BITS(*svh);
1871 * Unknown classname, we need to record it.
1875 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1876 CROAK(("Unable to record new classname"));
1878 *classnum = cxt->classnum;
1883 *** Sepcific store routines.
1889 * Store a reference.
1890 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1892 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1895 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1898 * Follow reference, and check if target is overloaded.
1904 TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1909 HV *stash = (HV *) SvSTASH(sv);
1910 if (stash && Gv_AMG(stash)) {
1911 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1912 PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1914 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1916 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1918 return store(aTHX_ cxt, sv);
1926 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1927 * The <data> section is omitted if <length> is 0.
1929 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1930 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1932 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
1937 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1939 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1942 * For efficiency, break the SV encapsulation by peaking at the flags
1943 * directly without using the Perl macros to avoid dereferencing
1944 * sv->sv_flags each time we wish to check the flags.
1947 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1948 if (sv == &PL_sv_undef) {
1949 TRACEME(("immortal undef"));
1950 PUTMARK(SX_SV_UNDEF);
1952 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
1959 * Always store the string representation of a scalar if it exists.
1960 * Gisle Aas provided me with this test case, better than a long speach:
1962 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1963 * SV = PVNV(0x80c8520)
1965 * FLAGS = (NOK,POK,pNOK,pPOK)
1968 * PV = 0x80c83d0 "abc"\0
1972 * Write SX_SCALAR, length, followed by the actual data.
1974 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
1975 * appropriate, followed by the actual (binary) data. A double
1976 * is written as a string if network order, for portability.
1978 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
1979 * The reason is that when the scalar value is tainted, the SvNOK(sv)
1982 * The test for a read-only scalar with both POK and NOK set is meant
1983 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
1984 * address comparison for each scalar we store.
1987 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
1989 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
1990 if (sv == &PL_sv_yes) {
1991 TRACEME(("immortal yes"));
1993 } else if (sv == &PL_sv_no) {
1994 TRACEME(("immortal no"));
1997 pv = SvPV(sv, len); /* We know it's SvPOK */
1998 goto string; /* Share code below */
2000 } else if (flags & SVf_POK) {
2001 /* public string - go direct to string read. */
2002 goto string_readlen;
2004 #if (PATCHLEVEL <= 6)
2005 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
2006 direct if NV flag is off. */
2007 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
2009 /* 5.7 rules are that if IV public flag is set, IV value is as
2010 good, if not better, than NV value. */
2016 * Will come here from below with iv set if double is an integer.
2020 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2022 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
2023 * (for example) and that ends up in the optimised small integer
2026 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
2027 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
2028 goto string_readlen;
2032 * Optimize small integers into a single byte, otherwise store as
2033 * a real integer (converted into network order if they asked).
2036 if (iv >= -128 && iv <= 127) {
2037 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
2040 TRACEME(("small integer stored as %d", siv));
2041 } else if (cxt->netorder) {
2043 TRACEME(("no htonl, fall back to string for integer"));
2044 goto string_readlen;
2052 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
2053 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
2055 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
2056 /* Bigger than 32 bits. */
2057 TRACEME(("large network order integer as string, value = %"IVdf, iv));
2058 goto string_readlen;
2062 niv = (I32) htonl((I32) iv);
2063 TRACEME(("using network order"));
2068 PUTMARK(SX_INTEGER);
2069 WRITE(&iv, sizeof(iv));
2072 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2073 } else if (flags & SVf_NOK) {
2075 #if (PATCHLEVEL <= 6)
2078 * Watch for number being an integer in disguise.
2080 if (nv == (NV) (iv = I_V(nv))) {
2081 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2082 goto integer; /* Share code above */
2087 if (SvIOK_notUV(sv)) {
2089 goto integer; /* Share code above */
2094 if (cxt->netorder) {
2095 TRACEME(("double %"NVff" stored as string", nv));
2096 goto string_readlen; /* Share code below */
2100 WRITE(&nv, sizeof(nv));
2102 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2104 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2105 I32 wlen; /* For 64-bit machines */
2111 * Will come here from above if it was readonly, POK and NOK but
2112 * neither &PL_sv_yes nor &PL_sv_no.
2116 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2118 STORE_UTF8STR(pv, wlen);
2120 STORE_SCALAR(pv, wlen);
2121 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2122 PTR2UV(sv), SvPVX(sv), (IV)len));
2124 CROAK(("Can't determine type of %s(0x%"UVxf")",
2125 sv_reftype(sv, FALSE),
2127 return 0; /* Ok, no recursion on scalars */
2135 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2136 * Each item is stored as <object>.
2138 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2141 I32 len = av_len(av) + 1;
2145 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2148 * Signal array by emitting SX_ARRAY, followed by the array length.
2153 TRACEME(("size = %d", len));
2156 * Now store each item recursively.
2159 for (i = 0; i < len; i++) {
2160 sav = av_fetch(av, i, 0);
2162 TRACEME(("(#%d) undef item", i));
2166 TRACEME(("(#%d) item", i));
2167 if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
2171 TRACEME(("ok (array)"));
2177 #if (PATCHLEVEL <= 6)
2183 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2186 sortcmp(const void *a, const void *b)
2188 #if defined(USE_ITHREADS)
2190 #endif /* USE_ITHREADS */
2191 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2194 #endif /* PATCHLEVEL <= 6 */
2199 * Store a hash table.
2201 * For a "normal" hash (not restricted, no utf8 keys):
2203 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2204 * Values are stored as <object>.
2205 * Keys are stored as <length> <data>, the <data> section being omitted
2208 * For a "fancy" hash (restricted or utf8 keys):
2210 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2212 * Values are stored as <object>.
2213 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2215 * Currently the only hash flag is "restriced"
2216 * Key flags are as for hv.h
2218 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2222 #ifdef HAS_RESTRICTED_HASHES
2231 int flagged_hash = ((SvREADONLY(hv)
2232 #ifdef HAS_HASH_KEY_FLAGS
2236 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2239 /* needs int cast for C++ compilers, doesn't it? */
2240 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2243 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2247 * Signal hash by emitting SX_HASH, followed by the table length.
2251 PUTMARK(SX_FLAG_HASH);
2252 PUTMARK(hash_flags);
2257 TRACEME(("size = %d", len));
2260 * Save possible iteration state via each() on that table.
2263 riter = HvRITER(hv);
2264 eiter = HvEITER(hv);
2268 * Now store each item recursively.
2270 * If canonical is defined to some true value then store each
2271 * key/value pair in sorted order otherwise the order is random.
2272 * Canonical order is irrelevant when a deep clone operation is performed.
2274 * Fetch the value from perl only once per store() operation, and only
2279 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2280 (cxt->canonical < 0 && (cxt->canonical =
2281 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2284 * Storing in order, sorted by key.
2285 * Run through the hash, building up an array of keys in a
2286 * mortal array, sort the array and then run through the
2292 /*av_extend (av, len);*/
2294 TRACEME(("using canonical order"));
2296 for (i = 0; i < len; i++) {
2297 #ifdef HAS_RESTRICTED_HASHES
2298 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2300 HE *he = hv_iternext(hv);
2302 SV *key = hv_iterkeysv(he);
2303 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2308 for (i = 0; i < len; i++) {
2309 #ifdef HAS_RESTRICTED_HASHES
2310 int placeholders = (int)HvPLACEHOLDERS_get(hv);
2312 unsigned char flags = 0;
2316 SV *key = av_shift(av);
2317 /* This will fail if key is a placeholder.
2318 Track how many placeholders we have, and error if we
2320 HE *he = hv_fetch_ent(hv, key, 0, 0);
2324 if (!(val = HeVAL(he))) {
2325 /* Internal error, not I/O error */
2329 #ifdef HAS_RESTRICTED_HASHES
2330 /* Should be a placeholder. */
2331 if (placeholders-- < 0) {
2332 /* This should not happen - number of
2333 retrieves should be identical to
2334 number of placeholders. */
2337 /* Value is never needed, and PL_sv_undef is
2338 more space efficient to store. */
2341 ("Flags not 0 but %d", flags));
2342 flags = SHV_K_PLACEHOLDER;
2349 * Store value first.
2352 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2354 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2359 * Keys are written after values to make sure retrieval
2360 * can be optimal in terms of memory usage, where keys are
2361 * read into a fixed unique buffer called kbuf.
2362 * See retrieve_hash() for details.
2365 /* Implementation of restricted hashes isn't nicely
2367 if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
2368 flags |= SHV_K_LOCKED;
2371 keyval = SvPV(key, keylen_tmp);
2372 keylen = keylen_tmp;
2373 #ifdef HAS_UTF8_HASHES
2374 /* If you build without optimisation on pre 5.6
2375 then nothing spots that SvUTF8(key) is always 0,
2376 so the block isn't optimised away, at which point
2377 the linker dislikes the reference to
2380 const char *keysave = keyval;
2381 bool is_utf8 = TRUE;
2383 /* Just casting the &klen to (STRLEN) won't work
2384 well if STRLEN and I32 are of different widths.
2386 keyval = (char*)bytes_from_utf8((U8*)keyval,
2390 /* If we were able to downgrade here, then than
2391 means that we have a key which only had chars
2392 0-255, but was utf8 encoded. */
2394 if (keyval != keysave) {
2395 keylen = keylen_tmp;
2396 flags |= SHV_K_WASUTF8;
2398 /* keylen_tmp can't have changed, so no need
2399 to assign back to keylen. */
2400 flags |= SHV_K_UTF8;
2407 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2409 /* This is a workaround for a bug in 5.8.0
2410 that causes the HEK_WASUTF8 flag to be
2411 set on an HEK without the hash being
2412 marked as having key flags. We just
2413 cross our fingers and drop the flag.
2415 assert (flags == 0 || flags == SHV_K_WASUTF8);
2416 TRACEME(("(#%d) key '%s'", i, keyval));
2420 WRITE(keyval, keylen);
2421 if (flags & SHV_K_WASUTF8)
2426 * Free up the temporary array
2435 * Storing in "random" order (in the order the keys are stored
2436 * within the hash). This is the default and will be faster!
2439 for (i = 0; i < len; i++) {
2442 unsigned char flags;
2443 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2444 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2446 HE *he = hv_iternext(hv);
2448 SV *val = (he ? hv_iterval(hv, he) : 0);
2453 return 1; /* Internal error, not I/O error */
2455 /* Implementation of restricted hashes isn't nicely
2458 = (((hash_flags & SHV_RESTRICTED)
2460 ? SHV_K_LOCKED : 0);
2462 if (val == &PL_sv_placeholder) {
2463 flags |= SHV_K_PLACEHOLDER;
2468 * Store value first.
2471 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2473 if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
2477 hek = HeKEY_hek(he);
2479 if (len == HEf_SVKEY) {
2480 /* This is somewhat sick, but the internal APIs are
2481 * such that XS code could put one of these in in
2483 * Maybe we should be capable of storing one if
2486 key_sv = HeKEY_sv(he);
2487 flags |= SHV_K_ISSV;
2489 /* Regular string key. */
2490 #ifdef HAS_HASH_KEY_FLAGS
2492 flags |= SHV_K_UTF8;
2493 if (HEK_WASUTF8(hek))
2494 flags |= SHV_K_WASUTF8;
2500 * Keys are written after values to make sure retrieval
2501 * can be optimal in terms of memory usage, where keys are
2502 * read into a fixed unique buffer called kbuf.
2503 * See retrieve_hash() for details.
2508 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2510 /* This is a workaround for a bug in 5.8.0
2511 that causes the HEK_WASUTF8 flag to be
2512 set on an HEK without the hash being
2513 marked as having key flags. We just
2514 cross our fingers and drop the flag.
2516 assert (flags == 0 || flags == SHV_K_WASUTF8);
2517 TRACEME(("(#%d) key '%s'", i, key));
2519 if (flags & SHV_K_ISSV) {
2520 store(aTHX_ cxt, key_sv);
2529 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2532 HvRITER(hv) = riter; /* Restore hash iterator state */
2533 HvEITER(hv) = eiter;
2541 * Store a code reference.
2543 * Layout is SX_CODE <length> followed by a scalar containing the perl
2544 * source code of the code reference.
2546 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2548 #if PERL_VERSION < 6
2550 * retrieve_code does not work with perl 5.005 or less
2552 return store_other(aTHX_ cxt, (SV*)cv);
2557 SV *text, *bdeparse;
2559 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2562 cxt->deparse == 0 ||
2563 (cxt->deparse < 0 && !(cxt->deparse =
2564 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2566 return store_other(aTHX_ cxt, (SV*)cv);
2570 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2571 * blessed code references.
2573 /* Ownership of both SVs is passed to load_module, which frees them. */
2574 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2580 * create the B::Deparse object
2584 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2586 count = call_method("new", G_SCALAR);
2589 CROAK(("Unexpected return value from B::Deparse::new\n"));
2593 * call the coderef2text method
2597 XPUSHs(bdeparse); /* XXX is this already mortal? */
2598 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2600 count = call_method("coderef2text", G_SCALAR);
2603 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2607 reallen = strlen(SvPV_nolen(text));
2610 * Empty code references or XS functions are deparsed as
2611 * "(prototype) ;" or ";".
2614 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2615 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2619 * Signal code by emitting SX_CODE.
2623 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
2624 TRACEME(("size = %d", len));
2625 TRACEME(("code = %s", SvPV_nolen(text)));
2628 * Now store the source code.
2631 STORE_SCALAR(SvPV_nolen(text), len);
2636 TRACEME(("ok (code)"));
2645 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2646 * a special mark, followed by the underlying tied object. For instance, when
2647 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2648 * <hash object> stands for the serialization of the tied hash.
2650 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2655 int svt = SvTYPE(sv);
2658 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2661 * We have a small run-time penalty here because we chose to factorise
2662 * all tieds objects into the same routine, and not have a store_tied_hash,
2663 * a store_tied_array, etc...
2665 * Don't use a switch() statement, as most compilers don't optimize that
2666 * well for 2/3 values. An if() else if() cascade is just fine. We put
2667 * tied hashes first, as they are the most likely beasts.
2670 if (svt == SVt_PVHV) {
2671 TRACEME(("tied hash"));
2672 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2673 } else if (svt == SVt_PVAV) {
2674 TRACEME(("tied array"));
2675 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2677 TRACEME(("tied scalar"));
2678 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2682 if (!(mg = mg_find(sv, mtype)))
2683 CROAK(("No magic '%c' found while storing tied %s", mtype,
2684 (svt == SVt_PVHV) ? "hash" :
2685 (svt == SVt_PVAV) ? "array" : "scalar"));
2688 * The mg->mg_obj found by mg_find() above actually points to the
2689 * underlying tied Perl object implementation. For instance, if the
2690 * original SV was that of a tied array, then mg->mg_obj is an AV.
2692 * Note that we store the Perl object as-is. We don't call its FETCH
2693 * method along the way. At retrieval time, we won't call its STORE
2694 * method either, but the tieing magic will be re-installed. In itself,
2695 * that ensures that the tieing semantics are preserved since futher
2696 * accesses on the retrieved object will indeed call the magic methods...
2699 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2700 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2701 if ((ret = store(aTHX_ cxt, obj)))
2704 TRACEME(("ok (tied)"));
2712 * Stores a reference to an item within a tied structure:
2714 * . \$h{key}, stores both the (tied %h) object and 'key'.
2715 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2717 * Layout is therefore either:
2718 * SX_TIED_KEY <object> <key>
2719 * SX_TIED_IDX <object> <index>
2721 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2726 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2728 if (!(mg = mg_find(sv, 'p')))
2729 CROAK(("No magic 'p' found while storing reference to tied item"));
2732 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2736 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2737 PUTMARK(SX_TIED_KEY);
2738 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2740 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
2743 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2745 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
2748 I32 idx = mg->mg_len;
2750 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2751 PUTMARK(SX_TIED_IDX);
2752 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2754 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
2757 TRACEME(("store_tied_item: storing IDX %d", idx));
2762 TRACEME(("ok (tied item)"));
2768 * store_hook -- dispatched manually, not via sv_store[]
2770 * The blessed SV is serialized by a hook.
2774 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2776 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2777 * the trailing part [] is present, the type of object (scalar, array or hash).
2778 * There is also a bit which says how the classname is stored between:
2783 * and when the <index> form is used (classname already seen), the "large
2784 * classname" bit in <flags> indicates how large the <index> is.
2786 * The serialized string returned by the hook is of length <len2> and comes
2787 * next. It is an opaque string for us.
2789 * Those <len3> object IDs which are listed last represent the extra references
2790 * not directly serialized by the hook, but which are linked to the object.
2792 * When recursion is mandated to resolve object-IDs not yet seen, we have
2793 * instead, with <header> being flags with bits set to indicate the object type
2794 * and that recursion was indeed needed:
2796 * SX_HOOK <header> <object> <header> <object> <flags>
2798 * that same header being repeated between serialized objects obtained through
2799 * recursion, until we reach flags indicating no recursion, at which point
2800 * we know we've resynchronized with a single layout, after <flags>.
2802 * When storing a blessed ref to a tied variable, the following format is
2805 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2807 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2808 * real object type is held in the <extra> flag. At the very end of the
2809 * serialization stream, the underlying magic object is serialized, just like
2810 * any other tied variable.
2812 static int store_hook(
2826 int count; /* really len3 + 1 */
2827 unsigned char flags;
2830 int recursed = 0; /* counts recursion */
2831 int obj_type; /* object type, on 2 bits */
2834 int clone = cxt->optype & ST_CLONE;
2835 char mtype = '\0'; /* for blessed ref to tied structures */
2836 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
2838 TRACEME(("store_hook, classname \"%s\", tagged #%d", HvNAME(pkg), cxt->tagnum));
2841 * Determine object type on 2 bits.
2846 obj_type = SHT_SCALAR;
2849 obj_type = SHT_ARRAY;
2852 obj_type = SHT_HASH;
2856 * Produced by a blessed ref to a tied data structure, $o in the
2857 * following Perl code.
2861 * my $o = bless \%h, 'BAR';
2863 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2864 * (since we have only 2 bits in <flags> to store the type), and an
2865 * <extra> byte flag will be emitted after the FIRST <flags> in the
2866 * stream, carrying what we put in `eflags'.
2868 obj_type = SHT_EXTRA;
2869 switch (SvTYPE(sv)) {
2871 eflags = (unsigned char) SHT_THASH;
2875 eflags = (unsigned char) SHT_TARRAY;
2879 eflags = (unsigned char) SHT_TSCALAR;
2885 CROAK(("Unexpected object type (%d) in store_hook()", type));
2887 flags = SHF_NEED_RECURSE | obj_type;
2889 classname = HvNAME(pkg);
2890 len = strlen(classname);
2893 * To call the hook, we need to fake a call like:
2895 * $object->STORABLE_freeze($cloning);
2897 * but we don't have the $object here. For instance, if $object is
2898 * a blessed array, what we have in `sv' is the array, and we can't
2899 * call a method on those.
2901 * Therefore, we need to create a temporary reference to the object and
2902 * make the call on that reference.
2905 TRACEME(("about to call STORABLE_freeze on class %s", classname));
2907 ref = newRV_noinc(sv); /* Temporary reference */
2908 av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2909 SvRV_set(ref, NULL);
2910 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2912 count = AvFILLp(av) + 1;
2913 TRACEME(("store_hook, array holds %d items", count));
2916 * If they return an empty list, it means they wish to ignore the
2917 * hook for this class (and not just this instance -- that's for them
2918 * to handle if they so wish).
2920 * Simply disable the cached entry for the hook (it won't be recomputed
2921 * since it's present in the cache) and recurse to store_blessed().
2926 * They must not change their mind in the middle of a serialization.
2929 if (hv_fetch(cxt->hclass, classname, len, FALSE))
2930 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2931 (cxt->optype & ST_CLONE) ? "cloning" : "storing", classname));
2933 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
2935 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2936 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", classname));
2938 return store_blessed(aTHX_ cxt, sv, type, pkg);
2942 * Get frozen string.
2946 pv = SvPV(ary[0], len2);
2947 /* We can't use pkg_can here because it only caches one method per
2950 GV* gv = gv_fetchmethod_autoload(pkg, "STORABLE_attach", FALSE);
2951 if (gv && isGV(gv)) {
2953 CROAK(("Freeze cannot return references if %s class is using STORABLE_attach", classname));
2959 * If they returned more than one item, we need to serialize some
2960 * extra references if not already done.
2962 * Loop over the array, starting at position #1, and for each item,
2963 * ensure it is a reference, serialize it if not already done, and
2964 * replace the entry with the tag ID of the corresponding serialized
2967 * We CHEAT by not calling av_fetch() and read directly within the
2971 for (i = 1; i < count; i++) {
2972 #ifdef USE_PTR_TABLE
2980 AV *av_hook = cxt->hook_seen;
2983 CROAK(("Item #%d returned by STORABLE_freeze "
2984 "for %s is not a reference", i, classname));
2985 xsv = SvRV(rsv); /* Follow ref to know what to look for */
2988 * Look in hseen and see if we have a tag already.
2989 * Serialize entry if not done already, and get its tag.
2992 #ifdef USE_PTR_TABLE
2993 /* Fakery needed because ptr_table_fetch returns zero for a
2994 failure, whereas the existing code assumes that it can
2995 safely store a tag zero. So for ptr_tables we store tag+1
2997 if (fake_tag = ptr_table_fetch(cxt->pseen, xsv))
2998 goto sv_seen; /* Avoid moving code too far to the right */
3000 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
3001 goto sv_seen; /* Avoid moving code too far to the right */
3004 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
3007 * We need to recurse to store that object and get it to be known
3008 * so that we can resolve the list of object-IDs at retrieve time.
3010 * The first time we do this, we need to emit the proper header
3011 * indicating that we recursed, and what the type of object is (the
3012 * object we're storing via a user-hook). Indeed, during retrieval,
3013 * we'll have to create the object before recursing to retrieve the
3014 * others, in case those would point back at that object.
3017 /* [SX_HOOK] <flags> [<extra>] <object>*/
3021 if (obj_type == SHT_EXTRA)
3026 if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
3029 #ifdef USE_PTR_TABLE
3030 fake_tag = ptr_table_fetch(cxt->pseen, xsv);
3032 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3034 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
3036 CROAK(("Could not serialize item #%d from hook in %s", i, classname));
3039 * It was the first time we serialized `xsv'.
3041 * Keep this SV alive until the end of the serialization: if we
3042 * disposed of it right now by decrementing its refcount, and it was
3043 * a temporary value, some next temporary value allocated during
3044 * another STORABLE_freeze might take its place, and we'd wrongly
3045 * assume that new SV was already serialized, based on its presence
3048 * Therefore, push it away in cxt->hook_seen.
3051 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
3055 * Dispose of the REF they returned. If we saved the `xsv' away
3056 * in the array of returned SVs, that will not cause the underlying
3057 * referenced SV to be reclaimed.
3060 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
3061 SvREFCNT_dec(rsv); /* Dispose of reference */
3064 * Replace entry with its tag (not a real SV, so no refcnt increment)
3067 #ifdef USE_PTR_TABLE
3068 tag = (SV *)--fake_tag;
3073 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
3074 i-1, PTR2UV(xsv), PTR2UV(tag)));
3078 * Allocate a class ID if not already done.
3080 * This needs to be done after the recursion above, since at retrieval
3081 * time, we'll see the inner objects first. Many thanks to
3082 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
3083 * proposed the right fix. -- RAM, 15/09/2000
3087 if (!known_class(aTHX_ cxt, classname, len, &classnum)) {
3088 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3089 classnum = -1; /* Mark: we must store classname */
3091 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3095 * Compute leading flags.
3099 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3100 flags |= SHF_LARGE_CLASSLEN;
3102 flags |= SHF_IDX_CLASSNAME;
3103 if (len2 > LG_SCALAR)
3104 flags |= SHF_LARGE_STRLEN;
3106 flags |= SHF_HAS_LIST;
3107 if (count > (LG_SCALAR + 1))
3108 flags |= SHF_LARGE_LISTLEN;
3111 * We're ready to emit either serialized form:
3113 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3114 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
3116 * If we recursed, the SX_HOOK has already been emitted.
3119 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3120 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3121 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3123 /* SX_HOOK <flags> [<extra>] */
3127 if (obj_type == SHT_EXTRA)
3132 /* <len> <classname> or <index> */
3133 if (flags & SHF_IDX_CLASSNAME) {
3134 if (flags & SHF_LARGE_CLASSLEN)
3137 unsigned char cnum = (unsigned char) classnum;
3141 if (flags & SHF_LARGE_CLASSLEN)
3144 unsigned char clen = (unsigned char) len;
3147 WRITE(classname, len); /* Final \0 is omitted */
3150 /* <len2> <frozen-str> */
3151 if (flags & SHF_LARGE_STRLEN) {
3152 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
3153 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
3155 unsigned char clen = (unsigned char) len2;
3159 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
3161 /* [<len3> <object-IDs>] */
3162 if (flags & SHF_HAS_LIST) {
3163 int len3 = count - 1;
3164 if (flags & SHF_LARGE_LISTLEN)
3167 unsigned char clen = (unsigned char) len3;
3172 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3173 * real pointer, rather a tag number, well under the 32-bit limit.
3176 for (i = 1; i < count; i++) {
3177 I32 tagval = htonl(LOW_32BITS(ary[i]));
3179 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3184 * Free the array. We need extra care for indices after 0, since they
3185 * don't hold real SVs but integers cast.
3189 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3194 * If object was tied, need to insert serialization of the magic object.
3197 if (obj_type == SHT_EXTRA) {
3200 if (!(mg = mg_find(sv, mtype))) {
3201 int svt = SvTYPE(sv);
3202 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3203 mtype, (svt == SVt_PVHV) ? "hash" :
3204 (svt == SVt_PVAV) ? "array" : "scalar"));
3207 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3208 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3214 if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
3222 * store_blessed -- dispatched manually, not via sv_store[]
3224 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3225 * of its ancestors. If there is, then redispatch to store_hook();
3227 * Otherwise, the blessed SV is stored using the following layout:
3229 * SX_BLESS <flag> <len> <classname> <object>
3231 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3232 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3233 * Otherwise, the low order bits give the length, thereby giving a compact
3234 * representation for class names less than 127 chars long.
3236 * Each <classname> seen is remembered and indexed, so that the next time
3237 * an object in the blessed in the same <classname> is stored, the following
3240 * SX_IX_BLESS <flag> <index> <object>
3242 * where <index> is the classname index, stored on 0 or 4 bytes depending
3243 * on the high-order bit in flag (same encoding as above for <len>).
3245 static int store_blessed(
3257 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME(pkg)));
3260 * Look for a hook for this blessed SV and redirect to store_hook()
3264 hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3266 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3269 * This is a blessed SV without any serialization hook.
3272 classname = HvNAME(pkg);
3273 len = strlen(classname);
3275 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3276 PTR2UV(sv), classname, cxt->tagnum));
3279 * Determine whether it is the first time we see that class name (in which
3280 * case it will be stored in the SX_BLESS form), or whether we already
3281 * saw that class name before (in which case the SX_IX_BLESS form will be
3285 if (known_class(aTHX_ cxt, classname, len, &classnum)) {
3286 TRACEME(("already seen class %s, ID = %d", classname, classnum));
3287 PUTMARK(SX_IX_BLESS);
3288 if (classnum <= LG_BLESS) {
3289 unsigned char cnum = (unsigned char) classnum;
3292 unsigned char flag = (unsigned char) 0x80;
3297 TRACEME(("first time we see class %s, ID = %d", classname, classnum));
3299 if (len <= LG_BLESS) {
3300 unsigned char clen = (unsigned char) len;
3303 unsigned char flag = (unsigned char) 0x80;
3305 WLEN(len); /* Don't BER-encode, this should be rare */
3307 WRITE(classname, len); /* Final \0 is omitted */
3311 * Now emit the <object> part.
3314 return SV_STORE(type)(aTHX_ cxt, sv);
3320 * We don't know how to store the item we reached, so return an error condition.
3321 * (it's probably a GLOB, some CODE reference, etc...)
3323 * If they defined the `forgive_me' variable at the Perl level to some
3324 * true value, then don't croak, just warn, and store a placeholder string
3327 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3332 TRACEME(("store_other"));
3335 * Fetch the value from perl only once per store() operation.
3339 cxt->forgive_me == 0 ||
3340 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3341 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3343 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3345 warn("Can't store item %s(0x%"UVxf")",
3346 sv_reftype(sv, FALSE), PTR2UV(sv));
3349 * Store placeholder string as a scalar instead...
3352 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3353 PTR2UV(sv), (char) 0);
3356 STORE_SCALAR(buf, len);
3357 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3363 *** Store driving routines
3369 * WARNING: partially duplicates Perl's sv_reftype for speed.
3371 * Returns the type of the SV, identified by an integer. That integer
3372 * may then be used to index the dynamic routine dispatch table.
3374 static int sv_type(pTHX_ SV *sv)
3376 switch (SvTYPE(sv)) {
3381 * No need to check for ROK, that can't be set here since there
3382 * is no field capable of hodling the xrv_rv reference.
3390 * Starting from SVt_PV, it is possible to have the ROK flag
3391 * set, the pointer to the other SV being either stored in
3392 * the xrv_rv (in the case of a pure SVt_RV), or as the
3393 * xpv_pv field of an SVt_PV and its heirs.
3395 * However, those SV cannot be magical or they would be an
3396 * SVt_PVMG at least.
3398 return SvROK(sv) ? svis_REF : svis_SCALAR;
3400 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3401 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3402 return svis_TIED_ITEM;
3405 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3407 return SvROK(sv) ? svis_REF : svis_SCALAR;
3409 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3413 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3428 * Recursively store objects pointed to by the sv to the specified file.
3430 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3431 * object (one for which storage has started -- it may not be over if we have
3432 * a self-referenced structure). This data set forms a stored <object>.
3434 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3439 #ifdef USE_PTR_TABLE
3440 struct ptr_tbl *pseen = cxt->pseen;
3442 HV *hseen = cxt->hseen;
3445 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3448 * If object has already been stored, do not duplicate data.
3449 * Simply emit the SX_OBJECT marker followed by its tag data.
3450 * The tag is always written in network order.
3452 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3453 * real pointer, rather a tag number (watch the insertion code below).
3454 * That means it probably safe to assume it is well under the 32-bit limit,
3455 * and makes the truncation safe.
3456 * -- RAM, 14/09/1999
3459 #ifdef USE_PTR_TABLE
3460 svh = ptr_table_fetch(pseen, sv);
3462 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3467 if (sv == &PL_sv_undef) {
3468 /* We have seen PL_sv_undef before, but fake it as
3471 Not the simplest solution to making restricted
3472 hashes work on 5.8.0, but it does mean that
3473 repeated references to the one true undef will
3474 take up less space in the output file.
3476 /* Need to jump past the next hv_store, because on the
3477 second store of undef the old hash value will be
3478 SvREFCNT_dec()ed, and as Storable cheats horribly
3479 by storing non-SVs in the hash a SEGV will ensure.
3480 Need to increase the tag number so that the
3481 receiver has no idea what games we're up to. This
3482 special casing doesn't affect hooks that store
3483 undef, as the hook routine does its own lookup into
3484 hseen. Also this means that any references back
3485 to PL_sv_undef (from the pathological case of hooks
3486 storing references to it) will find the seen hash
3487 entry for the first time, as if we didn't have this
3488 hackery here. (That hseen lookup works even on 5.8.0
3489 because it's a key of &PL_sv_undef and a value
3490 which is a tag number, not a value which is
3494 goto undef_special_case;
3497 #ifdef USE_PTR_TABLE
3498 tagval = htonl(LOW_32BITS(((char *)svh)-1));
3500 tagval = htonl(LOW_32BITS(*svh));
3503 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3511 * Allocate a new tag and associate it with the address of the sv being
3512 * stored, before recursing...
3514 * In order to avoid creating new SvIVs to hold the tagnum we just
3515 * cast the tagnum to an SV pointer and store that in the hash. This
3516 * means that we must clean up the hash manually afterwards, but gives
3517 * us a 15% throughput increase.
3522 #ifdef USE_PTR_TABLE
3523 ptr_table_store(pseen, sv, INT2PTR(SV*, 1 + cxt->tagnum));
3525 if (!hv_store(hseen,
3526 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3531 * Store `sv' and everything beneath it, using appropriate routine.
3532 * Abort immediately if we get a non-zero status back.
3535 type = sv_type(aTHX_ sv);
3538 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3539 PTR2UV(sv), cxt->tagnum, type));
3542 HV *pkg = SvSTASH(sv);
3543 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3545 ret = SV_STORE(type)(aTHX_ cxt, sv);
3547 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3548 ret ? "FAILED" : "ok", PTR2UV(sv),
3549 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3557 * Write magic number and system information into the file.
3558 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3559 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3560 * All size and lenghts are written as single characters here.
3562 * Note that no byte ordering info is emitted when <network> is true, since
3563 * integers will be emitted in network order in that case.
3565 static int magic_write(pTHX_ stcxt_t *cxt)
3568 * Starting with 0.6, the "use_network_order" byte flag is also used to
3569 * indicate the version number of the binary image, encoded in the upper
3570 * bits. The bit 0 is always used to indicate network order.
3573 * Starting with 0.7, a full byte is dedicated to the minor version of
3574 * the binary format, which is incremented only when new markers are
3575 * introduced, for instance, but when backward compatibility is preserved.
3578 /* Make these at compile time. The WRITE() macro is sufficiently complex
3579 that it saves about 200 bytes doing it this way and only using it
3581 static const unsigned char network_file_header[] = {
3583 (STORABLE_BIN_MAJOR << 1) | 1,
3584 STORABLE_BIN_WRITE_MINOR
3586 static const unsigned char file_header[] = {
3588 (STORABLE_BIN_MAJOR << 1) | 0,
3589 STORABLE_BIN_WRITE_MINOR,
3590 /* sizeof the array includes the 0 byte at the end: */
3591 (char) sizeof (byteorderstr) - 1,
3593 (unsigned char) sizeof(int),
3594 (unsigned char) sizeof(long),
3595 (unsigned char) sizeof(char *),
3596 (unsigned char) sizeof(NV)
3598 #ifdef USE_56_INTERWORK_KLUDGE
3599 static const unsigned char file_header_56[] = {
3601 (STORABLE_BIN_MAJOR << 1) | 0,
3602 STORABLE_BIN_WRITE_MINOR,
3603 /* sizeof the array includes the 0 byte at the end: */
3604 (char) sizeof (byteorderstr_56) - 1,
3606 (unsigned char) sizeof(int),
3607 (unsigned char) sizeof(long),
3608 (unsigned char) sizeof(char *),
3609 (unsigned char) sizeof(NV)
3612 const unsigned char *header;
3615 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3617 if (cxt->netorder) {
3618 header = network_file_header;
3619 length = sizeof (network_file_header);
3621 #ifdef USE_56_INTERWORK_KLUDGE
3622 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3623 header = file_header_56;
3624 length = sizeof (file_header_56);
3628 header = file_header;
3629 length = sizeof (file_header);
3634 /* sizeof the array includes the 0 byte at the end. */
3635 header += sizeof (magicstr) - 1;
3636 length -= sizeof (magicstr) - 1;
3639 WRITE( (unsigned char*) header, length);
3641 if (!cxt->netorder) {
3642 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3643 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3644 (int) sizeof(int), (int) sizeof(long),
3645 (int) sizeof(char *), (int) sizeof(NV)));
3653 * Common code for store operations.
3655 * When memory store is requested (f = NULL) and a non null SV* is given in
3656 * `res', it is filled with a new SV created out of the memory buffer.
3658 * It is required to provide a non-null `res' when the operation type is not
3659 * dclone() and store() is performed to memory.
3661 static int do_store(
3672 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3673 ("must supply result SV pointer for real recursion to memory"));
3675 TRACEME(("do_store (optype=%d, netorder=%d)",
3676 optype, network_order));
3681 * Workaround for CROAK leak: if they enter with a "dirty" context,
3682 * free up memory for them now.
3686 clean_context(aTHX_ cxt);
3689 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3690 * re-enter store() via the hooks. We need to stack contexts.
3694 cxt = allocate_context(aTHX_ cxt);
3698 ASSERT(cxt->entry == 1, ("starting new recursion"));
3699 ASSERT(!cxt->s_dirty, ("clean context"));
3702 * Ensure sv is actually a reference. From perl, we called something
3704 * pstore(aTHX_ FILE, \@array);
3705 * so we must get the scalar value behing that reference.
3709 CROAK(("Not a reference"));
3710 sv = SvRV(sv); /* So follow it to know what to store */
3713 * If we're going to store to memory, reset the buffer.
3720 * Prepare context and emit headers.
3723 init_store_context(aTHX_ cxt, f, optype, network_order);
3725 if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
3726 return 0; /* Error */
3729 * Recursively store object...
3732 ASSERT(is_storing(aTHX), ("within store operation"));
3734 status = store(aTHX_ cxt, sv); /* Just do it! */
3737 * If they asked for a memory store and they provided an SV pointer,
3738 * make an SV string out of the buffer and fill their pointer.
3740 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3741 * an SV, since context cleanup might free the buffer if we did recurse.
3742 * (unless caller is dclone(), which is aware of that).
3745 if (!cxt->fio && res)
3746 *res = mbuf2sv(aTHX);
3751 * The "root" context is never freed, since it is meant to be always
3752 * handy for the common case where no recursion occurs at all (i.e.
3753 * we enter store() outside of any Storable code and leave it, period).
3754 * We know it's the "root" context because there's nothing stacked
3759 * When deep cloning, we don't free the context: doing so would force
3760 * us to copy the data in the memory buffer. Sicne we know we're
3761 * about to enter do_retrieve...
3764 clean_store_context(aTHX_ cxt);
3765 if (cxt->prev && !(cxt->optype & ST_CLONE))
3766 free_context(aTHX_ cxt);
3768 TRACEME(("do_store returns %d", status));
3776 * Store the transitive data closure of given object to disk.
3777 * Returns 0 on error, a true value otherwise.
3779 int pstore(pTHX_ PerlIO *f, SV *sv)
3781 TRACEME(("pstore"));
3782 return do_store(aTHX_ f, sv, 0, FALSE, (SV**) 0);
3789 * Same as pstore(), but network order is used for integers and doubles are
3790 * emitted as strings.
3792 int net_pstore(pTHX_ PerlIO *f, SV *sv)
3794 TRACEME(("net_pstore"));
3795 return do_store(aTHX_ f, sv, 0, TRUE, (SV**) 0);
3805 * Build a new SV out of the content of the internal memory buffer.
3807 static SV *mbuf2sv(pTHX)
3811 return newSVpv(mbase, MBUF_SIZE());
3817 * Store the transitive data closure of given object to memory.
3818 * Returns undef on error, a scalar value containing the data otherwise.
3820 SV *mstore(pTHX_ SV *sv)
3824 TRACEME(("mstore"));
3826 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, FALSE, &out))
3827 return &PL_sv_undef;
3835 * Same as mstore(), but network order is used for integers and doubles are
3836 * emitted as strings.
3838 SV *net_mstore(pTHX_ SV *sv)
3842 TRACEME(("net_mstore"));
3844 if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, TRUE, &out))
3845 return &PL_sv_undef;
3851 *** Specific retrieve callbacks.
3857 * Return an error via croak, since it is not possible that we get here
3858 * under normal conditions, when facing a file produced via pstore().
3860 static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname)
3863 cxt->ver_major != STORABLE_BIN_MAJOR &&
3864 cxt->ver_minor != STORABLE_BIN_MINOR
3866 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3867 cxt->fio ? "file" : "string",
3868 cxt->ver_major, cxt->ver_minor,
3869 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3871 CROAK(("Corrupted storable %s (binary v%d.%d)",
3872 cxt->fio ? "file" : "string",
3873 cxt->ver_major, cxt->ver_minor));
3876 return (SV *) 0; /* Just in case */
3880 * retrieve_idx_blessed
3882 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3883 * <index> can be coded on either 1 or 5 bytes.
3885 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname)
3892 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3893 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3895 GETMARK(idx); /* Index coded on a single char? */
3900 * Fetch classname in `aclass'
3903 sva = av_fetch(cxt->aclass, idx, FALSE);
3905 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3907 classname = SvPVX(*sva); /* We know it's a PV, by construction */
3909 TRACEME(("class ID %d => %s", idx, classname));
3912 * Retrieve object and bless it.
3915 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3923 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3924 * <len> can be coded on either 1 or 5 bytes.
3926 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname)
3930 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3931 char *classname = buf;
3933 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3934 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3937 * Decode class name length and read that name.
3939 * Short classnames have two advantages: their length is stored on one
3940 * single byte, and the string can be read on the stack.
3943 GETMARK(len); /* Length coded on a single char? */
3946 TRACEME(("** allocating %d bytes for class name", len+1));
3947 New(10003, classname, len+1, char);
3949 READ(classname, len);
3950 classname[len] = '\0'; /* Mark string end */
3953 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3956 TRACEME(("new class name \"%s\" will bear ID = %d", classname, cxt->classnum));
3958 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len)))
3962 * Retrieve object and bless it.
3965 sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
3966 if (classname != buf)
3967 Safefree(classname);
3975 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3976 * with leading mark already read, as usual.
3978 * When recursion was involved during serialization of the object, there
3979 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
3980 * we reach a <flags> marker with the recursion bit cleared.
3982 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
3983 * is held in the <extra> byte, and if the object is tied, the serialized
3984 * magic object comes at the very end:
3986 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
https://perl5.git.perl.org / perl5.git / blob