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