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