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