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