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