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