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