This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #27567] [patch] a typo and a mistake in perltoot.pod
[perl5.git] / ext / Storable / Storable.xs
CommitLineData
7a6a85bf 1/*
6ad89a2f 2 * Store and retrieve mechanism.
7a6a85bf
RG
3 *
4 * Copyright (c) 1995-2000, Raphael Manfredi
5 *
9e21b3d0
JH
6 * You may redistribute only under the same terms as Perl 5, as specified
7 * in the README file that comes with the distribution.
7a6a85bf 8 *
7a6a85bf
RG
9 */
10
11#include <EXTERN.h>
12#include <perl.h>
a3bf621f
JH
13#include <XSUB.h>
14
eadddfac 15#ifndef PATCHLEVEL
a3bf621f
JH
16# include <patchlevel.h> /* Perl's one, needed since 5.6 */
17# if !(defined(PERL_VERSION) || (SUBVERSION > 0 && defined(PATCHLEVEL)))
18# include <could_not_find_Perl_patchlevel.h>
19# endif
069d7f71 20#endif
7a6a85bf 21
5dff01bc 22#ifndef NETWARE
e8189732 23#if 0
9e21b3d0
JH
24#define DEBUGME /* Debug mode, turns assertions on as well */
25#define DASSERT /* Assertion mode */
26#endif
5dff01bc
JH
27#else /* NETWARE */
28#if 0 /* On NetWare USE_PERLIO is not used */
29#define DEBUGME /* Debug mode, turns assertions on as well */
30#define DASSERT /* Assertion mode */
31#endif
32#endif
7a6a85bf
RG
33
34/*
35 * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
36 * Provide them with the necessary defines so they can build with pre-5.004.
37 */
38#ifndef USE_PERLIO
39#ifndef PERLIO_IS_STDIO
40#define PerlIO FILE
41#define PerlIO_getc(x) getc(x)
42#define PerlIO_putc(f,x) putc(x,f)
43#define PerlIO_read(x,y,z) fread(y,1,z,x)
44#define PerlIO_write(x,y,z) fwrite(y,1,z,x)
45#define PerlIO_stdoutf printf
46#endif /* PERLIO_IS_STDIO */
47#endif /* USE_PERLIO */
48
49/*
50 * Earlier versions of perl might be used, we can't assume they have the latest!
51 */
f0ffaed8
JH
52
53#ifndef PERL_VERSION /* For perls < 5.6 */
e993d95c 54#define PERL_VERSION PATCHLEVEL
7a6a85bf
RG
55#ifndef newRV_noinc
56#define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
57#endif
e993d95c 58#if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
7a6a85bf
RG
59#define PL_sv_yes sv_yes
60#define PL_sv_no sv_no
61#define PL_sv_undef sv_undef
e993d95c 62#if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
dd19458b 63#define newSVpvn newSVpv
7a6a85bf 64#endif
e993d95c 65#endif /* PATCHLEVEL <= 4 */
7a6a85bf
RG
66#ifndef HvSHAREKEYS_off
67#define HvSHAREKEYS_off(hv) /* Ignore */
68#endif
f0ffaed8
JH
69#ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
70#define AvFILLp AvFILL
71#endif
72typedef double NV; /* Older perls lack the NV type */
cc964657
JH
73#define IVdf "ld" /* Various printf formats for Perl types */
74#define UVuf "lu"
75#define UVof "lo"
76#define UVxf "lx"
77#define INT2PTR(t,v) (t)(IV)(v)
78#define PTR2UV(v) (unsigned long)(v)
f0ffaed8 79#endif /* PERL_VERSION -- perls < 5.6 */
7a6a85bf 80
cc964657 81#ifndef NVef /* The following were not part of perl 5.6 */
9e21b3d0
JH
82#if defined(USE_LONG_DOUBLE) && \
83 defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
84#define NVef PERL_PRIeldbl
85#define NVff PERL_PRIfldbl
86#define NVgf PERL_PRIgldbl
87#else
cc964657
JH
88#define NVef "e"
89#define NVff "f"
90#define NVgf "g"
91#endif
92#endif
93
7a6a85bf 94#ifdef DEBUGME
8be2b38b
JH
95
96#ifndef DASSERT
97#define DASSERT
98#endif
99
90826881
JH
100/*
101 * TRACEME() will only output things when the $Storable::DEBUGME is true.
102 */
103
111e03c1
RG
104#define TRACEME(x) \
105 STMT_START { \
90826881 106 if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
111e03c1
RG
107 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
108 } STMT_END
7a6a85bf
RG
109#else
110#define TRACEME(x)
8be2b38b 111#endif /* DEBUGME */
7a6a85bf
RG
112
113#ifdef DASSERT
111e03c1
RG
114#define ASSERT(x,y) \
115 STMT_START { \
7a6a85bf
RG
116 if (!(x)) { \
117 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
118 __FILE__, __LINE__); \
119 PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
120 } \
111e03c1 121 } STMT_END
7a6a85bf
RG
122#else
123#define ASSERT(x,y)
124#endif
125
126/*
127 * Type markers.
128 */
129
130#define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
131
132#define SX_OBJECT C(0) /* Already stored object */
dd19458b 133#define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
7a6a85bf
RG
134#define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
135#define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
136#define SX_REF C(4) /* Reference to object forthcoming */
137#define SX_UNDEF C(5) /* Undefined scalar */
138#define SX_INTEGER C(6) /* Integer forthcoming */
139#define SX_DOUBLE C(7) /* Double forthcoming */
140#define SX_BYTE C(8) /* (signed) byte forthcoming */
141#define SX_NETINT C(9) /* Integer in network order forthcoming */
dd19458b 142#define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
f062ea6c
PN
143#define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
144#define SX_TIED_HASH C(12) /* Tied hash forthcoming */
145#define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
7a6a85bf
RG
146#define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
147#define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
148#define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
149#define SX_BLESS C(17) /* Object is blessed */
150#define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
151#define SX_HOOK C(19) /* Stored via hook, user-defined */
152#define SX_OVERLOAD C(20) /* Overloaded reference */
f062ea6c
PN
153#define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
154#define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
155#define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
156#define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
157#define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
464b080a
SR
158#define SX_CODE C(26) /* Code references as perl source code */
159#define SX_ERROR C(27) /* Error */
7a6a85bf
RG
160
161/*
162 * Those are only used to retrieve "old" pre-0.6 binary images.
163 */
164#define SX_ITEM 'i' /* An array item introducer */
165#define SX_IT_UNDEF 'I' /* Undefined array item */
d1be9408
JF
166#define SX_KEY 'k' /* A hash key introducer */
167#define SX_VALUE 'v' /* A hash value introducer */
7a6a85bf
RG
168#define SX_VL_UNDEF 'V' /* Undefined hash value */
169
170/*
171 * Those are only used to retrieve "old" pre-0.7 binary images
172 */
173
174#define SX_CLASS 'b' /* Object is blessed, class name length <255 */
f062ea6c 175#define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
7a6a85bf
RG
176#define SX_STORED 'X' /* End of object */
177
178/*
179 * Limits between short/long length representation.
180 */
181
182#define LG_SCALAR 255 /* Large scalar length limit */
183#define LG_BLESS 127 /* Large classname bless limit */
184
185/*
186 * Operation types
187 */
188
189#define ST_STORE 0x1 /* Store operation */
190#define ST_RETRIEVE 0x2 /* Retrieval operation */
191#define ST_CLONE 0x4 /* Deep cloning operation */
192
193/*
194 * The following structure is used for hash table key retrieval. Since, when
195 * retrieving objects, we'll be facing blessed hash references, it's best
196 * to pre-allocate that buffer once and resize it as the need arises, never
197 * freeing it (keys will be saved away someplace else anyway, so even large
198 * keys are not enough a motivation to reclaim that space).
199 *
200 * This structure is also used for memory store/retrieve operations which
201 * happen in a fixed place before being malloc'ed elsewhere if persistency
202 * is required. Hence the aptr pointer.
203 */
204struct extendable {
205 char *arena; /* Will hold hash key strings, resized as needed */
206 STRLEN asiz; /* Size of aforementionned buffer */
207 char *aptr; /* Arena pointer, for in-place read/write ops */
208 char *aend; /* First invalid address */
209};
210
211/*
212 * At store time:
d1be9408 213 * A hash table records the objects which have already been stored.
7a6a85bf
RG
214 * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
215 * an arbitrary sequence number) is used to identify them.
216 *
217 * At retrieve time:
218 * An array table records the objects which have already been retrieved,
219 * as seen by the tag determind by counting the objects themselves. The
220 * reference to that retrieved object is kept in the table, and is returned
221 * when an SX_OBJECT is found bearing that same tag.
222 *
223 * The same processing is used to record "classname" for blessed objects:
224 * indexing by a hash at store time, and via an array at retrieve time.
225 */
226
227typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
228
229/*
230 * The following "thread-safe" related defines were contributed by
231 * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
232 * only renamed things a little bit to ensure consistency with surrounding
233 * code. -- RAM, 14/09/1999
234 *
235 * The original patch suffered from the fact that the stcxt_t structure
236 * was global. Murray tried to minimize the impact on the code as much as
237 * possible.
238 *
239 * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
240 * on objects. Therefore, the notion of context needs to be generalized,
241 * threading or not.
242 */
243
244#define MY_VERSION "Storable(" XS_VERSION ")"
245
530b72ba
NC
246
247/*
248 * Conditional UTF8 support.
249 *
250 */
251#ifdef SvUTF8_on
252#define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
253#define HAS_UTF8_SCALARS
254#ifdef HeKUTF8
255#define HAS_UTF8_HASHES
256#define HAS_UTF8_ALL
257#else
258/* 5.6 perl has utf8 scalars but not hashes */
259#endif
260#else
261#define SvUTF8(sv) 0
262#define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
263#endif
264#ifndef HAS_UTF8_ALL
265#define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
266#endif
267
268#ifdef HvPLACEHOLDERS
269#define HAS_RESTRICTED_HASHES
270#else
271#define HVhek_PLACEHOLD 0x200
272#define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
273#endif
274
275#ifdef HvHASKFLAGS
276#define HAS_HASH_KEY_FLAGS
277#endif
278
dd19458b
JH
279/*
280 * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
281 * files remap tainted and dirty when threading is enabled. That's bad for
282 * perl to remap such common words. -- RAM, 29/09/00
283 */
284
7a6a85bf
RG
285typedef struct stcxt {
286 int entry; /* flags recursion */
287 int optype; /* type of traversal operation */
e993d95c
JH
288 HV *hseen; /* which objects have been seen, store time */
289 AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
290 AV *aseen; /* which objects have been seen, retrieve time */
291 HV *hclass; /* which classnames have been seen, store time */
292 AV *aclass; /* which classnames have been seen, retrieve time */
293 HV *hook; /* cache for hook methods per class name */
294 IV tagnum; /* incremented at store time for each seen object */
295 IV classnum; /* incremented at store time for each seen classname */
296 int netorder; /* true if network order used */
297 int s_tainted; /* true if input source is tainted, at retrieve time */
298 int forgive_me; /* whether to be forgiving... */
464b080a
SR
299 int deparse; /* whether to deparse code refs */
300 SV *eval; /* whether to eval source code */
e993d95c 301 int canonical; /* whether to store hashes sorted by key */
530b72ba
NC
302#ifndef HAS_RESTRICTED_HASHES
303 int derestrict; /* whether to downgrade restrcted hashes */
304#endif
305#ifndef HAS_UTF8_ALL
306 int use_bytes; /* whether to bytes-ify utf8 */
307#endif
e8189732 308 int accept_future_minor; /* croak immediately on future minor versions? */
dd19458b 309 int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
e993d95c
JH
310 int membuf_ro; /* true means membuf is read-only and msaved is rw */
311 struct extendable keybuf; /* for hash key retrieval */
312 struct extendable membuf; /* for memory store/retrieve operations */
313 struct extendable msaved; /* where potentially valid mbuf is saved */
7a6a85bf
RG
314 PerlIO *fio; /* where I/O are performed, NULL for memory */
315 int ver_major; /* major of version for retrieved object */
316 int ver_minor; /* minor of version for retrieved object */
317 SV *(**retrieve_vtbl)(); /* retrieve dispatch table */
111e03c1
RG
318 SV *prev; /* contexts chained backwards in real recursion */
319 SV *my_sv; /* the blessed scalar who's SvPVX() I am */
7a6a85bf
RG
320} stcxt_t;
321
111e03c1
RG
322#define NEW_STORABLE_CXT_OBJ(cxt) \
323 STMT_START { \
324 SV *self = newSV(sizeof(stcxt_t) - 1); \
325 SV *my_sv = newRV_noinc(self); \
326 sv_bless(my_sv, gv_stashpv("Storable::Cxt", TRUE)); \
327 cxt = (stcxt_t *)SvPVX(self); \
328 Zero(cxt, 1, stcxt_t); \
329 cxt->my_sv = my_sv; \
330 } STMT_END
331
7a6a85bf
RG
332#if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
333
e993d95c 334#if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
7a6a85bf
RG
335#define dSTCXT_SV \
336 SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
337#else /* >= perl5.004_68 */
338#define dSTCXT_SV \
339 SV *perinterp_sv = *hv_fetch(PL_modglobal, \
340 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
341#endif /* < perl5.004_68 */
342
343#define dSTCXT_PTR(T,name) \
111e03c1 344 T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
436c6dd3 345 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
7a6a85bf
RG
346#define dSTCXT \
347 dSTCXT_SV; \
348 dSTCXT_PTR(stcxt_t *, cxt)
349
111e03c1
RG
350#define INIT_STCXT \
351 dSTCXT; \
352 NEW_STORABLE_CXT_OBJ(cxt); \
353 sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
7a6a85bf 354
111e03c1
RG
355#define SET_STCXT(x) \
356 STMT_START { \
7a6a85bf 357 dSTCXT_SV; \
111e03c1
RG
358 sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
359 } STMT_END
7a6a85bf
RG
360
361#else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
362
85535365 363static stcxt_t *Context_ptr = NULL;
7a6a85bf 364#define dSTCXT stcxt_t *cxt = Context_ptr
85535365 365#define SET_STCXT(x) Context_ptr = x
111e03c1
RG
366#define INIT_STCXT \
367 dSTCXT; \
85535365
RG
368 NEW_STORABLE_CXT_OBJ(cxt); \
369 SET_STCXT(cxt)
111e03c1 370
7a6a85bf
RG
371
372#endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
373
374/*
375 * KNOWN BUG:
376 * Croaking implies a memory leak, since we don't use setjmp/longjmp
377 * to catch the exit and free memory used during store or retrieve
378 * operations. This is not too difficult to fix, but I need to understand
379 * how Perl does it, and croaking is exceptional anyway, so I lack the
380 * motivation to do it.
381 *
382 * The current workaround is to mark the context as dirty when croaking,
383 * so that data structures can be freed whenever we renter Storable code
384 * (but only *then*: it's a workaround, not a fix).
385 *
386 * This is also imperfect, because we don't really know how far they trapped
387 * the croak(), and when we were recursing, we won't be able to clean anything
388 * but the topmost context stacked.
389 */
390
111e03c1 391#define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
7a6a85bf
RG
392
393/*
394 * End of "thread-safe" related definitions.
395 */
396
397/*
9e21b3d0
JH
398 * LOW_32BITS
399 *
400 * Keep only the low 32 bits of a pointer (used for tags, which are not
401 * really pointers).
402 */
403
404#if PTRSIZE <= 4
405#define LOW_32BITS(x) ((I32) (x))
406#else
407#define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
408#endif
409
410/*
411 * oI, oS, oC
412 *
413 * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
414 * Used in the WLEN and RLEN macros.
415 */
416
417#if INTSIZE > 4
418#define oI(x) ((I32 *) ((char *) (x) + 4))
419#define oS(x) ((x) - 4)
420#define oC(x) (x = 0)
421#define CRAY_HACK
422#else
423#define oI(x) (x)
424#define oS(x) (x)
425#define oC(x)
426#endif
427
428/*
7a6a85bf
RG
429 * key buffer handling
430 */
431#define kbuf (cxt->keybuf).arena
432#define ksiz (cxt->keybuf).asiz
111e03c1
RG
433#define KBUFINIT() \
434 STMT_START { \
7a6a85bf
RG
435 if (!kbuf) { \
436 TRACEME(("** allocating kbuf of 128 bytes")); \
437 New(10003, kbuf, 128, char); \
438 ksiz = 128; \
439 } \
111e03c1
RG
440 } STMT_END
441#define KBUFCHK(x) \
442 STMT_START { \
7a6a85bf 443 if (x >= ksiz) { \
e993d95c 444 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
7a6a85bf
RG
445 Renew(kbuf, x+1, char); \
446 ksiz = x+1; \
447 } \
111e03c1 448 } STMT_END
7a6a85bf
RG
449
450/*
451 * memory buffer handling
452 */
453#define mbase (cxt->membuf).arena
454#define msiz (cxt->membuf).asiz
455#define mptr (cxt->membuf).aptr
456#define mend (cxt->membuf).aend
457
458#define MGROW (1 << 13)
459#define MMASK (MGROW - 1)
460
461#define round_mgrow(x) \
462 ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
463#define trunc_int(x) \
464 ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
465#define int_aligned(x) \
466 ((unsigned long) (x) == trunc_int(x))
467
111e03c1
RG
468#define MBUF_INIT(x) \
469 STMT_START { \
7a6a85bf
RG
470 if (!mbase) { \
471 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
472 New(10003, mbase, MGROW, char); \
2cc1b180 473 msiz = (STRLEN)MGROW; \
7a6a85bf
RG
474 } \
475 mptr = mbase; \
476 if (x) \
477 mend = mbase + x; \
478 else \
479 mend = mbase + msiz; \
111e03c1 480 } STMT_END
7a6a85bf
RG
481
482#define MBUF_TRUNC(x) mptr = mbase + x
483#define MBUF_SIZE() (mptr - mbase)
484
485/*
e993d95c
JH
486 * MBUF_SAVE_AND_LOAD
487 * MBUF_RESTORE
488 *
489 * Those macros are used in do_retrieve() to save the current memory
490 * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
491 * data from a string.
492 */
111e03c1
RG
493#define MBUF_SAVE_AND_LOAD(in) \
494 STMT_START { \
e993d95c
JH
495 ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
496 cxt->membuf_ro = 1; \
497 TRACEME(("saving mbuf")); \
498 StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
499 MBUF_LOAD(in); \
111e03c1 500 } STMT_END
e993d95c 501
111e03c1
RG
502#define MBUF_RESTORE() \
503 STMT_START { \
e993d95c
JH
504 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
505 cxt->membuf_ro = 0; \
506 TRACEME(("restoring mbuf")); \
507 StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
111e03c1 508 } STMT_END
e993d95c
JH
509
510/*
7a6a85bf
RG
511 * Use SvPOKp(), because SvPOK() fails on tainted scalars.
512 * See store_scalar() for other usage of this workaround.
513 */
111e03c1
RG
514#define MBUF_LOAD(v) \
515 STMT_START { \
e993d95c 516 ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
7a6a85bf
RG
517 if (!SvPOKp(v)) \
518 CROAK(("Not a scalar string")); \
519 mptr = mbase = SvPV(v, msiz); \
520 mend = mbase + msiz; \
111e03c1 521 } STMT_END
7a6a85bf 522
111e03c1
RG
523#define MBUF_XTEND(x) \
524 STMT_START { \
7a6a85bf
RG
525 int nsz = (int) round_mgrow((x)+msiz); \
526 int offset = mptr - mbase; \
e993d95c
JH
527 ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
528 TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
529 msiz, nsz, (x))); \
7a6a85bf
RG
530 Renew(mbase, nsz, char); \
531 msiz = nsz; \
532 mptr = mbase + offset; \
533 mend = mbase + nsz; \
111e03c1 534 } STMT_END
7a6a85bf 535
111e03c1
RG
536#define MBUF_CHK(x) \
537 STMT_START { \
7a6a85bf
RG
538 if ((mptr + (x)) > mend) \
539 MBUF_XTEND(x); \
111e03c1 540 } STMT_END
7a6a85bf 541
111e03c1
RG
542#define MBUF_GETC(x) \
543 STMT_START { \
7a6a85bf
RG
544 if (mptr < mend) \
545 x = (int) (unsigned char) *mptr++; \
546 else \
547 return (SV *) 0; \
111e03c1 548 } STMT_END
7a6a85bf 549
9e21b3d0 550#ifdef CRAY_HACK
111e03c1
RG
551#define MBUF_GETINT(x) \
552 STMT_START { \
9e21b3d0
JH
553 oC(x); \
554 if ((mptr + 4) <= mend) { \
555 memcpy(oI(&x), mptr, 4); \
556 mptr += 4; \
557 } else \
558 return (SV *) 0; \
111e03c1 559 } STMT_END
9e21b3d0 560#else
111e03c1
RG
561#define MBUF_GETINT(x) \
562 STMT_START { \
7a6a85bf
RG
563 if ((mptr + sizeof(int)) <= mend) { \
564 if (int_aligned(mptr)) \
565 x = *(int *) mptr; \
566 else \
567 memcpy(&x, mptr, sizeof(int)); \
568 mptr += sizeof(int); \
569 } else \
570 return (SV *) 0; \
111e03c1 571 } STMT_END
9e21b3d0 572#endif
7a6a85bf 573
111e03c1
RG
574#define MBUF_READ(x,s) \
575 STMT_START { \
7a6a85bf
RG
576 if ((mptr + (s)) <= mend) { \
577 memcpy(x, mptr, s); \
578 mptr += s; \
579 } else \
580 return (SV *) 0; \
111e03c1 581 } STMT_END
7a6a85bf 582
111e03c1
RG
583#define MBUF_SAFEREAD(x,s,z) \
584 STMT_START { \
7a6a85bf
RG
585 if ((mptr + (s)) <= mend) { \
586 memcpy(x, mptr, s); \
587 mptr += s; \
588 } else { \
589 sv_free(z); \
590 return (SV *) 0; \
591 } \
111e03c1 592 } STMT_END
7a6a85bf 593
111e03c1
RG
594#define MBUF_PUTC(c) \
595 STMT_START { \
7a6a85bf
RG
596 if (mptr < mend) \
597 *mptr++ = (char) c; \
598 else { \
599 MBUF_XTEND(1); \
600 *mptr++ = (char) c; \
601 } \
111e03c1 602 } STMT_END
7a6a85bf 603
9e21b3d0 604#ifdef CRAY_HACK
111e03c1
RG
605#define MBUF_PUTINT(i) \
606 STMT_START { \
9e21b3d0
JH
607 MBUF_CHK(4); \
608 memcpy(mptr, oI(&i), 4); \
609 mptr += 4; \
111e03c1 610 } STMT_END
9e21b3d0 611#else
111e03c1
RG
612#define MBUF_PUTINT(i) \
613 STMT_START { \
7a6a85bf
RG
614 MBUF_CHK(sizeof(int)); \
615 if (int_aligned(mptr)) \
616 *(int *) mptr = i; \
617 else \
618 memcpy(mptr, &i, sizeof(int)); \
619 mptr += sizeof(int); \
111e03c1 620 } STMT_END
9e21b3d0 621#endif
7a6a85bf 622
111e03c1
RG
623#define MBUF_WRITE(x,s) \
624 STMT_START { \
7a6a85bf
RG
625 MBUF_CHK(s); \
626 memcpy(mptr, x, s); \
627 mptr += s; \
111e03c1 628 } STMT_END
7a6a85bf
RG
629
630/*
7a6a85bf
RG
631 * Possible return values for sv_type().
632 */
633
634#define svis_REF 0
635#define svis_SCALAR 1
636#define svis_ARRAY 2
637#define svis_HASH 3
638#define svis_TIED 4
639#define svis_TIED_ITEM 5
464b080a
SR
640#define svis_CODE 6
641#define svis_OTHER 7
7a6a85bf
RG
642
643/*
644 * Flags for SX_HOOK.
645 */
646
647#define SHF_TYPE_MASK 0x03
648#define SHF_LARGE_CLASSLEN 0x04
649#define SHF_LARGE_STRLEN 0x08
650#define SHF_LARGE_LISTLEN 0x10
651#define SHF_IDX_CLASSNAME 0x20
652#define SHF_NEED_RECURSE 0x40
653#define SHF_HAS_LIST 0x80
654
655/*
b12202d0 656 * Types for SX_HOOK (last 2 bits in flags).
7a6a85bf
RG
657 */
658
659#define SHT_SCALAR 0
660#define SHT_ARRAY 1
661#define SHT_HASH 2
b12202d0
JH
662#define SHT_EXTRA 3 /* Read extra byte for type */
663
664/*
665 * The following are held in the "extra byte"...
666 */
667
668#define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
669#define SHT_TARRAY 5 /* 4 + 1 -- tied array */
670#define SHT_THASH 6 /* 4 + 2 -- tied hash */
7a6a85bf
RG
671
672/*
e16e2ff8
NC
673 * per hash flags for flagged hashes
674 */
675
676#define SHV_RESTRICTED 0x01
677
678/*
679 * per key flags for flagged hashes
680 */
681
682#define SHV_K_UTF8 0x01
683#define SHV_K_WASUTF8 0x02
684#define SHV_K_LOCKED 0x04
685#define SHV_K_ISSV 0x08
686#define SHV_K_PLACEHOLDER 0x10
687
688/*
7a6a85bf
RG
689 * Before 0.6, the magic string was "perl-store" (binary version number 0).
690 *
691 * Since 0.6 introduced many binary incompatibilities, the magic string has
692 * been changed to "pst0" to allow an old image to be properly retrieved by
693 * a newer Storable, but ensure a newer image cannot be retrieved with an
694 * older version.
695 *
696 * At 0.7, objects are given the ability to serialize themselves, and the
697 * set of markers is extended, backward compatibility is not jeopardized,
698 * so the binary version number could have remained unchanged. To correctly
699 * spot errors if a file making use of 0.7-specific extensions is given to
700 * 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
701 * a "minor" version, to better track this kind of evolution from now on.
702 *
703 */
2aeb6432
NC
704static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
705static const char magicstr[] = "pst0"; /* Used as a magic number */
7a6a85bf 706
2aeb6432
NC
707#define MAGICSTR_BYTES 'p','s','t','0'
708#define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
709
ee0f7aac
NC
710/* 5.6.x introduced the ability to have IVs as long long.
711 However, Configure still defined BYTEORDER based on the size of a long.
712 Storable uses the BYTEORDER value as part of the header, but doesn't
713 explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
714 with IV as long long on a platform that uses Configure (ie most things
715 except VMS and Windows) headers are identical for the different IV sizes,
716 despite the files containing some fields based on sizeof(IV)
717 Erk. Broken-ness.
718 5.8 is consistent - the following redifinition kludge is only needed on
719 5.6.x, but the interwork is needed on 5.8 while data survives in files
720 with the 5.6 header.
721
722*/
723
724#if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
725#ifndef NO_56_INTERWORK_KLUDGE
726#define USE_56_INTERWORK_KLUDGE
727#endif
728#if BYTEORDER == 0x1234
729#undef BYTEORDER
730#define BYTEORDER 0x12345678
731#else
732#if BYTEORDER == 0x4321
733#undef BYTEORDER
734#define BYTEORDER 0x87654321
735#endif
736#endif
737#endif
738
2aeb6432
NC
739#if BYTEORDER == 0x1234
740#define BYTEORDER_BYTES '1','2','3','4'
741#else
742#if BYTEORDER == 0x12345678
743#define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
ee0f7aac
NC
744#ifdef USE_56_INTERWORK_KLUDGE
745#define BYTEORDER_BYTES_56 '1','2','3','4'
746#endif
2aeb6432
NC
747#else
748#if BYTEORDER == 0x87654321
749#define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
ee0f7aac
NC
750#ifdef USE_56_INTERWORK_KLUDGE
751#define BYTEORDER_BYTES_56 '4','3','2','1'
752#endif
2aeb6432
NC
753#else
754#if BYTEORDER == 0x4321
755#define BYTEORDER_BYTES '4','3','2','1'
756#else
757#error Unknown byteoder. Please append your byteorder to Storable.xs
758#endif
759#endif
760#endif
761#endif
762
763static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
ee0f7aac
NC
764#ifdef USE_56_INTERWORK_KLUDGE
765static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
766#endif
530b72ba 767
e16e2ff8 768#define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
464b080a 769#define STORABLE_BIN_MINOR 6 /* Binary minor "version" */
530b72ba
NC
770
771/* If we aren't 5.7.3 or later, we won't be writing out files that use the
772 * new flagged hash introdued in 2.5, so put 2.4 in the binary header to
773 * maximise ease of interoperation with older Storables.
774 * Could we write 2.3s if we're on 5.005_03? NWC
775 */
e16e2ff8 776#if (PATCHLEVEL <= 6)
530b72ba 777#define STORABLE_BIN_WRITE_MINOR 4
e16e2ff8
NC
778#else
779/*
780 * As of perl 5.7.3, utf8 hash key is introduced.
781 * So this must change -- dankogai
782*/
464b080a 783#define STORABLE_BIN_WRITE_MINOR 6
e16e2ff8 784#endif /* (PATCHLEVEL <= 6) */
7a6a85bf 785
e9822705 786#if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
fcaa57e7
AMS
787#define PL_sv_placeholder PL_sv_undef
788#endif
789
7a6a85bf
RG
790/*
791 * Useful store shortcuts...
792 */
793
a8b7ef86
AMS
794/*
795 * Note that if you put more than one mark for storing a particular
796 * type of thing, *and* in the retrieve_foo() function you mark both
797 * the thingy's you get off with SEEN(), you *must* increase the
798 * tagnum with cxt->tagnum++ along with this macro!
799 * - samv 20Jan04
800 */
111e03c1
RG
801#define PUTMARK(x) \
802 STMT_START { \
7a6a85bf
RG
803 if (!cxt->fio) \
804 MBUF_PUTC(x); \
805 else if (PerlIO_putc(cxt->fio, x) == EOF) \
806 return -1; \
111e03c1 807 } STMT_END
7a6a85bf 808
111e03c1
RG
809#define WRITE_I32(x) \
810 STMT_START { \
9e21b3d0
JH
811 ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
812 if (!cxt->fio) \
813 MBUF_PUTINT(x); \
814 else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
815 return -1; \
111e03c1 816 } STMT_END
9e21b3d0 817
7a6a85bf 818#ifdef HAS_HTONL
111e03c1
RG
819#define WLEN(x) \
820 STMT_START { \
7a6a85bf
RG
821 if (cxt->netorder) { \
822 int y = (int) htonl(x); \
823 if (!cxt->fio) \
824 MBUF_PUTINT(y); \
9e21b3d0 825 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
7a6a85bf
RG
826 return -1; \
827 } else { \
828 if (!cxt->fio) \
829 MBUF_PUTINT(x); \
9e21b3d0 830 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
7a6a85bf
RG
831 return -1; \
832 } \
111e03c1 833 } STMT_END
7a6a85bf 834#else
9e21b3d0 835#define WLEN(x) WRITE_I32(x)
7a6a85bf
RG
836#endif
837
111e03c1
RG
838#define WRITE(x,y) \
839 STMT_START { \
7a6a85bf
RG
840 if (!cxt->fio) \
841 MBUF_WRITE(x,y); \
842 else if (PerlIO_write(cxt->fio, x, y) != y) \
843 return -1; \
111e03c1 844 } STMT_END
7a6a85bf 845
111e03c1
RG
846#define STORE_PV_LEN(pv, len, small, large) \
847 STMT_START { \
7a6a85bf
RG
848 if (len <= LG_SCALAR) { \
849 unsigned char clen = (unsigned char) len; \
dd19458b 850 PUTMARK(small); \
7a6a85bf
RG
851 PUTMARK(clen); \
852 if (len) \
853 WRITE(pv, len); \
854 } else { \
dd19458b 855 PUTMARK(large); \
7a6a85bf
RG
856 WLEN(len); \
857 WRITE(pv, len); \
858 } \
111e03c1 859 } STMT_END
7a6a85bf 860
dd19458b
JH
861#define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
862
863/*
20bb3f55 864 * Store &PL_sv_undef in arrays without recursing through store().
7a6a85bf 865 */
20bb3f55 866#define STORE_SV_UNDEF() \
111e03c1 867 STMT_START { \
7a6a85bf 868 cxt->tagnum++; \
20bb3f55 869 PUTMARK(SX_SV_UNDEF); \
111e03c1 870 } STMT_END
7a6a85bf
RG
871
872/*
873 * Useful retrieve shortcuts...
874 */
875
876#define GETCHAR() \
877 (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
878
111e03c1
RG
879#define GETMARK(x) \
880 STMT_START { \
7a6a85bf
RG
881 if (!cxt->fio) \
882 MBUF_GETC(x); \
76df4757 883 else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
7a6a85bf 884 return (SV *) 0; \
111e03c1 885 } STMT_END
7a6a85bf 886
111e03c1
RG
887#define READ_I32(x) \
888 STMT_START { \
9e21b3d0
JH
889 ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
890 oC(x); \
7a6a85bf
RG
891 if (!cxt->fio) \
892 MBUF_GETINT(x); \
9e21b3d0 893 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
7a6a85bf 894 return (SV *) 0; \
111e03c1 895 } STMT_END
9e21b3d0
JH
896
897#ifdef HAS_NTOHL
111e03c1
RG
898#define RLEN(x) \
899 STMT_START { \
9e21b3d0 900 oC(x); \
7a6a85bf
RG
901 if (!cxt->fio) \
902 MBUF_GETINT(x); \
9e21b3d0 903 else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
7a6a85bf 904 return (SV *) 0; \
9e21b3d0
JH
905 if (cxt->netorder) \
906 x = (int) ntohl(x); \
111e03c1 907 } STMT_END
9e21b3d0
JH
908#else
909#define RLEN(x) READ_I32(x)
7a6a85bf
RG
910#endif
911
111e03c1
RG
912#define READ(x,y) \
913 STMT_START { \
7a6a85bf
RG
914 if (!cxt->fio) \
915 MBUF_READ(x, y); \
916 else if (PerlIO_read(cxt->fio, x, y) != y) \
917 return (SV *) 0; \
111e03c1 918 } STMT_END
7a6a85bf 919
111e03c1
RG
920#define SAFEREAD(x,y,z) \
921 STMT_START { \
7a6a85bf
RG
922 if (!cxt->fio) \
923 MBUF_SAFEREAD(x,y,z); \
924 else if (PerlIO_read(cxt->fio, x, y) != y) { \
925 sv_free(z); \
926 return (SV *) 0; \
927 } \
111e03c1 928 } STMT_END
7a6a85bf
RG
929
930/*
931 * This macro is used at retrieve time, to remember where object 'y', bearing a
932 * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
933 * we'll therefore know where it has been retrieved and will be able to
934 * share the same reference, as in the original stored memory image.
b12202d0
JH
935 *
936 * We also need to bless objects ASAP for hooks (which may compute "ref $x"
937 * on the objects given to STORABLE_thaw and expect that to be defined), and
938 * also for overloaded objects (for which we might not find the stash if the
939 * object is not blessed yet--this might occur for overloaded objects that
940 * refer to themselves indirectly: if we blessed upon return from a sub
941 * retrieve(), the SX_OBJECT marker we'd found could not have overloading
942 * restored on it because the underlying object would not be blessed yet!).
943 *
944 * To achieve that, the class name of the last retrieved object is passed down
945 * recursively, and the first SEEN() call for which the class name is not NULL
946 * will bless the object.
7a6a85bf 947 */
111e03c1
RG
948#define SEEN(y,c) \
949 STMT_START { \
7a6a85bf
RG
950 if (!y) \
951 return (SV *) 0; \
952 if (av_store(cxt->aseen, cxt->tagnum++, SvREFCNT_inc(y)) == 0) \
953 return (SV *) 0; \
43d061fe 954 TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
b12202d0
JH
955 PTR2UV(y), SvREFCNT(y)-1)); \
956 if (c) \
957 BLESS((SV *) (y), c); \
111e03c1 958 } STMT_END
7a6a85bf
RG
959
960/*
961 * Bless `s' in `p', via a temporary reference, required by sv_bless().
962 */
111e03c1
RG
963#define BLESS(s,p) \
964 STMT_START { \
7a6a85bf
RG
965 SV *ref; \
966 HV *stash; \
43d061fe 967 TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
7a6a85bf
RG
968 stash = gv_stashpv((p), TRUE); \
969 ref = newRV_noinc(s); \
970 (void) sv_bless(ref, stash); \
971 SvRV(ref) = 0; \
972 SvREFCNT_dec(ref); \
111e03c1 973 } STMT_END
7a6a85bf
RG
974
975static int store();
b12202d0 976static SV *retrieve(stcxt_t *cxt, char *cname);
7a6a85bf
RG
977
978/*
979 * Dynamic dispatching table for SV store.
980 */
981
982static int store_ref(stcxt_t *cxt, SV *sv);
983static int store_scalar(stcxt_t *cxt, SV *sv);
984static int store_array(stcxt_t *cxt, AV *av);
985static int store_hash(stcxt_t *cxt, HV *hv);
986static int store_tied(stcxt_t *cxt, SV *sv);
987static int store_tied_item(stcxt_t *cxt, SV *sv);
464b080a 988static int store_code(stcxt_t *cxt, CV *cv);
7a6a85bf 989static int store_other(stcxt_t *cxt, SV *sv);
f0ffaed8 990static int store_blessed(stcxt_t *cxt, SV *sv, int type, HV *pkg);
7a6a85bf 991
862382c7
JH
992static int (*sv_store[])(stcxt_t *cxt, SV *sv) = {
993 store_ref, /* svis_REF */
994 store_scalar, /* svis_SCALAR */
995 (int (*)(stcxt_t *cxt, SV *sv)) store_array, /* svis_ARRAY */
996 (int (*)(stcxt_t *cxt, SV *sv)) store_hash, /* svis_HASH */
997 store_tied, /* svis_TIED */
998 store_tied_item, /* svis_TIED_ITEM */
464b080a 999 (int (*)(stcxt_t *cxt, SV *sv)) store_code, /* svis_CODE */
862382c7 1000 store_other, /* svis_OTHER */
7a6a85bf
RG
1001};
1002
1003#define SV_STORE(x) (*sv_store[x])
1004
1005/*
1006 * Dynamic dispatching tables for SV retrieval.
1007 */
1008
b12202d0
JH
1009static SV *retrieve_lscalar(stcxt_t *cxt, char *cname);
1010static SV *retrieve_lutf8str(stcxt_t *cxt, char *cname);
1011static SV *old_retrieve_array(stcxt_t *cxt, char *cname);
1012static SV *old_retrieve_hash(stcxt_t *cxt, char *cname);
1013static SV *retrieve_ref(stcxt_t *cxt, char *cname);
1014static SV *retrieve_undef(stcxt_t *cxt, char *cname);
1015static SV *retrieve_integer(stcxt_t *cxt, char *cname);
1016static SV *retrieve_double(stcxt_t *cxt, char *cname);
1017static SV *retrieve_byte(stcxt_t *cxt, char *cname);
1018static SV *retrieve_netint(stcxt_t *cxt, char *cname);
1019static SV *retrieve_scalar(stcxt_t *cxt, char *cname);
1020static SV *retrieve_utf8str(stcxt_t *cxt, char *cname);
1021static SV *retrieve_tied_array(stcxt_t *cxt, char *cname);
1022static SV *retrieve_tied_hash(stcxt_t *cxt, char *cname);
1023static SV *retrieve_tied_scalar(stcxt_t *cxt, char *cname);
1024static SV *retrieve_other(stcxt_t *cxt, char *cname);
1025
1026static SV *(*sv_old_retrieve[])(stcxt_t *cxt, char *cname) = {
7a6a85bf
RG
1027 0, /* SX_OBJECT -- entry unused dynamically */
1028 retrieve_lscalar, /* SX_LSCALAR */
1029 old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
1030 old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
1031 retrieve_ref, /* SX_REF */
1032 retrieve_undef, /* SX_UNDEF */
1033 retrieve_integer, /* SX_INTEGER */
1034 retrieve_double, /* SX_DOUBLE */
1035 retrieve_byte, /* SX_BYTE */
1036 retrieve_netint, /* SX_NETINT */
1037 retrieve_scalar, /* SX_SCALAR */
1038 retrieve_tied_array, /* SX_ARRAY */
1039 retrieve_tied_hash, /* SX_HASH */
1040 retrieve_tied_scalar, /* SX_SCALAR */
1041 retrieve_other, /* SX_SV_UNDEF not supported */
1042 retrieve_other, /* SX_SV_YES not supported */
1043 retrieve_other, /* SX_SV_NO not supported */
1044 retrieve_other, /* SX_BLESS not supported */
1045 retrieve_other, /* SX_IX_BLESS not supported */
1046 retrieve_other, /* SX_HOOK not supported */
1047 retrieve_other, /* SX_OVERLOADED not supported */
1048 retrieve_other, /* SX_TIED_KEY not supported */
1049 retrieve_other, /* SX_TIED_IDX not supported */
dd19458b
JH
1050 retrieve_other, /* SX_UTF8STR not supported */
1051 retrieve_other, /* SX_LUTF8STR not supported */
e16e2ff8 1052 retrieve_other, /* SX_FLAG_HASH not supported */
464b080a 1053 retrieve_other, /* SX_CODE not supported */
7a6a85bf
RG
1054 retrieve_other, /* SX_ERROR */
1055};
1056
b12202d0
JH
1057static SV *retrieve_array(stcxt_t *cxt, char *cname);
1058static SV *retrieve_hash(stcxt_t *cxt, char *cname);
1059static SV *retrieve_sv_undef(stcxt_t *cxt, char *cname);
1060static SV *retrieve_sv_yes(stcxt_t *cxt, char *cname);
1061static SV *retrieve_sv_no(stcxt_t *cxt, char *cname);
1062static SV *retrieve_blessed(stcxt_t *cxt, char *cname);
1063static SV *retrieve_idx_blessed(stcxt_t *cxt, char *cname);
1064static SV *retrieve_hook(stcxt_t *cxt, char *cname);
1065static SV *retrieve_overloaded(stcxt_t *cxt, char *cname);
1066static SV *retrieve_tied_key(stcxt_t *cxt, char *cname);
1067static SV *retrieve_tied_idx(stcxt_t *cxt, char *cname);
e16e2ff8 1068static SV *retrieve_flag_hash(stcxt_t *cxt, char *cname);
464b080a 1069static SV *retrieve_code(stcxt_t *cxt, char *cname);
b12202d0
JH
1070
1071static SV *(*sv_retrieve[])(stcxt_t *cxt, char *cname) = {
7a6a85bf
RG
1072 0, /* SX_OBJECT -- entry unused dynamically */
1073 retrieve_lscalar, /* SX_LSCALAR */
1074 retrieve_array, /* SX_ARRAY */
1075 retrieve_hash, /* SX_HASH */
1076 retrieve_ref, /* SX_REF */
1077 retrieve_undef, /* SX_UNDEF */
1078 retrieve_integer, /* SX_INTEGER */
1079 retrieve_double, /* SX_DOUBLE */
1080 retrieve_byte, /* SX_BYTE */
1081 retrieve_netint, /* SX_NETINT */
1082 retrieve_scalar, /* SX_SCALAR */
1083 retrieve_tied_array, /* SX_ARRAY */
1084 retrieve_tied_hash, /* SX_HASH */
1085 retrieve_tied_scalar, /* SX_SCALAR */
1086 retrieve_sv_undef, /* SX_SV_UNDEF */
1087 retrieve_sv_yes, /* SX_SV_YES */
1088 retrieve_sv_no, /* SX_SV_NO */
1089 retrieve_blessed, /* SX_BLESS */
1090 retrieve_idx_blessed, /* SX_IX_BLESS */
1091 retrieve_hook, /* SX_HOOK */
1092 retrieve_overloaded, /* SX_OVERLOAD */
1093 retrieve_tied_key, /* SX_TIED_KEY */
1094 retrieve_tied_idx, /* SX_TIED_IDX */
dd19458b
JH
1095 retrieve_utf8str, /* SX_UTF8STR */
1096 retrieve_lutf8str, /* SX_LUTF8STR */
e16e2ff8 1097 retrieve_flag_hash, /* SX_HASH */
464b080a 1098 retrieve_code, /* SX_CODE */
7a6a85bf
RG
1099 retrieve_other, /* SX_ERROR */
1100};
1101
1102#define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1103
f0ffaed8 1104static SV *mbuf2sv(void);
7a6a85bf
RG
1105
1106/***
1107 *** Context management.
1108 ***/
1109
1110/*
1111 * init_perinterp
1112 *
1113 * Called once per "thread" (interpreter) to initialize some global context.
1114 */
f0ffaed8
JH
1115static void init_perinterp(void)
1116{
7a6a85bf
RG
1117 INIT_STCXT;
1118
1119 cxt->netorder = 0; /* true if network order used */
1120 cxt->forgive_me = -1; /* whether to be forgiving... */
1121}
1122
1123/*
e993d95c
JH
1124 * reset_context
1125 *
1126 * Called at the end of every context cleaning, to perform common reset
1127 * operations.
1128 */
1129static void reset_context(stcxt_t *cxt)
1130{
1131 cxt->entry = 0;
1132 cxt->s_dirty = 0;
1133 cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
1134}
1135
1136/*
7a6a85bf
RG
1137 * init_store_context
1138 *
1139 * Initialize a new store context for real recursion.
1140 */
f0ffaed8
JH
1141static void init_store_context(
1142 stcxt_t *cxt,
1143 PerlIO *f,
1144 int optype,
1145 int network_order)
7a6a85bf
RG
1146{
1147 TRACEME(("init_store_context"));
1148
1149 cxt->netorder = network_order;
1150 cxt->forgive_me = -1; /* Fetched from perl if needed */
464b080a
SR
1151 cxt->deparse = -1; /* Idem */
1152 cxt->eval = NULL; /* Idem */
7a6a85bf
RG
1153 cxt->canonical = -1; /* Idem */
1154 cxt->tagnum = -1; /* Reset tag numbers */
1155 cxt->classnum = -1; /* Reset class numbers */
1156 cxt->fio = f; /* Where I/O are performed */
1157 cxt->optype = optype; /* A store, or a deep clone */
1158 cxt->entry = 1; /* No recursion yet */
1159
1160 /*
1161 * The `hseen' table is used to keep track of each SV stored and their
1162 * associated tag numbers is special. It is "abused" because the
1163 * values stored are not real SV, just integers cast to (SV *),
1164 * which explains the freeing below.
1165 *
1166 * It is also one possible bottlneck to achieve good storing speed,
1167 * so the "shared keys" optimization is turned off (unlikely to be
1168 * of any use here), and the hash table is "pre-extended". Together,
1169 * those optimizations increase the throughput by 12%.
1170 */
1171
1172 cxt->hseen = newHV(); /* Table where seen objects are stored */
1173 HvSHAREKEYS_off(cxt->hseen);
1174
1175 /*
1176 * The following does not work well with perl5.004_04, and causes
1177 * a core dump later on, in a completely unrelated spot, which
1178 * makes me think there is a memory corruption going on.
1179 *
1180 * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1181 * it below does not make any difference. It seems to work fine
1182 * with perl5.004_68 but given the probable nature of the bug,
1183 * that does not prove anything.
1184 *
1185 * It's a shame because increasing the amount of buckets raises
1186 * store() throughput by 5%, but until I figure this out, I can't
1187 * allow for this to go into production.
1188 *
1189 * It is reported fixed in 5.005, hence the #if.
1190 */
f0ffaed8 1191#if PERL_VERSION >= 5
7a6a85bf
RG
1192#define HBUCKETS 4096 /* Buckets for %hseen */
1193 HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
1194#endif
1195
1196 /*
1197 * The `hclass' hash uses the same settings as `hseen' above, but it is
1198 * used to assign sequential tags (numbers) to class names for blessed
1199 * objects.
1200 *
1201 * We turn the shared key optimization on.
1202 */
1203
1204 cxt->hclass = newHV(); /* Where seen classnames are stored */
1205
f0ffaed8 1206#if PERL_VERSION >= 5
7a6a85bf
RG
1207 HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
1208#endif
1209
1210 /*
1211 * The `hook' hash table is used to keep track of the references on
1212 * the STORABLE_freeze hook routines, when found in some class name.
1213 *
1214 * It is assumed that the inheritance tree will not be changed during
1215 * storing, and that no new method will be dynamically created by the
1216 * hooks.
1217 */
1218
1219 cxt->hook = newHV(); /* Table where hooks are cached */
90826881
JH
1220
1221 /*
1222 * The `hook_seen' array keeps track of all the SVs returned by
1223 * STORABLE_freeze hooks for us to serialize, so that they are not
1224 * reclaimed until the end of the serialization process. Each SV is
1225 * only stored once, the first time it is seen.
1226 */
1227
1228 cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
7a6a85bf
RG
1229}
1230
1231/*
1232 * clean_store_context
1233 *
1234 * Clean store context by
1235 */
f0ffaed8 1236static void clean_store_context(stcxt_t *cxt)
7a6a85bf
RG
1237{
1238 HE *he;
1239
1240 TRACEME(("clean_store_context"));
1241
1242 ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1243
1244 /*
1245 * Insert real values into hashes where we stored faked pointers.
1246 */
1247
e993d95c
JH
1248 if (cxt->hseen) {
1249 hv_iterinit(cxt->hseen);
1250 while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
da5add9b 1251 HeVAL(he) = &PL_sv_undef;
e993d95c 1252 }
7a6a85bf 1253
e993d95c
JH
1254 if (cxt->hclass) {
1255 hv_iterinit(cxt->hclass);
1256 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
da5add9b 1257 HeVAL(he) = &PL_sv_undef;
e993d95c 1258 }
7a6a85bf
RG
1259
1260 /*
1261 * And now dispose of them...
862382c7
JH
1262 *
1263 * The surrounding if() protection has been added because there might be
1264 * some cases where this routine is called more than once, during
1265 * exceptionnal events. This was reported by Marc Lehmann when Storable
1266 * is executed from mod_perl, and the fix was suggested by him.
1267 * -- RAM, 20/12/2000
1268 */
1269
1270 if (cxt->hseen) {
1271 HV *hseen = cxt->hseen;
1272 cxt->hseen = 0;
1273 hv_undef(hseen);
1274 sv_free((SV *) hseen);
1275 }
7a6a85bf 1276
862382c7
JH
1277 if (cxt->hclass) {
1278 HV *hclass = cxt->hclass;
1279 cxt->hclass = 0;
1280 hv_undef(hclass);
1281 sv_free((SV *) hclass);
1282 }
7a6a85bf 1283
862382c7
JH
1284 if (cxt->hook) {
1285 HV *hook = cxt->hook;
1286 cxt->hook = 0;
1287 hv_undef(hook);
1288 sv_free((SV *) hook);
1289 }
7a6a85bf 1290
862382c7
JH
1291 if (cxt->hook_seen) {
1292 AV *hook_seen = cxt->hook_seen;
1293 cxt->hook_seen = 0;
1294 av_undef(hook_seen);
1295 sv_free((SV *) hook_seen);
1296 }
90826881 1297
e8189732 1298 cxt->forgive_me = -1; /* Fetched from perl if needed */
464b080a
SR
1299 cxt->deparse = -1; /* Idem */
1300 if (cxt->eval) {
1301 SvREFCNT_dec(cxt->eval);
1302 }
1303 cxt->eval = NULL; /* Idem */
e8189732
NC
1304 cxt->canonical = -1; /* Idem */
1305
e993d95c 1306 reset_context(cxt);
7a6a85bf
RG
1307}
1308
1309/*
1310 * init_retrieve_context
1311 *
1312 * Initialize a new retrieve context for real recursion.
1313 */
dd19458b 1314static void init_retrieve_context(stcxt_t *cxt, int optype, int is_tainted)
7a6a85bf
RG
1315{
1316 TRACEME(("init_retrieve_context"));
1317
1318 /*
1319 * The hook hash table is used to keep track of the references on
1320 * the STORABLE_thaw hook routines, when found in some class name.
1321 *
1322 * It is assumed that the inheritance tree will not be changed during
1323 * storing, and that no new method will be dynamically created by the
1324 * hooks.
1325 */
1326
1327 cxt->hook = newHV(); /* Caches STORABLE_thaw */
1328
1329 /*
1330 * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1331 * was set to sv_old_retrieve. We'll need a hash table to keep track of
1332 * the correspondance between the tags and the tag number used by the
1333 * new retrieve routines.
1334 */
1335
2cc1b180
JH
1336 cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1337 ? newHV() : 0);
7a6a85bf
RG
1338
1339 cxt->aseen = newAV(); /* Where retrieved objects are kept */
1340 cxt->aclass = newAV(); /* Where seen classnames are kept */
1341 cxt->tagnum = 0; /* Have to count objects... */
1342 cxt->classnum = 0; /* ...and class names as well */
1343 cxt->optype = optype;
dd19458b 1344 cxt->s_tainted = is_tainted;
7a6a85bf 1345 cxt->entry = 1; /* No recursion yet */
530b72ba
NC
1346#ifndef HAS_RESTRICTED_HASHES
1347 cxt->derestrict = -1; /* Fetched from perl if needed */
1348#endif
1349#ifndef HAS_UTF8_ALL
1350 cxt->use_bytes = -1; /* Fetched from perl if needed */
1351#endif
e8189732 1352 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
7a6a85bf
RG
1353}
1354
1355/*
1356 * clean_retrieve_context
1357 *
1358 * Clean retrieve context by
1359 */
dd19458b 1360static void clean_retrieve_context(stcxt_t *cxt)
7a6a85bf
RG
1361{
1362 TRACEME(("clean_retrieve_context"));
1363
1364 ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1365
862382c7
JH
1366 if (cxt->aseen) {
1367 AV *aseen = cxt->aseen;
1368 cxt->aseen = 0;
1369 av_undef(aseen);
1370 sv_free((SV *) aseen);
1371 }
7a6a85bf 1372
862382c7
JH
1373 if (cxt->aclass) {
1374 AV *aclass = cxt->aclass;
1375 cxt->aclass = 0;
1376 av_undef(aclass);
1377 sv_free((SV *) aclass);
1378 }
7a6a85bf 1379
862382c7
JH
1380 if (cxt->hook) {
1381 HV *hook = cxt->hook;
1382 cxt->hook = 0;
1383 hv_undef(hook);
1384 sv_free((SV *) hook);
1385 }
7a6a85bf 1386
862382c7
JH
1387 if (cxt->hseen) {
1388 HV *hseen = cxt->hseen;
1389 cxt->hseen = 0;
1390 hv_undef(hseen);
1391 sv_free((SV *) hseen); /* optional HV, for backward compat. */
1392 }
7a6a85bf 1393
e8189732
NC
1394#ifndef HAS_RESTRICTED_HASHES
1395 cxt->derestrict = -1; /* Fetched from perl if needed */
1396#endif
1397#ifndef HAS_UTF8_ALL
1398 cxt->use_bytes = -1; /* Fetched from perl if needed */
1399#endif
1400 cxt->accept_future_minor = -1; /* Fetched from perl if needed */
1401
e993d95c 1402 reset_context(cxt);
7a6a85bf
RG
1403}
1404
1405/*
1406 * clean_context
1407 *
1408 * A workaround for the CROAK bug: cleanup the last context.
1409 */
e993d95c 1410static void clean_context(stcxt_t *cxt)
7a6a85bf
RG
1411{
1412 TRACEME(("clean_context"));
1413
dd19458b 1414 ASSERT(cxt->s_dirty, ("dirty context"));
7a6a85bf 1415
e993d95c
JH
1416 if (cxt->membuf_ro)
1417 MBUF_RESTORE();
1418
1419 ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1420
7a6a85bf
RG
1421 if (cxt->optype & ST_RETRIEVE)
1422 clean_retrieve_context(cxt);
e993d95c 1423 else if (cxt->optype & ST_STORE)
7a6a85bf 1424 clean_store_context(cxt);
e993d95c
JH
1425 else
1426 reset_context(cxt);
862382c7
JH
1427
1428 ASSERT(!cxt->s_dirty, ("context is clean"));
e993d95c 1429 ASSERT(cxt->entry == 0, ("context is reset"));
7a6a85bf
RG
1430}
1431
1432/*
1433 * allocate_context
1434 *
1435 * Allocate a new context and push it on top of the parent one.
1436 * This new context is made globally visible via SET_STCXT().
1437 */
1438static stcxt_t *allocate_context(parent_cxt)
1439stcxt_t *parent_cxt;
1440{
1441 stcxt_t *cxt;
1442
1443 TRACEME(("allocate_context"));
1444
dd19458b 1445 ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
7a6a85bf 1446
111e03c1
RG
1447 NEW_STORABLE_CXT_OBJ(cxt);
1448 cxt->prev = parent_cxt->my_sv;
7a6a85bf
RG
1449 SET_STCXT(cxt);
1450
e993d95c
JH
1451 ASSERT(!cxt->s_dirty, ("clean context"));
1452
7a6a85bf
RG
1453 return cxt;
1454}
1455
1456/*
1457 * free_context
1458 *
1459 * Free current context, which cannot be the "root" one.
1460 * Make the context underneath globally visible via SET_STCXT().
1461 */
1462static void free_context(cxt)
1463stcxt_t *cxt;
1464{
111e03c1 1465 stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
7a6a85bf
RG
1466
1467 TRACEME(("free_context"));
1468
dd19458b 1469 ASSERT(!cxt->s_dirty, ("clean context"));
7a6a85bf
RG
1470 ASSERT(prev, ("not freeing root context"));
1471
111e03c1 1472 SvREFCNT_dec(cxt->my_sv);
7a6a85bf 1473 SET_STCXT(prev);
e993d95c
JH
1474
1475 ASSERT(cxt, ("context not void"));
7a6a85bf
RG
1476}
1477
1478/***
1479 *** Predicates.
1480 ***/
1481
1482/*
1483 * is_storing
1484 *
1485 * Tells whether we're in the middle of a store operation.
1486 */
f0ffaed8 1487int is_storing(void)
7a6a85bf
RG
1488{
1489 dSTCXT;
1490
1491 return cxt->entry && (cxt->optype & ST_STORE);
1492}
1493
1494/*
1495 * is_retrieving
1496 *
1497 * Tells whether we're in the middle of a retrieve operation.
1498 */
f0ffaed8 1499int is_retrieving(void)
7a6a85bf
RG
1500{
1501 dSTCXT;
1502
1503 return cxt->entry && (cxt->optype & ST_RETRIEVE);
1504}
1505
1506/*
1507 * last_op_in_netorder
1508 *
1509 * Returns whether last operation was made using network order.
1510 *
1511 * This is typically out-of-band information that might prove useful
1512 * to people wishing to convert native to network order data when used.
1513 */
f0ffaed8 1514int last_op_in_netorder(void)
7a6a85bf
RG
1515{
1516 dSTCXT;
1517
1518 return cxt->netorder;
1519}
1520
1521/***
1522 *** Hook lookup and calling routines.
1523 ***/
1524
1525/*
1526 * pkg_fetchmeth
1527 *
1528 * A wrapper on gv_fetchmethod_autoload() which caches results.
1529 *
1530 * Returns the routine reference as an SV*, or null if neither the package
1531 * nor its ancestors know about the method.
1532 */
f0ffaed8
JH
1533static SV *pkg_fetchmeth(
1534 HV *cache,
1535 HV *pkg,
1536 char *method)
7a6a85bf
RG
1537{
1538 GV *gv;
1539 SV *sv;
7a6a85bf
RG
1540
1541 /*
1542 * The following code is the same as the one performed by UNIVERSAL::can
1543 * in the Perl core.
1544 */
1545
1546 gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1547 if (gv && isGV(gv)) {
1548 sv = newRV((SV*) GvCV(gv));
9e21b3d0 1549 TRACEME(("%s->%s: 0x%"UVxf, HvNAME(pkg), method, PTR2UV(sv)));
7a6a85bf
RG
1550 } else {
1551 sv = newSVsv(&PL_sv_undef);
1552 TRACEME(("%s->%s: not found", HvNAME(pkg), method));
1553 }
1554
1555 /*
1556 * Cache the result, ignoring failure: if we can't store the value,
1557 * it just won't be cached.
1558 */
1559
1560 (void) hv_store(cache, HvNAME(pkg), strlen(HvNAME(pkg)), sv, 0);
1561
1562 return SvOK(sv) ? sv : (SV *) 0;
1563}
1564
1565/*
1566 * pkg_hide
1567 *
1568 * Force cached value to be undef: hook ignored even if present.
1569 */
f0ffaed8
JH
1570static void pkg_hide(
1571 HV *cache,
1572 HV *pkg,
1573 char *method)
7a6a85bf
RG
1574{
1575 (void) hv_store(cache,
1576 HvNAME(pkg), strlen(HvNAME(pkg)), newSVsv(&PL_sv_undef), 0);
1577}
1578
1579/*
212e9bde
JH
1580 * pkg_uncache
1581 *
1582 * Discard cached value: a whole fetch loop will be retried at next lookup.
1583 */
1584static void pkg_uncache(
1585 HV *cache,
1586 HV *pkg,
1587 char *method)
1588{
1589 (void) hv_delete(cache, HvNAME(pkg), strlen(HvNAME(pkg)), G_DISCARD);
1590}
1591
1592/*
7a6a85bf
RG
1593 * pkg_can
1594 *
1595 * Our own "UNIVERSAL::can", which caches results.
1596 *
1597 * Returns the routine reference as an SV*, or null if the object does not
1598 * know about the method.
1599 */
f0ffaed8
JH
1600static SV *pkg_can(
1601 HV *cache,
1602 HV *pkg,
1603 char *method)
7a6a85bf
RG
1604{
1605 SV **svh;
1606 SV *sv;
1607
1608 TRACEME(("pkg_can for %s->%s", HvNAME(pkg), method));
1609
1610 /*
1611 * Look into the cache to see whether we already have determined
1612 * where the routine was, if any.
1613 *
1614 * NOTA BENE: we don't use `method' at all in our lookup, since we know
1615 * that only one hook (i.e. always the same) is cached in a given cache.
1616 */
1617
1618 svh = hv_fetch(cache, HvNAME(pkg), strlen(HvNAME(pkg)), FALSE);
1619 if (svh) {
1620 sv = *svh;
1621 if (!SvOK(sv)) {
1622 TRACEME(("cached %s->%s: not found", HvNAME(pkg), method));
1623 return (SV *) 0;
1624 } else {
43d061fe 1625 TRACEME(("cached %s->%s: 0x%"UVxf,
9e21b3d0 1626 HvNAME(pkg), method, PTR2UV(sv)));
7a6a85bf
RG
1627 return sv;
1628 }
1629 }
1630
1631 TRACEME(("not cached yet"));
1632 return pkg_fetchmeth(cache, pkg, method); /* Fetch and cache */
1633}
1634
1635/*
1636 * scalar_call
1637 *
1638 * Call routine as obj->hook(av) in scalar context.
1639 * Propagates the single returned value if not called in void context.
1640 */
f0ffaed8
JH
1641static SV *scalar_call(
1642 SV *obj,
1643 SV *hook,
1644 int cloning,
1645 AV *av,
1646 I32 flags)
7a6a85bf
RG
1647{
1648 dSP;
1649 int count;
1650 SV *sv = 0;
1651
1652 TRACEME(("scalar_call (cloning=%d)", cloning));
1653
1654 ENTER;
1655 SAVETMPS;
1656
1657 PUSHMARK(sp);
1658 XPUSHs(obj);
1659 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1660 if (av) {
1661 SV **ary = AvARRAY(av);
1662 int cnt = AvFILLp(av) + 1;
1663 int i;
1664 XPUSHs(ary[0]); /* Frozen string */
1665 for (i = 1; i < cnt; i++) {
43d061fe
JH
1666 TRACEME(("pushing arg #%d (0x%"UVxf")...",
1667 i, PTR2UV(ary[i])));
7a6a85bf
RG
1668 XPUSHs(sv_2mortal(newRV(ary[i])));
1669 }
1670 }
1671 PUTBACK;
1672
1673 TRACEME(("calling..."));
1674 count = perl_call_sv(hook, flags); /* Go back to Perl code */
1675 TRACEME(("count = %d", count));
1676
1677 SPAGAIN;
1678
1679 if (count) {
1680 sv = POPs;
1681 SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
1682 }
1683
1684 PUTBACK;
1685 FREETMPS;
1686 LEAVE;
1687
1688 return sv;
1689}
1690
1691/*
1692 * array_call
1693 *
f9a1036d 1694 * Call routine obj->hook(cloning) in list context.
7a6a85bf
RG
1695 * Returns the list of returned values in an array.
1696 */
f0ffaed8
JH
1697static AV *array_call(
1698 SV *obj,
1699 SV *hook,
1700 int cloning)
7a6a85bf
RG
1701{
1702 dSP;
1703 int count;
1704 AV *av;
1705 int i;
1706
f0ffaed8 1707 TRACEME(("array_call (cloning=%d)", cloning));
7a6a85bf
RG
1708
1709 ENTER;
1710 SAVETMPS;
1711
1712 PUSHMARK(sp);
1713 XPUSHs(obj); /* Target object */
1714 XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
1715 PUTBACK;
1716
1717 count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
1718
1719 SPAGAIN;
1720
1721 av = newAV();
1722 for (i = count - 1; i >= 0; i--) {
1723 SV *sv = POPs;
1724 av_store(av, i, SvREFCNT_inc(sv));
1725 }
1726
1727 PUTBACK;
1728 FREETMPS;
1729 LEAVE;
1730
1731 return av;
1732}
1733
1734/*
1735 * known_class
1736 *
1737 * Lookup the class name in the `hclass' table and either assign it a new ID
1738 * or return the existing one, by filling in `classnum'.
1739 *
1740 * Return true if the class was known, false if the ID was just generated.
1741 */
f0ffaed8
JH
1742static int known_class(
1743 stcxt_t *cxt,
1744 char *name, /* Class name */
1745 int len, /* Name length */
1746 I32 *classnum)
7a6a85bf
RG
1747{
1748 SV **svh;
1749 HV *hclass = cxt->hclass;
1750
1751 TRACEME(("known_class (%s)", name));
1752
1753 /*
1754 * Recall that we don't store pointers in this hash table, but tags.
1755 * Therefore, we need LOW_32BITS() to extract the relevant parts.
1756 */
1757
1758 svh = hv_fetch(hclass, name, len, FALSE);
1759 if (svh) {
1760 *classnum = LOW_32BITS(*svh);
1761 return TRUE;
1762 }
1763
1764 /*
1765 * Unknown classname, we need to record it.
7a6a85bf
RG
1766 */
1767
1768 cxt->classnum++;
3341c981 1769 if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
7a6a85bf
RG
1770 CROAK(("Unable to record new classname"));
1771
1772 *classnum = cxt->classnum;
1773 return FALSE;
1774}
1775
1776/***
1777 *** Sepcific store routines.
1778 ***/
1779
1780/*
1781 * store_ref
1782 *
1783 * Store a reference.
1784 * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1785 */
f0ffaed8 1786static int store_ref(stcxt_t *cxt, SV *sv)
7a6a85bf 1787{
43d061fe 1788 TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
7a6a85bf
RG
1789
1790 /*
1791 * Follow reference, and check if target is overloaded.
1792 */
1793
1794 sv = SvRV(sv);
1795
1796 if (SvOBJECT(sv)) {
1797 HV *stash = (HV *) SvSTASH(sv);
1798 if (stash && Gv_AMG(stash)) {
9e21b3d0 1799 TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
7a6a85bf
RG
1800 PUTMARK(SX_OVERLOAD);
1801 } else
1802 PUTMARK(SX_REF);
1803 } else
1804 PUTMARK(SX_REF);
1805
1806 return store(cxt, sv);
1807}
1808
1809/*
1810 * store_scalar
1811 *
1812 * Store a scalar.
1813 *
e16e2ff8 1814 * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
7a6a85bf
RG
1815 * The <data> section is omitted if <length> is 0.
1816 *
1817 * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1818 * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1819 */
f0ffaed8 1820static int store_scalar(stcxt_t *cxt, SV *sv)
7a6a85bf
RG
1821{
1822 IV iv;
1823 char *pv;
1824 STRLEN len;
1825 U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
1826
43d061fe 1827 TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
7a6a85bf
RG
1828
1829 /*
1830 * For efficiency, break the SV encapsulation by peaking at the flags
1831 * directly without using the Perl macros to avoid dereferencing
1832 * sv->sv_flags each time we wish to check the flags.
1833 */
1834
1835 if (!(flags & SVf_OK)) { /* !SvOK(sv) */
1836 if (sv == &PL_sv_undef) {
1837 TRACEME(("immortal undef"));
1838 PUTMARK(SX_SV_UNDEF);
1839 } else {
86bbd6dc 1840 TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
7a6a85bf
RG
1841 PUTMARK(SX_UNDEF);
1842 }
1843 return 0;
1844 }
1845
1846 /*
1847 * Always store the string representation of a scalar if it exists.
1848 * Gisle Aas provided me with this test case, better than a long speach:
1849 *
1850 * perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1851 * SV = PVNV(0x80c8520)
1852 * REFCNT = 1
1853 * FLAGS = (NOK,POK,pNOK,pPOK)
1854 * IV = 0
1855 * NV = 0
1856 * PV = 0x80c83d0 "abc"\0
1857 * CUR = 3
1858 * LEN = 4
1859 *
1860 * Write SX_SCALAR, length, followed by the actual data.
1861 *
1862 * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
1863 * appropriate, followed by the actual (binary) data. A double
1864 * is written as a string if network order, for portability.
1865 *
1866 * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
1867 * The reason is that when the scalar value is tainted, the SvNOK(sv)
1868 * value is false.
1869 *
1870 * The test for a read-only scalar with both POK and NOK set is meant
1871 * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
1872 * address comparison for each scalar we store.
1873 */
1874
1875#define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
1876
1877 if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
1878 if (sv == &PL_sv_yes) {
1879 TRACEME(("immortal yes"));
1880 PUTMARK(SX_SV_YES);
1881 } else if (sv == &PL_sv_no) {
1882 TRACEME(("immortal no"));
1883 PUTMARK(SX_SV_NO);
1884 } else {
1885 pv = SvPV(sv, len); /* We know it's SvPOK */
1886 goto string; /* Share code below */
1887 }
db670f21
NC
1888 } else if (flags & SVf_POK) {
1889 /* public string - go direct to string read. */
1890 goto string_readlen;
1891 } else if (
1892#if (PATCHLEVEL <= 6)
1893 /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
1894 direct if NV flag is off. */
1895 (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
1896#else
1897 /* 5.7 rules are that if IV public flag is set, IV value is as
1898 good, if not better, than NV value. */
1899 flags & SVf_IOK
1900#endif
1901 ) {
1902 iv = SvIV(sv);
1903 /*
1904 * Will come here from below with iv set if double is an integer.
1905 */
1906 integer:
7a6a85bf 1907
db670f21
NC
1908 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1909#ifdef SVf_IVisUV
1910 /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
1911 * (for example) and that ends up in the optimised small integer
1912 * case.
1913 */
1914 if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
1915 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
1916 goto string_readlen;
1917 }
1918#endif
1919 /*
1920 * Optimize small integers into a single byte, otherwise store as
1921 * a real integer (converted into network order if they asked).
1922 */
7a6a85bf 1923
db670f21
NC
1924 if (iv >= -128 && iv <= 127) {
1925 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
1926 PUTMARK(SX_BYTE);
1927 PUTMARK(siv);
1928 TRACEME(("small integer stored as %d", siv));
1929 } else if (cxt->netorder) {
1930#ifndef HAS_HTONL
1931 TRACEME(("no htonl, fall back to string for integer"));
1932 goto string_readlen;
1933#else
1934 I32 niv;
7a6a85bf 1935
7a6a85bf 1936
db670f21
NC
1937#if IVSIZE > 4
1938 if (
1939#ifdef SVf_IVisUV
1940 /* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
1941 ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
1942#endif
1943 (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
1944 /* Bigger than 32 bits. */
1945 TRACEME(("large network order integer as string, value = %"IVdf, iv));
1946 goto string_readlen;
1947 }
1948#endif
7a6a85bf 1949
db670f21
NC
1950 niv = (I32) htonl((I32) iv);
1951 TRACEME(("using network order"));
1952 PUTMARK(SX_NETINT);
1953 WRITE_I32(niv);
1954#endif
1955 } else {
1956 PUTMARK(SX_INTEGER);
1957 WRITE(&iv, sizeof(iv));
1958 }
1959
1960 TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
1961 } else if (flags & SVf_NOK) {
1962 NV nv;
1963#if (PATCHLEVEL <= 6)
1964 nv = SvNV(sv);
1965 /*
1966 * Watch for number being an integer in disguise.
1967 */
1968 if (nv == (NV) (iv = I_V(nv))) {
1969 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
1970 goto integer; /* Share code above */
1971 }
1972#else
7a6a85bf 1973
db670f21 1974 SvIV_please(sv);
3ddd445a 1975 if (SvIOK_notUV(sv)) {
db670f21
NC
1976 iv = SvIV(sv);
1977 goto integer; /* Share code above */
1978 }
1979 nv = SvNV(sv);
1980#endif
7a6a85bf 1981
db670f21
NC
1982 if (cxt->netorder) {
1983 TRACEME(("double %"NVff" stored as string", nv));
1984 goto string_readlen; /* Share code below */
1985 }
7a6a85bf 1986
db670f21
NC
1987 PUTMARK(SX_DOUBLE);
1988 WRITE(&nv, sizeof(nv));
7a6a85bf 1989
db670f21 1990 TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
7a6a85bf 1991
db670f21
NC
1992 } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
1993 I32 wlen; /* For 64-bit machines */
7a6a85bf 1994
db670f21
NC
1995 string_readlen:
1996 pv = SvPV(sv, len);
7a6a85bf 1997
db670f21
NC
1998 /*
1999 * Will come here from above if it was readonly, POK and NOK but
2000 * neither &PL_sv_yes nor &PL_sv_no.
2001 */
2002 string:
2003
2004 wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2005 if (SvUTF8 (sv))
2006 STORE_UTF8STR(pv, wlen);
2007 else
2008 STORE_SCALAR(pv, wlen);
2009 TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2010 PTR2UV(sv), SvPVX(sv), (IV)len));
7a6a85bf 2011 } else
db670f21
NC
2012 CROAK(("Can't determine type of %s(0x%"UVxf")",
2013 sv_reftype(sv, FALSE),
2014 PTR2UV(sv)));
2015 return 0; /* Ok, no recursion on scalars */
7a6a85bf
RG
2016}
2017
2018/*
2019 * store_array
2020 *
2021 * Store an array.
2022 *
2023 * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2024 * Each item is stored as <object>.
2025 */
f0ffaed8 2026static int store_array(stcxt_t *cxt, AV *av)
7a6a85bf
RG
2027{
2028 SV **sav;
2029 I32 len = av_len(av) + 1;
2030 I32 i;
2031 int ret;
2032
43d061fe 2033 TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
7a6a85bf
RG
2034
2035 /*
2036 * Signal array by emitting SX_ARRAY, followed by the array length.
2037 */
2038
2039 PUTMARK(SX_ARRAY);
2040 WLEN(len);
2041 TRACEME(("size = %d", len));
2042
2043 /*
2044 * Now store each item recursively.
2045 */
2046
2047 for (i = 0; i < len; i++) {
2048 sav = av_fetch(av, i, 0);
2049 if (!sav) {
2050 TRACEME(("(#%d) undef item", i));
20bb3f55 2051 STORE_SV_UNDEF();
7a6a85bf
RG
2052 continue;
2053 }
2054 TRACEME(("(#%d) item", i));
e993d95c 2055 if ((ret = store(cxt, *sav))) /* Extra () for -Wall, grr... */
7a6a85bf
RG
2056 return ret;
2057 }
2058
2059 TRACEME(("ok (array)"));
2060
2061 return 0;
2062}
2063
2064/*
2065 * sortcmp
2066 *
2067 * Sort two SVs
2068 * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2069 */
2070static int
f0ffaed8 2071sortcmp(const void *a, const void *b)
7a6a85bf
RG
2072{
2073 return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2074}
2075
2076
2077/*
2078 * store_hash
2079 *
d1be9408 2080 * Store a hash table.
7a6a85bf 2081 *
e16e2ff8
NC
2082 * For a "normal" hash (not restricted, no utf8 keys):
2083 *
7a6a85bf
RG
2084 * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2085 * Values are stored as <object>.
2086 * Keys are stored as <length> <data>, the <data> section being omitted
2087 * if length is 0.
c194a0a3
TB
2088 *
2089 * For a "fancy" hash (restricted or utf8 keys):
2090 *
2091 * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
e16e2ff8
NC
2092 * in random order.
2093 * Values are stored as <object>.
2094 * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2095 * if length is 0.
2096 * Currently the only hash flag is "restriced"
2097 * Key flags are as for hv.h
7a6a85bf 2098 */
f0ffaed8 2099static int store_hash(stcxt_t *cxt, HV *hv)
7a6a85bf 2100{
530b72ba
NC
2101 I32 len =
2102#ifdef HAS_RESTRICTED_HASHES
2103 HvTOTALKEYS(hv);
2104#else
2105 HvKEYS(hv);
2106#endif
7a6a85bf
RG
2107 I32 i;
2108 int ret = 0;
2109 I32 riter;
2110 HE *eiter;
530b72ba
NC
2111 int flagged_hash = ((SvREADONLY(hv)
2112#ifdef HAS_HASH_KEY_FLAGS
2113 || HvHASKFLAGS(hv)
2114#endif
2115 ) ? 1 : 0);
e16e2ff8 2116 unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
7a6a85bf 2117
e16e2ff8
NC
2118 if (flagged_hash) {
2119 /* needs int cast for C++ compilers, doesn't it? */
2120 TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2121 (int) hash_flags));
2122 } else {
2123 TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2124 }
7a6a85bf
RG
2125
2126 /*
2127 * Signal hash by emitting SX_HASH, followed by the table length.
2128 */
2129
e16e2ff8
NC
2130 if (flagged_hash) {
2131 PUTMARK(SX_FLAG_HASH);
2132 PUTMARK(hash_flags);
2133 } else {
2134 PUTMARK(SX_HASH);
2135 }
7a6a85bf
RG
2136 WLEN(len);
2137 TRACEME(("size = %d", len));
2138
2139 /*
2140 * Save possible iteration state via each() on that table.
2141 */
2142
2143 riter = HvRITER(hv);
2144 eiter = HvEITER(hv);
2145 hv_iterinit(hv);
2146
2147 /*
2148 * Now store each item recursively.
2149 *
2150 * If canonical is defined to some true value then store each
2151 * key/value pair in sorted order otherwise the order is random.
2152 * Canonical order is irrelevant when a deep clone operation is performed.
2153 *
2154 * Fetch the value from perl only once per store() operation, and only
2155 * when needed.
2156 */
2157
2158 if (
2159 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2160 (cxt->canonical < 0 && (cxt->canonical =
e16e2ff8 2161 (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
7a6a85bf
RG
2162 ) {
2163 /*
2164 * Storing in order, sorted by key.
2165 * Run through the hash, building up an array of keys in a
2166 * mortal array, sort the array and then run through the
2167 * array.
2168 */
2169
2170 AV *av = newAV();
2171
e16e2ff8
NC
2172 /*av_extend (av, len);*/
2173
7a6a85bf
RG
2174 TRACEME(("using canonical order"));
2175
2176 for (i = 0; i < len; i++) {
530b72ba 2177#ifdef HAS_RESTRICTED_HASHES
e16e2ff8 2178 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
530b72ba
NC
2179#else
2180 HE *he = hv_iternext(hv);
2181#endif
7a6a85bf
RG
2182 SV *key = hv_iterkeysv(he);
2183 av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
2184 }
2185
2186 qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
2187
2188 for (i = 0; i < len; i++) {
e16e2ff8 2189 unsigned char flags;
7a6a85bf 2190 char *keyval;
e16e2ff8
NC
2191 STRLEN keylen_tmp;
2192 I32 keylen;
7a6a85bf
RG
2193 SV *key = av_shift(av);
2194 HE *he = hv_fetch_ent(hv, key, 0, 0);
2195 SV *val = HeVAL(he);
2196 if (val == 0)
2197 return 1; /* Internal error, not I/O error */
2198
2199 /*
2200 * Store value first.
2201 */
2202
9e21b3d0 2203 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
7a6a85bf 2204
e993d95c 2205 if ((ret = store(cxt, val))) /* Extra () for -Wall, grr... */
7a6a85bf
RG
2206 goto out;
2207
2208 /*
2209 * Write key string.
2210 * Keys are written after values to make sure retrieval
2211 * can be optimal in terms of memory usage, where keys are
2212 * read into a fixed unique buffer called kbuf.
2213 * See retrieve_hash() for details.
2214 */
2215
e16e2ff8
NC
2216 /* Implementation of restricted hashes isn't nicely
2217 abstracted: */
2218 flags
2219 = (((hash_flags & SHV_RESTRICTED)
2220 && SvREADONLY(val))
2221 ? SHV_K_LOCKED : 0);
7996736c 2222 if (val == &PL_sv_placeholder)
e16e2ff8
NC
2223 flags |= SHV_K_PLACEHOLDER;
2224
2225 keyval = SvPV(key, keylen_tmp);
2226 keylen = keylen_tmp;
530b72ba
NC
2227#ifdef HAS_UTF8_HASHES
2228 /* If you build without optimisation on pre 5.6
2229 then nothing spots that SvUTF8(key) is always 0,
2230 so the block isn't optimised away, at which point
2231 the linker dislikes the reference to
2232 bytes_from_utf8. */
e16e2ff8
NC
2233 if (SvUTF8(key)) {
2234 const char *keysave = keyval;
2235 bool is_utf8 = TRUE;
2236
2237 /* Just casting the &klen to (STRLEN) won't work
2238 well if STRLEN and I32 are of different widths.
2239 --jhi */
2240 keyval = (char*)bytes_from_utf8((U8*)keyval,
2241 &keylen_tmp,
2242 &is_utf8);
2243
2244 /* If we were able to downgrade here, then than
2245 means that we have a key which only had chars
2246 0-255, but was utf8 encoded. */
2247
2248 if (keyval != keysave) {
2249 keylen = keylen_tmp;
2250 flags |= SHV_K_WASUTF8;
2251 } else {
2252 /* keylen_tmp can't have changed, so no need
2253 to assign back to keylen. */
2254 flags |= SHV_K_UTF8;
2255 }
2256 }
530b72ba 2257#endif
e16e2ff8
NC
2258
2259 if (flagged_hash) {
2260 PUTMARK(flags);
2261 TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2262 } else {
fcaa57e7
AMS
2263 /* This is a workaround for a bug in 5.8.0
2264 that causes the HEK_WASUTF8 flag to be
2265 set on an HEK without the hash being
2266 marked as having key flags. We just
2267 cross our fingers and drop the flag.
2268 AMS 20030901 */
2269 assert (flags == 0 || flags == SHV_K_WASUTF8);
e16e2ff8
NC
2270 TRACEME(("(#%d) key '%s'", i, keyval));
2271 }
7a6a85bf
RG
2272 WLEN(keylen);
2273 if (keylen)
2274 WRITE(keyval, keylen);
e16e2ff8
NC
2275 if (flags & SHV_K_WASUTF8)
2276 Safefree (keyval);
7a6a85bf
RG
2277 }
2278
2279 /*
2280 * Free up the temporary array
2281 */
2282
2283 av_undef(av);
2284 sv_free((SV *) av);
2285
2286 } else {
2287
2288 /*
2289 * Storing in "random" order (in the order the keys are stored
a6d05634 2290 * within the hash). This is the default and will be faster!
7a6a85bf
RG
2291 */
2292
2293 for (i = 0; i < len; i++) {
2294 char *key;
2295 I32 len;
e16e2ff8 2296 unsigned char flags;
530b72ba 2297#ifdef HV_ITERNEXT_WANTPLACEHOLDERS
e16e2ff8 2298 HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
530b72ba
NC
2299#else
2300 HE *he = hv_iternext(hv);
2301#endif
e16e2ff8
NC
2302 SV *val = (he ? hv_iterval(hv, he) : 0);
2303 SV *key_sv = NULL;
2304 HEK *hek;
7a6a85bf
RG
2305
2306 if (val == 0)
2307 return 1; /* Internal error, not I/O error */
2308
2309 /*
2310 * Store value first.
2311 */
2312
9e21b3d0 2313 TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
7a6a85bf 2314
e993d95c 2315 if ((ret = store(cxt, val))) /* Extra () for -Wall, grr... */
7a6a85bf
RG
2316 goto out;
2317
e16e2ff8
NC
2318 /* Implementation of restricted hashes isn't nicely
2319 abstracted: */
2320 flags
2321 = (((hash_flags & SHV_RESTRICTED)
2322 && SvREADONLY(val))
2323 ? SHV_K_LOCKED : 0);
7996736c 2324 if (val == &PL_sv_placeholder)
e16e2ff8
NC
2325 flags |= SHV_K_PLACEHOLDER;
2326
2327 hek = HeKEY_hek(he);
2328 len = HEK_LEN(hek);
2329 if (len == HEf_SVKEY) {
2330 /* This is somewhat sick, but the internal APIs are
2331 * such that XS code could put one of these in in
2332 * a regular hash.
2333 * Maybe we should be capable of storing one if
2334 * found.
2335 */
2336 key_sv = HeKEY_sv(he);
2337 flags |= SHV_K_ISSV;
2338 } else {
2339 /* Regular string key. */
530b72ba 2340#ifdef HAS_HASH_KEY_FLAGS
e16e2ff8
NC
2341 if (HEK_UTF8(hek))
2342 flags |= SHV_K_UTF8;
2343 if (HEK_WASUTF8(hek))
2344 flags |= SHV_K_WASUTF8;
530b72ba 2345#endif
e16e2ff8
NC
2346 key = HEK_KEY(hek);
2347 }
7a6a85bf
RG
2348 /*
2349 * Write key string.
2350 * Keys are written after values to make sure retrieval
2351 * can be optimal in terms of memory usage, where keys are
2352 * read into a fixed unique buffer called kbuf.
2353 * See retrieve_hash() for details.
2354 */
2355
e16e2ff8
NC
2356 if (flagged_hash) {
2357 PUTMARK(flags);
2358 TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2359 } else {
fcaa57e7
AMS
2360 /* This is a workaround for a bug in 5.8.0
2361 that causes the HEK_WASUTF8 flag to be
2362 set on an HEK without the hash being
2363 marked as having key flags. We just
2364 cross our fingers and drop the flag.
2365 AMS 20030901 */
2366 assert (flags == 0 || flags == SHV_K_WASUTF8);
e16e2ff8
NC
2367 TRACEME(("(#%d) key '%s'", i, key));
2368 }
2369 if (flags & SHV_K_ISSV) {
2370 store(cxt, key_sv);
2371 } else {
2372 WLEN(len);
2373 if (len)
7a6a85bf 2374 WRITE(key, len);
e16e2ff8 2375 }
7a6a85bf
RG
2376 }
2377 }
2378
43d061fe 2379 TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
7a6a85bf
RG
2380
2381out:
2382 HvRITER(hv) = riter; /* Restore hash iterator state */
2383 HvEITER(hv) = eiter;
2384
2385 return ret;
2386}
2387
2388/*
464b080a
SR
2389 * store_code
2390 *
2391 * Store a code reference.
2392 *
2393 * Layout is SX_CODE <length> followed by a scalar containing the perl
2394 * source code of the code reference.
2395 */
2396static int store_code(stcxt_t *cxt, CV *cv)
2397{
2398#if PERL_VERSION < 6
2399 /*
2400 * retrieve_code does not work with perl 5.005 or less
2401 */
2402 return store_other(cxt, (SV*)cv);
2403#else
2404 dSP;
2405 I32 len;
c5661c80 2406 int count, reallen;
464b080a
SR
2407 SV *text, *bdeparse;
2408
2409 TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2410
2411 if (
2412 cxt->deparse == 0 ||
2413 (cxt->deparse < 0 && !(cxt->deparse =
2414 SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2415 ) {
2416 return store_other(cxt, (SV*)cv);
2417 }
2418
2419 /*
2420 * Require B::Deparse. At least B::Deparse 0.61 is needed for
2421 * blessed code references.
2422 */
2423 /* XXX sv_2mortal seems to be evil here. why? */
2424 load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2425
2426 ENTER;
2427 SAVETMPS;
2428
2429 /*
2430 * create the B::Deparse object
2431 */
2432
2433 PUSHMARK(sp);
2434 XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2435 PUTBACK;
2436 count = call_method("new", G_SCALAR);
2437 SPAGAIN;
2438 if (count != 1)
2439 CROAK(("Unexpected return value from B::Deparse::new\n"));
2440 bdeparse = POPs;
2441
2442 /*
2443 * call the coderef2text method
2444 */
2445
2446 PUSHMARK(sp);
2447 XPUSHs(bdeparse); /* XXX is this already mortal? */
2448 XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2449 PUTBACK;
2450 count = call_method("coderef2text", G_SCALAR);
2451 SPAGAIN;
2452 if (count != 1)
2453 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2454
2455 text = POPs;
2456 len = SvLEN(text);
e3feee4e 2457 reallen = strlen(SvPV_nolen(text));
464b080a
SR
2458
2459 /*
2460 * Empty code references or XS functions are deparsed as
2461 * "(prototype) ;" or ";".
2462 */
2463
e3feee4e 2464 if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
464b080a
SR
2465 CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2466 }
2467
2468 /*
2469 * Signal code by emitting SX_CODE.
2470 */
2471
2472 PUTMARK(SX_CODE);
a8b7ef86 2473 cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
464b080a 2474 TRACEME(("size = %d", len));
e3feee4e 2475 TRACEME(("code = %s", SvPV_nolen(text)));
464b080a
SR
2476
2477 /*
2478 * Now store the source code.
2479 */
2480
e3feee4e 2481 STORE_SCALAR(SvPV_nolen(text), len);
464b080a
SR
2482
2483 FREETMPS;
2484 LEAVE;
2485
2486 TRACEME(("ok (code)"));
2487
2488 return 0;
2489#endif
2490}
2491
2492/*
7a6a85bf
RG
2493 * store_tied
2494 *
2495 * When storing a tied object (be it a tied scalar, array or hash), we lay out
2496 * a special mark, followed by the underlying tied object. For instance, when
2497 * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2498 * <hash object> stands for the serialization of the tied hash.
2499 */
f0ffaed8 2500static int store_tied(stcxt_t *cxt, SV *sv)
7a6a85bf
RG
2501{
2502 MAGIC *mg;
72edffd8 2503 SV *obj = NULL;
7a6a85bf
RG
2504 int ret = 0;
2505 int svt = SvTYPE(sv);
2506 char mtype = 'P';
2507
43d061fe 2508 TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
7a6a85bf
RG
2509
2510 /*
2511 * We have a small run-time penalty here because we chose to factorise
2512 * all tieds objects into the same routine, and not have a store_tied_hash,
2513 * a store_tied_array, etc...
2514 *
2515 * Don't use a switch() statement, as most compilers don't optimize that
2516 * well for 2/3 values. An if() else if() cascade is just fine. We put
2517 * tied hashes first, as they are the most likely beasts.
2518 */
2519
2520 if (svt == SVt_PVHV) {
2521 TRACEME(("tied hash"));
2522 PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
2523 } else if (svt == SVt_PVAV) {
2524 TRACEME(("tied array"));
2525 PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
2526 } else {
2527 TRACEME(("tied scalar"));
2528 PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
2529 mtype = 'q';
2530 }
2531
2532 if (!(mg = mg_find(sv, mtype)))
2533 CROAK(("No magic '%c' found while storing tied %s", mtype,
2534 (svt == SVt_PVHV) ? "hash" :
2535 (svt == SVt_PVAV) ? "array" : "scalar"));
2536
2537 /*
2538 * The mg->mg_obj found by mg_find() above actually points to the
2539 * underlying tied Perl object implementation. For instance, if the
2540 * original SV was that of a tied array, then mg->mg_obj is an AV.
2541 *
2542 * Note that we store the Perl object as-is. We don't call its FETCH
2543 * method along the way. At retrieval time, we won't call its STORE
2544 * method either, but the tieing magic will be re-installed. In itself,
2545 * that ensures that the tieing semantics are preserved since futher
2546 * accesses on the retrieved object will indeed call the magic methods...
2547 */
2548
72edffd8
AMS
2549 /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2550 obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2551 if ((ret = store(cxt, obj)))
7a6a85bf
RG
2552 return ret;
2553
2554 TRACEME(("ok (tied)"));
2555
2556 return 0;
2557}
2558
2559/*
2560 * store_tied_item
2561 *
2562 * Stores a reference to an item within a tied structure:
2563 *
2564 * . \$h{key}, stores both the (tied %h) object and 'key'.
2565 * . \$a[idx], stores both the (tied @a) object and 'idx'.
2566 *
2567 * Layout is therefore either:
2568 * SX_TIED_KEY <object> <key>
2569 * SX_TIED_IDX <object> <index>
2570 */
f0ffaed8 2571static int store_tied_item(stcxt_t *cxt, SV *sv)
7a6a85bf
RG
2572{
2573 MAGIC *mg;
2574 int ret;
2575
43d061fe 2576 TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
7a6a85bf
RG
2577
2578 if (!(mg = mg_find(sv, 'p')))
2579 CROAK(("No magic 'p' found while storing reference to tied item"));
2580
2581 /*
2582 * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2583 */
2584
2585 if (mg->mg_ptr) {
2586 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2587 PUTMARK(SX_TIED_KEY);
9e21b3d0 2588 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
7a6a85bf 2589
e993d95c 2590 if ((ret = store(cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
7a6a85bf
RG
2591 return ret;
2592
9e21b3d0 2593 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
7a6a85bf 2594
e993d95c 2595 if ((ret = store(cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
7a6a85bf
RG
2596 return ret;
2597 } else {
2598 I32 idx = mg->mg_len;
2599
2600 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2601 PUTMARK(SX_TIED_IDX);
9e21b3d0 2602 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
7a6a85bf 2603
e993d95c 2604 if ((ret = store(cxt, mg->mg_obj))) /* Idem, for -Wall */
7a6a85bf
RG
2605 return ret;
2606
2607 TRACEME(("store_tied_item: storing IDX %d", idx));
2608
2609 WLEN(idx);
2610 }
2611
2612 TRACEME(("ok (tied item)"));
2613
2614 return 0;
2615}
2616
2617/*
2618 * store_hook -- dispatched manually, not via sv_store[]
2619 *
2620 * The blessed SV is serialized by a hook.
2621 *
2622 * Simple Layout is:
2623 *
2624 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2625 *
2626 * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2627 * the trailing part [] is present, the type of object (scalar, array or hash).
2628 * There is also a bit which says how the classname is stored between:
2629 *
2630 * <len> <classname>
2631 * <index>
2632 *
2633 * and when the <index> form is used (classname already seen), the "large
2634 * classname" bit in <flags> indicates how large the <index> is.
2635 *
2636 * The serialized string returned by the hook is of length <len2> and comes
2637 * next. It is an opaque string for us.
2638 *
2639 * Those <len3> object IDs which are listed last represent the extra references
2640 * not directly serialized by the hook, but which are linked to the object.
2641 *
2642 * When recursion is mandated to resolve object-IDs not yet seen, we have
2643 * instead, with <header> being flags with bits set to indicate the object type
2644 * and that recursion was indeed needed:
2645 *
2646 * SX_HOOK <header> <object> <header> <object> <flags>
2647 *
2648 * that same header being repeated between serialized objects obtained through
2649 * recursion, until we reach flags indicating no recursion, at which point
2650 * we know we've resynchronized with a single layout, after <flags>.
b12202d0
JH
2651 *
2652 * When storing a blessed ref to a tied variable, the following format is
2653 * used:
2654 *
2655 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2656 *
2657 * The first <flags> indication carries an object of type SHT_EXTRA, and the
2658 * real object type is held in the <extra> flag. At the very end of the
2659 * serialization stream, the underlying magic object is serialized, just like
2660 * any other tied variable.
7a6a85bf 2661 */
f0ffaed8
JH
2662static int store_hook(
2663 stcxt_t *cxt,
2664 SV *sv,
2665 int type,
2666 HV *pkg,
2667 SV *hook)
7a6a85bf
RG
2668{
2669 I32 len;
2670 char *class;
2671 STRLEN len2;
2672 SV *ref;
2673 AV *av;
2674 SV **ary;
2675 int count; /* really len3 + 1 */
2676 unsigned char flags;
2677 char *pv;
2678 int i;
2679 int recursed = 0; /* counts recursion */
2680 int obj_type; /* object type, on 2 bits */
2681 I32 classnum;
2682 int ret;
2683 int clone = cxt->optype & ST_CLONE;
e993d95c
JH
2684 char mtype = '\0'; /* for blessed ref to tied structures */
2685 unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
7a6a85bf
RG
2686
2687 TRACEME(("store_hook, class \"%s\", tagged #%d", HvNAME(pkg), cxt->tagnum));
2688
2689 /*
2690 * Determine object type on 2 bits.
2691 */
2692
2693 switch (type) {
2694 case svis_SCALAR:
2695 obj_type = SHT_SCALAR;
2696 break;
2697 case svis_ARRAY:
2698 obj_type = SHT_ARRAY;
2699 break;
2700 case svis_HASH:
2701 obj_type = SHT_HASH;
2702 break;
b12202d0
JH
2703 case svis_TIED:
2704 /*
2705 * Produced by a blessed ref to a tied data structure, $o in the
2706 * following Perl code.
2707 *
2708 * my %h;
2709 * tie %h, 'FOO';
2710 * my $o = bless \%h, 'BAR';
2711 *
2712 * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2713 * (since we have only 2 bits in <flags> to store the type), and an
2714 * <extra> byte flag will be emitted after the FIRST <flags> in the
2715 * stream, carrying what we put in `eflags'.
2716 */
2717 obj_type = SHT_EXTRA;
2718 switch (SvTYPE(sv)) {
2719 case SVt_PVHV:
2720 eflags = (unsigned char) SHT_THASH;
2721 mtype = 'P';
2722 break;
2723 case SVt_PVAV:
2724 eflags = (unsigned char) SHT_TARRAY;
2725 mtype = 'P';
2726 break;
2727 default:
2728 eflags = (unsigned char) SHT_TSCALAR;
2729 mtype = 'q';
2730 break;
2731 }
2732 break;
7a6a85bf
RG
2733 default:
2734 CROAK(("Unexpected object type (%d) in store_hook()", type));
2735 }
2736 flags = SHF_NEED_RECURSE | obj_type;
2737
2738 class = HvNAME(pkg);
2739 len = strlen(class);
2740
2741 /*
2742 * To call the hook, we need to fake a call like:
2743 *
2744 * $object->STORABLE_freeze($cloning);
2745 *
2746 * but we don't have the $object here. For instance, if $object is
2747 * a blessed array, what we have in `sv' is the array, and we can't
2748 * call a method on those.
2749 *
2750 * Therefore, we need to create a temporary reference to the object and
2751 * make the call on that reference.
2752 */
2753
2754 TRACEME(("about to call STORABLE_freeze on class %s", class));
2755
2756 ref = newRV_noinc(sv); /* Temporary reference */
2757 av = array_call(ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
2758 SvRV(ref) = 0;
2759 SvREFCNT_dec(ref); /* Reclaim temporary reference */
2760
2761 count = AvFILLp(av) + 1;
2762 TRACEME(("store_hook, array holds %d items", count));
2763
2764 /*
2765 * If they return an empty list, it means they wish to ignore the
2766 * hook for this class (and not just this instance -- that's for them
2767 * to handle if they so wish).
2768 *
2769 * Simply disable the cached entry for the hook (it won't be recomputed
2770 * since it's present in the cache) and recurse to store_blessed().
2771 */
2772
2773 if (!count) {
2774 /*
2775 * They must not change their mind in the middle of a serialization.
2776 */
2777
2778 if (hv_fetch(cxt->hclass, class, len, FALSE))
2779 CROAK(("Too late to ignore hooks for %s class \"%s\"",
2780 (cxt->optype & ST_CLONE) ? "cloning" : "storing", class));
2781
2782 pkg_hide(cxt->hook, pkg, "STORABLE_freeze");
2783
2784 ASSERT(!pkg_can(cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
cc964657 2785 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", class));
7a6a85bf
RG
2786
2787 return store_blessed(cxt, sv, type, pkg);
2788 }
2789
2790 /*
2791 * Get frozen string.
2792 */
2793
2794 ary = AvARRAY(av);
2795 pv = SvPV(ary[0], len2);
2796
2797 /*
7a6a85bf
RG
2798 * If they returned more than one item, we need to serialize some
2799 * extra references if not already done.
2800 *
10ffa93f 2801 * Loop over the array, starting at position #1, and for each item,
7a6a85bf
RG
2802 * ensure it is a reference, serialize it if not already done, and
2803 * replace the entry with the tag ID of the corresponding serialized
2804 * object.
2805 *
2806 * We CHEAT by not calling av_fetch() and read directly within the
2807 * array, for speed.
2808 */
2809
2810 for (i = 1; i < count; i++) {
2811 SV **svh;
90826881
JH
2812 SV *rsv = ary[i];
2813 SV *xsv;
2814 AV *av_hook = cxt->hook_seen;
7a6a85bf 2815
90826881
JH
2816 if (!SvROK(rsv))
2817 CROAK(("Item #%d returned by STORABLE_freeze "
2818 "for %s is not a reference", i, class));
2819 xsv = SvRV(rsv); /* Follow ref to know what to look for */
7a6a85bf
RG
2820
2821 /*
2822 * Look in hseen and see if we have a tag already.
2823 * Serialize entry if not done already, and get its tag.
2824 */
2825
13689cfe 2826 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
7a6a85bf
RG
2827 goto sv_seen; /* Avoid moving code too far to the right */
2828
9e21b3d0 2829 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
7a6a85bf
RG
2830
2831 /*
2832 * We need to recurse to store that object and get it to be known
2833 * so that we can resolve the list of object-IDs at retrieve time.
2834 *
2835 * The first time we do this, we need to emit the proper header
2836 * indicating that we recursed, and what the type of object is (the
2837 * object we're storing via a user-hook). Indeed, during retrieval,
2838 * we'll have to create the object before recursing to retrieve the
2839 * others, in case those would point back at that object.
2840 */
2841
b12202d0
JH
2842 /* [SX_HOOK] <flags> [<extra>] <object>*/
2843 if (!recursed++) {
7a6a85bf 2844 PUTMARK(SX_HOOK);
b12202d0
JH
2845 PUTMARK(flags);
2846 if (obj_type == SHT_EXTRA)
2847 PUTMARK(eflags);
2848 } else
2849 PUTMARK(flags);
7a6a85bf 2850
e993d95c 2851 if ((ret = store(cxt, xsv))) /* Given by hook for us to store */
7a6a85bf
RG
2852 return ret;
2853
2854 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
2855 if (!svh)
2856 CROAK(("Could not serialize item #%d from hook in %s", i, class));
2857
2858 /*
90826881
JH
2859 * It was the first time we serialized `xsv'.
2860 *
2861 * Keep this SV alive until the end of the serialization: if we
2862 * disposed of it right now by decrementing its refcount, and it was
2863 * a temporary value, some next temporary value allocated during
2864 * another STORABLE_freeze might take its place, and we'd wrongly
2865 * assume that new SV was already serialized, based on its presence
2866 * in cxt->hseen.
2867 *
2868 * Therefore, push it away in cxt->hook_seen.
7a6a85bf
RG
2869 */
2870
90826881
JH
2871 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
2872
7a6a85bf 2873 sv_seen:
90826881
JH
2874 /*
2875 * Dispose of the REF they returned. If we saved the `xsv' away
2876 * in the array of returned SVs, that will not cause the underlying
2877 * referenced SV to be reclaimed.
2878 */
2879
2880 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
2881 SvREFCNT_dec(rsv); /* Dispose of reference */
2882
2883 /*
2884 * Replace entry with its tag (not a real SV, so no refcnt increment)
2885 */
2886
7a6a85bf 2887 ary[i] = *svh;
76edffbb 2888 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
d67b2c17 2889 i-1, PTR2UV(xsv), PTR2UV(*svh)));
7a6a85bf
RG
2890 }
2891
2892 /*
dd19458b
JH
2893 * Allocate a class ID if not already done.
2894 *
2895 * This needs to be done after the recursion above, since at retrieval
2896 * time, we'll see the inner objects first. Many thanks to
2897 * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
2898 * proposed the right fix. -- RAM, 15/09/2000
2899 */
2900
2901 if (!known_class(cxt, class, len, &classnum)) {
2902 TRACEME(("first time we see class %s, ID = %d", class, classnum));
2903 classnum = -1; /* Mark: we must store classname */
2904 } else {
2905 TRACEME(("already seen class %s, ID = %d", class, classnum));
2906 }
2907
2908 /*
7a6a85bf
RG
2909 * Compute leading flags.
2910 */
2911
2912 flags = obj_type;
2913 if (((classnum == -1) ? len : classnum) > LG_SCALAR)
2914 flags |= SHF_LARGE_CLASSLEN;
2915 if (classnum != -1)
2916 flags |= SHF_IDX_CLASSNAME;
2917 if (len2 > LG_SCALAR)
2918 flags |= SHF_LARGE_STRLEN;
2919 if (count > 1)
2920 flags |= SHF_HAS_LIST;
2921 if (count > (LG_SCALAR + 1))
2922 flags |= SHF_LARGE_LISTLEN;
2923
2924 /*
2925 * We're ready to emit either serialized form:
2926 *
2927 * SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2928 * SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
2929 *
2930 * If we recursed, the SX_HOOK has already been emitted.
2931 */
2932
9e21b3d0
JH
2933 TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
2934 "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
d67b2c17 2935 recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
7a6a85bf 2936
b12202d0
JH
2937 /* SX_HOOK <flags> [<extra>] */
2938 if (!recursed) {
7a6a85bf 2939 PUTMARK(SX_HOOK);
b12202d0
JH
2940 PUTMARK(flags);
2941 if (obj_type == SHT_EXTRA)
2942 PUTMARK(eflags);
2943 } else
2944 PUTMARK(flags);
7a6a85bf
RG
2945
2946 /* <len> <classname> or <index> */
2947 if (flags & SHF_IDX_CLASSNAME) {
2948 if (flags & SHF_LARGE_CLASSLEN)
2949 WLEN(classnum);
2950 else {
2951 unsigned char cnum = (unsigned char) classnum;
2952 PUTMARK(cnum);
2953 }
2954 } else {
2955 if (flags & SHF_LARGE_CLASSLEN)
2956 WLEN(len);
2957 else {
2958 unsigned char clen = (unsigned char) len;
2959 PUTMARK(clen);
2960 }
2961 WRITE(class, len); /* Final \0 is omitted */
2962 }
2963
2964 /* <len2> <frozen-str> */
cc964657
JH
2965 if (flags & SHF_LARGE_STRLEN) {
2966 I32 wlen2 = len2; /* STRLEN might be 8 bytes */
2967 WLEN(wlen2); /* Must write an I32 for 64-bit machines */
2968 } else {
7a6a85bf
RG
2969 unsigned char clen = (unsigned char) len2;
2970 PUTMARK(clen);
2971 }
2972 if (len2)
7c436af3 2973 WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
7a6a85bf
RG
2974
2975 /* [<len3> <object-IDs>] */
2976 if (flags & SHF_HAS_LIST) {
2977 int len3 = count - 1;
2978 if (flags & SHF_LARGE_LISTLEN)
2979 WLEN(len3);
2980 else {
2981 unsigned char clen = (unsigned char) len3;
2982 PUTMARK(clen);
2983 }
2984
2985 /*
2986 * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
2987 * real pointer, rather a tag number, well under the 32-bit limit.
2988 */
2989
2990 for (i = 1; i < count; i++) {
2991 I32 tagval = htonl(LOW_32BITS(ary[i]));
9e21b3d0 2992 WRITE_I32(tagval);
7a6a85bf
RG
2993 TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
2994 }
2995 }
2996
2997 /*
2998 * Free the array. We need extra care for indices after 0, since they
2999 * don't hold real SVs but integers cast.
3000 */
3001
3002 if (count > 1)
3003 AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
3004 av_undef(av);
3005 sv_free((SV *) av);
3006
b12202d0
JH
3007 /*
3008 * If object was tied, need to insert serialization of the magic object.
3009 */
3010
3011 if (obj_type == SHT_EXTRA) {
3012 MAGIC *mg;
3013
3014 if (!(mg = mg_find(sv, mtype))) {
3015 int svt = SvTYPE(sv);
3016 CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3017 mtype, (svt == SVt_PVHV) ? "hash" :
3018 (svt == SVt_PVAV) ? "array" : "scalar"));
3019 }
3020
3021 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3022 PTR2UV(mg->mg_obj), PTR2UV(sv)));
3023
3024 /*
3025 * [<magic object>]
3026 */
3027
e993d95c 3028 if ((ret = store(cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
b12202d0
JH
3029 return ret;
3030 }
3031
7a6a85bf
RG
3032 return 0;
3033}
3034
3035/*
3036 * store_blessed -- dispatched manually, not via sv_store[]
3037 *
3038 * Check whether there is a STORABLE_xxx hook defined in the class or in one
3039 * of its ancestors. If there is, then redispatch to store_hook();
3040 *
3041 * Otherwise, the blessed SV is stored using the following layout:
3042 *
3043 * SX_BLESS <flag> <len> <classname> <object>
3044 *
3045 * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3046 * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3047 * Otherwise, the low order bits give the length, thereby giving a compact
3048 * representation for class names less than 127 chars long.
3049 *
3050 * Each <classname> seen is remembered and indexed, so that the next time
3051 * an object in the blessed in the same <classname> is stored, the following
3052 * will be emitted:
3053 *
3054 * SX_IX_BLESS <flag> <index> <object>
3055 *
3056 * where <index> is the classname index, stored on 0 or 4 bytes depending
3057 * on the high-order bit in flag (same encoding as above for <len>).
3058 */
f0ffaed8
JH
3059static int store_blessed(
3060 stcxt_t *cxt,
3061 SV *sv,
3062 int type,
3063 HV *pkg)
7a6a85bf
RG
3064{
3065 SV *hook;
3066 I32 len;
3067 char *class;
3068 I32 classnum;
3069
3070 TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME(pkg)));
3071
3072 /*
3073 * Look for a hook for this blessed SV and redirect to store_hook()
3074 * if needed.
3075 */
3076
3077 hook = pkg_can(cxt->hook, pkg, "STORABLE_freeze");
3078 if (hook)
3079 return store_hook(cxt, sv, type, pkg, hook);
3080
3081 /*
3082 * This is a blessed SV without any serialization hook.
3083 */
3084
3085 class = HvNAME(pkg);
3086 len = strlen(class);
3087
43d061fe
JH
3088 TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3089 PTR2UV(sv), class, cxt->tagnum));
7a6a85bf
RG
3090
3091 /*
3092 * Determine whether it is the first time we see that class name (in which
3093 * case it will be stored in the SX_BLESS form), or whether we already
3094 * saw that class name before (in which case the SX_IX_BLESS form will be
3095 * used).
3096 */
3097
3098 if (known_class(cxt, class, len, &classnum)) {
3099 TRACEME(("already seen class %s, ID = %d", class, classnum));
3100 PUTMARK(SX_IX_BLESS);
3101 if (classnum <= LG_BLESS) {
3102 unsigned char cnum = (unsigned char) classnum;
3103 PUTMARK(cnum);
3104 } else {
3105 unsigned char flag = (unsigned char) 0x80;
3106 PUTMARK(flag);
3107 WLEN(classnum);
3108 }
3109 } else {
3110 TRACEME(("first time we see class %s, ID = %d", class, classnum));
3111 PUTMARK(SX_BLESS);
3112 if (len <= LG_BLESS) {
3113 unsigned char clen = (unsigned char) len;
3114 PUTMARK(clen);
3115 } else {
3116 unsigned char flag = (unsigned char) 0x80;
3117 PUTMARK(flag);
3118 WLEN(len); /* Don't BER-encode, this should be rare */
3119 }
3120 WRITE(class, len); /* Final \0 is omitted */
3121 }
3122
3123 /*
3124 * Now emit the <object> part.
3125 */
3126
3127 return SV_STORE(type)(cxt, sv);
3128}
3129
3130/*
3131 * store_other
3132 *
3133 * We don't know how to store the item we reached, so return an error condition.
3134 * (it's probably a GLOB, some CODE reference, etc...)
3135 *
3136 * If they defined the `forgive_me' variable at the Perl level to some
3137 * true value, then don't croak, just warn, and store a placeholder string
3138 * instead.
3139 */
f0ffaed8 3140static int store_other(stcxt_t *cxt, SV *sv)
7a6a85bf 3141{
cc964657 3142 I32 len;
7a6a85bf
RG
3143 static char buf[80];
3144
3145 TRACEME(("store_other"));
3146
3147 /*
3148 * Fetch the value from perl only once per store() operation.
3149 */
3150
3151 if (
3152 cxt->forgive_me == 0 ||
3153 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3154 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3155 )
3156 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3157
43d061fe
JH
3158 warn("Can't store item %s(0x%"UVxf")",
3159 sv_reftype(sv, FALSE), PTR2UV(sv));
7a6a85bf
RG
3160
3161 /*
3162 * Store placeholder string as a scalar instead...
3163 */
3164
13689cfe 3165 (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
e993d95c 3166 PTR2UV(sv), (char) 0);
7a6a85bf
RG
3167
3168 len = strlen(buf);
3169 STORE_SCALAR(buf, len);
1cf92b12 3170 TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
7a6a85bf
RG
3171
3172 return 0;
3173}
3174
3175/***
3176 *** Store driving routines
3177 ***/
3178
3179/*
3180 * sv_type
3181 *
3182 * WARNING: partially duplicates Perl's sv_reftype for speed.
3183 *
3184 * Returns the type of the SV, identified by an integer. That integer
3185 * may then be used to index the dynamic routine dispatch table.
3186 */
f0ffaed8 3187static int sv_type(SV *sv)
7a6a85bf
RG
3188{
3189 switch (SvTYPE(sv)) {
3190 case SVt_NULL:
3191 case SVt_IV:
3192 case SVt_NV:
3193 /*
3194 * No need to check for ROK, that can't be set here since there
3195 * is no field capable of hodling the xrv_rv reference.
3196 */
3197 return svis_SCALAR;
3198 case SVt_PV:
3199 case SVt_RV:
3200 case SVt_PVIV:
3201 case SVt_PVNV:
3202 /*
3203 * Starting from SVt_PV, it is possible to have the ROK flag
3204 * set, the pointer to the other SV being either stored in
3205 * the xrv_rv (in the case of a pure SVt_RV), or as the
3206 * xpv_pv field of an SVt_PV and its heirs.
3207 *
3208 * However, those SV cannot be magical or they would be an
3209 * SVt_PVMG at least.
3210 */
3211 return SvROK(sv) ? svis_REF : svis_SCALAR;
3212 case SVt_PVMG:
3213 case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
3214 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3215 return svis_TIED_ITEM;
3216 /* FALL THROUGH */
3217 case SVt_PVBM:
3218 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3219 return svis_TIED;
3220 return SvROK(sv) ? svis_REF : svis_SCALAR;
3221 case SVt_PVAV:
3222 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3223 return svis_TIED;
3224 return svis_ARRAY;
3225 case SVt_PVHV:
3226 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3227 return svis_TIED;
3228 return svis_HASH;
464b080a
SR
3229 case SVt_PVCV:
3230 return svis_CODE;
7a6a85bf
RG
3231 default:
3232 break;
3233 }
3234
3235 return svis_OTHER;
3236}
3237
3238/*
3239 * store
3240 *
3241 * Recursively store objects pointed to by the sv to the specified file.
3242 *
3243 * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3244 * object (one for which storage has started -- it may not be over if we have
3245 * a self-referenced structure). This data set forms a stored <object>.
3246 */
f0ffaed8 3247static int store(stcxt_t *cxt, SV *sv)
7a6a85bf
RG
3248{
3249 SV **svh;
3250 int ret;
7a6a85bf 3251 int type;
43d061fe 3252 HV *hseen = cxt->hseen;
7a6a85bf 3253
43d061fe 3254 TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
7a6a85bf
RG
3255
3256 /*
3257 * If object has already been stored, do not duplicate data.
3258 * Simply emit the SX_OBJECT marker followed by its tag data.
3259 * The tag is always written in network order.
3260 *
3261 * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3262 * real pointer, rather a tag number (watch the insertion code below).
464b080a 3263 * That means it probably safe to assume it is well under the 32-bit limit,
7a6a85bf
RG
3264 * and makes the truncation safe.
3265 * -- RAM, 14/09/1999
3266 */
3267
3268 svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3269 if (svh) {
3270 I32 tagval = htonl(LOW_32BITS(*svh));
3271
9e21b3d0 3272 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
7a6a85bf
RG
3273
3274 PUTMARK(SX_OBJECT);
9e21b3d0 3275 WRITE_I32(tagval);
7a6a85bf
RG
3276 return 0;
3277 }
3278
3279 /*
3280 * Allocate a new tag and associate it with the address of the sv being
3281 * stored, before recursing...
3282 *
3283 * In order to avoid creating new SvIVs to hold the tagnum we just
d1be9408 3284 * cast the tagnum to an SV pointer and store that in the hash. This
7a6a85bf
RG
3285 * means that we must clean up the hash manually afterwards, but gives
3286 * us a 15% throughput increase.
3287 *
7a6a85bf
RG
3288 */
3289
3290 cxt->tagnum++;
3291 if (!hv_store(hseen,
3341c981 3292 (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
7a6a85bf
RG
3293 return -1;
3294
3295 /*
3296 * Store `sv' and everything beneath it, using appropriate routine.
3297 * Abort immediately if we get a non-zero status back.
3298 */
3299
3300 type = sv_type(sv);
3301
43d061fe
JH
3302 TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3303 PTR2UV(sv), cxt->tagnum, type));
7a6a85bf
RG
3304
3305 if (SvOBJECT(sv)) {
3306 HV *pkg = SvSTASH(sv);
3307 ret = store_blessed(cxt, sv, type, pkg);
3308 } else
3309 ret = SV_STORE(type)(cxt, sv);
3310
43d061fe
JH
3311 TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3312 ret ? "FAILED" : "ok", PTR2UV(sv),
7a6a85bf
RG
3313 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3314
3315 return ret;
3316}
3317
3318/*
3319 * magic_write
3320 *
3321 * Write magic number and system information into the file.
3322 * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3323 * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3324 * All size and lenghts are written as single characters here.
3325 *
3326 * Note that no byte ordering info is emitted when <network> is true, since
3327 * integers will be emitted in network order in that case.
3328 */
f0ffaed8 3329static int magic_write(stcxt_t *cxt)
7a6a85bf 3330{
2aeb6432
NC
3331 /*
3332 * Starting with 0.6, the "use_network_order" byte flag is also used to
3333 * indicate the version number of the binary image, encoded in the upper
3334 * bits. The bit 0 is always used to indicate network order.
3335 */
3336 /*
3337 * Starting with 0.7, a full byte is dedicated to the minor version of
3338 * the binary format, which is incremented only when new markers are
3339 * introduced, for instance, but when backward compatibility is preserved.
3340 */
7a6a85bf 3341
2aeb6432
NC
3342 /* Make these at compile time. The WRITE() macro is sufficiently complex
3343 that it saves about 200 bytes doing it this way and only using it
3344 once. */
3345 static const unsigned char network_file_header[] = {
3346 MAGICSTR_BYTES,
3347 (STORABLE_BIN_MAJOR << 1) | 1,
3348 STORABLE_BIN_WRITE_MINOR
3349 };
3350 static const unsigned char file_header[] = {
3351 MAGICSTR_BYTES,
3352 (STORABLE_BIN_MAJOR << 1) | 0,
3353 STORABLE_BIN_WRITE_MINOR,
3354 /* sizeof the array includes the 0 byte at the end: */
3355 (char) sizeof (byteorderstr) - 1,
3356 BYTEORDER_BYTES,
3357 (unsigned char) sizeof(int),
3358 (unsigned char) sizeof(long),
3359 (unsigned char) sizeof(char *),
3360 (unsigned char) sizeof(NV)
3361 };
ee0f7aac
NC
3362#ifdef USE_56_INTERWORK_KLUDGE
3363 static const unsigned char file_header_56[] = {
3364 MAGICSTR_BYTES,
3365 (STORABLE_BIN_MAJOR << 1) | 0,
3366 STORABLE_BIN_WRITE_MINOR,
3367 /* sizeof the array includes the 0 byte at the end: */
3368 (char) sizeof (byteorderstr_56) - 1,
3369 BYTEORDER_BYTES_56,
3370 (unsigned char) sizeof(int),
3371 (unsigned char) sizeof(long),
3372 (unsigned char) sizeof(char *),
3373 (unsigned char) sizeof(NV)
3374 };
3375#endif
2aeb6432
NC
3376 const unsigned char *header;
3377 SSize_t length;
3378
3379 TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3380
3381 if (cxt->netorder) {
3382 header = network_file_header;
3383 length = sizeof (network_file_header);
3384 } else {
ee0f7aac
NC
3385#ifdef USE_56_INTERWORK_KLUDGE
3386 if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3387 header = file_header_56;
3388 length = sizeof (file_header_56);
3389 } else
3390#endif
3391 {
3392 header = file_header;
3393 length = sizeof (file_header);
3394 }
2aeb6432
NC
3395 }
3396
3397 if (!cxt->fio) {
3398 /* sizeof the array includes the 0 byte at the end. */
3399 header += sizeof (magicstr) - 1;
3400 length -= sizeof (magicstr) - 1;
3401 }
3402
69495e6a 3403 WRITE( (unsigned char*) header, length);
2aeb6432
NC
3404
3405 if (!cxt->netorder) {
9e21b3d0 3406 TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
2aeb6432 3407 (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
9e21b3d0
JH
3408 (int) sizeof(int), (int) sizeof(long),
3409 (int) sizeof(char *), (int) sizeof(NV)));
2aeb6432
NC
3410 }
3411 return 0;
7a6a85bf
RG
3412}
3413
3414/*
3415 * do_store
3416 *
3417 * Common code for store operations.
3418 *
3419 * When memory store is requested (f = NULL) and a non null SV* is given in
3420 * `res', it is filled with a new SV created out of the memory buffer.
3421 *
3422 * It is required to provide a non-null `res' when the operation type is not
3423 * dclone() and store() is performed to memory.
3424 */
f0ffaed8
JH
3425static int do_store(
3426 PerlIO *f,
3427 SV *sv,
3428 int optype,
3429 int network_order,
3430 SV **res)
7a6a85bf
RG
3431{
3432 dSTCXT;
3433 int status;
3434
3435 ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3436 ("must supply result SV pointer for real recursion to memory"));
3437
3438 TRACEME(("do_store (optype=%d, netorder=%d)",
3439 optype, network_order));
3440
3441 optype |= ST_STORE;
3442
3443 /*
3444 * Workaround for CROAK leak: if they enter with a "dirty" context,
3445 * free up memory for them now.
3446 */
3447
dd19458b 3448 if (cxt->s_dirty)
7a6a85bf
RG
3449 clean_context(cxt);
3450
3451 /*
3452 * Now that STORABLE_xxx hooks exist, it is possible that they try to
3453 * re-enter store() via the hooks. We need to stack contexts.
3454 */
3455
3456 if (cxt->entry)
3457 cxt = allocate_context(cxt);
3458
3459 cxt->entry++;
3460
3461 ASSERT(cxt->entry == 1, ("starting new recursion"));
dd19458b 3462 ASSERT(!cxt->s_dirty, ("clean context"));
7a6a85bf
RG
3463
3464 /*
3465 * Ensure sv is actually a reference. From perl, we called something
3466 * like:
3467 * pstore(FILE, \@array);
3468 * so we must get the scalar value behing that reference.
3469 */
3470
3471 if (!SvROK(sv))
3472 CROAK(("Not a reference"));
3473 sv = SvRV(sv); /* So follow it to know what to store */
3474
3475 /*
3476 * If we're going to store to memory, reset the buffer.
3477 */
3478
3479 if (!f)
3480 MBUF_INIT(0);
3481
3482 /*
3483 * Prepare context and emit headers.
3484 */
3485
3486 init_store_context(cxt, f, optype, network_order);
3487
3488 if (-1 == magic_write(cxt)) /* Emit magic and ILP info */
3489 return 0; /* Error */
3490
3491 /*
3492 * Recursively store object...
3493 */
3494
3495 ASSERT(is_storing(), ("within store operation"));
3496
3497 status = store(cxt, sv); /* Just do it! */
3498
3499 /*
3500 * If they asked for a memory store and they provided an SV pointer,
3501 * make an SV string out of the buffer and fill their pointer.
3502 *
3503 * When asking for ST_REAL, it's MANDATORY for the caller to provide
3504 * an SV, since context cleanup might free the buffer if we did recurse.
3505 * (unless caller is dclone(), which is aware of that).
3506 */
3507
3508 if (!cxt->fio && res)
3509 *res = mbuf2sv();
3510
3511 /*
3512 * Final cleanup.
3513 *
3514 * The "root" context is never freed, since it is meant to be always
3515 * handy for the common case where no recursion occurs at all (i.e.
3516 * we enter store() outside of any Storable code and leave it, period).
3517 * We know it's the "root" context because there's nothing stacked
3518 * underneath it.
3519 *
3520 * OPTIMIZATION:
3521 *
3522 * When deep cloning, we don't free the context: doing so would force
3523 * us to copy the data in the memory buffer. Sicne we know we're
3524 * about to enter do_retrieve...
3525 */
3526
3527 clean_store_context(cxt);
3528 if (cxt->prev && !(cxt->optype & ST_CLONE))
3529 free_context(cxt);
3530
3531 TRACEME(("do_store returns %d", status));
3532
3533 return status == 0;
3534}
3535
3536/*
3537 * pstore
3538 *
3539 * Store the transitive data closure of given object to disk.
3540 * Returns 0 on error, a true value otherwise.
3541 */
f0ffaed8 3542int pstore(PerlIO *f, SV *sv)
7a6a85bf
RG
3543{
3544 TRACEME(("pstore"));
f0ffaed8 3545 return do_store(f, sv, 0, FALSE, (SV**) 0);
7a6a85bf
RG
3546
3547}
3548
3549/*
3550 * net_pstore
3551 *
3552 * Same as pstore(), but network order is used for integers and doubles are
3553 * emitted as strings.
3554 */
f0ffaed8 3555int net_pstore(PerlIO *f, SV *sv)
7a6a85bf
RG
3556{
3557 TRACEME(("net_pstore"));
f0ffaed8 3558 return do_store(f, sv, 0, TRUE, (SV**) 0);
7a6a85bf
RG
3559}
3560
3561/***
3562 *** Memory stores.
3563 ***/
3564
3565/*
3566 * mbuf2sv
3567 *
3568 * Build a new SV out of the content of the internal memory buffer.
3569 */
f0ffaed8 3570static SV *mbuf2sv(void)
7a6a85bf
RG
3571{
3572 dSTCXT;
3573
3574 return newSVpv(mbase, MBUF_SIZE());
3575}
3576
3577/*
3578 * mstore
3579 *
3580 * Store the transitive data closure of given object to memory.
3581 * Returns undef on error, a scalar value containing the data otherwise.
3582 */
f0ffaed8 3583SV *mstore(SV *sv)
7a6a85bf 3584{
7a6a85bf
RG
3585 SV *out;
3586
3587 TRACEME(("mstore"));
3588
f0ffaed8 3589 if (!do_store((PerlIO*) 0, sv, 0, FALSE, &out))
7a6a85bf
RG
3590 return &PL_sv_undef;
3591
3592 return out;
3593}
3594
3595/*
3596 * net_mstore
3597 *
3598 * Same as mstore(), but network order is used for integers and doubles are
3599 * emitted as strings.
3600 */
f0ffaed8 3601SV *net_mstore(SV *sv)
7a6a85bf 3602{
7a6a85bf
RG
3603 SV *out;
3604
3605 TRACEME(("net_mstore"));
3606
f0ffaed8 3607 if (!do_store((PerlIO*) 0, sv, 0, TRUE, &out))
7a6a85bf
RG
3608 return &PL_sv_undef;
3609
3610 return out;
3611}
3612
3613/***
3614 *** Specific retrieve callbacks.
3615 ***/
3616
3617/*
3618 * retrieve_other
3619 *
3620 * Return an error via croak, since it is not possible that we get here
3621 * under normal conditions, when facing a file produced via pstore().
3622 */
b12202d0 3623static SV *retrieve_other(stcxt_t *cxt, char *cname)
7a6a85bf
RG
3624{
3625 if (
3626 cxt->ver_major != STORABLE_BIN_MAJOR &&
3627 cxt->ver_minor != STORABLE_BIN_MINOR
3628 ) {
3629 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3630 cxt->fio ? "file" : "string",
3631 cxt->ver_major, cxt->ver_minor,
3632 STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3633 } else {
3634 CROAK(("Corrupted storable %s (binary v%d.%d)",
3635 cxt->fio ? "file" : "string",
3636 cxt->ver_major, cxt->ver_minor));
3637 }
3638
3639 return (SV *) 0; /* Just in case */
3640}
3641
3642/*
3643 * retrieve_idx_blessed
3644 *
3645 * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3646 * <index> can be coded on either 1 or 5 bytes.
3647 */
b12202d0 3648static SV *retrieve_idx_blessed(stcxt_t *cxt, char *cname)
7a6a85bf
RG
3649{
3650 I32 idx;
3651 char *class;
3652 SV **sva;
3653 SV *sv;
3654
3655 TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
b12202d0 3656 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
7a6a85bf
RG
3657
3658 GETMARK(idx); /* Index coded on a single char? */
3659 if (idx & 0x80)
3660 RLEN(idx);
3661
3662 /*
3663 * Fetch classname in `aclass'
3664 */
3665
3666 sva = av_fetch(cxt->aclass, idx, FALSE);
3667 if (!sva)
e993d95c 3668 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
7a6a85bf
RG
3669
3670 class = SvPVX(*sva); /* We know it's a PV, by construction */
3671
3672 TRACEME(("class ID %d => %s", idx, class));
3673
3674 /*
3675 * Retrieve object and bless it.
3676 */
3677
b12202d0 3678 sv = retrieve(cxt, class); /* First SV which is SEEN will be blessed */
7a6a85bf
RG
3679
3680 return sv;
3681}
3682
3683/*
3684 * retrieve_blessed
3685 *
3686 * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3687 * <len> can be coded on either 1 or 5 bytes.
3688 */
b12202d0 3689static SV *retrieve_blessed(stcxt_t *cxt, char *cname)
7a6a85bf
RG
3690{
3691 I32 len;
3692 SV *sv;
3693 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3694 char *class = buf;
3695
3696 TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
b12202d0 3697 ASSERT(!cname, ("no bless-into class given here, got %s", cname));
7a6a85bf
RG
3698
3699 /*
3700 * Decode class name length and read that name.
3701 *
3702 * Short classnames have two advantages: their length is stored on one
3703 * single byte, and the string can be read on the stack.
3704 */
3705
3706 GETMARK(len); /* Length coded on a single char? */
3707 if (len & 0x80) {
3708 RLEN(len);
3709 TRACEME(("** allocating %d bytes for class name", len+1));
3710 New(10003, class, len+1, char);
3711 }
3712 READ(class, len);
3713 class[len] = '\0'; /* Mark string end */
3714
3715 /*
3716 * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3717 */
3718
b12202d0
JH
3719 TRACEME(("new class name \"%s\" will bear ID = %d", class, cxt->classnum));
3720
7a6a85bf
RG
3721 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
3722 return (SV *) 0;
3723
3724 /*
3725 * Retrieve object and bless it.
3726 */
3727
b12202d0
JH
3728 sv = retrieve(cxt, class); /* First SV which is SEEN will be blessed */
3729 if (class != buf)
3730 Safefree(class);
7a6a85bf
RG
3731
3732 return sv;
3733}
3734
3735/*
3736 * retrieve_hook
3737 *
3738 * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3739 * with leading mark already read, as usual.
3740 *
3741 * When recursion was involved during serialization of the object, there
3742 * is an unknown amount of serialized objects after the SX_HOOK mark. Until
3743 * we reach a <flags> marker with the recursion bit cleared.
b12202d0
JH
3744 *
3745 * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
3746 * is held in the <extra> byte, and if the object is tied, the serialized
3747 * magic object comes at the very end:
3748 *
3749 * SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
3750 *
3751 * This means the STORABLE_thaw hook will NOT get a tied variable during its
3752 * processing (since we won't have seen the magic object by the time the hook
3753 * is called). See comments below for why it was done that way.
7a6a85bf 3754 */
b12202d0 3755static SV *retrieve_hook(stcxt_t *cxt, char *cname)
7a6a85bf
RG
3756{
3757 I32 len;
3758 char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
3759 char *class = buf;
3760 unsigned int flags;