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