ext/Storable/Storable.xs

   1 /*
   2  *  Store and retrieve mechanism.
   3  *
   4  *  Copyright (c) 1995-2000, Raphael Manfredi
   5  *
   6  *  You may redistribute only under the same terms as Perl 5, as specified
   7  *  in the README file that comes with the distribution.
   8  *
   9  */
  10
  11 #define PERL_NO_GET_CONTEXT     /* we want efficiency */
  12 #include <EXTERN.h>
  13 #include <perl.h>
  14 #include <XSUB.h>
  15
  16 #ifndef PATCHLEVEL
  17 #    include <patchlevel.h>             /* Perl's one, needed since 5.6 */
  18 #    if !(defined(PERL_VERSION) || (SUBVERSION > 0 && defined(PATCHLEVEL)))
  19 #        include <could_not_find_Perl_patchlevel.h>
  20 #    endif
  21 #endif
  22
  23 #if PERL_VERSION < 8
  24 #include "ppport.h"             /* handle old perls */
  25 #endif
  26
  27 #ifndef NETWARE
  28 #if 0
  29 #define DEBUGME /* Debug mode, turns assertions on as well */
  30 #define DASSERT /* Assertion mode */
  31 #endif
  32 #else   /* NETWARE */
  33 #if 0   /* On NetWare USE_PERLIO is not used */
  34 #define DEBUGME /* Debug mode, turns assertions on as well */
  35 #define DASSERT /* Assertion mode */
  36 #endif
  37 #endif
  38
  39 /*
  40  * Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
  41  * Provide them with the necessary defines so they can build with pre-5.004.
  42  */
  43 #ifndef USE_PERLIO
  44 #ifndef PERLIO_IS_STDIO
  45 #define PerlIO FILE
  46 #define PerlIO_getc(x) getc(x)
  47 #define PerlIO_putc(f,x) putc(x,f)
  48 #define PerlIO_read(x,y,z) fread(y,1,z,x)
  49 #define PerlIO_write(x,y,z) fwrite(y,1,z,x)
  50 #define PerlIO_stdoutf printf
  51 #endif  /* PERLIO_IS_STDIO */
  52 #endif  /* USE_PERLIO */
  53
  54 /*
  55  * Earlier versions of perl might be used, we can't assume they have the latest!
  56  */
  57
  58 #ifndef PERL_VERSION            /* For perls < 5.6 */
  59 #define PERL_VERSION PATCHLEVEL
  60 #ifndef newRV_noinc
  61 #define newRV_noinc(sv)         ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
  62 #endif
  63 #if (PATCHLEVEL <= 4)           /* Older perls (<= 5.004) lack PL_ namespace */
  64 #define PL_sv_yes       sv_yes
  65 #define PL_sv_no        sv_no
  66 #define PL_sv_undef     sv_undef
  67 #if (SUBVERSION <= 4)           /* 5.004_04 has been reported to lack newSVpvn */
  68 #define newSVpvn newSVpv
  69 #endif
  70 #endif                                          /* PATCHLEVEL <= 4 */
  71 #ifndef HvSHAREKEYS_off
  72 #define HvSHAREKEYS_off(hv)     /* Ignore */
  73 #endif
  74 #ifndef AvFILLp                         /* Older perls (<=5.003) lack AvFILLp */
  75 #define AvFILLp AvFILL
  76 #endif
  77 typedef double NV;                      /* Older perls lack the NV type */
  78 #define IVdf            "ld"    /* Various printf formats for Perl types */
  79 #define UVuf            "lu"
  80 #define UVof            "lo"
  81 #define UVxf            "lx"
  82 #define INT2PTR(t,v) (t)(IV)(v)
  83 #define PTR2UV(v)    (unsigned long)(v)
  84 #endif                                          /* PERL_VERSION -- perls < 5.6 */
  85
  86 #ifndef NVef                            /* The following were not part of perl 5.6 */
  87 #if defined(USE_LONG_DOUBLE) && \
  88         defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
  89 #define NVef            PERL_PRIeldbl
  90 #define NVff            PERL_PRIfldbl
  91 #define NVgf            PERL_PRIgldbl
  92 #else
  93 #define NVef            "e"
  94 #define NVff            "f"
  95 #define NVgf            "g"
  96 #endif
  97 #endif
  98
  99 #ifdef DEBUGME
 100
 101 #ifndef DASSERT
 102 #define DASSERT
 103 #endif
 104
 105 /*
 106  * TRACEME() will only output things when the $Storable::DEBUGME is true.
 107  */
 108
 109 #define TRACEME(x)                                                                              \
 110   STMT_START {                                                                                  \
 111         if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE)))     \
 112                 { PerlIO_stdoutf x; PerlIO_stdoutf("\n"); }             \
 113   } STMT_END
 114 #else
 115 #define TRACEME(x)
 116 #endif  /* DEBUGME */
 117
 118 #ifdef DASSERT
 119 #define ASSERT(x,y)                                                                             \
 120   STMT_START {                                                                                  \
 121         if (!(x)) {                                                                                             \
 122                 PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ",     \
 123                         __FILE__, __LINE__);                                                    \
 124                 PerlIO_stdoutf y; PerlIO_stdoutf("\n");                         \
 125         }                                                                                                               \
 126   } STMT_END
 127 #else
 128 #define ASSERT(x,y)
 129 #endif
 130
 131 /*
 132  * Type markers.
 133  */
 134
 135 #define C(x) ((char) (x))       /* For markers with dynamic retrieval handling */
 136
 137 #define SX_OBJECT       C(0)    /* Already stored object */
 138 #define SX_LSCALAR      C(1)    /* Scalar (large binary) follows (length, data) */
 139 #define SX_ARRAY        C(2)    /* Array forthcominng (size, item list) */
 140 #define SX_HASH         C(3)    /* Hash forthcoming (size, key/value pair list) */
 141 #define SX_REF          C(4)    /* Reference to object forthcoming */
 142 #define SX_UNDEF        C(5)    /* Undefined scalar */
 143 #define SX_INTEGER      C(6)    /* Integer forthcoming */
 144 #define SX_DOUBLE       C(7)    /* Double forthcoming */
 145 #define SX_BYTE         C(8)    /* (signed) byte forthcoming */
 146 #define SX_NETINT       C(9)    /* Integer in network order forthcoming */
 147 #define SX_SCALAR       C(10)   /* Scalar (binary, small) follows (length, data) */
 148 #define SX_TIED_ARRAY   C(11)   /* Tied array forthcoming */
 149 #define SX_TIED_HASH    C(12)   /* Tied hash forthcoming */
 150 #define SX_TIED_SCALAR  C(13)   /* Tied scalar forthcoming */
 151 #define SX_SV_UNDEF     C(14)   /* Perl's immortal PL_sv_undef */
 152 #define SX_SV_YES       C(15)   /* Perl's immortal PL_sv_yes */
 153 #define SX_SV_NO        C(16)   /* Perl's immortal PL_sv_no */
 154 #define SX_BLESS        C(17)   /* Object is blessed */
 155 #define SX_IX_BLESS     C(18)   /* Object is blessed, classname given by index */
 156 #define SX_HOOK         C(19)   /* Stored via hook, user-defined */
 157 #define SX_OVERLOAD     C(20)   /* Overloaded reference */
 158 #define SX_TIED_KEY     C(21)   /* Tied magic key forthcoming */
 159 #define SX_TIED_IDX     C(22)   /* Tied magic index forthcoming */
 160 #define SX_UTF8STR      C(23)   /* UTF-8 string forthcoming (small) */
 161 #define SX_LUTF8STR     C(24)   /* UTF-8 string forthcoming (large) */
 162 #define SX_FLAG_HASH    C(25)   /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
 163 #define SX_CODE         C(26)   /* Code references as perl source code */
 164 #define SX_WEAKREF      C(27)   /* Weak reference to object forthcoming */
 165 #define SX_WEAKOVERLOAD C(28)   /* Overloaded weak reference */
 166 #define SX_ERROR        C(29)   /* Error */
 167
 168 /*
 169  * Those are only used to retrieve "old" pre-0.6 binary images.
 170  */
 171 #define SX_ITEM         'i'             /* An array item introducer */
 172 #define SX_IT_UNDEF     'I'             /* Undefined array item */
 173 #define SX_KEY          'k'             /* A hash key introducer */
 174 #define SX_VALUE        'v'             /* A hash value introducer */
 175 #define SX_VL_UNDEF     'V'             /* Undefined hash value */
 176
 177 /*
 178  * Those are only used to retrieve "old" pre-0.7 binary images
 179  */
 180
 181 #define SX_CLASS        'b'             /* Object is blessed, class name length <255 */
 182 #define SX_LG_CLASS     'B'             /* Object is blessed, class name length >255 */
 183 #define SX_STORED       'X'             /* End of object */
 184
 185 /*
 186  * Limits between short/long length representation.
 187  */
 188
 189 #define LG_SCALAR       255             /* Large scalar length limit */
 190 #define LG_BLESS        127             /* Large classname bless limit */
 191
 192 /*
 193  * Operation types
 194  */
 195
 196 #define ST_STORE        0x1             /* Store operation */
 197 #define ST_RETRIEVE     0x2             /* Retrieval operation */
 198 #define ST_CLONE        0x4             /* Deep cloning operation */
 199
 200 /*
 201  * The following structure is used for hash table key retrieval. Since, when
 202  * retrieving objects, we'll be facing blessed hash references, it's best
 203  * to pre-allocate that buffer once and resize it as the need arises, never
 204  * freeing it (keys will be saved away someplace else anyway, so even large
 205  * keys are not enough a motivation to reclaim that space).
 206  *
 207  * This structure is also used for memory store/retrieve operations which
 208  * happen in a fixed place before being malloc'ed elsewhere if persistency
 209  * is required. Hence the aptr pointer.
 210  */
 211 struct extendable {
 212         char *arena;            /* Will hold hash key strings, resized as needed */
 213         STRLEN asiz;            /* Size of aforementionned buffer */
 214         char *aptr;                     /* Arena pointer, for in-place read/write ops */
 215         char *aend;                     /* First invalid address */
 216 };
 217
 218 /*
 219  * At store time:
 220  * A hash table records the objects which have already been stored.
 221  * Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
 222  * an arbitrary sequence number) is used to identify them.
 223  *
 224  * At retrieve time:
 225  * An array table records the objects which have already been retrieved,
 226  * as seen by the tag determind by counting the objects themselves. The
 227  * reference to that retrieved object is kept in the table, and is returned
 228  * when an SX_OBJECT is found bearing that same tag.
 229  *
 230  * The same processing is used to record "classname" for blessed objects:
 231  * indexing by a hash at store time, and via an array at retrieve time.
 232  */
 233
 234 typedef unsigned long stag_t;   /* Used by pre-0.6 binary format */
 235
 236 /*
 237  * The following "thread-safe" related defines were contributed by
 238  * Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
 239  * only renamed things a little bit to ensure consistency with surrounding
 240  * code.        -- RAM, 14/09/1999
 241  *
 242  * The original patch suffered from the fact that the stcxt_t structure
 243  * was global.  Murray tried to minimize the impact on the code as much as
 244  * possible.
 245  *
 246  * Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
 247  * on objects.  Therefore, the notion of context needs to be generalized,
 248  * threading or not.
 249  */
 250
 251 #define MY_VERSION "Storable(" XS_VERSION ")"
 252
 253
 254 /*
 255  * Conditional UTF8 support.
 256  *
 257  */
 258 #ifdef SvUTF8_on
 259 #define STORE_UTF8STR(pv, len)  STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
 260 #define HAS_UTF8_SCALARS
 261 #ifdef HeKUTF8
 262 #define HAS_UTF8_HASHES
 263 #define HAS_UTF8_ALL
 264 #else
 265 /* 5.6 perl has utf8 scalars but not hashes */
 266 #endif
 267 #else
 268 #define SvUTF8(sv) 0
 269 #define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
 270 #endif
 271 #ifndef HAS_UTF8_ALL
 272 #define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
 273 #endif
 274 #ifndef SvWEAKREF
 275 #define WEAKREF_CROAK() CROAK(("Cannot retrieve weak references in this perl"))
 276 #endif
 277
 278 #ifdef HvPLACEHOLDERS
 279 #define HAS_RESTRICTED_HASHES
 280 #else
 281 #define HVhek_PLACEHOLD 0x200
 282 #define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
 283 #endif
 284
 285 #ifdef HvHASKFLAGS
 286 #define HAS_HASH_KEY_FLAGS
 287 #endif
 288
 289 /*
 290  * Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
 291  * files remap tainted and dirty when threading is enabled.  That's bad for
 292  * perl to remap such common words.     -- RAM, 29/09/00
 293  */
 294
 295 typedef struct stcxt {
 296         int entry;                      /* flags recursion */
 297         int optype;                     /* type of traversal operation */
 298         HV *hseen;                      /* which objects have been seen, store time */
 299         AV *hook_seen;          /* which SVs were returned by STORABLE_freeze() */
 300         AV *aseen;                      /* which objects have been seen, retrieve time */
 301         IV where_is_undef;              /* index in aseen of PL_sv_undef */
 302         HV *hclass;                     /* which classnames have been seen, store time */
 303         AV *aclass;                     /* which classnames have been seen, retrieve time */
 304         HV *hook;                       /* cache for hook methods per class name */
 305         IV tagnum;                      /* incremented at store time for each seen object */
 306         IV classnum;            /* incremented at store time for each seen classname */
 307         int netorder;           /* true if network order used */
 308         int s_tainted;          /* true if input source is tainted, at retrieve time */
 309         int forgive_me;         /* whether to be forgiving... */
 310         int deparse;        /* whether to deparse code refs */
 311         SV *eval;           /* whether to eval source code */
 312         int canonical;          /* whether to store hashes sorted by key */
 313 #ifndef HAS_RESTRICTED_HASHES
 314         int derestrict;         /* whether to downgrade restrcted hashes */
 315 #endif
 316 #ifndef HAS_UTF8_ALL
 317         int use_bytes;         /* whether to bytes-ify utf8 */
 318 #endif
 319         int accept_future_minor; /* croak immediately on future minor versions?  */
 320         int s_dirty;            /* context is dirty due to CROAK() -- can be cleaned */
 321         int membuf_ro;          /* true means membuf is read-only and msaved is rw */
 322         struct extendable keybuf;       /* for hash key retrieval */
 323         struct extendable membuf;       /* for memory store/retrieve operations */
 324         struct extendable msaved;       /* where potentially valid mbuf is saved */
 325         PerlIO *fio;            /* where I/O are performed, NULL for memory */
 326         int ver_major;          /* major of version for retrieved object */
 327         int ver_minor;          /* minor of version for retrieved object */
 328         SV *(**retrieve_vtbl)();        /* retrieve dispatch table */
 329         SV *prev;               /* contexts chained backwards in real recursion */
 330         SV *my_sv;              /* the blessed scalar who's SvPVX() I am */
 331 } stcxt_t;
 332
 333 #define NEW_STORABLE_CXT_OBJ(cxt)                                       \
 334   STMT_START {                                                                          \
 335         SV *self = newSV(sizeof(stcxt_t) - 1);                  \
 336         SV *my_sv = newRV_noinc(self);                                  \
 337         sv_bless(my_sv, gv_stashpv("Storable::Cxt", TRUE));     \
 338         cxt = (stcxt_t *)SvPVX(self);                                   \
 339         Zero(cxt, 1, stcxt_t);                                                  \
 340         cxt->my_sv = my_sv;                                                             \
 341   } STMT_END
 342
 343 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
 344
 345 #if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
 346 #define dSTCXT_SV                                                                       \
 347         SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
 348 #else   /* >= perl5.004_68 */
 349 #define dSTCXT_SV                                                                       \
 350         SV *perinterp_sv = *hv_fetch(PL_modglobal,              \
 351                 MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
 352 #endif  /* < perl5.004_68 */
 353
 354 #define dSTCXT_PTR(T,name)                                                      \
 355         T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv)   \
 356                                 ? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
 357 #define dSTCXT                                                                          \
 358         dSTCXT_SV;                                                                              \
 359         dSTCXT_PTR(stcxt_t *, cxt)
 360
 361 #define INIT_STCXT                                                      \
 362         dSTCXT;                                                                 \
 363         NEW_STORABLE_CXT_OBJ(cxt);                              \
 364         sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
 365
 366 #define SET_STCXT(x)                                                            \
 367   STMT_START {                                                                          \
 368         dSTCXT_SV;                                                                              \
 369         sv_setiv(perinterp_sv, PTR2IV(x->my_sv));               \
 370   } STMT_END
 371
 372 #else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
 373
 374 static stcxt_t *Context_ptr = NULL;
 375 #define dSTCXT                  stcxt_t *cxt = Context_ptr
 376 #define SET_STCXT(x)            Context_ptr = x
 377 #define INIT_STCXT                                              \
 378         dSTCXT;                                                         \
 379         NEW_STORABLE_CXT_OBJ(cxt);                      \
 380         SET_STCXT(cxt)
 381
 382
 383 #endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
 384
 385 /*
 386  * KNOWN BUG:
 387  *   Croaking implies a memory leak, since we don't use setjmp/longjmp
 388  *   to catch the exit and free memory used during store or retrieve
 389  *   operations.  This is not too difficult to fix, but I need to understand
 390  *   how Perl does it, and croaking is exceptional anyway, so I lack the
 391  *   motivation to do it.
 392  *
 393  * The current workaround is to mark the context as dirty when croaking,
 394  * so that data structures can be freed whenever we renter Storable code
 395  * (but only *then*: it's a workaround, not a fix).
 396  *
 397  * This is also imperfect, because we don't really know how far they trapped
 398  * the croak(), and when we were recursing, we won't be able to clean anything
 399  * but the topmost context stacked.
 400  */
 401
 402 #define CROAK(x)        STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
 403
 404 /*
 405  * End of "thread-safe" related definitions.
 406  */
 407
 408 /*
 409  * LOW_32BITS
 410  *
 411  * Keep only the low 32 bits of a pointer (used for tags, which are not
 412  * really pointers).
 413  */
 414
 415 #if PTRSIZE <= 4
 416 #define LOW_32BITS(x)   ((I32) (x))
 417 #else
 418 #define LOW_32BITS(x)   ((I32) ((unsigned long) (x) & 0xffffffffUL))
 419 #endif
 420
 421 /*
 422  * oI, oS, oC
 423  *
 424  * Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
 425  * Used in the WLEN and RLEN macros.
 426  */
 427
 428 #if INTSIZE > 4
 429 #define oI(x)   ((I32 *) ((char *) (x) + 4))
 430 #define oS(x)   ((x) - 4)
 431 #define oC(x)   (x = 0)
 432 #define CRAY_HACK
 433 #else
 434 #define oI(x)   (x)
 435 #define oS(x)   (x)
 436 #define oC(x)
 437 #endif
 438
 439 /*
 440  * key buffer handling
 441  */
 442 #define kbuf    (cxt->keybuf).arena
 443 #define ksiz    (cxt->keybuf).asiz
 444 #define KBUFINIT()                                              \
 445   STMT_START {                                                  \
 446         if (!kbuf) {                                            \
 447                 TRACEME(("** allocating kbuf of 128 bytes")); \
 448                 New(10003, kbuf, 128, char);    \
 449                 ksiz = 128;                                             \
 450         }                                                                       \
 451   } STMT_END
 452 #define KBUFCHK(x)                              \
 453   STMT_START {                                  \
 454         if (x >= ksiz) {                        \
 455                 TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
 456                 Renew(kbuf, x+1, char); \
 457                 ksiz = x+1;                             \
 458         }                                                       \
 459   } STMT_END
 460
 461 /*
 462  * memory buffer handling
 463  */
 464 #define mbase   (cxt->membuf).arena
 465 #define msiz    (cxt->membuf).asiz
 466 #define mptr    (cxt->membuf).aptr
 467 #define mend    (cxt->membuf).aend
 468
 469 #define MGROW   (1 << 13)
 470 #define MMASK   (MGROW - 1)
 471
 472 #define round_mgrow(x)  \
 473         ((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
 474 #define trunc_int(x)    \
 475         ((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
 476 #define int_aligned(x)  \
 477         ((unsigned long) (x) == trunc_int(x))
 478
 479 #define MBUF_INIT(x)                                    \
 480   STMT_START {                                                  \
 481         if (!mbase) {                                           \
 482                 TRACEME(("** allocating mbase of %d bytes", MGROW)); \
 483                 New(10003, mbase, MGROW, char); \
 484                 msiz = (STRLEN)MGROW;                                   \
 485         }                                                                       \
 486         mptr = mbase;                                           \
 487         if (x)                                                          \
 488                 mend = mbase + x;                               \
 489         else                                                            \
 490                 mend = mbase + msiz;                    \
 491   } STMT_END
 492
 493 #define MBUF_TRUNC(x)   mptr = mbase + x
 494 #define MBUF_SIZE()             (mptr - mbase)
 495
 496 /*
 497  * MBUF_SAVE_AND_LOAD
 498  * MBUF_RESTORE
 499  *
 500  * Those macros are used in do_retrieve() to save the current memory
 501  * buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
 502  * data from a string.
 503  */
 504 #define MBUF_SAVE_AND_LOAD(in)                  \
 505   STMT_START {                                                  \
 506         ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
 507         cxt->membuf_ro = 1;                                     \
 508         TRACEME(("saving mbuf"));                       \
 509         StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
 510         MBUF_LOAD(in);                                          \
 511   } STMT_END
 512
 513 #define MBUF_RESTORE()                                  \
 514   STMT_START {                                                  \
 515         ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
 516         cxt->membuf_ro = 0;                                     \
 517         TRACEME(("restoring mbuf"));            \
 518         StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
 519   } STMT_END
 520
 521 /*
 522  * Use SvPOKp(), because SvPOK() fails on tainted scalars.
 523  * See store_scalar() for other usage of this workaround.
 524  */
 525 #define MBUF_LOAD(v)                                    \
 526   STMT_START {                                                  \
 527         ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
 528         if (!SvPOKp(v))                                         \
 529                 CROAK(("Not a scalar string")); \
 530         mptr = mbase = SvPV(v, msiz);           \
 531         mend = mbase + msiz;                            \
 532   } STMT_END
 533
 534 #define MBUF_XTEND(x)                           \
 535   STMT_START {                                          \
 536         int nsz = (int) round_mgrow((x)+msiz);  \
 537         int offset = mptr - mbase;              \
 538         ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
 539         TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
 540                 msiz, nsz, (x)));                       \
 541         Renew(mbase, nsz, char);                \
 542         msiz = nsz;                                             \
 543         mptr = mbase + offset;                  \
 544         mend = mbase + nsz;                             \
 545   } STMT_END
 546
 547 #define MBUF_CHK(x)                             \
 548   STMT_START {                                          \
 549         if ((mptr + (x)) > mend)                \
 550                 MBUF_XTEND(x);                          \
 551   } STMT_END
 552
 553 #define MBUF_GETC(x)                            \
 554   STMT_START {                                          \
 555         if (mptr < mend)                                \
 556                 x = (int) (unsigned char) *mptr++;      \
 557         else                                                    \
 558                 return (SV *) 0;                        \
 559   } STMT_END
 560
 561 #ifdef CRAY_HACK
 562 #define MBUF_GETINT(x)                                  \
 563   STMT_START {                                                  \
 564         oC(x);                                                          \
 565         if ((mptr + 4) <= mend) {                       \
 566                 memcpy(oI(&x), mptr, 4);                \
 567                 mptr += 4;                                              \
 568         } else                                                          \
 569                 return (SV *) 0;                                \
 570   } STMT_END
 571 #else
 572 #define MBUF_GETINT(x)                                  \
 573   STMT_START {                                                  \
 574         if ((mptr + sizeof(int)) <= mend) {     \
 575                 if (int_aligned(mptr))                  \
 576                         x = *(int *) mptr;                      \
 577                 else                                                    \
 578                         memcpy(&x, mptr, sizeof(int));  \
 579                 mptr += sizeof(int);                    \
 580         } else                                                          \
 581                 return (SV *) 0;                                \
 582   } STMT_END
 583 #endif
 584
 585 #define MBUF_READ(x,s)                          \
 586   STMT_START {                                          \
 587         if ((mptr + (s)) <= mend) {             \
 588                 memcpy(x, mptr, s);                     \
 589                 mptr += s;                                      \
 590         } else                                                  \
 591                 return (SV *) 0;                        \
 592   } STMT_END
 593
 594 #define MBUF_SAFEREAD(x,s,z)            \
 595   STMT_START {                                          \
 596         if ((mptr + (s)) <= mend) {             \
 597                 memcpy(x, mptr, s);                     \
 598                 mptr += s;                                      \
 599         } else {                                                \
 600                 sv_free(z);                                     \
 601                 return (SV *) 0;                        \
 602         }                                                               \
 603   } STMT_END
 604
 605 #define MBUF_PUTC(c)                            \
 606   STMT_START {                                          \
 607         if (mptr < mend)                                \
 608                 *mptr++ = (char) c;                     \
 609         else {                                                  \
 610                 MBUF_XTEND(1);                          \
 611                 *mptr++ = (char) c;                     \
 612         }                                                               \
 613   } STMT_END
 614
 615 #ifdef CRAY_HACK
 616 #define MBUF_PUTINT(i)                          \
 617   STMT_START {                                          \
 618         MBUF_CHK(4);                                    \
 619         memcpy(mptr, oI(&i), 4);                \
 620         mptr += 4;                                              \
 621   } STMT_END
 622 #else
 623 #define MBUF_PUTINT(i)                          \
 624   STMT_START {                                          \
 625         MBUF_CHK(sizeof(int));                  \
 626         if (int_aligned(mptr))                  \
 627                 *(int *) mptr = i;                      \
 628         else                                                    \
 629                 memcpy(mptr, &i, sizeof(int));  \
 630         mptr += sizeof(int);                    \
 631   } STMT_END
 632 #endif
 633
 634 #define MBUF_WRITE(x,s)                         \
 635   STMT_START {                                          \
 636         MBUF_CHK(s);                                    \
 637         memcpy(mptr, x, s);                             \
 638         mptr += s;                                              \
 639   } STMT_END
 640
 641 /*
 642  * Possible return values for sv_type().
 643  */
 644
 645 #define svis_REF                0
 646 #define svis_SCALAR             1
 647 #define svis_ARRAY              2
 648 #define svis_HASH               3
 649 #define svis_TIED               4
 650 #define svis_TIED_ITEM  5
 651 #define svis_CODE               6
 652 #define svis_OTHER              7
 653
 654 /*
 655  * Flags for SX_HOOK.
 656  */
 657
 658 #define SHF_TYPE_MASK           0x03
 659 #define SHF_LARGE_CLASSLEN      0x04
 660 #define SHF_LARGE_STRLEN        0x08
 661 #define SHF_LARGE_LISTLEN       0x10
 662 #define SHF_IDX_CLASSNAME       0x20
 663 #define SHF_NEED_RECURSE        0x40
 664 #define SHF_HAS_LIST            0x80
 665
 666 /*
 667  * Types for SX_HOOK (last 2 bits in flags).
 668  */
 669
 670 #define SHT_SCALAR                      0
 671 #define SHT_ARRAY                       1
 672 #define SHT_HASH                        2
 673 #define SHT_EXTRA                       3               /* Read extra byte for type */
 674
 675 /*
 676  * The following are held in the "extra byte"...
 677  */
 678
 679 #define SHT_TSCALAR                     4               /* 4 + 0 -- tied scalar */
 680 #define SHT_TARRAY                      5               /* 4 + 1 -- tied array */
 681 #define SHT_THASH                       6               /* 4 + 2 -- tied hash */
 682
 683 /*
 684  * per hash flags for flagged hashes
 685  */
 686
 687 #define SHV_RESTRICTED          0x01
 688
 689 /*
 690  * per key flags for flagged hashes
 691  */
 692
 693 #define SHV_K_UTF8              0x01
 694 #define SHV_K_WASUTF8           0x02
 695 #define SHV_K_LOCKED            0x04
 696 #define SHV_K_ISSV              0x08
 697 #define SHV_K_PLACEHOLDER       0x10
 698
 699 /*
 700  * Before 0.6, the magic string was "perl-store" (binary version number 0).
 701  *
 702  * Since 0.6 introduced many binary incompatibilities, the magic string has
 703  * been changed to "pst0" to allow an old image to be properly retrieved by
 704  * a newer Storable, but ensure a newer image cannot be retrieved with an
 705  * older version.
 706  *
 707  * At 0.7, objects are given the ability to serialize themselves, and the
 708  * set of markers is extended, backward compatibility is not jeopardized,
 709  * so the binary version number could have remained unchanged.  To correctly
 710  * spot errors if a file making use of 0.7-specific extensions is given to
 711  * 0.6 for retrieval, the binary version was moved to "2".  And I'm introducing
 712  * a "minor" version, to better track this kind of evolution from now on.
 713  *
 714  */
 715 static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
 716 static const char magicstr[] = "pst0";           /* Used as a magic number */
 717
 718 #define MAGICSTR_BYTES  'p','s','t','0'
 719 #define OLDMAGICSTR_BYTES  'p','e','r','l','-','s','t','o','r','e'
 720
 721 /* 5.6.x introduced the ability to have IVs as long long.
 722    However, Configure still defined BYTEORDER based on the size of a long.
 723    Storable uses the BYTEORDER value as part of the header, but doesn't
 724    explicity store sizeof(IV) anywhere in the header.  Hence on 5.6.x built
 725    with IV as long long on a platform that uses Configure (ie most things
 726    except VMS and Windows) headers are identical for the different IV sizes,
 727    despite the files containing some fields based on sizeof(IV)
 728    Erk. Broken-ness.
 729    5.8 is consistent - the following redifinition kludge is only needed on
 730    5.6.x, but the interwork is needed on 5.8 while data survives in files
 731    with the 5.6 header.
 732
 733 */
 734
 735 #if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
 736 #ifndef NO_56_INTERWORK_KLUDGE
 737 #define USE_56_INTERWORK_KLUDGE
 738 #endif
 739 #if BYTEORDER == 0x1234
 740 #undef BYTEORDER
 741 #define BYTEORDER 0x12345678
 742 #else
 743 #if BYTEORDER == 0x4321
 744 #undef BYTEORDER
 745 #define BYTEORDER 0x87654321
 746 #endif
 747 #endif
 748 #endif
 749
 750 #if BYTEORDER == 0x1234
 751 #define BYTEORDER_BYTES  '1','2','3','4'
 752 #else
 753 #if BYTEORDER == 0x12345678
 754 #define BYTEORDER_BYTES  '1','2','3','4','5','6','7','8'
 755 #ifdef USE_56_INTERWORK_KLUDGE
 756 #define BYTEORDER_BYTES_56  '1','2','3','4'
 757 #endif
 758 #else
 759 #if BYTEORDER == 0x87654321
 760 #define BYTEORDER_BYTES  '8','7','6','5','4','3','2','1'
 761 #ifdef USE_56_INTERWORK_KLUDGE
 762 #define BYTEORDER_BYTES_56  '4','3','2','1'
 763 #endif
 764 #else
 765 #if BYTEORDER == 0x4321
 766 #define BYTEORDER_BYTES  '4','3','2','1'
 767 #else
 768 #error Unknown byteoder. Please append your byteorder to Storable.xs
 769 #endif
 770 #endif
 771 #endif
 772 #endif
 773
 774 static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
 775 #ifdef USE_56_INTERWORK_KLUDGE
 776 static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
 777 #endif
 778
 779 #define STORABLE_BIN_MAJOR      2               /* Binary major "version" */
 780 #define STORABLE_BIN_MINOR      7               /* Binary minor "version" */
 781
 782 #if (PATCHLEVEL <= 5)
 783 #define STORABLE_BIN_WRITE_MINOR        4
 784 #else
 785 /*
 786  * Perl 5.6.0 onwards can do weak references.
 787 */
 788 #define STORABLE_BIN_WRITE_MINOR        7
 789 #endif /* (PATCHLEVEL <= 5) */
 790
 791 #if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
 792 #define PL_sv_placeholder PL_sv_undef
 793 #endif
 794
 795 /*
 796  * Useful store shortcuts...
 797  */
 798
 799 /*
 800  * Note that if you put more than one mark for storing a particular
 801  * type of thing, *and* in the retrieve_foo() function you mark both
 802  * the thingy's you get off with SEEN(), you *must* increase the
 803  * tagnum with cxt->tagnum++ along with this macro!
 804  *     - samv 20Jan04
 805  */
 806 #define PUTMARK(x)                                                      \
 807   STMT_START {                                                          \
 808         if (!cxt->fio)                                                  \
 809                 MBUF_PUTC(x);                                           \
 810         else if (PerlIO_putc(cxt->fio, x) == EOF)       \
 811                 return -1;                                                      \
 812   } STMT_END
 813
 814 #define WRITE_I32(x)                                    \
 815   STMT_START {                                                  \
 816         ASSERT(sizeof(x) == sizeof(I32), ("writing an I32"));   \
 817         if (!cxt->fio)                                          \
 818                 MBUF_PUTINT(x);                                 \
 819         else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
 820                 return -1;                                      \
 821   } STMT_END
 822
 823 #ifdef HAS_HTONL
 824 #define WLEN(x)                                         \
 825   STMT_START {                                          \
 826         if (cxt->netorder) {                    \
 827                 int y = (int) htonl(x);         \
 828                 if (!cxt->fio)                          \
 829                         MBUF_PUTINT(y);                 \
 830                 else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
 831                         return -1;                              \
 832         } else {                                                \
 833                 if (!cxt->fio)                          \
 834                         MBUF_PUTINT(x);                 \
 835                 else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
 836                         return -1;                              \
 837         }                                                               \
 838   } STMT_END
 839 #else
 840 #define WLEN(x) WRITE_I32(x)
 841 #endif
 842
 843 #define WRITE(x,y)                                                      \
 844   STMT_START {                                                          \
 845         if (!cxt->fio)                                                  \
 846                 MBUF_WRITE(x,y);                                        \
 847         else if (PerlIO_write(cxt->fio, x, y) != y)     \
 848                 return -1;                                                      \
 849   } STMT_END
 850
 851 #define STORE_PV_LEN(pv, len, small, large)                     \
 852   STMT_START {                                                  \
 853         if (len <= LG_SCALAR) {                         \
 854                 unsigned char clen = (unsigned char) len;       \
 855                 PUTMARK(small);                                 \
 856                 PUTMARK(clen);                                  \
 857                 if (len)                                                \
 858                         WRITE(pv, len);                         \
 859         } else {                                                        \
 860                 PUTMARK(large);                                 \
 861                 WLEN(len);                                              \
 862                 WRITE(pv, len);                                 \
 863         }                                                                       \
 864   } STMT_END
 865
 866 #define STORE_SCALAR(pv, len)   STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
 867
 868 /*
 869  * Store &PL_sv_undef in arrays without recursing through store().
 870  */
 871 #define STORE_SV_UNDEF()                                        \
 872   STMT_START {                                                  \
 873         cxt->tagnum++;                                          \
 874         PUTMARK(SX_SV_UNDEF);                                   \
 875   } STMT_END
 876
 877 /*
 878  * Useful retrieve shortcuts...
 879  */
 880
 881 #define GETCHAR() \
 882         (cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
 883
 884 #define GETMARK(x)                                                              \
 885   STMT_START {                                                                  \
 886         if (!cxt->fio)                                                          \
 887                 MBUF_GETC(x);                                                   \
 888         else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF)      \
 889                 return (SV *) 0;                                                \
 890   } STMT_END
 891
 892 #define READ_I32(x)                                             \
 893   STMT_START {                                                  \
 894         ASSERT(sizeof(x) == sizeof(I32), ("reading an I32"));   \
 895         oC(x);                                                          \
 896         if (!cxt->fio)                                          \
 897                 MBUF_GETINT(x);                                 \
 898         else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
 899                 return (SV *) 0;                                \
 900   } STMT_END
 901
 902 #ifdef HAS_NTOHL
 903 #define RLEN(x)                                                 \
 904   STMT_START {                                                  \
 905         oC(x);                                                          \
 906         if (!cxt->fio)                                          \
 907                 MBUF_GETINT(x);                                 \
 908         else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
 909                 return (SV *) 0;                                \
 910         if (cxt->netorder)                                      \
 911                 x = (int) ntohl(x);                             \
 912   } STMT_END
 913 #else
 914 #define RLEN(x) READ_I32(x)
 915 #endif
 916
 917 #define READ(x,y)                                                       \
 918   STMT_START {                                                          \
 919         if (!cxt->fio)                                                  \
 920                 MBUF_READ(x, y);                                        \
 921         else if (PerlIO_read(cxt->fio, x, y) != y)      \
 922                 return (SV *) 0;                                        \
 923   } STMT_END
 924
 925 #define SAFEREAD(x,y,z)                                                 \
 926   STMT_START {                                                                  \
 927         if (!cxt->fio)                                                          \
 928                 MBUF_SAFEREAD(x,y,z);                                   \
 929         else if (PerlIO_read(cxt->fio, x, y) != y)       {      \
 930                 sv_free(z);                                                             \
 931                 return (SV *) 0;                                                \
 932         }                                                                                       \
 933   } STMT_END
 934
 935 /*
 936  * This macro is used at retrieve time, to remember where object 'y', bearing a
 937  * given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
 938  * we'll therefore know where it has been retrieved and will be able to
 939  * share the same reference, as in the original stored memory image.
 940  *
 941  * We also need to bless objects ASAP for hooks (which may compute "ref $x"
 942  * on the objects given to STORABLE_thaw and expect that to be defined), and
 943  * also for overloaded objects (for which we might not find the stash if the
 944  * object is not blessed yet--this might occur for overloaded objects that
 945  * refer to themselves indirectly: if we blessed upon return from a sub
 946  * retrieve(), the SX_OBJECT marker we'd found could not have overloading
 947  * restored on it because the underlying object would not be blessed yet!).
 948  *
 949  * To achieve that, the class name of the last retrieved object is passed down
 950  * recursively, and the first SEEN() call for which the class name is not NULL
 951  * will bless the object.
 952  *
 953  * i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
 954  */
 955 #define SEEN(y,c,i)                                                     \
 956   STMT_START {                                                          \
 957         if (!y)                                                                 \
 958                 return (SV *) 0;                                        \
 959         if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
 960                 return (SV *) 0;                                        \
 961         TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
 962                  PTR2UV(y), SvREFCNT(y)-1));            \
 963         if (c)                                                                  \
 964                 BLESS((SV *) (y), c);                           \
 965   } STMT_END
 966
 967 /*
 968  * Bless `s' in `p', via a temporary reference, required by sv_bless().
 969  */
 970 #define BLESS(s,p)                                                      \
 971   STMT_START {                                                          \
 972         SV *ref;                                                                \
 973         HV *stash;                                                              \
 974         TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
 975         stash = gv_stashpv((p), TRUE);                  \
 976         ref = newRV_noinc(s);                                   \
 977         (void) sv_bless(ref, stash);                    \
 978         SvRV(ref) = 0;                                                  \
 979         SvREFCNT_dec(ref);                                              \
 980   } STMT_END
 981 /*
 982  * sort (used in store_hash) - conditionally use qsort when
 983  * sortsv is not available ( <= 5.6.1 ).
 984  */
 985
 986 #if (PATCHLEVEL <= 6)
 987
 988 #if defined(USE_ITHREADS)
 989
 990 #define STORE_HASH_SORT \
 991         ENTER; { \
 992         PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
 993         SAVESPTR(orig_perl); \
 994         PERL_SET_CONTEXT(aTHX); \
 995         qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
 996         } LEAVE;
 997
 998 #else /* ! USE_ITHREADS */
 999
1000 #define STORE_HASH_SORT \
1001         qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
1002
1003 #endif  /* USE_ITHREADS */
1004
1005 #else /* PATCHLEVEL > 6 */
1006
1007 #define STORE_HASH_SORT \
1008         sortsv(AvARRAY(av), len, Perl_sv_cmp);
1009
1010 #endif /* PATCHLEVEL <= 6 */
1011
1012 static int store(pTHX_ stcxt_t *cxt, SV *sv);
1013 static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname);
1014
1015 /*
1016  * Dynamic dispatching table for SV store.
1017  */
1018
1019 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
1020 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
1021 static int store_array(pTHX_ stcxt_t *cxt, AV *av);
1022 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
1023 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
1024 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
1025 static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
1026 static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
1027 static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
1028
1029 static int (*sv_store[])(pTHX_ stcxt_t *cxt, SV *sv) = {
1030         store_ref,                                                                              /* svis_REF */
1031         store_scalar,                                                                   /* svis_SCALAR */
1032         (int (*)(pTHX_ stcxt_t *cxt, SV *sv)) store_array,      /* svis_ARRAY */
1033         (int (*)(pTHX_ stcxt_t *cxt, SV *sv)) store_hash,               /* svis_HASH */
1034         store_tied,                                                                             /* svis_TIED */
1035         store_tied_item,                                                                /* svis_TIED_ITEM */
1036         (int (*)(pTHX_ stcxt_t *cxt, SV *sv)) store_code,               /* svis_CODE */
1037         store_other,                                                                    /* svis_OTHER */
1038 };
1039
1040 #define SV_STORE(x)     (*sv_store[x])
1041
1042 /*
1043  * Dynamic dispatching tables for SV retrieval.
1044  */
1045
1046 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname);
1047 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname);
1048 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
1049 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
1050 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname);
1051 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname);
1052 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname);
1053 static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname);
1054 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname);
1055 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname);
1056 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname);
1057 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname);
1058 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname);
1059 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname);
1060 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname);
1061 static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname);
1062
1063 static SV *(*sv_old_retrieve[])(pTHX_ stcxt_t *cxt, char *cname) = {
1064         0,                      /* SX_OBJECT -- entry unused dynamically */
1065         retrieve_lscalar,               /* SX_LSCALAR */
1066         old_retrieve_array,             /* SX_ARRAY -- for pre-0.6 binaries */
1067         old_retrieve_hash,              /* SX_HASH -- for pre-0.6 binaries */
1068         retrieve_ref,                   /* SX_REF */
1069         retrieve_undef,                 /* SX_UNDEF */
1070         retrieve_integer,               /* SX_INTEGER */
1071         retrieve_double,                /* SX_DOUBLE */
1072         retrieve_byte,                  /* SX_BYTE */
1073         retrieve_netint,                /* SX_NETINT */
1074         retrieve_scalar,                /* SX_SCALAR */
1075         retrieve_tied_array,    /* SX_ARRAY */
1076         retrieve_tied_hash,             /* SX_HASH */
1077         retrieve_tied_scalar,   /* SX_SCALAR */
1078         retrieve_other,                 /* SX_SV_UNDEF not supported */
1079         retrieve_other,                 /* SX_SV_YES not supported */
1080         retrieve_other,                 /* SX_SV_NO not supported */
1081         retrieve_other,                 /* SX_BLESS not supported */
1082         retrieve_other,                 /* SX_IX_BLESS not supported */
1083         retrieve_other,                 /* SX_HOOK not supported */
1084         retrieve_other,                 /* SX_OVERLOADED not supported */
1085         retrieve_other,                 /* SX_TIED_KEY not supported */
1086         retrieve_other,                 /* SX_TIED_IDX not supported */
1087         retrieve_other,                 /* SX_UTF8STR not supported */
1088         retrieve_other,                 /* SX_LUTF8STR not supported */
1089         retrieve_other,                 /* SX_FLAG_HASH not supported */
1090         retrieve_other,                 /* SX_CODE not supported */
1091         retrieve_other,                 /* SX_WEAKREF not supported */
1092         retrieve_other,                 /* SX_WEAKOVERLOAD not supported */
1093         retrieve_other,                 /* SX_ERROR */
1094 };
1095
1096 static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
1097 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
1098 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname);
1099 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname);
1100 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname);
1101 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname);
1102 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname);
1103 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname);
1104 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname);
1105 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname);
1106 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname);
1107 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname);
1108 static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname);
1109 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, char *cname);
1110 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, char *cname);
1111
1112 static SV *(*sv_retrieve[])(pTHX_ stcxt_t *cxt, char *cname) = {
1113         0,                      /* SX_OBJECT -- entry unused dynamically */
1114         retrieve_lscalar,               /* SX_LSCALAR */
1115         retrieve_array,                 /* SX_ARRAY */
1116         retrieve_hash,                  /* SX_HASH */
1117         retrieve_ref,                   /* SX_REF */
1118         retrieve_undef,                 /* SX_UNDEF */
1119         retrieve_integer,               /* SX_INTEGER */
1120         retrieve_double,                /* SX_DOUBLE */
1121         retrieve_byte,                  /* SX_BYTE */
1122         retrieve_netint,                /* SX_NETINT */
1123         retrieve_scalar,                /* SX_SCALAR */
1124         retrieve_tied_array,    /* SX_ARRAY */
1125         retrieve_tied_hash,             /* SX_HASH */
1126         retrieve_tied_scalar,   /* SX_SCALAR */
1127         retrieve_sv_undef,              /* SX_SV_UNDEF */
1128         retrieve_sv_yes,                /* SX_SV_YES */
1129         retrieve_sv_no,                 /* SX_SV_NO */
1130         retrieve_blessed,               /* SX_BLESS */
1131         retrieve_idx_blessed,   /* SX_IX_BLESS */
1132         retrieve_hook,                  /* SX_HOOK */
1133         retrieve_overloaded,    /* SX_OVERLOAD */
1134         retrieve_tied_key,              /* SX_TIED_KEY */
1135         retrieve_tied_idx,              /* SX_TIED_IDX */
1136         retrieve_utf8str,               /* SX_UTF8STR  */
1137         retrieve_lutf8str,              /* SX_LUTF8STR */
1138         retrieve_flag_hash,             /* SX_HASH */
1139         retrieve_code,                  /* SX_CODE */
1140         retrieve_weakref,               /* SX_WEAKREF */
1141         retrieve_weakoverloaded,        /* SX_WEAKOVERLOAD */
1142         retrieve_other,                 /* SX_ERROR */
1143 };
1144
1145 #define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
1146
1147 static SV *mbuf2sv(pTHX);
1148
1149 /***
1150  *** Context management.
1151  ***/
1152
1153 /*
1154  * init_perinterp
1155  *
1156  * Called once per "thread" (interpreter) to initialize some global context.
1157  */
1158 static void init_perinterp(pTHX)
1159 {
1160     INIT_STCXT;
1161
1162     cxt->netorder = 0;          /* true if network order used */
1163     cxt->forgive_me = -1;       /* whether to be forgiving... */
1164 }
1165
1166 /*
1167  * reset_context
1168  *
1169  * Called at the end of every context cleaning, to perform common reset
1170  * operations.
1171  */
1172 static void reset_context(stcxt_t *cxt)
1173 {
1174         cxt->entry = 0;
1175         cxt->s_dirty = 0;
1176         cxt->optype &= ~(ST_STORE|ST_RETRIEVE);         /* Leave ST_CLONE alone */
1177 }
1178
1179 /*
1180  * init_store_context
1181  *
1182  * Initialize a new store context for real recursion.
1183  */
1184 static void init_store_context(
1185         pTHX_
1186         stcxt_t *cxt,
1187         PerlIO *f,
1188         int optype,
1189         int network_order)
1190 {
1191         TRACEME(("init_store_context"));
1192
1193         cxt->netorder = network_order;
1194         cxt->forgive_me = -1;                   /* Fetched from perl if needed */
1195         cxt->deparse = -1;                              /* Idem */
1196         cxt->eval = NULL;                               /* Idem */
1197         cxt->canonical = -1;                    /* Idem */
1198         cxt->tagnum = -1;                               /* Reset tag numbers */
1199         cxt->classnum = -1;                             /* Reset class numbers */
1200         cxt->fio = f;                                   /* Where I/O are performed */
1201         cxt->optype = optype;                   /* A store, or a deep clone */
1202         cxt->entry = 1;                                 /* No recursion yet */
1203
1204         /*
1205          * The `hseen' table is used to keep track of each SV stored and their
1206          * associated tag numbers is special. It is "abused" because the
1207          * values stored are not real SV, just integers cast to (SV *),
1208          * which explains the freeing below.
1209          *
1210          * It is also one possible bottlneck to achieve good storing speed,
1211          * so the "shared keys" optimization is turned off (unlikely to be
1212          * of any use here), and the hash table is "pre-extended". Together,
1213          * those optimizations increase the throughput by 12%.
1214          */
1215
1216         cxt->hseen = newHV();                   /* Table where seen objects are stored */
1217         HvSHAREKEYS_off(cxt->hseen);
1218
1219         /*
1220          * The following does not work well with perl5.004_04, and causes
1221          * a core dump later on, in a completely unrelated spot, which
1222          * makes me think there is a memory corruption going on.
1223          *
1224          * Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
1225          * it below does not make any difference. It seems to work fine
1226          * with perl5.004_68 but given the probable nature of the bug,
1227          * that does not prove anything.
1228          *
1229          * It's a shame because increasing the amount of buckets raises
1230          * store() throughput by 5%, but until I figure this out, I can't
1231          * allow for this to go into production.
1232          *
1233          * It is reported fixed in 5.005, hence the #if.
1234          */
1235 #if PERL_VERSION >= 5
1236 #define HBUCKETS        4096                            /* Buckets for %hseen */
1237         HvMAX(cxt->hseen) = HBUCKETS - 1;       /* keys %hseen = $HBUCKETS; */
1238 #endif
1239
1240         /*
1241          * The `hclass' hash uses the same settings as `hseen' above, but it is
1242          * used to assign sequential tags (numbers) to class names for blessed
1243          * objects.
1244          *
1245          * We turn the shared key optimization on.
1246          */
1247
1248         cxt->hclass = newHV();                  /* Where seen classnames are stored */
1249
1250 #if PERL_VERSION >= 5
1251         HvMAX(cxt->hclass) = HBUCKETS - 1;      /* keys %hclass = $HBUCKETS; */
1252 #endif
1253
1254         /*
1255          * The `hook' hash table is used to keep track of the references on
1256          * the STORABLE_freeze hook routines, when found in some class name.
1257          *
1258          * It is assumed that the inheritance tree will not be changed during
1259          * storing, and that no new method will be dynamically created by the
1260          * hooks.
1261          */
1262
1263         cxt->hook = newHV();                    /* Table where hooks are cached */
1264
1265         /*
1266          * The `hook_seen' array keeps track of all the SVs returned by
1267          * STORABLE_freeze hooks for us to serialize, so that they are not
1268          * reclaimed until the end of the serialization process.  Each SV is
1269          * only stored once, the first time it is seen.
1270          */
1271
1272         cxt->hook_seen = newAV();               /* Lists SVs returned by STORABLE_freeze */
1273 }
1274
1275 /*
1276  * clean_store_context
1277  *
1278  * Clean store context by
1279  */
1280 static void clean_store_context(pTHX_ stcxt_t *cxt)
1281 {
1282         HE *he;
1283
1284         TRACEME(("clean_store_context"));
1285
1286         ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
1287
1288         /*
1289          * Insert real values into hashes where we stored faked pointers.
1290          */
1291
1292         if (cxt->hseen) {
1293                 hv_iterinit(cxt->hseen);
1294                 while ((he = hv_iternext(cxt->hseen)))  /* Extra () for -Wall, grr.. */
1295                         HeVAL(he) = &PL_sv_undef;
1296         }
1297
1298         if (cxt->hclass) {
1299                 hv_iterinit(cxt->hclass);
1300                 while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
1301                         HeVAL(he) = &PL_sv_undef;
1302         }
1303
1304         /*
1305          * And now dispose of them...
1306          *
1307          * The surrounding if() protection has been added because there might be
1308          * some cases where this routine is called more than once, during
1309          * exceptionnal events.  This was reported by Marc Lehmann when Storable
1310          * is executed from mod_perl, and the fix was suggested by him.
1311          *              -- RAM, 20/12/2000
1312          */
1313
1314         if (cxt->hseen) {
1315                 HV *hseen = cxt->hseen;
1316                 cxt->hseen = 0;
1317                 hv_undef(hseen);
1318                 sv_free((SV *) hseen);
1319         }
1320
1321         if (cxt->hclass) {
1322                 HV *hclass = cxt->hclass;
1323                 cxt->hclass = 0;
1324                 hv_undef(hclass);
1325                 sv_free((SV *) hclass);
1326         }
1327
1328         if (cxt->hook) {
1329                 HV *hook = cxt->hook;
1330                 cxt->hook = 0;
1331                 hv_undef(hook);
1332                 sv_free((SV *) hook);
1333         }
1334
1335         if (cxt->hook_seen) {
1336                 AV *hook_seen = cxt->hook_seen;
1337                 cxt->hook_seen = 0;
1338                 av_undef(hook_seen);
1339                 sv_free((SV *) hook_seen);
1340         }
1341
1342         cxt->forgive_me = -1;                   /* Fetched from perl if needed */
1343         cxt->deparse = -1;                              /* Idem */
1344         if (cxt->eval) {
1345             SvREFCNT_dec(cxt->eval);
1346         }
1347         cxt->eval = NULL;                               /* Idem */
1348         cxt->canonical = -1;                    /* Idem */
1349
1350         reset_context(cxt);
1351 }
1352
1353 /*
1354  * init_retrieve_context
1355  *
1356  * Initialize a new retrieve context for real recursion.
1357  */
1358 static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
1359 {
1360         TRACEME(("init_retrieve_context"));
1361
1362         /*
1363          * The hook hash table is used to keep track of the references on
1364          * the STORABLE_thaw hook routines, when found in some class name.
1365          *
1366          * It is assumed that the inheritance tree will not be changed during
1367          * storing, and that no new method will be dynamically created by the
1368          * hooks.
1369          */
1370
1371         cxt->hook  = newHV();                   /* Caches STORABLE_thaw */
1372
1373         /*
1374          * If retrieving an old binary version, the cxt->retrieve_vtbl variable
1375          * was set to sv_old_retrieve. We'll need a hash table to keep track of
1376          * the correspondance between the tags and the tag number used by the
1377          * new retrieve routines.
1378          */
1379
1380         cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
1381                       ? newHV() : 0);
1382
1383         cxt->aseen = newAV();                   /* Where retrieved objects are kept */
1384         cxt->where_is_undef = -1;               /* Special case for PL_sv_undef */
1385         cxt->aclass = newAV();                  /* Where seen classnames are kept */
1386         cxt->tagnum = 0;                                /* Have to count objects... */
1387         cxt->classnum = 0;                              /* ...and class names as well */
1388         cxt->optype = optype;
1389         cxt->s_tainted = is_tainted;
1390         cxt->entry = 1;                                 /* No recursion yet */
1391 #ifndef HAS_RESTRICTED_HASHES
1392         cxt->derestrict = -1;           /* Fetched from perl if needed */
1393 #endif
1394 #ifndef HAS_UTF8_ALL
1395         cxt->use_bytes = -1;            /* Fetched from perl if needed */
1396 #endif
1397         cxt->accept_future_minor = -1;  /* Fetched from perl if needed */
1398 }
1399
1400 /*
1401  * clean_retrieve_context
1402  *
1403  * Clean retrieve context by
1404  */
1405 static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
1406 {
1407         TRACEME(("clean_retrieve_context"));
1408
1409         ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
1410
1411         if (cxt->aseen) {
1412                 AV *aseen = cxt->aseen;
1413                 cxt->aseen = 0;
1414                 av_undef(aseen);
1415                 sv_free((SV *) aseen);
1416         }
1417         cxt->where_is_undef = -1;
1418
1419         if (cxt->aclass) {
1420                 AV *aclass = cxt->aclass;
1421                 cxt->aclass = 0;
1422                 av_undef(aclass);
1423                 sv_free((SV *) aclass);
1424         }
1425
1426         if (cxt->hook) {
1427                 HV *hook = cxt->hook;
1428                 cxt->hook = 0;
1429                 hv_undef(hook);
1430                 sv_free((SV *) hook);
1431         }
1432
1433         if (cxt->hseen) {
1434                 HV *hseen = cxt->hseen;
1435                 cxt->hseen = 0;
1436                 hv_undef(hseen);
1437                 sv_free((SV *) hseen);          /* optional HV, for backward compat. */
1438         }
1439
1440 #ifndef HAS_RESTRICTED_HASHES
1441         cxt->derestrict = -1;           /* Fetched from perl if needed */
1442 #endif
1443 #ifndef HAS_UTF8_ALL
1444         cxt->use_bytes = -1;            /* Fetched from perl if needed */
1445 #endif
1446         cxt->accept_future_minor = -1;  /* Fetched from perl if needed */
1447
1448         reset_context(cxt);
1449 }
1450
1451 /*
1452  * clean_context
1453  *
1454  * A workaround for the CROAK bug: cleanup the last context.
1455  */
1456 static void clean_context(pTHX_ stcxt_t *cxt)
1457 {
1458         TRACEME(("clean_context"));
1459
1460         ASSERT(cxt->s_dirty, ("dirty context"));
1461
1462         if (cxt->membuf_ro)
1463                 MBUF_RESTORE();
1464
1465         ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
1466
1467         if (cxt->optype & ST_RETRIEVE)
1468                 clean_retrieve_context(aTHX_ cxt);
1469         else if (cxt->optype & ST_STORE)
1470                 clean_store_context(aTHX_ cxt);
1471         else
1472                 reset_context(cxt);
1473
1474         ASSERT(!cxt->s_dirty, ("context is clean"));
1475         ASSERT(cxt->entry == 0, ("context is reset"));
1476 }
1477
1478 /*
1479  * allocate_context
1480  *
1481  * Allocate a new context and push it on top of the parent one.
1482  * This new context is made globally visible via SET_STCXT().
1483  */
1484 static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
1485 {
1486         stcxt_t *cxt;
1487
1488         TRACEME(("allocate_context"));
1489
1490         ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
1491
1492         NEW_STORABLE_CXT_OBJ(cxt);
1493         cxt->prev = parent_cxt->my_sv;
1494         SET_STCXT(cxt);
1495
1496         ASSERT(!cxt->s_dirty, ("clean context"));
1497
1498         return cxt;
1499 }
1500
1501 /*
1502  * free_context
1503  *
1504  * Free current context, which cannot be the "root" one.
1505  * Make the context underneath globally visible via SET_STCXT().
1506  */
1507 static void free_context(pTHX_ stcxt_t *cxt)
1508 {
1509         stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
1510
1511         TRACEME(("free_context"));
1512
1513         ASSERT(!cxt->s_dirty, ("clean context"));
1514         ASSERT(prev, ("not freeing root context"));
1515
1516         SvREFCNT_dec(cxt->my_sv);
1517         SET_STCXT(prev);
1518
1519         ASSERT(cxt, ("context not void"));
1520 }
1521
1522 /***
1523  *** Predicates.
1524  ***/
1525
1526 /*
1527  * is_storing
1528  *
1529  * Tells whether we're in the middle of a store operation.
1530  */
1531 int is_storing(pTHX)
1532 {
1533         dSTCXT;
1534
1535         return cxt->entry && (cxt->optype & ST_STORE);
1536 }
1537
1538 /*
1539  * is_retrieving
1540  *
1541  * Tells whether we're in the middle of a retrieve operation.
1542  */
1543 int is_retrieving(pTHX)
1544 {
1545         dSTCXT;
1546
1547         return cxt->entry && (cxt->optype & ST_RETRIEVE);
1548 }
1549
1550 /*
1551  * last_op_in_netorder
1552  *
1553  * Returns whether last operation was made using network order.
1554  *
1555  * This is typically out-of-band information that might prove useful
1556  * to people wishing to convert native to network order data when used.
1557  */
1558 int last_op_in_netorder(pTHX)
1559 {
1560         dSTCXT;
1561
1562         return cxt->netorder;
1563 }
1564
1565 /***
1566  *** Hook lookup and calling routines.
1567  ***/
1568
1569 /*
1570  * pkg_fetchmeth
1571  *
1572  * A wrapper on gv_fetchmethod_autoload() which caches results.
1573  *
1574  * Returns the routine reference as an SV*, or null if neither the package
1575  * nor its ancestors know about the method.
1576  */
1577 static SV *pkg_fetchmeth(
1578         pTHX_
1579         HV *cache,
1580         HV *pkg,
1581         char *method)
1582 {
1583         GV *gv;
1584         SV *sv;
1585
1586         /*
1587          * The following code is the same as the one performed by UNIVERSAL::can
1588          * in the Perl core.
1589          */
1590
1591         gv = gv_fetchmethod_autoload(pkg, method, FALSE);
1592         if (gv && isGV(gv)) {
1593                 sv = newRV((SV*) GvCV(gv));
1594                 TRACEME(("%s->%s: 0x%"UVxf, HvNAME(pkg), method, PTR2UV(sv)));
1595         } else {
1596                 sv = newSVsv(&PL_sv_undef);
1597                 TRACEME(("%s->%s: not found", HvNAME(pkg), method));
1598         }
1599
1600         /*
1601          * Cache the result, ignoring failure: if we can't store the value,
1602          * it just won't be cached.
1603          */
1604
1605         (void) hv_store(cache, HvNAME(pkg), strlen(HvNAME(pkg)), sv, 0);
1606
1607         return SvOK(sv) ? sv : (SV *) 0;
1608 }
1609
1610 /*
1611  * pkg_hide
1612  *
1613  * Force cached value to be undef: hook ignored even if present.
1614  */
1615 static void pkg_hide(
1616         pTHX_
1617         HV *cache,
1618         HV *pkg,
1619         char *method)
1620 {
1621         (void) hv_store(cache,
1622                 HvNAME(pkg), strlen(HvNAME(pkg)), newSVsv(&PL_sv_undef), 0);
1623 }
1624
1625 /*
1626  * pkg_uncache
1627  *
1628  * Discard cached value: a whole fetch loop will be retried at next lookup.
1629  */
1630 static void pkg_uncache(
1631         pTHX_
1632         HV *cache,
1633         HV *pkg,
1634         char *method)
1635 {
1636         (void) hv_delete(cache, HvNAME(pkg), strlen(HvNAME(pkg)), G_DISCARD);
1637 }
1638
1639 /*
1640  * pkg_can
1641  *
1642  * Our own "UNIVERSAL::can", which caches results.
1643  *
1644  * Returns the routine reference as an SV*, or null if the object does not
1645  * know about the method.
1646  */
1647 static SV *pkg_can(
1648         pTHX_
1649         HV *cache,
1650         HV *pkg,
1651         char *method)
1652 {
1653         SV **svh;
1654         SV *sv;
1655
1656         TRACEME(("pkg_can for %s->%s", HvNAME(pkg), method));
1657
1658         /*
1659          * Look into the cache to see whether we already have determined
1660          * where the routine was, if any.
1661          *
1662          * NOTA BENE: we don't use `method' at all in our lookup, since we know
1663          * that only one hook (i.e. always the same) is cached in a given cache.
1664          */
1665
1666         svh = hv_fetch(cache, HvNAME(pkg), strlen(HvNAME(pkg)), FALSE);
1667         if (svh) {
1668                 sv = *svh;
1669                 if (!SvOK(sv)) {
1670                         TRACEME(("cached %s->%s: not found", HvNAME(pkg), method));
1671                         return (SV *) 0;
1672                 } else {
1673                         TRACEME(("cached %s->%s: 0x%"UVxf,
1674                                 HvNAME(pkg), method, PTR2UV(sv)));
1675                         return sv;
1676                 }
1677         }
1678
1679         TRACEME(("not cached yet"));
1680         return pkg_fetchmeth(aTHX_ cache, pkg, method);         /* Fetch and cache */
1681 }
1682
1683 /*
1684  * scalar_call
1685  *
1686  * Call routine as obj->hook(av) in scalar context.
1687  * Propagates the single returned value if not called in void context.
1688  */
1689 static SV *scalar_call(
1690         pTHX_
1691         SV *obj,
1692         SV *hook,
1693         int cloning,
1694         AV *av,
1695         I32 flags)
1696 {
1697         dSP;
1698         int count;
1699         SV *sv = 0;
1700
1701         TRACEME(("scalar_call (cloning=%d)", cloning));
1702
1703         ENTER;
1704         SAVETMPS;
1705
1706         PUSHMARK(sp);
1707         XPUSHs(obj);
1708         XPUSHs(sv_2mortal(newSViv(cloning)));           /* Cloning flag */
1709         if (av) {
1710                 SV **ary = AvARRAY(av);
1711                 int cnt = AvFILLp(av) + 1;
1712                 int i;
1713                 XPUSHs(ary[0]);                                                 /* Frozen string */
1714                 for (i = 1; i < cnt; i++) {
1715                         TRACEME(("pushing arg #%d (0x%"UVxf")...",
1716                                  i, PTR2UV(ary[i])));
1717                         XPUSHs(sv_2mortal(newRV(ary[i])));
1718                 }
1719         }
1720         PUTBACK;
1721
1722         TRACEME(("calling..."));
1723         count = perl_call_sv(hook, flags);              /* Go back to Perl code */
1724         TRACEME(("count = %d", count));
1725
1726         SPAGAIN;
1727
1728         if (count) {
1729                 sv = POPs;
1730                 SvREFCNT_inc(sv);               /* We're returning it, must stay alive! */
1731         }
1732
1733         PUTBACK;
1734         FREETMPS;
1735         LEAVE;
1736
1737         return sv;
1738 }
1739
1740 /*
1741  * array_call
1742  *
1743  * Call routine obj->hook(cloning) in list context.
1744  * Returns the list of returned values in an array.
1745  */
1746 static AV *array_call(
1747         pTHX_
1748         SV *obj,
1749         SV *hook,
1750         int cloning)
1751 {
1752         dSP;
1753         int count;
1754         AV *av;
1755         int i;
1756
1757         TRACEME(("array_call (cloning=%d)", cloning));
1758
1759         ENTER;
1760         SAVETMPS;
1761
1762         PUSHMARK(sp);
1763         XPUSHs(obj);                                                            /* Target object */
1764         XPUSHs(sv_2mortal(newSViv(cloning)));           /* Cloning flag */
1765         PUTBACK;
1766
1767         count = perl_call_sv(hook, G_ARRAY);            /* Go back to Perl code */
1768
1769         SPAGAIN;
1770
1771         av = newAV();
1772         for (i = count - 1; i >= 0; i--) {
1773                 SV *sv = POPs;
1774                 av_store(av, i, SvREFCNT_inc(sv));
1775         }
1776
1777         PUTBACK;
1778         FREETMPS;
1779         LEAVE;
1780
1781         return av;
1782 }
1783
1784 /*
1785  * known_class
1786  *
1787  * Lookup the class name in the `hclass' table and either assign it a new ID
1788  * or return the existing one, by filling in `classnum'.
1789  *
1790  * Return true if the class was known, false if the ID was just generated.
1791  */
1792 static int known_class(
1793         pTHX_
1794         stcxt_t *cxt,
1795         char *name,             /* Class name */
1796         int len,                /* Name length */
1797         I32 *classnum)
1798 {
1799         SV **svh;
1800         HV *hclass = cxt->hclass;
1801
1802         TRACEME(("known_class (%s)", name));
1803
1804         /*
1805          * Recall that we don't store pointers in this hash table, but tags.
1806          * Therefore, we need LOW_32BITS() to extract the relevant parts.
1807          */
1808
1809         svh = hv_fetch(hclass, name, len, FALSE);
1810         if (svh) {
1811                 *classnum = LOW_32BITS(*svh);
1812                 return TRUE;
1813         }
1814
1815         /*
1816          * Unknown classname, we need to record it.
1817          */
1818
1819         cxt->classnum++;
1820         if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
1821                 CROAK(("Unable to record new classname"));
1822
1823         *classnum = cxt->classnum;
1824         return FALSE;
1825 }
1826
1827 /***
1828  *** Sepcific store routines.
1829  ***/
1830
1831 /*
1832  * store_ref
1833  *
1834  * Store a reference.
1835  * Layout is SX_REF <object> or SX_OVERLOAD <object>.
1836  */
1837 static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
1838 {
1839         int is_weak = 0;
1840         TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
1841
1842         /*
1843          * Follow reference, and check if target is overloaded.
1844          */
1845
1846 #ifdef SvWEAKREF;
1847         if (SvWEAKREF(sv))
1848                 is_weak = 1;
1849         TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
1850 #endif
1851         sv = SvRV(sv);
1852
1853         if (SvOBJECT(sv)) {
1854                 HV *stash = (HV *) SvSTASH(sv);
1855                 if (stash && Gv_AMG(stash)) {
1856                         TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
1857                         PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
1858                 } else
1859                         PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1860         } else
1861                 PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
1862
1863         return store(aTHX_ cxt, sv);
1864 }
1865
1866 /*
1867  * store_scalar
1868  *
1869  * Store a scalar.
1870  *
1871  * Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
1872  * The <data> section is omitted if <length> is 0.
1873  *
1874  * If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
1875  * Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
1876  */
1877 static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
1878 {
1879         IV iv;
1880         char *pv;
1881         STRLEN len;
1882         U32 flags = SvFLAGS(sv);                        /* "cc -O" may put it in register */
1883
1884         TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
1885
1886         /*
1887          * For efficiency, break the SV encapsulation by peaking at the flags
1888          * directly without using the Perl macros to avoid dereferencing
1889          * sv->sv_flags each time we wish to check the flags.
1890          */
1891
1892         if (!(flags & SVf_OK)) {                        /* !SvOK(sv) */
1893                 if (sv == &PL_sv_undef) {
1894                         TRACEME(("immortal undef"));
1895                         PUTMARK(SX_SV_UNDEF);
1896                 } else {
1897                         TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
1898                         PUTMARK(SX_UNDEF);
1899                 }
1900                 return 0;
1901         }
1902
1903         /*
1904          * Always store the string representation of a scalar if it exists.
1905          * Gisle Aas provided me with this test case, better than a long speach:
1906          *
1907          *  perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
1908          *  SV = PVNV(0x80c8520)
1909          *       REFCNT = 1
1910          *       FLAGS = (NOK,POK,pNOK,pPOK)
1911          *       IV = 0
1912          *       NV = 0
1913          *       PV = 0x80c83d0 "abc"\0
1914          *       CUR = 3
1915          *       LEN = 4
1916          *
1917          * Write SX_SCALAR, length, followed by the actual data.
1918          *
1919          * Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
1920          * appropriate, followed by the actual (binary) data. A double
1921          * is written as a string if network order, for portability.
1922          *
1923          * NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
1924          * The reason is that when the scalar value is tainted, the SvNOK(sv)
1925          * value is false.
1926          *
1927          * The test for a read-only scalar with both POK and NOK set is meant
1928          * to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
1929          * address comparison for each scalar we store.
1930          */
1931
1932 #define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
1933
1934         if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
1935                 if (sv == &PL_sv_yes) {
1936                         TRACEME(("immortal yes"));
1937                         PUTMARK(SX_SV_YES);
1938                 } else if (sv == &PL_sv_no) {
1939                         TRACEME(("immortal no"));
1940                         PUTMARK(SX_SV_NO);
1941                 } else {
1942                         pv = SvPV(sv, len);                     /* We know it's SvPOK */
1943                         goto string;                            /* Share code below */
1944                 }
1945         } else if (flags & SVf_POK) {
1946             /* public string - go direct to string read.  */
1947             goto string_readlen;
1948         } else if (
1949 #if (PATCHLEVEL <= 6)
1950             /* For 5.6 and earlier NV flag trumps IV flag, so only use integer
1951                direct if NV flag is off.  */
1952             (flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
1953 #else
1954             /* 5.7 rules are that if IV public flag is set, IV value is as
1955                good, if not better, than NV value.  */
1956             flags & SVf_IOK
1957 #endif
1958             ) {
1959             iv = SvIV(sv);
1960             /*
1961              * Will come here from below with iv set if double is an integer.
1962              */
1963           integer:
1964
1965             /* Sorry. This isn't in 5.005_56 (IIRC) or earlier.  */
1966 #ifdef SVf_IVisUV
1967             /* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
1968              * (for example) and that ends up in the optimised small integer
1969              * case.
1970              */
1971             if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
1972                 TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
1973                 goto string_readlen;
1974             }
1975 #endif
1976             /*
1977              * Optimize small integers into a single byte, otherwise store as
1978              * a real integer (converted into network order if they asked).
1979              */
1980
1981             if (iv >= -128 && iv <= 127) {
1982                 unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
1983                 PUTMARK(SX_BYTE);
1984                 PUTMARK(siv);
1985                 TRACEME(("small integer stored as %d", siv));
1986             } else if (cxt->netorder) {
1987 #ifndef HAS_HTONL
1988                 TRACEME(("no htonl, fall back to string for integer"));
1989                 goto string_readlen;
1990 #else
1991                 I32 niv;
1992
1993
1994 #if IVSIZE > 4
1995                 if (
1996 #ifdef SVf_IVisUV
1997                     /* Sorry. This isn't in 5.005_56 (IIRC) or earlier.  */
1998                     ((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
1999 #endif
2000                     (iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
2001                     /* Bigger than 32 bits.  */
2002                     TRACEME(("large network order integer as string, value = %"IVdf, iv));
2003                     goto string_readlen;
2004                 }
2005 #endif
2006
2007                 niv = (I32) htonl((I32) iv);
2008                 TRACEME(("using network order"));
2009                 PUTMARK(SX_NETINT);
2010                 WRITE_I32(niv);
2011 #endif
2012             } else {
2013                 PUTMARK(SX_INTEGER);
2014                 WRITE(&iv, sizeof(iv));
2015             }
2016
2017             TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
2018         } else if (flags & SVf_NOK) {
2019             NV nv;
2020 #if (PATCHLEVEL <= 6)
2021             nv = SvNV(sv);
2022             /*
2023              * Watch for number being an integer in disguise.
2024              */
2025             if (nv == (NV) (iv = I_V(nv))) {
2026                 TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
2027                 goto integer;           /* Share code above */
2028             }
2029 #else
2030
2031             SvIV_please(sv);
2032             if (SvIOK_notUV(sv)) {
2033                 iv = SvIV(sv);
2034                 goto integer;           /* Share code above */
2035             }
2036             nv = SvNV(sv);
2037 #endif
2038
2039             if (cxt->netorder) {
2040                 TRACEME(("double %"NVff" stored as string", nv));
2041                 goto string_readlen;            /* Share code below */
2042             }
2043
2044             PUTMARK(SX_DOUBLE);
2045             WRITE(&nv, sizeof(nv));
2046
2047             TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
2048
2049         } else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
2050             I32 wlen; /* For 64-bit machines */
2051
2052           string_readlen:
2053             pv = SvPV(sv, len);
2054
2055             /*
2056              * Will come here from above  if it was readonly, POK and NOK but
2057              * neither &PL_sv_yes nor &PL_sv_no.
2058              */
2059           string:
2060
2061             wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
2062             if (SvUTF8 (sv))
2063                 STORE_UTF8STR(pv, wlen);
2064             else
2065                 STORE_SCALAR(pv, wlen);
2066             TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
2067                      PTR2UV(sv), SvPVX(sv), (IV)len));
2068         } else
2069             CROAK(("Can't determine type of %s(0x%"UVxf")",
2070                    sv_reftype(sv, FALSE),
2071                    PTR2UV(sv)));
2072         return 0;               /* Ok, no recursion on scalars */
2073 }
2074
2075 /*
2076  * store_array
2077  *
2078  * Store an array.
2079  *
2080  * Layout is SX_ARRAY <size> followed by each item, in increading index order.
2081  * Each item is stored as <object>.
2082  */
2083 static int store_array(pTHX_ stcxt_t *cxt, AV *av)
2084 {
2085         SV **sav;
2086         I32 len = av_len(av) + 1;
2087         I32 i;
2088         int ret;
2089
2090         TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
2091
2092         /*
2093          * Signal array by emitting SX_ARRAY, followed by the array length.
2094          */
2095
2096         PUTMARK(SX_ARRAY);
2097         WLEN(len);
2098         TRACEME(("size = %d", len));
2099
2100         /*
2101          * Now store each item recursively.
2102          */
2103
2104         for (i = 0; i < len; i++) {
2105                 sav = av_fetch(av, i, 0);
2106                 if (!sav) {
2107                         TRACEME(("(#%d) undef item", i));
2108                         STORE_SV_UNDEF();
2109                         continue;
2110                 }
2111                 TRACEME(("(#%d) item", i));
2112                 if ((ret = store(aTHX_ cxt, *sav)))     /* Extra () for -Wall, grr... */
2113                         return ret;
2114         }
2115
2116         TRACEME(("ok (array)"));
2117
2118         return 0;
2119 }
2120
2121
2122 #if (PATCHLEVEL <= 6)
2123
2124 /*
2125  * sortcmp
2126  *
2127  * Sort two SVs
2128  * Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
2129  */
2130 static int
2131 sortcmp(const void *a, const void *b)
2132 {
2133 #if defined(USE_ITHREADS)
2134         dTHX;
2135 #endif /* USE_ITHREADS */
2136         return sv_cmp(*(SV * const *) a, *(SV * const *) b);
2137 }
2138
2139 #endif /* PATCHLEVEL <= 6 */
2140
2141 /*
2142  * store_hash
2143  *
2144  * Store a hash table.
2145  *
2146  * For a "normal" hash (not restricted, no utf8 keys):
2147  *
2148  * Layout is SX_HASH <size> followed by each key/value pair, in random order.
2149  * Values are stored as <object>.
2150  * Keys are stored as <length> <data>, the <data> section being omitted
2151  * if length is 0.
2152  *
2153  * For a "fancy" hash (restricted or utf8 keys):
2154  *
2155  * Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
2156  * in random order.
2157  * Values are stored as <object>.
2158  * Keys are stored as <flags> <length> <data>, the <data> section being omitted
2159  * if length is 0.
2160  * Currently the only hash flag is "restriced"
2161  * Key flags are as for hv.h
2162  */
2163 static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
2164 {
2165         I32 len =
2166 #ifdef HAS_RESTRICTED_HASHES
2167             HvTOTALKEYS(hv);
2168 #else
2169             HvKEYS(hv);
2170 #endif
2171         I32 i;
2172         int ret = 0;
2173         I32 riter;
2174         HE *eiter;
2175         int flagged_hash = ((SvREADONLY(hv)
2176 #ifdef HAS_HASH_KEY_FLAGS
2177                              || HvHASKFLAGS(hv)
2178 #endif
2179                                 ) ? 1 : 0);
2180         unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
2181
2182         if (flagged_hash) {
2183             /* needs int cast for C++ compilers, doesn't it?  */
2184             TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
2185                      (int) hash_flags));
2186         } else {
2187             TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
2188         }
2189
2190         /*
2191          * Signal hash by emitting SX_HASH, followed by the table length.
2192          */
2193
2194         if (flagged_hash) {
2195             PUTMARK(SX_FLAG_HASH);
2196             PUTMARK(hash_flags);
2197         } else {
2198             PUTMARK(SX_HASH);
2199         }
2200         WLEN(len);
2201         TRACEME(("size = %d", len));
2202
2203         /*
2204          * Save possible iteration state via each() on that table.
2205          */
2206
2207         riter = HvRITER(hv);
2208         eiter = HvEITER(hv);
2209         hv_iterinit(hv);
2210
2211         /*
2212          * Now store each item recursively.
2213          *
2214      * If canonical is defined to some true value then store each
2215      * key/value pair in sorted order otherwise the order is random.
2216          * Canonical order is irrelevant when a deep clone operation is performed.
2217          *
2218          * Fetch the value from perl only once per store() operation, and only
2219          * when needed.
2220          */
2221
2222         if (
2223                 !(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
2224                 (cxt->canonical < 0 && (cxt->canonical =
2225                         (SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
2226         ) {
2227                 /*
2228                  * Storing in order, sorted by key.
2229                  * Run through the hash, building up an array of keys in a
2230                  * mortal array, sort the array and then run through the
2231                  * array.
2232                  */
2233
2234                 AV *av = newAV();
2235
2236                 /*av_extend (av, len);*/
2237
2238                 TRACEME(("using canonical order"));
2239
2240                 for (i = 0; i < len; i++) {
2241 #ifdef HAS_RESTRICTED_HASHES
2242                         HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2243 #else
2244                         HE *he = hv_iternext(hv);
2245 #endif
2246                         SV *key = hv_iterkeysv(he);
2247                         av_store(av, AvFILLp(av)+1, key);       /* av_push(), really */
2248                 }
2249
2250                 STORE_HASH_SORT;
2251
2252                 for (i = 0; i < len; i++) {
2253 #ifdef HAS_RESTRICTED_HASHES
2254                         int placeholders = HvPLACEHOLDERS(hv);
2255 #endif
2256                         unsigned char flags = 0;
2257                         char *keyval;
2258                         STRLEN keylen_tmp;
2259                         I32 keylen;
2260                         SV *key = av_shift(av);
2261                         /* This will fail if key is a placeholder.
2262                            Track how many placeholders we have, and error if we
2263                            "see" too many.  */
2264                         HE *he  = hv_fetch_ent(hv, key, 0, 0);
2265                         SV *val;
2266
2267                         if (he) {
2268                                 if (!(val =  HeVAL(he))) {
2269                                         /* Internal error, not I/O error */
2270                                         return 1;
2271                                 }
2272                         } else {
2273 #ifdef HAS_RESTRICTED_HASHES
2274                                 /* Should be a placeholder.  */
2275                                 if (placeholders-- < 0) {
2276                                         /* This should not happen - number of
2277                                            retrieves should be identical to
2278                                            number of placeholders.  */
2279                                         return 1;
2280                                 }
2281                                 /* Value is never needed, and PL_sv_undef is
2282                                    more space efficient to store.  */
2283                                 val = &PL_sv_undef;
2284                                 ASSERT (flags == 0,
2285                                         ("Flags not 0 but %d", flags));
2286                                 flags = SHV_K_PLACEHOLDER;
2287 #else
2288                                 return 1;
2289 #endif
2290                         }
2291
2292                         /*
2293                          * Store value first.
2294                          */
2295
2296                         TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2297
2298                         if ((ret = store(aTHX_ cxt, val)))      /* Extra () for -Wall, grr... */
2299                                 goto out;
2300
2301                         /*
2302                          * Write key string.
2303                          * Keys are written after values to make sure retrieval
2304                          * can be optimal in terms of memory usage, where keys are
2305                          * read into a fixed unique buffer called kbuf.
2306                          * See retrieve_hash() for details.
2307                          */
2308
2309                         /* Implementation of restricted hashes isn't nicely
2310                            abstracted:  */
2311                         if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
2312                                 flags |= SHV_K_LOCKED;
2313                         }
2314
2315                         keyval = SvPV(key, keylen_tmp);
2316                         keylen = keylen_tmp;
2317 #ifdef HAS_UTF8_HASHES
2318                         /* If you build without optimisation on pre 5.6
2319                            then nothing spots that SvUTF8(key) is always 0,
2320                            so the block isn't optimised away, at which point
2321                            the linker dislikes the reference to
2322                            bytes_from_utf8.  */
2323                         if (SvUTF8(key)) {
2324                             const char *keysave = keyval;
2325                             bool is_utf8 = TRUE;
2326
2327                             /* Just casting the &klen to (STRLEN) won't work
2328                                well if STRLEN and I32 are of different widths.
2329                                --jhi */
2330                             keyval = (char*)bytes_from_utf8((U8*)keyval,
2331                                                             &keylen_tmp,
2332                                                             &is_utf8);
2333
2334                             /* If we were able to downgrade here, then than
2335                                means that we have  a key which only had chars
2336                                0-255, but was utf8 encoded.  */
2337
2338                             if (keyval != keysave) {
2339                                 keylen = keylen_tmp;
2340                                 flags |= SHV_K_WASUTF8;
2341                             } else {
2342                                 /* keylen_tmp can't have changed, so no need
2343                                    to assign back to keylen.  */
2344                                 flags |= SHV_K_UTF8;
2345                             }
2346                         }
2347 #endif
2348
2349                         if (flagged_hash) {
2350                             PUTMARK(flags);
2351                             TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
2352                         } else {
2353                             /* This is a workaround for a bug in 5.8.0
2354                                that causes the HEK_WASUTF8 flag to be
2355                                set on an HEK without the hash being
2356                                marked as having key flags. We just
2357                                cross our fingers and drop the flag.
2358                                AMS 20030901 */
2359                             assert (flags == 0 || flags == SHV_K_WASUTF8);
2360                             TRACEME(("(#%d) key '%s'", i, keyval));
2361                         }
2362                         WLEN(keylen);
2363                         if (keylen)
2364                                 WRITE(keyval, keylen);
2365                         if (flags & SHV_K_WASUTF8)
2366                             Safefree (keyval);
2367                 }
2368
2369                 /*
2370                  * Free up the temporary array
2371                  */
2372
2373                 av_undef(av);
2374                 sv_free((SV *) av);
2375
2376         } else {
2377
2378                 /*
2379                  * Storing in "random" order (in the order the keys are stored
2380                  * within the hash).  This is the default and will be faster!
2381                  */
2382
2383                 for (i = 0; i < len; i++) {
2384                         char *key;
2385                         I32 len;
2386                         unsigned char flags;
2387 #ifdef HV_ITERNEXT_WANTPLACEHOLDERS
2388                         HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
2389 #else
2390                         HE *he = hv_iternext(hv);
2391 #endif
2392                         SV *val = (he ? hv_iterval(hv, he) : 0);
2393                         SV *key_sv = NULL;
2394                         HEK *hek;
2395
2396                         if (val == 0)
2397                                 return 1;               /* Internal error, not I/O error */
2398
2399                         /* Implementation of restricted hashes isn't nicely
2400                            abstracted:  */
2401                         flags
2402                             = (((hash_flags & SHV_RESTRICTED)
2403                                 && SvREADONLY(val))
2404                                              ? SHV_K_LOCKED : 0);
2405
2406                         if (val == &PL_sv_placeholder) {
2407                             flags |= SHV_K_PLACEHOLDER;
2408                             val = &PL_sv_undef;
2409                         }
2410
2411                         /*
2412                          * Store value first.
2413                          */
2414
2415                         TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
2416
2417                         if ((ret = store(aTHX_ cxt, val)))      /* Extra () for -Wall, grr... */
2418                                 goto out;
2419
2420
2421                         hek = HeKEY_hek(he);
2422                         len = HEK_LEN(hek);
2423                         if (len == HEf_SVKEY) {
2424                             /* This is somewhat sick, but the internal APIs are
2425                              * such that XS code could put one of these in in
2426                              * a regular hash.
2427                              * Maybe we should be capable of storing one if
2428                              * found.
2429                              */
2430                             key_sv = HeKEY_sv(he);
2431                             flags |= SHV_K_ISSV;
2432                         } else {
2433                             /* Regular string key. */
2434 #ifdef HAS_HASH_KEY_FLAGS
2435                             if (HEK_UTF8(hek))
2436                                 flags |= SHV_K_UTF8;
2437                             if (HEK_WASUTF8(hek))
2438                                 flags |= SHV_K_WASUTF8;
2439 #endif
2440                             key = HEK_KEY(hek);
2441                         }
2442                         /*
2443                          * Write key string.
2444                          * Keys are written after values to make sure retrieval
2445                          * can be optimal in terms of memory usage, where keys are
2446                          * read into a fixed unique buffer called kbuf.
2447                          * See retrieve_hash() for details.
2448                          */
2449
2450                         if (flagged_hash) {
2451                             PUTMARK(flags);
2452                             TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
2453                         } else {
2454                             /* This is a workaround for a bug in 5.8.0
2455                                that causes the HEK_WASUTF8 flag to be
2456                                set on an HEK without the hash being
2457                                marked as having key flags. We just
2458                                cross our fingers and drop the flag.
2459                                AMS 20030901 */
2460                             assert (flags == 0 || flags == SHV_K_WASUTF8);
2461                             TRACEME(("(#%d) key '%s'", i, key));
2462                         }
2463                         if (flags & SHV_K_ISSV) {
2464                             store(aTHX_ cxt, key_sv);
2465                         } else {
2466                             WLEN(len);
2467                             if (len)
2468                                 WRITE(key, len);
2469                         }
2470                 }
2471     }
2472
2473         TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
2474
2475 out:
2476         HvRITER(hv) = riter;            /* Restore hash iterator state */
2477         HvEITER(hv) = eiter;
2478
2479         return ret;
2480 }
2481
2482 /*
2483  * store_code
2484  *
2485  * Store a code reference.
2486  *
2487  * Layout is SX_CODE <length> followed by a scalar containing the perl
2488  * source code of the code reference.
2489  */
2490 static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
2491 {
2492 #if PERL_VERSION < 6
2493     /*
2494          * retrieve_code does not work with perl 5.005 or less
2495          */
2496         return store_other(aTHX_ cxt, (SV*)cv);
2497 #else
2498         dSP;
2499         I32 len;
2500         int count, reallen;
2501         SV *text, *bdeparse;
2502
2503         TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
2504
2505         if (
2506                 cxt->deparse == 0 ||
2507                 (cxt->deparse < 0 && !(cxt->deparse =
2508                         SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
2509         ) {
2510                 return store_other(aTHX_ cxt, (SV*)cv);
2511         }
2512
2513         /*
2514          * Require B::Deparse. At least B::Deparse 0.61 is needed for
2515          * blessed code references.
2516          */
2517         /* Ownership of both SVs is passed to load_module, which frees them. */
2518         load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
2519
2520         ENTER;
2521         SAVETMPS;
2522
2523         /*
2524          * create the B::Deparse object
2525          */
2526
2527         PUSHMARK(sp);
2528         XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
2529         PUTBACK;
2530         count = call_method("new", G_SCALAR);
2531         SPAGAIN;
2532         if (count != 1)
2533                 CROAK(("Unexpected return value from B::Deparse::new\n"));
2534         bdeparse = POPs;
2535
2536         /*
2537          * call the coderef2text method
2538          */
2539
2540         PUSHMARK(sp);
2541         XPUSHs(bdeparse); /* XXX is this already mortal? */
2542         XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
2543         PUTBACK;
2544         count = call_method("coderef2text", G_SCALAR);
2545         SPAGAIN;
2546         if (count != 1)
2547                 CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
2548
2549         text = POPs;
2550         len = SvLEN(text);
2551         reallen = strlen(SvPV_nolen(text));
2552
2553         /*
2554          * Empty code references or XS functions are deparsed as
2555          * "(prototype) ;" or ";".
2556          */
2557
2558         if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
2559             CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
2560         }
2561
2562         /*
2563          * Signal code by emitting SX_CODE.
2564          */
2565
2566         PUTMARK(SX_CODE);
2567         cxt->tagnum++;   /* necessary, as SX_CODE is a SEEN() candidate */
2568         TRACEME(("size = %d", len));
2569         TRACEME(("code = %s", SvPV_nolen(text)));
2570
2571         /*
2572          * Now store the source code.
2573          */
2574
2575         STORE_SCALAR(SvPV_nolen(text), len);
2576
2577         FREETMPS;
2578         LEAVE;
2579
2580         TRACEME(("ok (code)"));
2581
2582         return 0;
2583 #endif
2584 }
2585
2586 /*
2587  * store_tied
2588  *
2589  * When storing a tied object (be it a tied scalar, array or hash), we lay out
2590  * a special mark, followed by the underlying tied object. For instance, when
2591  * dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
2592  * <hash object> stands for the serialization of the tied hash.
2593  */
2594 static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
2595 {
2596         MAGIC *mg;
2597         SV *obj = NULL;
2598         int ret = 0;
2599         int svt = SvTYPE(sv);
2600         char mtype = 'P';
2601
2602         TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
2603
2604         /*
2605          * We have a small run-time penalty here because we chose to factorise
2606          * all tieds objects into the same routine, and not have a store_tied_hash,
2607          * a store_tied_array, etc...
2608          *
2609          * Don't use a switch() statement, as most compilers don't optimize that
2610          * well for 2/3 values. An if() else if() cascade is just fine. We put
2611          * tied hashes first, as they are the most likely beasts.
2612          */
2613
2614         if (svt == SVt_PVHV) {
2615                 TRACEME(("tied hash"));
2616                 PUTMARK(SX_TIED_HASH);                  /* Introduces tied hash */
2617         } else if (svt == SVt_PVAV) {
2618                 TRACEME(("tied array"));
2619                 PUTMARK(SX_TIED_ARRAY);                 /* Introduces tied array */
2620         } else {
2621                 TRACEME(("tied scalar"));
2622                 PUTMARK(SX_TIED_SCALAR);                /* Introduces tied scalar */
2623                 mtype = 'q';
2624         }
2625
2626         if (!(mg = mg_find(sv, mtype)))
2627                 CROAK(("No magic '%c' found while storing tied %s", mtype,
2628                         (svt == SVt_PVHV) ? "hash" :
2629                                 (svt == SVt_PVAV) ? "array" : "scalar"));
2630
2631         /*
2632          * The mg->mg_obj found by mg_find() above actually points to the
2633          * underlying tied Perl object implementation. For instance, if the
2634          * original SV was that of a tied array, then mg->mg_obj is an AV.
2635          *
2636          * Note that we store the Perl object as-is. We don't call its FETCH
2637          * method along the way. At retrieval time, we won't call its STORE
2638          * method either, but the tieing magic will be re-installed. In itself,
2639          * that ensures that the tieing semantics are preserved since futher
2640          * accesses on the retrieved object will indeed call the magic methods...
2641          */
2642
2643         /* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
2644         obj = mg->mg_obj ? mg->mg_obj : newSV(0);
2645         if ((ret = store(aTHX_ cxt, obj)))
2646                 return ret;
2647
2648         TRACEME(("ok (tied)"));
2649
2650         return 0;
2651 }
2652
2653 /*
2654  * store_tied_item
2655  *
2656  * Stores a reference to an item within a tied structure:
2657  *
2658  *  . \$h{key}, stores both the (tied %h) object and 'key'.
2659  *  . \$a[idx], stores both the (tied @a) object and 'idx'.
2660  *
2661  * Layout is therefore either:
2662  *     SX_TIED_KEY <object> <key>
2663  *     SX_TIED_IDX <object> <index>
2664  */
2665 static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
2666 {
2667         MAGIC *mg;
2668         int ret;
2669
2670         TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
2671
2672         if (!(mg = mg_find(sv, 'p')))
2673                 CROAK(("No magic 'p' found while storing reference to tied item"));
2674
2675         /*
2676          * We discriminate between \$h{key} and \$a[idx] via mg_ptr.
2677          */
2678
2679         if (mg->mg_ptr) {
2680                 TRACEME(("store_tied_item: storing a ref to a tied hash item"));
2681                 PUTMARK(SX_TIED_KEY);
2682                 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2683
2684                 if ((ret = store(aTHX_ cxt, mg->mg_obj)))               /* Extra () for -Wall, grr... */
2685                         return ret;
2686
2687                 TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
2688
2689                 if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr)))        /* Idem, for -Wall */
2690                         return ret;
2691         } else {
2692                 I32 idx = mg->mg_len;
2693
2694                 TRACEME(("store_tied_item: storing a ref to a tied array item "));
2695                 PUTMARK(SX_TIED_IDX);
2696                 TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
2697
2698                 if ((ret = store(aTHX_ cxt, mg->mg_obj)))               /* Idem, for -Wall */
2699                         return ret;
2700
2701                 TRACEME(("store_tied_item: storing IDX %d", idx));
2702
2703                 WLEN(idx);
2704         }
2705
2706         TRACEME(("ok (tied item)"));
2707
2708         return 0;
2709 }
2710
2711 /*
2712  * store_hook           -- dispatched manually, not via sv_store[]
2713  *
2714  * The blessed SV is serialized by a hook.
2715  *
2716  * Simple Layout is:
2717  *
2718  *     SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
2719  *
2720  * where <flags> indicates how long <len>, <len2> and <len3> are, whether
2721  * the trailing part [] is present, the type of object (scalar, array or hash).
2722  * There is also a bit which says how the classname is stored between:
2723  *
2724  *     <len> <classname>
2725  *     <index>
2726  *
2727  * and when the <index> form is used (classname already seen), the "large
2728  * classname" bit in <flags> indicates how large the <index> is.
2729  *
2730  * The serialized string returned by the hook is of length <len2> and comes
2731  * next.  It is an opaque string for us.
2732  *
2733  * Those <len3> object IDs which are listed last represent the extra references
2734  * not directly serialized by the hook, but which are linked to the object.
2735  *
2736  * When recursion is mandated to resolve object-IDs not yet seen, we have
2737  * instead, with <header> being flags with bits set to indicate the object type
2738  * and that recursion was indeed needed:
2739  *
2740  *     SX_HOOK <header> <object> <header> <object> <flags>
2741  *
2742  * that same header being repeated between serialized objects obtained through
2743  * recursion, until we reach flags indicating no recursion, at which point
2744  * we know we've resynchronized with a single layout, after <flags>.
2745  *
2746  * When storing a blessed ref to a tied variable, the following format is
2747  * used:
2748  *
2749  *     SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
2750  *
2751  * The first <flags> indication carries an object of type SHT_EXTRA, and the
2752  * real object type is held in the <extra> flag.  At the very end of the
2753  * serialization stream, the underlying magic object is serialized, just like
2754  * any other tied variable.
2755  */
2756 static int store_hook(
2757         pTHX_
2758         stcxt_t *cxt,
2759         SV *sv,
2760         int type,
2761         HV *pkg,
2762         SV *hook)
2763 {
2764         I32 len;
2765         char *class;
2766         STRLEN len2;
2767         SV *ref;
2768         AV *av;
2769         SV **ary;
2770         int count;                              /* really len3 + 1 */
2771         unsigned char flags;
2772         char *pv;
2773         int i;
2774         int recursed = 0;               /* counts recursion */
2775         int obj_type;                   /* object type, on 2 bits */
2776         I32 classnum;
2777         int ret;
2778         int clone = cxt->optype & ST_CLONE;
2779         char mtype = '\0';                              /* for blessed ref to tied structures */
2780         unsigned char eflags = '\0';    /* used when object type is SHT_EXTRA */
2781
2782         TRACEME(("store_hook, class \"%s\", tagged #%d", HvNAME(pkg), cxt->tagnum));
2783
2784         /*
2785          * Determine object type on 2 bits.
2786          */
2787
2788         switch (type) {
2789         case svis_SCALAR:
2790                 obj_type = SHT_SCALAR;
2791                 break;
2792         case svis_ARRAY:
2793                 obj_type = SHT_ARRAY;
2794                 break;
2795         case svis_HASH:
2796                 obj_type = SHT_HASH;
2797                 break;
2798         case svis_TIED:
2799                 /*
2800                  * Produced by a blessed ref to a tied data structure, $o in the
2801                  * following Perl code.
2802                  *
2803                  *      my %h;
2804                  *  tie %h, 'FOO';
2805                  *      my $o = bless \%h, 'BAR';
2806                  *
2807                  * Signal the tie-ing magic by setting the object type as SHT_EXTRA
2808                  * (since we have only 2 bits in <flags> to store the type), and an
2809                  * <extra> byte flag will be emitted after the FIRST <flags> in the
2810                  * stream, carrying what we put in `eflags'.
2811                  */
2812                 obj_type = SHT_EXTRA;
2813                 switch (SvTYPE(sv)) {
2814                 case SVt_PVHV:
2815                         eflags = (unsigned char) SHT_THASH;
2816                         mtype = 'P';
2817                         break;
2818                 case SVt_PVAV:
2819                         eflags = (unsigned char) SHT_TARRAY;
2820                         mtype = 'P';
2821                         break;
2822                 default:
2823                         eflags = (unsigned char) SHT_TSCALAR;
2824                         mtype = 'q';
2825                         break;
2826                 }
2827                 break;
2828         default:
2829                 CROAK(("Unexpected object type (%d) in store_hook()", type));
2830         }
2831         flags = SHF_NEED_RECURSE | obj_type;
2832
2833         class = HvNAME(pkg);
2834         len = strlen(class);
2835
2836         /*
2837          * To call the hook, we need to fake a call like:
2838          *
2839          *    $object->STORABLE_freeze($cloning);
2840          *
2841          * but we don't have the $object here.  For instance, if $object is
2842          * a blessed array, what we have in `sv' is the array, and we can't
2843          * call a method on those.
2844          *
2845          * Therefore, we need to create a temporary reference to the object and
2846          * make the call on that reference.
2847          */
2848
2849         TRACEME(("about to call STORABLE_freeze on class %s", class));
2850
2851         ref = newRV_noinc(sv);                          /* Temporary reference */
2852         av = array_call(aTHX_ ref, hook, clone);        /* @a = $object->STORABLE_freeze($c) */
2853         SvRV(ref) = 0;
2854         SvREFCNT_dec(ref);                                      /* Reclaim temporary reference */
2855
2856         count = AvFILLp(av) + 1;
2857         TRACEME(("store_hook, array holds %d items", count));
2858
2859         /*
2860          * If they return an empty list, it means they wish to ignore the
2861          * hook for this class (and not just this instance -- that's for them
2862          * to handle if they so wish).
2863          *
2864          * Simply disable the cached entry for the hook (it won't be recomputed
2865          * since it's present in the cache) and recurse to store_blessed().
2866          */
2867
2868         if (!count) {
2869                 /*
2870                  * They must not change their mind in the middle of a serialization.
2871                  */
2872
2873                 if (hv_fetch(cxt->hclass, class, len, FALSE))
2874                         CROAK(("Too late to ignore hooks for %s class \"%s\"",
2875                                 (cxt->optype & ST_CLONE) ? "cloning" : "storing", class));
2876
2877                 pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
2878
2879                 ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
2880                 TRACEME(("ignoring STORABLE_freeze in class \"%s\"", class));
2881
2882                 return store_blessed(aTHX_ cxt, sv, type, pkg);
2883         }
2884
2885         /*
2886          * Get frozen string.
2887          */
2888
2889         ary = AvARRAY(av);
2890         pv = SvPV(ary[0], len2);
2891
2892         /*
2893          * If they returned more than one item, we need to serialize some
2894          * extra references if not already done.
2895          *
2896          * Loop over the array, starting at position #1, and for each item,
2897          * ensure it is a reference, serialize it if not already done, and
2898          * replace the entry with the tag ID of the corresponding serialized
2899          * object.
2900          *
2901          * We CHEAT by not calling av_fetch() and read directly within the
2902          * array, for speed.
2903          */
2904
2905         for (i = 1; i < count; i++) {
2906                 SV **svh;
2907                 SV *rsv = ary[i];
2908                 SV *xsv;
2909                 AV *av_hook = cxt->hook_seen;
2910
2911                 if (!SvROK(rsv))
2912                         CROAK(("Item #%d returned by STORABLE_freeze "
2913                                 "for %s is not a reference", i, class));
2914                 xsv = SvRV(rsv);                /* Follow ref to know what to look for */
2915
2916                 /*
2917                  * Look in hseen and see if we have a tag already.
2918                  * Serialize entry if not done already, and get its tag.
2919                  */
2920
2921                 if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
2922                         goto sv_seen;           /* Avoid moving code too far to the right */
2923
2924                 TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
2925
2926                 /*
2927                  * We need to recurse to store that object and get it to be known
2928                  * so that we can resolve the list of object-IDs at retrieve time.
2929                  *
2930                  * The first time we do this, we need to emit the proper header
2931                  * indicating that we recursed, and what the type of object is (the
2932                  * object we're storing via a user-hook).  Indeed, during retrieval,
2933                  * we'll have to create the object before recursing to retrieve the
2934                  * others, in case those would point back at that object.
2935                  */
2936
2937                 /* [SX_HOOK] <flags> [<extra>] <object>*/
2938                 if (!recursed++) {
2939                         PUTMARK(SX_HOOK);
2940                         PUTMARK(flags);
2941                         if (obj_type == SHT_EXTRA)
2942                                 PUTMARK(eflags);
2943                 } else
2944                         PUTMARK(flags);
2945
2946                 if ((ret = store(aTHX_ cxt, xsv)))      /* Given by hook for us to store */
2947                         return ret;
2948
2949                 svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
2950                 if (!svh)
2951                         CROAK(("Could not serialize item #%d from hook in %s", i, class));
2952
2953                 /*
2954                  * It was the first time we serialized `xsv'.
2955                  *
2956                  * Keep this SV alive until the end of the serialization: if we
2957                  * disposed of it right now by decrementing its refcount, and it was
2958                  * a temporary value, some next temporary value allocated during
2959                  * another STORABLE_freeze might take its place, and we'd wrongly
2960                  * assume that new SV was already serialized, based on its presence
2961                  * in cxt->hseen.
2962                  *
2963                  * Therefore, push it away in cxt->hook_seen.
2964                  */
2965
2966                 av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
2967
2968         sv_seen:
2969                 /*
2970                  * Dispose of the REF they returned.  If we saved the `xsv' away
2971                  * in the array of returned SVs, that will not cause the underlying
2972                  * referenced SV to be reclaimed.
2973                  */
2974
2975                 ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
2976                 SvREFCNT_dec(rsv);                      /* Dispose of reference */
2977
2978                 /*
2979                  * Replace entry with its tag (not a real SV, so no refcnt increment)
2980                  */
2981
2982                 ary[i] = *svh;
2983                 TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
2984                          i-1, PTR2UV(xsv), PTR2UV(*svh)));
2985         }
2986
2987         /*
2988          * Allocate a class ID if not already done.
2989          *
2990          * This needs to be done after the recursion above, since at retrieval
2991          * time, we'll see the inner objects first.  Many thanks to
2992          * Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
2993          * proposed the right fix.  -- RAM, 15/09/2000
2994          */
2995
2996         if (!known_class(aTHX_ cxt, class, len, &classnum)) {
2997                 TRACEME(("first time we see class %s, ID = %d", class, classnum));
2998                 classnum = -1;                          /* Mark: we must store classname */
2999         } else {
3000                 TRACEME(("already seen class %s, ID = %d", class, classnum));
3001         }
3002
3003         /*
3004          * Compute leading flags.
3005          */
3006
3007         flags = obj_type;
3008         if (((classnum == -1) ? len : classnum) > LG_SCALAR)
3009                 flags |= SHF_LARGE_CLASSLEN;
3010         if (classnum != -1)
3011                 flags |= SHF_IDX_CLASSNAME;
3012         if (len2 > LG_SCALAR)
3013                 flags |= SHF_LARGE_STRLEN;
3014         if (count > 1)
3015                 flags |= SHF_HAS_LIST;
3016         if (count > (LG_SCALAR + 1))
3017                 flags |= SHF_LARGE_LISTLEN;
3018
3019         /*
3020          * We're ready to emit either serialized form:
3021          *
3022          *   SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3023          *   SX_HOOK <flags> <index>           <len2> <str> [<len3> <object-IDs>]
3024          *
3025          * If we recursed, the SX_HOOK has already been emitted.
3026          */
3027
3028         TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
3029                         "class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
3030                  recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
3031
3032         /* SX_HOOK <flags> [<extra>] */
3033         if (!recursed) {
3034                 PUTMARK(SX_HOOK);
3035                 PUTMARK(flags);
3036                 if (obj_type == SHT_EXTRA)
3037                         PUTMARK(eflags);
3038         } else
3039                 PUTMARK(flags);
3040
3041         /* <len> <classname> or <index> */
3042         if (flags & SHF_IDX_CLASSNAME) {
3043                 if (flags & SHF_LARGE_CLASSLEN)
3044                         WLEN(classnum);
3045                 else {
3046                         unsigned char cnum = (unsigned char) classnum;
3047                         PUTMARK(cnum);
3048                 }
3049         } else {
3050                 if (flags & SHF_LARGE_CLASSLEN)
3051                         WLEN(len);
3052                 else {
3053                         unsigned char clen = (unsigned char) len;
3054                         PUTMARK(clen);
3055                 }
3056                 WRITE(class, len);              /* Final \0 is omitted */
3057         }
3058
3059         /* <len2> <frozen-str> */
3060         if (flags & SHF_LARGE_STRLEN) {
3061                 I32 wlen2 = len2;               /* STRLEN might be 8 bytes */
3062                 WLEN(wlen2);                    /* Must write an I32 for 64-bit machines */
3063         } else {
3064                 unsigned char clen = (unsigned char) len2;
3065                 PUTMARK(clen);
3066         }
3067         if (len2)
3068                 WRITE(pv, (SSize_t)len2);       /* Final \0 is omitted */
3069
3070         /* [<len3> <object-IDs>] */
3071         if (flags & SHF_HAS_LIST) {
3072                 int len3 = count - 1;
3073                 if (flags & SHF_LARGE_LISTLEN)
3074                         WLEN(len3);
3075                 else {
3076                         unsigned char clen = (unsigned char) len3;
3077                         PUTMARK(clen);
3078                 }
3079
3080                 /*
3081                  * NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
3082                  * real pointer, rather a tag number, well under the 32-bit limit.
3083                  */
3084
3085                 for (i = 1; i < count; i++) {
3086                         I32 tagval = htonl(LOW_32BITS(ary[i]));
3087                         WRITE_I32(tagval);
3088                         TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
3089                 }
3090         }
3091
3092         /*
3093          * Free the array.  We need extra care for indices after 0, since they
3094          * don't hold real SVs but integers cast.
3095          */
3096
3097         if (count > 1)
3098                 AvFILLp(av) = 0;        /* Cheat, nothing after 0 interests us */
3099         av_undef(av);
3100         sv_free((SV *) av);
3101
3102         /*
3103          * If object was tied, need to insert serialization of the magic object.
3104          */
3105
3106         if (obj_type == SHT_EXTRA) {
3107                 MAGIC *mg;
3108
3109                 if (!(mg = mg_find(sv, mtype))) {
3110                         int svt = SvTYPE(sv);
3111                         CROAK(("No magic '%c' found while storing ref to tied %s with hook",
3112                                 mtype, (svt == SVt_PVHV) ? "hash" :
3113                                         (svt == SVt_PVAV) ? "array" : "scalar"));
3114                 }
3115
3116                 TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
3117                         PTR2UV(mg->mg_obj), PTR2UV(sv)));
3118
3119                 /*
3120                  * [<magic object>]
3121                  */
3122
3123                 if ((ret = store(aTHX_ cxt, mg->mg_obj)))       /* Extra () for -Wall, grr... */
3124                         return ret;
3125         }
3126
3127         return 0;
3128 }
3129
3130 /*
3131  * store_blessed        -- dispatched manually, not via sv_store[]
3132  *
3133  * Check whether there is a STORABLE_xxx hook defined in the class or in one
3134  * of its ancestors.  If there is, then redispatch to store_hook();
3135  *
3136  * Otherwise, the blessed SV is stored using the following layout:
3137  *
3138  *    SX_BLESS <flag> <len> <classname> <object>
3139  *
3140  * where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
3141  * on the high-order bit in flag: if 1, then length follows on 4 bytes.
3142  * Otherwise, the low order bits give the length, thereby giving a compact
3143  * representation for class names less than 127 chars long.
3144  *
3145  * Each <classname> seen is remembered and indexed, so that the next time
3146  * an object in the blessed in the same <classname> is stored, the following
3147  * will be emitted:
3148  *
3149  *    SX_IX_BLESS <flag> <index> <object>
3150  *
3151  * where <index> is the classname index, stored on 0 or 4 bytes depending
3152  * on the high-order bit in flag (same encoding as above for <len>).
3153  */
3154 static int store_blessed(
3155         pTHX_
3156         stcxt_t *cxt,
3157         SV *sv,
3158         int type,
3159         HV *pkg)
3160 {
3161         SV *hook;
3162         I32 len;
3163         char *class;
3164         I32 classnum;
3165
3166         TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME(pkg)));
3167
3168         /*
3169          * Look for a hook for this blessed SV and redirect to store_hook()
3170          * if needed.
3171          */
3172
3173         hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
3174         if (hook)
3175                 return store_hook(aTHX_ cxt, sv, type, pkg, hook);
3176
3177         /*
3178          * This is a blessed SV without any serialization hook.
3179          */
3180
3181         class = HvNAME(pkg);
3182         len = strlen(class);
3183
3184         TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
3185                  PTR2UV(sv), class, cxt->tagnum));
3186
3187         /*
3188          * Determine whether it is the first time we see that class name (in which
3189          * case it will be stored in the SX_BLESS form), or whether we already
3190          * saw that class name before (in which case the SX_IX_BLESS form will be
3191          * used).
3192          */
3193
3194         if (known_class(aTHX_ cxt, class, len, &classnum)) {
3195                 TRACEME(("already seen class %s, ID = %d", class, classnum));
3196                 PUTMARK(SX_IX_BLESS);
3197                 if (classnum <= LG_BLESS) {
3198                         unsigned char cnum = (unsigned char) classnum;
3199                         PUTMARK(cnum);
3200                 } else {
3201                         unsigned char flag = (unsigned char) 0x80;
3202                         PUTMARK(flag);
3203                         WLEN(classnum);
3204                 }
3205         } else {
3206                 TRACEME(("first time we see class %s, ID = %d", class, classnum));
3207                 PUTMARK(SX_BLESS);
3208                 if (len <= LG_BLESS) {
3209                         unsigned char clen = (unsigned char) len;
3210                         PUTMARK(clen);
3211                 } else {
3212                         unsigned char flag = (unsigned char) 0x80;
3213                         PUTMARK(flag);
3214                         WLEN(len);                                      /* Don't BER-encode, this should be rare */
3215                 }
3216                 WRITE(class, len);                              /* Final \0 is omitted */
3217         }
3218
3219         /*
3220          * Now emit the <object> part.
3221          */
3222
3223         return SV_STORE(type)(aTHX_ cxt, sv);
3224 }
3225
3226 /*
3227  * store_other
3228  *
3229  * We don't know how to store the item we reached, so return an error condition.
3230  * (it's probably a GLOB, some CODE reference, etc...)
3231  *
3232  * If they defined the `forgive_me' variable at the Perl level to some
3233  * true value, then don't croak, just warn, and store a placeholder string
3234  * instead.
3235  */
3236 static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
3237 {
3238         I32 len;
3239         static char buf[80];
3240
3241         TRACEME(("store_other"));
3242
3243         /*
3244          * Fetch the value from perl only once per store() operation.
3245          */
3246
3247         if (
3248                 cxt->forgive_me == 0 ||
3249                 (cxt->forgive_me < 0 && !(cxt->forgive_me =
3250                         SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
3251         )
3252                 CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
3253
3254         warn("Can't store item %s(0x%"UVxf")",
3255                 sv_reftype(sv, FALSE), PTR2UV(sv));
3256
3257         /*
3258          * Store placeholder string as a scalar instead...
3259          */
3260
3261         (void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
3262                        PTR2UV(sv), (char) 0);
3263
3264         len = strlen(buf);
3265         STORE_SCALAR(buf, len);
3266         TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
3267
3268         return 0;
3269 }
3270
3271 /***
3272  *** Store driving routines
3273  ***/
3274
3275 /*
3276  * sv_type
3277  *
3278  * WARNING: partially duplicates Perl's sv_reftype for speed.
3279  *
3280  * Returns the type of the SV, identified by an integer. That integer
3281  * may then be used to index the dynamic routine dispatch table.
3282  */
3283 static int sv_type(pTHX_ SV *sv)
3284 {
3285         switch (SvTYPE(sv)) {
3286         case SVt_NULL:
3287         case SVt_IV:
3288         case SVt_NV:
3289                 /*
3290                  * No need to check for ROK, that can't be set here since there
3291                  * is no field capable of hodling the xrv_rv reference.
3292                  */
3293                 return svis_SCALAR;
3294         case SVt_PV:
3295         case SVt_RV:
3296         case SVt_PVIV:
3297         case SVt_PVNV:
3298                 /*
3299                  * Starting from SVt_PV, it is possible to have the ROK flag
3300                  * set, the pointer to the other SV being either stored in
3301                  * the xrv_rv (in the case of a pure SVt_RV), or as the
3302                  * xpv_pv field of an SVt_PV and its heirs.
3303                  *
3304                  * However, those SV cannot be magical or they would be an
3305                  * SVt_PVMG at least.
3306                  */
3307                 return SvROK(sv) ? svis_REF : svis_SCALAR;
3308         case SVt_PVMG:
3309         case SVt_PVLV:          /* Workaround for perl5.004_04 "LVALUE" bug */
3310                 if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
3311                         return svis_TIED_ITEM;
3312                 /* FALL THROUGH */
3313         case SVt_PVBM:
3314                 if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
3315                         return svis_TIED;
3316                 return SvROK(sv) ? svis_REF : svis_SCALAR;
3317         case SVt_PVAV:
3318                 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3319                         return svis_TIED;
3320                 return svis_ARRAY;
3321         case SVt_PVHV:
3322                 if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
3323                         return svis_TIED;
3324                 return svis_HASH;
3325         case SVt_PVCV:
3326                 return svis_CODE;
3327         default:
3328                 break;
3329         }
3330
3331         return svis_OTHER;
3332 }
3333
3334 /*
3335  * store
3336  *
3337  * Recursively store objects pointed to by the sv to the specified file.
3338  *
3339  * Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
3340  * object (one for which storage has started -- it may not be over if we have
3341  * a self-referenced structure). This data set forms a stored <object>.
3342  */
3343 static int store(pTHX_ stcxt_t *cxt, SV *sv)
3344 {
3345         SV **svh;
3346         int ret;
3347         int type;
3348         HV *hseen = cxt->hseen;
3349
3350         TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
3351
3352         /*
3353          * If object has already been stored, do not duplicate data.
3354          * Simply emit the SX_OBJECT marker followed by its tag data.
3355          * The tag is always written in network order.
3356          *
3357          * NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
3358          * real pointer, rather a tag number (watch the insertion code below).
3359          * That means it probably safe to assume it is well under the 32-bit limit,
3360          * and makes the truncation safe.
3361          *              -- RAM, 14/09/1999
3362          */
3363
3364         svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
3365         if (svh) {
3366                 I32 tagval;
3367
3368                 if (sv == &PL_sv_undef) {
3369                         /* We have seen PL_sv_undef before, but fake it as
3370                            if we have not.
3371
3372                            Not the simplest solution to making restricted
3373                            hashes work on 5.8.0, but it does mean that
3374                            repeated references to the one true undef will
3375                            take up less space in the output file.
3376                         */
3377                         /* Need to jump past the next hv_store, because on the
3378                            second store of undef the old hash value will be
3379                            SvREFCNT_dec()ed, and as Storable cheats horribly
3380                            by storing non-SVs in the hash a SEGV will ensure.
3381                            Need to increase the tag number so that the
3382                            receiver has no idea what games we're up to.  This
3383                            special casing doesn't affect hooks that store
3384                            undef, as the hook routine does its own lookup into
3385                            hseen.  Also this means that any references back
3386                            to PL_sv_undef (from the pathological case of hooks
3387                            storing references to it) will find the seen hash
3388                            entry for the first time, as if we didn't have this
3389                            hackery here. (That hseen lookup works even on 5.8.0
3390                            because it's a key of &PL_sv_undef and a value
3391                            which is a tag number, not a value which is
3392                            PL_sv_undef.)  */
3393                         cxt->tagnum++;
3394                         type = svis_SCALAR;
3395                         goto undef_special_case;
3396                 }
3397
3398                 tagval = htonl(LOW_32BITS(*svh));
3399
3400                 TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
3401
3402                 PUTMARK(SX_OBJECT);
3403                 WRITE_I32(tagval);
3404                 return 0;
3405         }
3406
3407         /*
3408          * Allocate a new tag and associate it with the address of the sv being
3409          * stored, before recursing...
3410          *
3411          * In order to avoid creating new SvIVs to hold the tagnum we just
3412          * cast the tagnum to an SV pointer and store that in the hash.  This
3413          * means that we must clean up the hash manually afterwards, but gives
3414          * us a 15% throughput increase.
3415          *
3416          */
3417
3418         cxt->tagnum++;
3419         if (!hv_store(hseen,
3420                         (char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
3421                 return -1;
3422
3423         /*
3424          * Store `sv' and everything beneath it, using appropriate routine.
3425          * Abort immediately if we get a non-zero status back.
3426          */
3427
3428         type = sv_type(aTHX_ sv);
3429
3430 undef_special_case:
3431         TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
3432                  PTR2UV(sv), cxt->tagnum, type));
3433
3434         if (SvOBJECT(sv)) {
3435                 HV *pkg = SvSTASH(sv);
3436                 ret = store_blessed(aTHX_ cxt, sv, type, pkg);
3437         } else
3438                 ret = SV_STORE(type)(aTHX_ cxt, sv);
3439
3440         TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
3441                 ret ? "FAILED" : "ok", PTR2UV(sv),
3442                 SvREFCNT(sv), sv_reftype(sv, FALSE)));
3443
3444         return ret;
3445 }
3446
3447 /*
3448  * magic_write
3449  *
3450  * Write magic number and system information into the file.
3451  * Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
3452  * <sizeof ptr>] where <len> is the length of the byteorder hexa string.
3453  * All size and lenghts are written as single characters here.
3454  *
3455  * Note that no byte ordering info is emitted when <network> is true, since
3456  * integers will be emitted in network order in that case.
3457  */
3458 static int magic_write(pTHX_ stcxt_t *cxt)
3459 {
3460     /*
3461      * Starting with 0.6, the "use_network_order" byte flag is also used to
3462      * indicate the version number of the binary image, encoded in the upper
3463      * bits. The bit 0 is always used to indicate network order.
3464      */
3465     /*
3466      * Starting with 0.7, a full byte is dedicated to the minor version of
3467      * the binary format, which is incremented only when new markers are
3468      * introduced, for instance, but when backward compatibility is preserved.
3469      */
3470
3471     /* Make these at compile time.  The WRITE() macro is sufficiently complex
3472        that it saves about 200 bytes doing it this way and only using it
3473        once.  */
3474     static const unsigned char network_file_header[] = {
3475         MAGICSTR_BYTES,
3476         (STORABLE_BIN_MAJOR << 1) | 1,
3477         STORABLE_BIN_WRITE_MINOR
3478     };
3479     static const unsigned char file_header[] = {
3480         MAGICSTR_BYTES,
3481         (STORABLE_BIN_MAJOR << 1) | 0,
3482         STORABLE_BIN_WRITE_MINOR,
3483         /* sizeof the array includes the 0 byte at the end:  */
3484         (char) sizeof (byteorderstr) - 1,
3485         BYTEORDER_BYTES,
3486         (unsigned char) sizeof(int),
3487         (unsigned char) sizeof(long),
3488         (unsigned char) sizeof(char *),
3489         (unsigned char) sizeof(NV)
3490     };
3491 #ifdef USE_56_INTERWORK_KLUDGE
3492     static const unsigned char file_header_56[] = {
3493         MAGICSTR_BYTES,
3494         (STORABLE_BIN_MAJOR << 1) | 0,
3495         STORABLE_BIN_WRITE_MINOR,
3496         /* sizeof the array includes the 0 byte at the end:  */
3497         (char) sizeof (byteorderstr_56) - 1,
3498         BYTEORDER_BYTES_56,
3499         (unsigned char) sizeof(int),
3500         (unsigned char) sizeof(long),
3501         (unsigned char) sizeof(char *),
3502         (unsigned char) sizeof(NV)
3503     };
3504 #endif
3505     const unsigned char *header;
3506     SSize_t length;
3507
3508     TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
3509
3510     if (cxt->netorder) {
3511         header = network_file_header;
3512         length = sizeof (network_file_header);
3513     } else {
3514 #ifdef USE_56_INTERWORK_KLUDGE
3515         if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
3516             header = file_header_56;
3517             length = sizeof (file_header_56);
3518         } else
3519 #endif
3520         {
3521             header = file_header;
3522             length = sizeof (file_header);
3523         }
3524     }
3525
3526     if (!cxt->fio) {
3527         /* sizeof the array includes the 0 byte at the end.  */
3528         header += sizeof (magicstr) - 1;
3529         length -= sizeof (magicstr) - 1;
3530     }
3531
3532     WRITE( (unsigned char*) header, length);
3533
3534     if (!cxt->netorder) {
3535         TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
3536                  (unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
3537                  (int) sizeof(int), (int) sizeof(long),
3538                  (int) sizeof(char *), (int) sizeof(NV)));
3539     }
3540     return 0;
3541 }
3542
3543 /*
3544  * do_store
3545  *
3546  * Common code for store operations.
3547  *
3548  * When memory store is requested (f = NULL) and a non null SV* is given in
3549  * `res', it is filled with a new SV created out of the memory buffer.
3550  *
3551  * It is required to provide a non-null `res' when the operation type is not
3552  * dclone() and store() is performed to memory.
3553  */
3554 static int do_store(
3555         pTHX_
3556         PerlIO *f,
3557         SV *sv,
3558         int optype,
3559         int network_order,
3560         SV **res)
3561 {
3562         dSTCXT;
3563         int status;
3564
3565         ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
3566                 ("must supply result SV pointer for real recursion to memory"));
3567
3568         TRACEME(("do_store (optype=%d, netorder=%d)",
3569                 optype, network_order));
3570
3571         optype |= ST_STORE;
3572
3573         /*
3574          * Workaround for CROAK leak: if they enter with a "dirty" context,
3575          * free up memory for them now.
3576          */
3577
3578         if (cxt->s_dirty)
3579                 clean_context(aTHX_ cxt);
3580
3581         /*
3582          * Now that STORABLE_xxx hooks exist, it is possible that they try to
3583          * re-enter store() via the hooks.  We need to stack contexts.
3584          */
3585
3586         if (cxt->entry)
3587                 cxt = allocate_context(aTHX_ cxt);
3588
3589         cxt->entry++;
3590
3591         ASSERT(cxt->entry == 1, ("starting new recursion"));
3592         ASSERT(!cxt->s_dirty, ("clean context"));
3593
3594         /*
3595          * Ensure sv is actually a reference. From perl, we called something
3596          * like:
3597          *       pstore(aTHX_ FILE, \@array);
3598          * so we must get the scalar value behing that reference.
3599          */
3600
3601         if (!SvROK(sv))
3602                 CROAK(("Not a reference"));
3603         sv = SvRV(sv);                  /* So follow it to know what to store */
3604
3605         /*
3606          * If we're going to store to memory, reset the buffer.
3607          */
3608
3609         if (!f)
3610                 MBUF_INIT(0);
3611
3612         /*
3613          * Prepare context and emit headers.
3614          */
3615
3616         init_store_context(aTHX_ cxt, f, optype, network_order);
3617
3618         if (-1 == magic_write(aTHX_ cxt))               /* Emit magic and ILP info */
3619                 return 0;                                       /* Error */
3620
3621         /*
3622          * Recursively store object...
3623          */
3624
3625         ASSERT(is_storing(), ("within store operation"));
3626
3627         status = store(aTHX_ cxt, sv);          /* Just do it! */
3628
3629         /*
3630          * If they asked for a memory store and they provided an SV pointer,
3631          * make an SV string out of the buffer and fill their pointer.
3632          *
3633          * When asking for ST_REAL, it's MANDATORY for the caller to provide
3634          * an SV, since context cleanup might free the buffer if we did recurse.
3635          * (unless caller is dclone(), which is aware of that).
3636          */
3637
3638         if (!cxt->fio && res)
3639                 *res = mbuf2sv(aTHX);
3640
3641         /*
3642          * Final cleanup.
3643          *
3644          * The "root" context is never freed, since it is meant to be always
3645          * handy for the common case where no recursion occurs at all (i.e.
3646          * we enter store() outside of any Storable code and leave it, period).
3647          * We know it's the "root" context because there's nothing stacked
3648          * underneath it.
3649          *
3650          * OPTIMIZATION:
3651          *
3652          * When deep cloning, we don't free the context: doing so would force
3653          * us to copy the data in the memory buffer.  Sicne we know we're
3654          * about to enter do_retrieve...
3655          */
3656
3657         clean_store_context(aTHX_ cxt);
3658         if (cxt->prev && !(cxt->optype & ST_CLONE))
3659                 free_context(aTHX_ cxt);
3660
3661         TRACEME(("do_store returns %d", status));
3662
3663         return status == 0;
3664 }
3665
3666 /*
3667  * pstore
3668  *
3669  * Store the transitive data closure of given object to disk.
3670  * Returns 0 on error, a true value otherwise.
3671  */
3672 int pstore(pTHX_ PerlIO *f, SV *sv)
3673 {
3674         TRACEME(("pstore"));
3675         return do_store(aTHX_ f, sv, 0, FALSE, (SV**) 0);
3676
3677 }
3678
3679 /*
3680  * net_pstore
3681  *
3682  * Same as pstore(), but network order is used for integers and doubles are
3683  * emitted as strings.
3684  */
3685 int net_pstore(pTHX_ PerlIO *f, SV *sv)
3686 {
3687         TRACEME(("net_pstore"));
3688         return do_store(aTHX_ f, sv, 0, TRUE, (SV**) 0);
3689 }
3690
3691 /***
3692  *** Memory stores.
3693  ***/
3694
3695 /*
3696  * mbuf2sv
3697  *
3698  * Build a new SV out of the content of the internal memory buffer.
3699  */
3700 static SV *mbuf2sv(pTHX)
3701 {
3702         dSTCXT;
3703
3704         return newSVpv(mbase, MBUF_SIZE());
3705 }
3706
3707 /*
3708  * mstore
3709  *
3710  * Store the transitive data closure of given object to memory.
3711  * Returns undef on error, a scalar value containing the data otherwise.
3712  */
3713 SV *mstore(pTHX_ SV *sv)
3714 {
3715         SV *out;
3716
3717         TRACEME(("mstore"));
3718
3719         if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, FALSE, &out))
3720                 return &PL_sv_undef;
3721
3722         return out;
3723 }
3724
3725 /*
3726  * net_mstore
3727  *
3728  * Same as mstore(), but network order is used for integers and doubles are
3729  * emitted as strings.
3730  */
3731 SV *net_mstore(pTHX_ SV *sv)
3732 {
3733         SV *out;
3734
3735         TRACEME(("net_mstore"));
3736
3737         if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, TRUE, &out))
3738                 return &PL_sv_undef;
3739
3740         return out;
3741 }
3742
3743 /***
3744  *** Specific retrieve callbacks.
3745  ***/
3746
3747 /*
3748  * retrieve_other
3749  *
3750  * Return an error via croak, since it is not possible that we get here
3751  * under normal conditions, when facing a file produced via pstore().
3752  */
3753 static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname)
3754 {
3755         if (
3756                 cxt->ver_major != STORABLE_BIN_MAJOR &&
3757                 cxt->ver_minor != STORABLE_BIN_MINOR
3758         ) {
3759                 CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
3760                         cxt->fio ? "file" : "string",
3761                         cxt->ver_major, cxt->ver_minor,
3762                         STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
3763         } else {
3764                 CROAK(("Corrupted storable %s (binary v%d.%d)",
3765                         cxt->fio ? "file" : "string",
3766                         cxt->ver_major, cxt->ver_minor));
3767         }
3768
3769         return (SV *) 0;                /* Just in case */
3770 }
3771
3772 /*
3773  * retrieve_idx_blessed
3774  *
3775  * Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
3776  * <index> can be coded on either 1 or 5 bytes.
3777  */
3778 static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname)
3779 {
3780         I32 idx;
3781         char *class;
3782         SV **sva;
3783         SV *sv;
3784
3785         TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
3786         ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3787
3788         GETMARK(idx);                   /* Index coded on a single char? */
3789         if (idx & 0x80)
3790                 RLEN(idx);
3791
3792         /*
3793          * Fetch classname in `aclass'
3794          */
3795
3796         sva = av_fetch(cxt->aclass, idx, FALSE);
3797         if (!sva)
3798                 CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
3799
3800         class = SvPVX(*sva);    /* We know it's a PV, by construction */
3801
3802         TRACEME(("class ID %d => %s", idx, class));
3803
3804         /*
3805          * Retrieve object and bless it.
3806          */
3807
3808         sv = retrieve(aTHX_ cxt, class);        /* First SV which is SEEN will be blessed */
3809
3810         return sv;
3811 }
3812
3813 /*
3814  * retrieve_blessed
3815  *
3816  * Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
3817  * <len> can be coded on either 1 or 5 bytes.
3818  */
3819 static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname)
3820 {
3821         I32 len;
3822         SV *sv;
3823         char buf[LG_BLESS + 1];         /* Avoid malloc() if possible */
3824         char *class = buf;
3825
3826         TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
3827         ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3828
3829         /*
3830          * Decode class name length and read that name.
3831          *
3832          * Short classnames have two advantages: their length is stored on one
3833          * single byte, and the string can be read on the stack.
3834          */
3835
3836         GETMARK(len);                   /* Length coded on a single char? */
3837         if (len & 0x80) {
3838                 RLEN(len);
3839                 TRACEME(("** allocating %d bytes for class name", len+1));
3840                 New(10003, class, len+1, char);
3841         }
3842         READ(class, len);
3843         class[len] = '\0';              /* Mark string end */
3844
3845         /*
3846          * It's a new classname, otherwise it would have been an SX_IX_BLESS.
3847          */
3848
3849         TRACEME(("new class name \"%s\" will bear ID = %d", class, cxt->classnum));
3850
3851         if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
3852                 return (SV *) 0;
3853
3854         /*
3855          * Retrieve object and bless it.
3856          */
3857
3858         sv = retrieve(aTHX_ cxt, class);        /* First SV which is SEEN will be blessed */
3859         if (class != buf)
3860                 Safefree(class);
3861
3862         return sv;
3863 }
3864
3865 /*
3866  * retrieve_hook
3867  *
3868  * Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
3869  * with leading mark already read, as usual.
3870  *
3871  * When recursion was involved during serialization of the object, there
3872  * is an unknown amount of serialized objects after the SX_HOOK mark.  Until
3873  * we reach a <flags> marker with the recursion bit cleared.
3874  *
3875  * If the first <flags> byte contains a type of SHT_EXTRA, then the real type
3876  * is held in the <extra> byte, and if the object is tied, the serialized
3877  * magic object comes at the very end:
3878  *
3879  *     SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
3880  *
3881  * This means the STORABLE_thaw hook will NOT get a tied variable during its
3882  * processing (since we won't have seen the magic object by the time the hook
3883  * is called).  See comments below for why it was done that way.
3884  */
3885 static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname)
3886 {
3887         I32 len;
3888         char buf[LG_BLESS + 1];         /* Avoid malloc() if possible */
3889         char *class = buf;
3890         unsigned int flags;
3891         I32 len2;
3892         SV *frozen;
3893         I32 len3 = 0;
3894         AV *av = 0;
3895         SV *hook;
3896         SV *sv;
3897         SV *rv;
3898         int obj_type;
3899         int clone = cxt->optype & ST_CLONE;
3900         char mtype = '\0';
3901         unsigned int extra_type = 0;
3902
3903         TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
3904         ASSERT(!cname, ("no bless-into class given here, got %s", cname));
3905
3906         /*
3907          * Read flags, which tell us about the type, and whether we need to recurse.
3908          */
3909
3910         GETMARK(flags);
3911
3912         /*
3913          * Create the (empty) object, and mark it as seen.
3914          *
3915          * This must be done now, because tags are incremented, and during
3916          * serialization, the object tag was affected before recursion could
3917          * take place.
3918          */
3919
3920         obj_type = flags & SHF_TYPE_MASK;
3921         switch (obj_type) {
3922         case SHT_SCALAR:
3923                 sv = newSV(0);
3924                 break;
3925         case SHT_ARRAY:
3926                 sv = (SV *) newAV();
3927                 break;
3928         case SHT_HASH:
3929                 sv = (SV *) newHV();
3930                 break;
3931         case SHT_EXTRA:
3932                 /*
3933                  * Read <extra> flag to know the type of the object.
3934                  * Record associated magic type for later.
3935                  */
3936                 GETMARK(extra_type);
3937                 switch (extra_type) {
3938                 case SHT_TSCALAR:
3939                         sv = newSV(0);
3940                         mtype = 'q';
3941                         break;
3942                 case SHT_TARRAY:
3943                         sv = (SV *) newAV();
3944                         mtype = 'P';
3945                         break;
3946                 case SHT_THASH:
3947                         sv = (SV *) newHV();
3948                         mtype = 'P';
3949                         break;
3950                 default:
3951                         return retrieve_other(aTHX_ cxt, 0);    /* Let it croak */
3952                 }
3953                 break;
3954         default:
3955                 return retrieve_other(aTHX_ cxt, 0);            /* Let it croak */
3956         }
3957         SEEN(sv, 0, 0);                                                 /* Don't bless yet */
3958
3959         /*
3960          * Whilst flags tell us to recurse, do so.
3961          *
3962          * We don't need to remember the addresses returned by retrieval, because
3963          * all the references will be obtained through indirection via the object
3964          * tags in the object-ID list.
3965          *
3966          * We need to decrement the reference count for these objects
3967          * because, if the user doesn't save a reference to them in the hook,
3968          * they must be freed when this context is cleaned.
3969          */
3970
3971         while (flags & SHF_NEED_RECURSE) {
3972                 TRACEME(("retrieve_hook recursing..."));
3973                 rv = retrieve(aTHX_ cxt, 0);
3974                 if (!rv)
3975                         return (SV *) 0;
3976                 SvREFCNT_dec(rv);
3977                 TRACEME(("retrieve_hook back with rv=0x%"UVxf,
3978                          PTR2UV(rv)));
3979                 GETMARK(flags);
3980         }
3981
3982         if (flags & SHF_IDX_CLASSNAME) {
3983                 SV **sva;
3984                 I32 idx;
3985
3986                 /*
3987                  * Fetch index from `aclass'
3988                  */
3989
3990                 if (flags & SHF_LARGE_CLASSLEN)
3991                         RLEN(idx);
3992                 else
3993                         GETMARK(idx);
3994
3995                 sva = av_fetch(cxt->aclass, idx, FALSE);
3996                 if (!sva)
3997                         CROAK(("Class name #%"IVdf" should have been seen already",
3998                                 (IV) idx));
3999
4000                 class = SvPVX(*sva);    /* We know it's a PV, by construction */
4001                 TRACEME(("class ID %d => %s", idx, class));
4002
4003         } else {
4004                 /*
4005                  * Decode class name length and read that name.
4006                  *
4007                  * NOTA BENE: even if the length is stored on one byte, we don't read
4008                  * on the stack.  Just like retrieve_blessed(), we limit the name to
4009                  * LG_BLESS bytes.  This is an arbitrary decision.
4010                  */
4011
4012                 if (flags & SHF_LARGE_CLASSLEN)
4013                         RLEN(len);
4014                 else
4015                         GETMARK(len);
4016
4017                 if (len > LG_BLESS) {
4018                         TRACEME(("** allocating %d bytes for class name", len+1));
4019                         New(10003, class, len+1, char);
4020                 }
4021
4022                 READ(class, len);
4023                 class[len] = '\0';              /* Mark string end */
4024
4025                 /*
4026                  * Record new classname.
4027                  */
4028
4029                 if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(class, len)))
4030                         return (SV *) 0;
4031         }
4032
4033         TRACEME(("class name: %s", class));
4034
4035         /*
4036          * Decode user-frozen string length and read it in an SV.
4037          *
4038          * For efficiency reasons, we read data directly into the SV buffer.
4039          * To understand that code, read retrieve_scalar()
4040          */
4041
4042         if (flags & SHF_LARGE_STRLEN)
4043                 RLEN(len2);
4044         else
4045                 GETMARK(len2);
4046
4047         frozen = NEWSV(10002, len2);
4048         if (len2) {
4049                 SAFEREAD(SvPVX(frozen), len2, frozen);
4050                 SvCUR_set(frozen, len2);
4051                 *SvEND(frozen) = '\0';
4052         }
4053         (void) SvPOK_only(frozen);              /* Validates string pointer */
4054         if (cxt->s_tainted)                             /* Is input source tainted? */
4055                 SvTAINT(frozen);
4056
4057         TRACEME(("frozen string: %d bytes", len2));
4058
4059         /*
4060          * Decode object-ID list length, if present.
4061          */
4062
4063         if (flags & SHF_HAS_LIST) {
4064                 if (flags & SHF_LARGE_LISTLEN)
4065                         RLEN(len3);
4066                 else
4067                         GETMARK(len3);
4068                 if (len3) {
4069                         av = newAV();
4070                         av_extend(av, len3 + 1);        /* Leave room for [0] */
4071                         AvFILLp(av) = len3;                     /* About to be filled anyway */
4072                 }
4073         }
4074
4075         TRACEME(("has %d object IDs to link", len3));
4076
4077         /*
4078          * Read object-ID list into array.
4079          * Because we pre-extended it, we can cheat and fill it manually.
4080          *
4081          * We read object tags and we can convert them into SV* on the fly
4082          * because we know all the references listed in there (as tags)
4083          * have been already serialized, hence we have a valid correspondance
4084          * between each of those tags and the recreated SV.
4085          */
4086
4087         if (av) {
4088                 SV **ary = AvARRAY(av);
4089                 int i;
4090                 for (i = 1; i <= len3; i++) {   /* We leave [0] alone */
4091                         I32 tag;
4092                         SV **svh;
4093                         SV *xsv;
4094
4095                         READ_I32(tag);
4096                         tag = ntohl(tag);
4097                         svh = av_fetch(cxt->aseen, tag, FALSE);
4098                         if (!svh) {
4099                                 if (tag == cxt->where_is_undef) {
4100                                         /* av_fetch uses PL_sv_undef internally, hence this
4101                                            somewhat gruesome hack. */
4102                                         xsv = &PL_sv_undef;
4103                                         svh = &xsv;
4104                                 } else {
4105                                         CROAK(("Object #%"IVdf" should have been retrieved already",
4106                                                (IV) tag));
4107                                 }
4108                         }
4109                         xsv = *svh;
4110                         ary[i] = SvREFCNT_inc(xsv);
4111                 }
4112         }
4113
4114         /*
4115          * Bless the object and look up the STORABLE_thaw hook.
4116          */
4117
4118         BLESS(sv, class);
4119         hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4120         if (!hook) {
4121                 /*
4122                  * Hook not found.  Maybe they did not require the module where this
4123                  * hook is defined yet?
4124                  *
4125                  * If the require below succeeds, we'll be able to find the hook.
4126                  * Still, it only works reliably when each class is defined in a
4127                  * file of its own.
4128                  */
4129
4130                 SV *psv = newSVpvn("require ", 8);
4131                 sv_catpv(psv, class);
4132
4133                 TRACEME(("No STORABLE_thaw defined for objects of class %s", class));
4134                 TRACEME(("Going to require module '%s' with '%s'", class, SvPVX(psv)));
4135
4136                 perl_eval_sv(psv, G_DISCARD);
4137                 sv_free(psv);
4138
4139                 /*
4140                  * We cache results of pkg_can, so we need to uncache before attempting
4141                  * the lookup again.
4142                  */
4143
4144                 pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4145                 hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
4146
4147                 if (!hook)
4148                         CROAK(("No STORABLE_thaw defined for objects of class %s "
4149                                         "(even after a \"require %s;\")", class, class));
4150         }
4151
4152         /*
4153          * If we don't have an `av' yet, prepare one.
4154          * Then insert the frozen string as item [0].
4155          */
4156
4157         if (!av) {
4158                 av = newAV();
4159                 av_extend(av, 1);
4160                 AvFILLp(av) = 0;
4161         }
4162         AvARRAY(av)[0] = SvREFCNT_inc(frozen);
4163
4164         /*
4165          * Call the hook as:
4166          *
4167          *   $object->STORABLE_thaw($cloning, $frozen, @refs);
4168          *
4169          * where $object is our blessed (empty) object, $cloning is a boolean
4170          * telling whether we're running a deep clone, $frozen is the frozen
4171          * string the user gave us in his serializing hook, and @refs, which may
4172          * be empty, is the list of extra references he returned along for us
4173          * to serialize.
4174          *
4175          * In effect, the hook is an alternate creation routine for the class,
4176          * the object itself being already created by the runtime.
4177          */
4178
4179         TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
4180                  class, PTR2UV(sv), (IV) AvFILLp(av) + 1));
4181
4182         rv = newRV(sv);
4183         (void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
4184         SvREFCNT_dec(rv);
4185
4186         /*
4187          * Final cleanup.
4188          */
4189
4190         SvREFCNT_dec(frozen);
4191         av_undef(av);
4192         sv_free((SV *) av);
4193         if (!(flags & SHF_IDX_CLASSNAME) && class != buf)
4194                 Safefree(class);
4195
4196         /*
4197          * If we had an <extra> type, then the object was not as simple, and
4198          * we need to restore extra magic now.
4199          */
4200
4201         if (!extra_type)
4202                 return sv;
4203
4204         TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
4205
4206         rv = retrieve(aTHX_ cxt, 0);            /* Retrieve <magic object> */
4207
4208         TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
4209                 PTR2UV(rv), PTR2UV(sv)));
4210
4211         switch (extra_type) {
4212         case SHT_TSCALAR:
4213                 sv_upgrade(sv, SVt_PVMG);
4214                 break;
4215         case SHT_TARRAY:
4216                 sv_upgrade(sv, SVt_PVAV);
4217                 AvREAL_off((AV *)sv);
4218                 break;
4219         case SHT_THASH:
4220                 sv_upgrade(sv, SVt_PVHV);
4221                 break;
4222         default:
4223                 CROAK(("Forgot to deal with extra type %d", extra_type));
4224                 break;
4225         }
4226
4227         /*
4228          * Adding the magic only now, well after the STORABLE_thaw hook was called
4229          * means the hook cannot know it deals with an object whose variable is
4230          * tied.  But this is happening when retrieving $o in the following case:
4231          *
4232          *      my %h;
4233          *  tie %h, 'FOO';
4234          *      my $o = bless \%h, 'BAR';
4235          *
4236          * The 'BAR' class is NOT the one where %h is tied into.  Therefore, as
4237          * far as the 'BAR' class is concerned, the fact that %h is not a REAL
4238          * hash but a tied one should not matter at all, and remain transparent.
4239          * This means the magic must be restored by Storable AFTER the hook is
4240          * called.
4241          *
4242          * That looks very reasonable to me, but then I've come up with this
4243          * after a bug report from David Nesting, who was trying to store such
4244          * an object and caused Storable to fail.  And unfortunately, it was
4245          * also the easiest way to retrofit support for blessed ref to tied objects
4246          * into the existing design.  -- RAM, 17/02/2001
4247          */
4248
4249         sv_magic(sv, rv, mtype, Nullch, 0);
4250         SvREFCNT_dec(rv);                       /* Undo refcnt inc from sv_magic() */
4251
4252         return sv;
4253 }
4254
4255 /*
4256  * retrieve_ref
4257  *
4258  * Retrieve reference to some other scalar.
4259  * Layout is SX_REF <object>, with SX_REF already read.
4260  */
4261 static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname)
4262 {
4263         SV *rv;
4264         SV *sv;
4265
4266         TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
4267
4268         /*
4269          * We need to create the SV that holds the reference to the yet-to-retrieve
4270          * object now, so that we may record the address in the seen table.
4271          * Otherwise, if the object to retrieve references us, we won't be able
4272          * to resolve the SX_OBJECT we'll see at that point! Hence we cannot
4273          * do the retrieve first and use rv = newRV(sv) since it will be too late
4274          * for SEEN() recording.
4275          */
4276
4277         rv = NEWSV(10002, 0);
4278         SEEN(rv, cname, 0);             /* Will return if rv is null */
4279         sv = retrieve(aTHX_ cxt, 0);    /* Retrieve <object> */
4280         if (!sv)
4281                 return (SV *) 0;        /* Failed */
4282
4283         /*
4284          * WARNING: breaks RV encapsulation.
4285          *
4286          * Now for the tricky part. We have to upgrade our existing SV, so that
4287          * it is now an RV on sv... Again, we cheat by duplicating the code
4288          * held in newSVrv(), since we already got our SV from retrieve().
4289          *
4290          * We don't say:
4291          *
4292          *              SvRV(rv) = SvREFCNT_inc(sv);
4293          *
4294          * here because the reference count we got from retrieve() above is
4295          * already correct: if the object was retrieved from the file, then
4296          * its reference count is one. Otherwise, if it was retrieved via
4297          * an SX_OBJECT indication, a ref count increment was done.
4298          */
4299
4300         if (cname) {
4301                 /* No need to do anything, as rv will already be PVMG.  */
4302                 assert (SvTYPE(rv) >= SVt_RV);
4303         } else {
4304                 sv_upgrade(rv, SVt_RV);
4305         }
4306
4307         SvRV(rv) = sv;                          /* $rv = \$sv */
4308         SvROK_on(rv);
4309
4310         TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
4311
4312         return rv;
4313 }
4314
4315 /*
4316  * retrieve_weakref
4317  *
4318  * Retrieve weak reference to some other scalar.
4319  * Layout is SX_WEAKREF <object>, with SX_WEAKREF already read.
4320  */
4321 static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, char *cname)
4322 {
4323         SV *sv;
4324
4325         TRACEME(("retrieve_weakref (#%d)", cxt->tagnum));
4326
4327         sv = retrieve_ref(aTHX_ cxt, cname);
4328         if (sv) {
4329 #ifdef SvWEAKREF
4330                 sv_rvweaken(sv);
4331 #else
4332                 WEAKREF_CROAK();
4333 #endif
4334         }
4335         return sv;
4336 }
4337
4338 /*
4339  * retrieve_overloaded
4340  *
4341  * Retrieve reference to some other scalar with overloading.
4342  * Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
4343  */
4344 static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname)
4345 {
4346         SV *rv;
4347         SV *sv;
4348         HV *stash;
4349
4350         TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
4351
4352         /*
4353          * Same code as retrieve_ref(), duplicated to avoid extra call.
4354          */
4355
4356         rv = NEWSV(10002, 0);
4357         SEEN(rv, cname, 0);             /* Will return if rv is null */
4358         sv = retrieve(aTHX_ cxt, 0);    /* Retrieve <object> */
4359         if (!sv)
4360                 return (SV *) 0;        /* Failed */
4361
4362         /*
4363          * WARNING: breaks RV encapsulation.
4364          */
4365
4366         sv_upgrade(rv, SVt_RV);
4367         SvRV(rv) = sv;                          /* $rv = \$sv */
4368         SvROK_on(rv);
4369
4370         /*
4371          * Restore overloading magic.
4372          */
4373
4374         stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
4375         if (!stash) {
4376                 CROAK(("Cannot restore overloading on %s(0x%"UVxf
4377                        ") (package <unknown>)",
4378                        sv_reftype(sv, FALSE),
4379                        PTR2UV(sv)));
4380         }
4381         if (!Gv_AMG(stash)) {
4382                 SV *psv = newSVpvn("require ", 8);
4383                 const char *package = HvNAME(stash);
4384                 sv_catpv(psv, package);
4385
4386                 TRACEME(("No overloading defined for package %s", package));
4387                 TRACEME(("Going to require module '%s' with '%s'", package, SvPVX(psv)));
4388
4389                 perl_eval_sv(psv, G_DISCARD);
4390                 sv_free(psv);
4391                 if (!Gv_AMG(stash)) {
4392                         CROAK(("Cannot restore overloading on %s(0x%"UVxf
4393                                ") (package %s) (even after a \"require %s;\")",
4394                                sv_reftype(sv, FALSE),
4395                                PTR2UV(sv),
4396                                package, package));
4397                 }
4398         }
4399
4400         SvAMAGIC_on(rv);
4401
4402         TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
4403
4404         return rv;
4405 }
4406
4407 /*
4408  * retrieve_weakoverloaded
4409  *
4410  * Retrieve weak overloaded reference to some other scalar.
4411  * Layout is SX_WEAKOVERLOADED <object>, with SX_WEAKOVERLOADED already read.
4412  */
4413 static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, char *cname)
4414 {
4415         SV *sv;
4416
4417         TRACEME(("retrieve_weakoverloaded (#%d)", cxt->tagnum));
4418
4419         sv = retrieve_overloaded(aTHX_ cxt, cname);
4420         if (sv) {
4421 #ifdef SvWEAKREF
4422                 sv_rvweaken(sv);
4423 #else
4424                 WEAKREF_CROAK();
4425 #endif
4426         }
4427         return sv;
4428 }
4429
4430 /*
4431  * retrieve_tied_array
4432  *
4433  * Retrieve tied array
4434  * Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
4435  */
4436 static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname)
4437 {
4438         SV *tv;
4439         SV *sv;
4440
4441         TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
4442
4443         tv = NEWSV(10002, 0);
4444         SEEN(tv, cname, 0);                     /* Will return if tv is null */
4445         sv = retrieve(aTHX_ cxt, 0);            /* Retrieve <object> */
4446         if (!sv)
4447                 return (SV *) 0;                /* Failed */
4448
4449         sv_upgrade(tv, SVt_PVAV);
4450         AvREAL_off((AV *)tv);
4451         sv_magic(tv, sv, 'P', Nullch, 0);
4452         SvREFCNT_dec(sv);                       /* Undo refcnt inc from sv_magic() */
4453
4454         TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
4455
4456         return tv;
4457 }
4458
4459 /*
4460  * retrieve_tied_hash
4461  *
4462  * Retrieve tied hash
4463  * Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
4464  */
4465 static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname)
4466 {
4467         SV *tv;
4468         SV *sv;
4469
4470         TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
4471
4472         tv = NEWSV(10002, 0);
4473         SEEN(tv, cname, 0);                     /* Will return if tv is null */
4474         sv = retrieve(aTHX_ cxt, 0);            /* Retrieve <object> */
4475         if (!sv)
4476                 return (SV *) 0;                /* Failed */
4477
4478         sv_upgrade(tv, SVt_PVHV);
4479         sv_magic(tv, sv, 'P', Nullch, 0);
4480         SvREFCNT_dec(sv);                       /* Undo refcnt inc from sv_magic() */
4481
4482         TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
4483
4484         return tv;
4485 }
4486
4487 /*
4488  * retrieve_tied_scalar
4489  *
4490  * Retrieve tied scalar
4491  * Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
4492  */
4493 static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname)
4494 {
4495         SV *tv;
4496         SV *sv, *obj = NULL;
4497
4498         TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
4499
4500         tv = NEWSV(10002, 0);
4501         SEEN(tv, cname, 0);                     /* Will return if rv is null */
4502         sv = retrieve(aTHX_ cxt, 0);            /* Retrieve <object> */
4503         if (!sv) {
4504                 return (SV *) 0;                /* Failed */
4505         }
4506         else if (SvTYPE(sv) != SVt_NULL) {
4507                 obj = sv;
4508         }
4509
4510         sv_upgrade(tv, SVt_PVMG);
4511         sv_magic(tv, obj, 'q', Nullch, 0);
4512
4513         if (obj) {
4514                 /* Undo refcnt inc from sv_magic() */
4515                 SvREFCNT_dec(obj);
4516         }
4517
4518         TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
4519
4520         return tv;
4521 }
4522
4523 /*
4524  * retrieve_tied_key
4525  *
4526  * Retrieve reference to value in a tied hash.
4527  * Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
4528  */
4529 static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname)
4530 {
4531         SV *tv;
4532         SV *sv;
4533         SV *key;
4534
4535         TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
4536
4537         tv = NEWSV(10002, 0);
4538         SEEN(tv, cname, 0);                     /* Will return if tv is null */
4539         sv = retrieve(aTHX_ cxt, 0);            /* Retrieve <object> */
4540         if (!sv)
4541                 return (SV *) 0;                /* Failed */
4542
4543         key = retrieve(aTHX_ cxt, 0);           /* Retrieve <key> */
4544         if (!key)
4545                 return (SV *) 0;                /* Failed */
4546
4547         sv_upgrade(tv, SVt_PVMG);
4548         sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
4549         SvREFCNT_dec(key);                      /* Undo refcnt inc from sv_magic() */
4550         SvREFCNT_dec(sv);                       /* Undo refcnt inc from sv_magic() */
4551
4552         return tv;
4553 }
4554
4555 /*
4556  * retrieve_tied_idx
4557  *
4558  * Retrieve reference to value in a tied array.
4559  * Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
4560  */
4561 static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname)
4562 {
4563         SV *tv;
4564         SV *sv;
4565         I32 idx;
4566
4567         TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
4568
4569         tv = NEWSV(10002, 0);
4570         SEEN(tv, cname, 0);                     /* Will return if tv is null */
4571         sv = retrieve(aTHX_ cxt, 0);            /* Retrieve <object> */
4572         if (!sv)
4573                 return (SV *) 0;                /* Failed */
4574
4575         RLEN(idx);                                      /* Retrieve <idx> */
4576
4577         sv_upgrade(tv, SVt_PVMG);
4578         sv_magic(tv, sv, 'p', Nullch, idx);
4579         SvREFCNT_dec(sv);                       /* Undo refcnt inc from sv_magic() */
4580
4581         return tv;
4582 }
4583
4584
4585 /*
4586  * retrieve_lscalar
4587  *
4588  * Retrieve defined long (string) scalar.
4589  *
4590  * Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
4591  * The scalar is "long" in that <length> is larger than LG_SCALAR so it
4592  * was not stored on a single byte.
4593  */
4594 static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname)
4595 {
4596         I32 len;
4597         SV *sv;
4598
4599         RLEN(len);
4600         TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
4601
4602         /*
4603          * Allocate an empty scalar of the suitable length.
4604          */
4605
4606         sv = NEWSV(10002, len);
4607         SEEN(sv, cname, 0);     /* Associate this new scalar with tag "tagnum" */
4608
4609         /*
4610          * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4611          *
4612          * Now, for efficiency reasons, read data directly inside the SV buffer,
4613          * and perform the SV final settings directly by duplicating the final
4614          * work done by sv_setpv. Since we're going to allocate lots of scalars
4615          * this way, it's worth the hassle and risk.
4616          */
4617
4618         SAFEREAD(SvPVX(sv), len, sv);
4619         SvCUR_set(sv, len);                             /* Record C string length */
4620         *SvEND(sv) = '\0';                              /* Ensure it's null terminated anyway */
4621         (void) SvPOK_only(sv);                  /* Validate string pointer */
4622         if (cxt->s_tainted)                             /* Is input source tainted? */
4623                 SvTAINT(sv);                            /* External data cannot be trusted */
4624
4625         TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
4626         TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
4627
4628         return sv;
4629 }
4630
4631 /*
4632  * retrieve_scalar
4633  *
4634  * Retrieve defined short (string) scalar.
4635  *
4636  * Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
4637  * The scalar is "short" so <length> is single byte. If it is 0, there
4638  * is no <data> section.
4639  */
4640 static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname)
4641 {
4642         int len;
4643         SV *sv;
4644
4645         GETMARK(len);
4646         TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
4647
4648         /*
4649          * Allocate an empty scalar of the suitable length.
4650          */
4651
4652         sv = NEWSV(10002, len);
4653         SEEN(sv, cname, 0);     /* Associate this new scalar with tag "tagnum" */
4654
4655         /*
4656          * WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
4657          */
4658
4659         if (len == 0) {
4660                 /*
4661                  * newSV did not upgrade to SVt_PV so the scalar is undefined.
4662                  * To make it defined with an empty length, upgrade it now...
4663                  * Don't upgrade to a PV if the original type contains more
4664                  * information than a scalar.
4665                  */
4666                 if (SvTYPE(sv) <= SVt_PV) {
4667                         sv_upgrade(sv, SVt_PV);
4668                 }
4669                 SvGROW(sv, 1);
4670                 *SvEND(sv) = '\0';                      /* Ensure it's null terminated anyway */
4671                 TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
4672         } else {
4673                 /*
4674                  * Now, for efficiency reasons, read data directly inside the SV buffer,
4675                  * and perform the SV final settings directly by duplicating the final
4676                  * work done by sv_setpv. Since we're going to allocate lots of scalars
4677                  * this way, it's worth the hassle and risk.
4678                  */
4679                 SAFEREAD(SvPVX(sv), len, sv);
4680                 SvCUR_set(sv, len);                     /* Record C string length */
4681                 *SvEND(sv) = '\0';                      /* Ensure it's null terminated anyway */
4682                 TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
4683         }
4684
4685         (void) SvPOK_only(sv);                  /* Validate string pointer */
4686         if (cxt->s_tainted)                             /* Is input source tainted? */
4687                 SvTAINT(sv);                            /* External data cannot be trusted */
4688
4689         TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
4690         return sv;
4691 }
4692
4693 /*
4694  * retrieve_utf8str
4695  *
4696  * Like retrieve_scalar(), but tag result as utf8.
4697  * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4698  */
4699 static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname)
4700 {
4701     SV *sv;
4702
4703     TRACEME(("retrieve_utf8str"));
4704
4705     sv = retrieve_scalar(aTHX_ cxt, cname);
4706     if (sv) {
4707 #ifdef HAS_UTF8_SCALARS
4708         SvUTF8_on(sv);
4709 #else
4710         if (cxt->use_bytes < 0)
4711             cxt->use_bytes
4712                 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4713                    ? 1 : 0);
4714         if (cxt->use_bytes == 0)
4715             UTF8_CROAK();
4716 #endif
4717     }
4718
4719     return sv;
4720 }
4721
4722 /*
4723  * retrieve_lutf8str
4724  *
4725  * Like retrieve_lscalar(), but tag result as utf8.
4726  * If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
4727  */
4728 static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname)
4729 {
4730     SV *sv;
4731
4732     TRACEME(("retrieve_lutf8str"));
4733
4734     sv = retrieve_lscalar(aTHX_ cxt, cname);
4735     if (sv) {
4736 #ifdef HAS_UTF8_SCALARS
4737         SvUTF8_on(sv);
4738 #else
4739         if (cxt->use_bytes < 0)
4740             cxt->use_bytes
4741                 = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
4742                    ? 1 : 0);
4743         if (cxt->use_bytes == 0)
4744             UTF8_CROAK();
4745 #endif
4746     }
4747     return sv;
4748 }
4749
4750 /*
4751  * retrieve_integer
4752  *
4753  * Retrieve defined integer.
4754  * Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
4755  */
4756 static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname)
4757 {
4758         SV *sv;
4759         IV iv;
4760
4761         TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
4762
4763         READ(&iv, sizeof(iv));
4764         sv = newSViv(iv);
4765         SEEN(sv, cname, 0);     /* Associate this new scalar with tag "tagnum" */
4766
4767         TRACEME(("integer %"IVdf, iv));
4768         TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
4769
4770         return sv;
4771 }
4772
4773 /*
4774  * retrieve_netint
4775  *
4776  * Retrieve defined integer in network order.
4777  * Layout is SX_NETINT <data>, whith SX_NETINT already read.
4778  */
4779 static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname)
4780 {
4781         SV *sv;
4782         I32 iv;
4783
4784         TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
4785
4786         READ_I32(iv);
4787 #ifdef HAS_NTOHL
4788         sv = newSViv((int) ntohl(iv));
4789         TRACEME(("network integer %d", (int) ntohl(iv)));
4790 #else
4791         sv = newSViv(iv);
4792         TRACEME(("network integer (as-is) %d", iv));
4793 #endif
4794         SEEN(sv, cname, 0);     /* Associate this new scalar with tag "tagnum" */
4795
4796         TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
4797
4798         return sv;
4799 }
4800
4801 /*
4802  * retrieve_double
4803  *
4804  * Retrieve defined double.
4805  * Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
4806  */
4807 static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname)
4808 {
4809         SV *sv;
4810         NV nv;
4811
4812         TRACEME(("retrieve_double (#%d)", cxt->tagnum));
4813
4814         READ(&nv, sizeof(nv));
4815         sv = newSVnv(nv);
4816         SEEN(sv, cname, 0);     /* Associate this new scalar with tag "tagnum" */
4817
4818         TRACEME(("double %"NVff, nv));
4819         TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
4820
4821         return sv;
4822 }
4823
4824 /*
4825  * retrieve_byte
4826  *
4827  * Retrieve defined byte (small integer within the [-128, +127] range).
4828  * Layout is SX_BYTE <data>, whith SX_BYTE already read.
4829  */
4830 static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname)
4831 {
4832         SV *sv;
4833         int siv;
4834         signed char tmp;        /* Workaround for AIX cc bug --H.Merijn Brand */
4835
4836         TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
4837
4838         GETMARK(siv);
4839         TRACEME(("small integer read as %d", (unsigned char) siv));
4840         tmp = (unsigned char) siv - 128;
4841         sv = newSViv(tmp);
4842         SEEN(sv, cname, 0);     /* Associate this new scalar with tag "tagnum" */
4843
4844         TRACEME(("byte %d", tmp));
4845         TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
4846
4847         return sv;
4848 }
4849
4850 /*
4851  * retrieve_undef
4852  *
4853  * Return the undefined value.
4854  */
4855 static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname)
4856 {
4857         SV* sv;
4858
4859         TRACEME(("retrieve_undef"));
4860
4861         sv = newSV(0);
4862         SEEN(sv, cname, 0);
4863
4864         return sv;
4865 }
4866
4867 /*
4868  * retrieve_sv_undef
4869  *
4870  * Return the immortal undefined value.
4871  */
4872 static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname)
4873 {
4874         SV *sv = &PL_sv_undef;
4875
4876         TRACEME(("retrieve_sv_undef"));
4877
4878         /* Special case PL_sv_undef, as av_fetch uses it internally to mark
4879            deleted elements, and will return NULL (fetch failed) whenever it
4880            is fetched.  */
4881         if (cxt->where_is_undef == -1) {
4882                 cxt->where_is_undef = cxt->tagnum;
4883         }
4884         SEEN(sv, cname, 1);
4885         return sv;
4886 }
4887
4888 /*
4889  * retrieve_sv_yes
4890  *
4891  * Return the immortal yes value.
4892  */
4893 static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname)
4894 {
4895         SV *sv = &PL_sv_yes;
4896
4897         TRACEME(("retrieve_sv_yes"));
4898
4899         SEEN(sv, cname, 1);
4900         return sv;
4901 }
4902
4903 /*
4904  * retrieve_sv_no
4905  *
4906  * Return the immortal no value.
4907  */
4908 static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname)
4909 {
4910         SV *sv = &PL_sv_no;
4911
4912         TRACEME(("retrieve_sv_no"));
4913
4914         SEEN(sv, cname, 1);
4915         return sv;
4916 }
4917
4918 /*
4919  * retrieve_array
4920  *
4921  * Retrieve a whole array.
4922  * Layout is SX_ARRAY <size> followed by each item, in increading index order.
4923  * Each item is stored as <object>.
4924  *
4925  * When we come here, SX_ARRAY has been read already.
4926  */
4927 static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname)
4928 {
4929         I32 len;
4930         I32 i;
4931         AV *av;
4932         SV *sv;
4933
4934         TRACEME(("retrieve_array (#%d)", cxt->tagnum));
4935
4936         /*
4937          * Read length, and allocate array, then pre-extend it.
4938          */
4939
4940         RLEN(len);
4941         TRACEME(("size = %d", len));
4942         av = newAV();
4943         SEEN(av, cname, 0);                     /* Will return if array not allocated nicely */
4944         if (len)
4945                 av_extend(av, len);
4946         else
4947                 return (SV *) av;               /* No data follow if array is empty */
4948
4949         /*
4950          * Now get each item in turn...
4951          */
4952
4953         for (i = 0; i < len; i++) {
4954                 TRACEME(("(#%d) item", i));
4955                 sv = retrieve(aTHX_ cxt, 0);                    /* Retrieve item */
4956                 if (!sv)
4957                         return (SV *) 0;
4958                 if (av_store(av, i, sv) == 0)
4959                         return (SV *) 0;
4960         }
4961
4962         TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
4963
4964         return (SV *) av;
4965 }
4966
4967 /*
4968  * retrieve_hash
4969  *
4970  * Retrieve a whole hash table.
4971  * Layout is SX_HASH <size> followed by each key/value pair, in random order.
4972  * Keys are stored as <length> <data>, the <data> section being omitted
4973  * if length is 0.
4974  * Values are stored as <object>.
4975  *
4976  * When we come here, SX_HASH has been read already.
4977  */
4978 static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname)
4979 {
4980         I32 len;
4981         I32 size;
4982         I32 i;
4983         HV *hv;
4984         SV *sv;
4985
4986         TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
4987
4988         /*
4989          * Read length, allocate table.
4990          */
4991
4992         RLEN(len);
4993         TRACEME(("size = %d", len));
4994         hv = newHV();
4995         SEEN(hv, cname, 0);             /* Will return if table not allocated properly */
4996         if (len == 0)
4997                 return (SV *) hv;       /* No data follow if table empty */
4998         hv_ksplit(hv, len);             /* pre-extend hash to save multiple splits */
4999
5000         /*
5001          * Now get each key/value pair in turn...
5002          */
5003
5004         for (i = 0; i < len; i++) {
5005                 /*
5006                  * Get value first.
5007                  */
5008
5009                 TRACEME(("(#%d) value", i));
5010                 sv = retrieve(aTHX_ cxt, 0);
5011                 if (!sv)
5012                         return (SV *) 0;
5013
5014                 /*
5015                  * Get key.
5016                  * Since we're reading into kbuf, we must ensure we're not
5017                  * recursing between the read and the hv_store() where it's used.
5018                  * Hence the key comes after the value.
5019                  */
5020
5021                 RLEN(size);                                             /* Get key size */
5022                 KBUFCHK((STRLEN)size);                                  /* Grow hash key read pool if needed */
5023                 if (size)
5024                         READ(kbuf, size);
5025                 kbuf[size] = '\0';                              /* Mark string end, just in case */
5026                 TRACEME(("(#%d) key '%s'", i, kbuf));
5027
5028                 /*
5029                  * Enter key/value pair into hash table.
5030                  */
5031
5032                 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5033                         return (SV *) 0;
5034         }
5035
5036         TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5037
5038         return (SV *) hv;
5039 }
5040
5041 /*
5042  * retrieve_hash
5043  *
5044  * Retrieve a whole hash table.
5045  * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5046  * Keys are stored as <length> <data>, the <data> section being omitted
5047  * if length is 0.
5048  * Values are stored as <object>.
5049  *
5050  * When we come here, SX_HASH has been read already.
5051  */
5052 static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname)
5053 {
5054     I32 len;
5055     I32 size;
5056     I32 i;
5057     HV *hv;
5058     SV *sv;
5059     int hash_flags;
5060
5061     GETMARK(hash_flags);
5062     TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
5063     /*
5064      * Read length, allocate table.
5065      */
5066
5067 #ifndef HAS_RESTRICTED_HASHES
5068     if (hash_flags & SHV_RESTRICTED) {
5069         if (cxt->derestrict < 0)
5070             cxt->derestrict
5071                 = (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
5072                    ? 1 : 0);
5073         if (cxt->derestrict == 0)
5074             RESTRICTED_HASH_CROAK();
5075     }
5076 #endif
5077
5078     RLEN(len);
5079     TRACEME(("size = %d, flags = %d", len, hash_flags));
5080     hv = newHV();
5081     SEEN(hv, cname, 0);         /* Will return if table not allocated properly */
5082     if (len == 0)
5083         return (SV *) hv;       /* No data follow if table empty */
5084     hv_ksplit(hv, len);         /* pre-extend hash to save multiple splits */
5085
5086     /*
5087      * Now get each key/value pair in turn...
5088      */
5089
5090     for (i = 0; i < len; i++) {
5091         int flags;
5092         int store_flags = 0;
5093         /*
5094          * Get value first.
5095          */
5096
5097         TRACEME(("(#%d) value", i));
5098         sv = retrieve(aTHX_ cxt, 0);
5099         if (!sv)
5100             return (SV *) 0;
5101
5102         GETMARK(flags);
5103 #ifdef HAS_RESTRICTED_HASHES
5104         if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
5105             SvREADONLY_on(sv);
5106 #endif
5107
5108         if (flags & SHV_K_ISSV) {
5109             /* XXX you can't set a placeholder with an SV key.
5110                Then again, you can't get an SV key.
5111                Without messing around beyond what the API is supposed to do.
5112             */
5113             SV *keysv;
5114             TRACEME(("(#%d) keysv, flags=%d", i, flags));
5115             keysv = retrieve(aTHX_ cxt, 0);
5116             if (!keysv)
5117                 return (SV *) 0;
5118
5119             if (!hv_store_ent(hv, keysv, sv, 0))
5120                 return (SV *) 0;
5121         } else {
5122             /*
5123              * Get key.
5124              * Since we're reading into kbuf, we must ensure we're not
5125              * recursing between the read and the hv_store() where it's used.
5126              * Hence the key comes after the value.
5127              */
5128
5129             if (flags & SHV_K_PLACEHOLDER) {
5130                 SvREFCNT_dec (sv);
5131                 sv = &PL_sv_placeholder;
5132                 store_flags |= HVhek_PLACEHOLD;
5133             }
5134             if (flags & SHV_K_UTF8) {
5135 #ifdef HAS_UTF8_HASHES
5136                 store_flags |= HVhek_UTF8;
5137 #else
5138                 if (cxt->use_bytes < 0)
5139                     cxt->use_bytes
5140                         = (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
5141                            ? 1 : 0);
5142                 if (cxt->use_bytes == 0)
5143                     UTF8_CROAK();
5144 #endif
5145             }
5146 #ifdef HAS_UTF8_HASHES
5147             if (flags & SHV_K_WASUTF8)
5148                 store_flags |= HVhek_WASUTF8;
5149 #endif
5150
5151             RLEN(size);                                         /* Get key size */
5152             KBUFCHK((STRLEN)size);                              /* Grow hash key read pool if needed */
5153             if (size)
5154                 READ(kbuf, size);
5155             kbuf[size] = '\0';                          /* Mark string end, just in case */
5156             TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
5157                      flags, store_flags));
5158
5159             /*
5160              * Enter key/value pair into hash table.
5161              */
5162
5163 #ifdef HAS_RESTRICTED_HASHES
5164             if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
5165                 return (SV *) 0;
5166 #else
5167             if (!(store_flags & HVhek_PLACEHOLD))
5168                 if (hv_store(hv, kbuf, size, sv, 0) == 0)
5169                     return (SV *) 0;
5170 #endif
5171         }
5172     }
5173 #ifdef HAS_RESTRICTED_HASHES
5174     if (hash_flags & SHV_RESTRICTED)
5175         SvREADONLY_on(hv);
5176 #endif
5177
5178     TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5179
5180     return (SV *) hv;
5181 }
5182
5183 /*
5184  * retrieve_code
5185  *
5186  * Return a code reference.
5187  */
5188 static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname)
5189 {
5190 #if PERL_VERSION < 6
5191     CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
5192 #else
5193         dSP;
5194         int type, count, tagnum;
5195         SV *cv;
5196         SV *sv, *text, *sub;
5197
5198         TRACEME(("retrieve_code (#%d)", cxt->tagnum));
5199
5200         /*
5201          *  Insert dummy SV in the aseen array so that we don't screw
5202          *  up the tag numbers.  We would just make the internal
5203          *  scalar an untagged item in the stream, but
5204          *  retrieve_scalar() calls SEEN().  So we just increase the
5205          *  tag number.
5206          */
5207         tagnum = cxt->tagnum;
5208         sv = newSViv(0);
5209         SEEN(sv, cname, 0);
5210
5211         /*
5212          * Retrieve the source of the code reference
5213          * as a small or large scalar
5214          */
5215
5216         GETMARK(type);
5217         switch (type) {
5218         case SX_SCALAR:
5219                 text = retrieve_scalar(aTHX_ cxt, cname);
5220                 break;
5221         case SX_LSCALAR:
5222                 text = retrieve_lscalar(aTHX_ cxt, cname);
5223                 break;
5224         default:
5225                 CROAK(("Unexpected type %d in retrieve_code\n", type));
5226         }
5227
5228         /*
5229          * prepend "sub " to the source
5230          */
5231
5232         sub = newSVpvn("sub ", 4);
5233         sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
5234         SvREFCNT_dec(text);
5235
5236         /*
5237          * evaluate the source to a code reference and use the CV value
5238          */
5239
5240         if (cxt->eval == NULL) {
5241                 cxt->eval = perl_get_sv("Storable::Eval", TRUE);
5242                 SvREFCNT_inc(cxt->eval);
5243         }
5244         if (!SvTRUE(cxt->eval)) {
5245                 if (
5246                         cxt->forgive_me == 0 ||
5247                         (cxt->forgive_me < 0 && !(cxt->forgive_me =
5248                                 SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
5249                 ) {
5250                         CROAK(("Can't eval, please set $Storable::Eval to a true value"));
5251                 } else {
5252                         sv = newSVsv(sub);
5253                         /* fix up the dummy entry... */
5254                         av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5255                         return sv;
5256                 }
5257         }
5258
5259         ENTER;
5260         SAVETMPS;
5261
5262         if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
5263                 SV* errsv = get_sv("@", TRUE);
5264                 sv_setpv(errsv, "");                                    /* clear $@ */
5265                 PUSHMARK(sp);
5266                 XPUSHs(sv_2mortal(newSVsv(sub)));
5267                 PUTBACK;
5268                 count = call_sv(cxt->eval, G_SCALAR);
5269                 SPAGAIN;
5270                 if (count != 1)
5271                         CROAK(("Unexpected return value from $Storable::Eval callback\n"));
5272                 cv = POPs;
5273                 if (SvTRUE(errsv)) {
5274                         CROAK(("code %s caused an error: %s",
5275                                 SvPV_nolen(sub), SvPV_nolen(errsv)));
5276                 }
5277                 PUTBACK;
5278         } else {
5279                 cv = eval_pv(SvPV_nolen(sub), TRUE);
5280         }
5281         if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
5282             sv = SvRV(cv);
5283         } else {
5284             CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
5285         }
5286
5287         SvREFCNT_inc(sv); /* XXX seems to be necessary */
5288         SvREFCNT_dec(sub);
5289
5290         FREETMPS;
5291         LEAVE;
5292         /* fix up the dummy entry... */
5293         av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
5294
5295         return sv;
5296 #endif
5297 }
5298
5299 /*
5300  * old_retrieve_array
5301  *
5302  * Retrieve a whole array in pre-0.6 binary format.
5303  *
5304  * Layout is SX_ARRAY <size> followed by each item, in increading index order.
5305  * Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
5306  *
5307  * When we come here, SX_ARRAY has been read already.
5308  */
5309 static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname)
5310 {
5311         I32 len;
5312         I32 i;
5313         AV *av;
5314         SV *sv;
5315         int c;
5316
5317         TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
5318
5319         /*
5320          * Read length, and allocate array, then pre-extend it.
5321          */
5322
5323         RLEN(len);
5324         TRACEME(("size = %d", len));
5325         av = newAV();
5326         SEEN(av, 0, 0);                         /* Will return if array not allocated nicely */
5327         if (len)
5328                 av_extend(av, len);
5329         else
5330                 return (SV *) av;               /* No data follow if array is empty */
5331
5332         /*
5333          * Now get each item in turn...
5334          */
5335
5336         for (i = 0; i < len; i++) {
5337                 GETMARK(c);
5338                 if (c == SX_IT_UNDEF) {
5339                         TRACEME(("(#%d) undef item", i));
5340                         continue;                       /* av_extend() already filled us with undef */
5341                 }
5342                 if (c != SX_ITEM)
5343                         (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0);  /* Will croak out */
5344                 TRACEME(("(#%d) item", i));
5345                 sv = retrieve(aTHX_ cxt, 0);                                            /* Retrieve item */
5346                 if (!sv)
5347                         return (SV *) 0;
5348                 if (av_store(av, i, sv) == 0)
5349                         return (SV *) 0;
5350         }
5351
5352         TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
5353
5354         return (SV *) av;
5355 }
5356
5357 /*
5358  * old_retrieve_hash
5359  *
5360  * Retrieve a whole hash table in pre-0.6 binary format.
5361  *
5362  * Layout is SX_HASH <size> followed by each key/value pair, in random order.
5363  * Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
5364  * if length is 0.
5365  * Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
5366  *
5367  * When we come here, SX_HASH has been read already.
5368  */
5369 static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname)
5370 {
5371         I32 len;
5372         I32 size;
5373         I32 i;
5374         HV *hv;
5375         SV *sv = (SV *) 0;
5376         int c;
5377         static SV *sv_h_undef = (SV *) 0;               /* hv_store() bug */
5378
5379         TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
5380
5381         /*
5382          * Read length, allocate table.
5383          */
5384
5385         RLEN(len);
5386         TRACEME(("size = %d", len));
5387         hv = newHV();
5388         SEEN(hv, 0, 0);                 /* Will return if table not allocated properly */
5389         if (len == 0)
5390                 return (SV *) hv;       /* No data follow if table empty */
5391         hv_ksplit(hv, len);             /* pre-extend hash to save multiple splits */
5392
5393         /*
5394          * Now get each key/value pair in turn...
5395          */
5396
5397         for (i = 0; i < len; i++) {
5398                 /*
5399                  * Get value first.
5400                  */
5401
5402                 GETMARK(c);
5403                 if (c == SX_VL_UNDEF) {
5404                         TRACEME(("(#%d) undef value", i));
5405                         /*
5406                          * Due to a bug in hv_store(), it's not possible to pass
5407                          * &PL_sv_undef to hv_store() as a value, otherwise the
5408                          * associated key will not be creatable any more. -- RAM, 14/01/97
5409                          */
5410                         if (!sv_h_undef)
5411                                 sv_h_undef = newSVsv(&PL_sv_undef);
5412                         sv = SvREFCNT_inc(sv_h_undef);
5413                 } else if (c == SX_VALUE) {
5414                         TRACEME(("(#%d) value", i));
5415                         sv = retrieve(aTHX_ cxt, 0);
5416                         if (!sv)
5417                                 return (SV *) 0;
5418                 } else
5419                         (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0);  /* Will croak out */
5420
5421                 /*
5422                  * Get key.
5423                  * Since we're reading into kbuf, we must ensure we're not
5424                  * recursing between the read and the hv_store() where it's used.
5425                  * Hence the key comes after the value.
5426                  */
5427
5428                 GETMARK(c);
5429                 if (c != SX_KEY)
5430                         (void) retrieve_other(aTHX_ (stcxt_t *) 0, 0);  /* Will croak out */
5431                 RLEN(size);                                             /* Get key size */
5432                 KBUFCHK((STRLEN)size);                                  /* Grow hash key read pool if needed */
5433                 if (size)
5434                         READ(kbuf, size);
5435                 kbuf[size] = '\0';                              /* Mark string end, just in case */
5436                 TRACEME(("(#%d) key '%s'", i, kbuf));
5437
5438                 /*
5439                  * Enter key/value pair into hash table.
5440                  */
5441
5442                 if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
5443                         return (SV *) 0;
5444         }
5445
5446         TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
5447
5448         return (SV *) hv;
5449 }
5450
5451 /***
5452  *** Retrieval engine.
5453  ***/
5454
5455 /*
5456  * magic_check
5457  *
5458  * Make sure the stored data we're trying to retrieve has been produced
5459  * on an ILP compatible system with the same byteorder. It croaks out in
5460  * case an error is detected. [ILP = integer-long-pointer sizes]
5461  * Returns null if error is detected, &PL_sv_undef otherwise.
5462  *
5463  * Note that there's no byte ordering info emitted when network order was
5464  * used at store time.
5465  */
5466 static SV *magic_check(pTHX_ stcxt_t *cxt)
5467 {
5468     /* The worst case for a malicious header would be old magic (which is
5469        longer), major, minor, byteorder length byte of 255, 255 bytes of
5470        garbage, sizeof int, long, pointer, NV.
5471        So the worse of that we can read is 255 bytes of garbage plus 4.
5472        Err, I am assuming 8 bit bytes here. Please file a bug report if you're
5473        compiling perl on a system with chars that are larger than 8 bits.
5474        (Even Crays aren't *that* perverse).
5475     */
5476     unsigned char buf[4 + 255];
5477     unsigned char *current;
5478     int c;
5479     int length;
5480     int use_network_order;
5481     int use_NV_size;
5482     int version_major;
5483     int version_minor = 0;
5484
5485     TRACEME(("magic_check"));
5486
5487     /*
5488      * The "magic number" is only for files, not when freezing in memory.
5489      */
5490
5491     if (cxt->fio) {
5492         /* This includes the '\0' at the end.  I want to read the extra byte,
5493            which is usually going to be the major version number.  */
5494         STRLEN len = sizeof(magicstr);
5495         STRLEN old_len;
5496
5497         READ(buf, (SSize_t)(len));      /* Not null-terminated */
5498
5499         /* Point at the byte after the byte we read.  */
5500         current = buf + --len;  /* Do the -- outside of macros.  */
5501
5502         if (memNE(buf, magicstr, len)) {
5503             /*
5504              * Try to read more bytes to check for the old magic number, which
5505              * was longer.
5506              */
5507
5508             TRACEME(("trying for old magic number"));
5509
5510             old_len = sizeof(old_magicstr) - 1;
5511             READ(current + 1, (SSize_t)(old_len - len));
5512
5513             if (memNE(buf, old_magicstr, old_len))
5514                 CROAK(("File is not a perl storable"));
5515             current = buf + old_len;
5516         }
5517         use_network_order = *current;
5518     } else
5519         GETMARK(use_network_order);
5520
5521     /*
5522      * Starting with 0.6, the "use_network_order" byte flag is also used to
5523      * indicate the version number of the binary, and therefore governs the
5524      * setting of sv_retrieve_vtbl. See magic_write().
5525      */
5526
5527     version_major = use_network_order >> 1;
5528     cxt->retrieve_vtbl = version_major ? sv_retrieve : sv_old_retrieve;
5529
5530     TRACEME(("magic_check: netorder = 0x%x", use_network_order));
5531
5532
5533     /*
5534      * Starting with 0.7 (binary major 2), a full byte is dedicated to the
5535      * minor version of the protocol.  See magic_write().
5536      */
5537
5538     if (version_major > 1)
5539         GETMARK(version_minor);
5540
5541     cxt->ver_major = version_major;
5542     cxt->ver_minor = version_minor;
5543
5544     TRACEME(("binary image version is %d.%d", version_major, version_minor));
5545
5546     /*
5547      * Inter-operability sanity check: we can't retrieve something stored
5548      * using a format more recent than ours, because we have no way to
5549      * know what has changed, and letting retrieval go would mean a probable
5550      * failure reporting a "corrupted" storable file.
5551      */
5552
5553     if (
5554         version_major > STORABLE_BIN_MAJOR ||
5555         (version_major == STORABLE_BIN_MAJOR &&
5556          version_minor > STORABLE_BIN_MINOR)
5557         ) {
5558         int croak_now = 1;
5559         TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
5560                  STORABLE_BIN_MINOR));
5561
5562         if (version_major == STORABLE_BIN_MAJOR) {
5563             TRACEME(("cxt->accept_future_minor is %d",
5564                      cxt->accept_future_minor));
5565             if (cxt->accept_future_minor < 0)
5566                 cxt->accept_future_minor
5567                     = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5568                                           TRUE))
5569                        ? 1 : 0);
5570             if (cxt->accept_future_minor == 1)
5571                 croak_now = 0;  /* Don't croak yet.  */
5572         }
5573         if (croak_now) {
5574             CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
5575                    version_major, version_minor,
5576                    STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
5577         }
5578     }
5579
5580     /*
5581      * If they stored using network order, there's no byte ordering
5582      * information to check.
5583      */
5584
5585     if ((cxt->netorder = (use_network_order & 0x1)))    /* Extra () for -Wall */
5586         return &PL_sv_undef;                    /* No byte ordering info */
5587
5588     /* In C truth is 1, falsehood is 0. Very convienient.  */
5589     use_NV_size = version_major >= 2 && version_minor >= 2;
5590
5591     GETMARK(c);
5592     length = c + 3 + use_NV_size;
5593     READ(buf, length);  /* Not null-terminated */
5594
5595     TRACEME(("byte order '%.*s' %d", c, buf, c));
5596
5597 #ifdef USE_56_INTERWORK_KLUDGE
5598     /* No point in caching this in the context as we only need it once per
5599        retrieve, and we need to recheck it each read.  */
5600     if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
5601         if ((c != (sizeof (byteorderstr_56) - 1))
5602             || memNE(buf, byteorderstr_56, c))
5603             CROAK(("Byte order is not compatible"));
5604     } else
5605 #endif
5606     {
5607         if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
5608             CROAK(("Byte order is not compatible"));
5609     }
5610
5611     current = buf + c;
5612
5613     /* sizeof(int) */
5614     if ((int) *current++ != sizeof(int))
5615         CROAK(("Integer size is not compatible"));
5616
5617     /* sizeof(long) */
5618     if ((int) *current++ != sizeof(long))
5619         CROAK(("Long integer size is not compatible"));
5620
5621     /* sizeof(char *) */
5622     if ((int) *current != sizeof(char *))
5623         CROAK(("Pointer size is not compatible"));
5624
5625     if (use_NV_size) {
5626         /* sizeof(NV) */
5627         if ((int) *++current != sizeof(NV))
5628             CROAK(("Double size is not compatible"));
5629     }
5630
5631     return &PL_sv_undef;        /* OK */
5632 }
5633
5634 /*
5635  * retrieve
5636  *
5637  * Recursively retrieve objects from the specified file and return their
5638  * root SV (which may be an AV or an HV for what we care).
5639  * Returns null if there is a problem.
5640  */
5641 static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname)
5642 {
5643         int type;
5644         SV **svh;
5645         SV *sv;
5646
5647         TRACEME(("retrieve"));
5648
5649         /*
5650          * Grab address tag which identifies the object if we are retrieving
5651          * an older format. Since the new binary format counts objects and no
5652          * longer explicitely tags them, we must keep track of the correspondance
5653          * ourselves.
5654          *
5655          * The following section will disappear one day when the old format is
5656          * no longer supported, hence the final "goto" in the "if" block.
5657          */
5658
5659         if (cxt->hseen) {                                               /* Retrieving old binary */
5660                 stag_t tag;
5661                 if (cxt->netorder) {
5662                         I32 nettag;
5663                         READ(&nettag, sizeof(I32));             /* Ordered sequence of I32 */
5664                         tag = (stag_t) nettag;
5665                 } else
5666                         READ(&tag, sizeof(stag_t));             /* Original address of the SV */
5667
5668                 GETMARK(type);
5669                 if (type == SX_OBJECT) {
5670                         I32 tagn;
5671                         svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
5672                         if (!svh)
5673                                 CROAK(("Old tag 0x%"UVxf" should have been mapped already",
5674                                         (UV) tag));
5675                         tagn = SvIV(*svh);      /* Mapped tag number computed earlier below */
5676
5677                         /*
5678                          * The following code is common with the SX_OBJECT case below.
5679                          */
5680
5681                         svh = av_fetch(cxt->aseen, tagn, FALSE);
5682                         if (!svh)
5683                                 CROAK(("Object #%"IVdf" should have been retrieved already",
5684                                         (IV) tagn));
5685                         sv = *svh;
5686                         TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
5687                         SvREFCNT_inc(sv);       /* One more reference to this same sv */
5688                         return sv;                      /* The SV pointer where object was retrieved */
5689                 }
5690
5691                 /*
5692                  * Map new object, but don't increase tagnum. This will be done
5693                  * by each of the retrieve_* functions when they call SEEN().
5694                  *
5695                  * The mapping associates the "tag" initially present with a unique
5696                  * tag number. See test for SX_OBJECT above to see how this is perused.
5697                  */
5698
5699                 if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
5700                                 newSViv(cxt->tagnum), 0))
5701                         return (SV *) 0;
5702
5703                 goto first_time;
5704         }
5705
5706         /*
5707          * Regular post-0.6 binary format.
5708          */
5709
5710         GETMARK(type);
5711
5712         TRACEME(("retrieve type = %d", type));
5713
5714         /*
5715          * Are we dealing with an object we should have already retrieved?
5716          */
5717
5718         if (type == SX_OBJECT) {
5719                 I32 tag;
5720                 READ_I32(tag);
5721                 tag = ntohl(tag);
5722                 svh = av_fetch(cxt->aseen, tag, FALSE);
5723                 if (!svh)
5724                         CROAK(("Object #%"IVdf" should have been retrieved already",
5725                                 (IV) tag));
5726                 sv = *svh;
5727                 TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
5728                 SvREFCNT_inc(sv);       /* One more reference to this same sv */
5729                 return sv;                      /* The SV pointer where object was retrieved */
5730         } else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
5731             if (cxt->accept_future_minor < 0)
5732                 cxt->accept_future_minor
5733                     = (SvTRUE(perl_get_sv("Storable::accept_future_minor",
5734                                           TRUE))
5735                        ? 1 : 0);
5736             if (cxt->accept_future_minor == 1) {
5737                 CROAK(("Storable binary image v%d.%d contains data of type %d. "
5738                        "This Storable is v%d.%d and can only handle data types up to %d",
5739                        cxt->ver_major, cxt->ver_minor, type,
5740                        STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
5741             }
5742         }
5743
5744 first_time:             /* Will disappear when support for old format is dropped */
5745
5746         /*
5747          * Okay, first time through for this one.
5748          */
5749
5750         sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
5751         if (!sv)
5752                 return (SV *) 0;                        /* Failed */
5753
5754         /*
5755          * Old binary formats (pre-0.7).
5756          *
5757          * Final notifications, ended by SX_STORED may now follow.
5758          * Currently, the only pertinent notification to apply on the
5759          * freshly retrieved object is either:
5760          *    SX_CLASS <char-len> <classname> for short classnames.
5761          *    SX_LG_CLASS <int-len> <classname> for larger one (rare!).
5762          * Class name is then read into the key buffer pool used by
5763          * hash table key retrieval.
5764          */
5765
5766         if (cxt->ver_major < 2) {
5767                 while ((type = GETCHAR()) != SX_STORED) {
5768                         I32 len;
5769                         switch (type) {
5770                         case SX_CLASS:
5771                                 GETMARK(len);                   /* Length coded on a single char */
5772                                 break;
5773                         case SX_LG_CLASS:                       /* Length coded on a regular integer */
5774                                 RLEN(len);
5775                                 break;
5776                         case EOF:
5777                         default:
5778                                 return (SV *) 0;                /* Failed */
5779                         }
5780                         KBUFCHK((STRLEN)len);                   /* Grow buffer as necessary */
5781                         if (len)
5782                                 READ(kbuf, len);
5783                         kbuf[len] = '\0';                       /* Mark string end */
5784                         BLESS(sv, kbuf);
5785                 }
5786         }
5787
5788         TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
5789                 SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
5790
5791         return sv;      /* Ok */
5792 }
5793
5794 /*
5795  * do_retrieve
5796  *
5797  * Retrieve data held in file and return the root object.
5798  * Common routine for pretrieve and mretrieve.
5799  */
5800 static SV *do_retrieve(
5801         pTHX_
5802         PerlIO *f,
5803         SV *in,
5804         int optype)
5805 {
5806         dSTCXT;
5807         SV *sv;
5808         int is_tainted;                         /* Is input source tainted? */
5809         int pre_06_fmt = 0;                     /* True with pre Storable 0.6 formats */
5810
5811         TRACEME(("do_retrieve (optype = 0x%x)", optype));
5812
5813         optype |= ST_RETRIEVE;
5814
5815         /*
5816          * Sanity assertions for retrieve dispatch tables.
5817          */
5818
5819         ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
5820                 ("old and new retrieve dispatch table have same size"));
5821         ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
5822                 ("SX_ERROR entry correctly initialized in old dispatch table"));
5823         ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
5824                 ("SX_ERROR entry correctly initialized in new dispatch table"));
5825
5826         /*
5827          * Workaround for CROAK leak: if they enter with a "dirty" context,
5828          * free up memory for them now.
5829          */
5830
5831         if (cxt->s_dirty)
5832                 clean_context(aTHX_ cxt);
5833
5834         /*
5835          * Now that STORABLE_xxx hooks exist, it is possible that they try to
5836          * re-enter retrieve() via the hooks.
5837          */
5838
5839         if (cxt->entry)
5840                 cxt = allocate_context(aTHX_ cxt);
5841
5842         cxt->entry++;
5843
5844         ASSERT(cxt->entry == 1, ("starting new recursion"));
5845         ASSERT(!cxt->s_dirty, ("clean context"));
5846
5847         /*
5848          * Prepare context.
5849          *
5850          * Data is loaded into the memory buffer when f is NULL, unless `in' is
5851          * also NULL, in which case we're expecting the data to already lie
5852          * in the buffer (dclone case).
5853          */
5854
5855         KBUFINIT();                                     /* Allocate hash key reading pool once */
5856
5857         if (!f && in) {
5858 #ifdef SvUTF8_on
5859                 if (SvUTF8(in)) {
5860                         STRLEN length;
5861                         const char *orig = SvPV(in, length);
5862                         char *asbytes;
5863                         /* This is quite deliberate. I want the UTF8 routines
5864                            to encounter the '\0' which perl adds at the end
5865                            of all scalars, so that any new string also has
5866                            this.
5867                         */
5868                         STRLEN klen_tmp = length + 1;
5869                         bool is_utf8 = TRUE;
5870
5871                         /* Just casting the &klen to (STRLEN) won't work
5872                            well if STRLEN and I32 are of different widths.
5873                            --jhi */
5874                         asbytes = (char*)bytes_from_utf8((U8*)orig,
5875                                                          &klen_tmp,
5876                                                          &is_utf8);
5877                         if (is_utf8) {
5878                                 CROAK(("Frozen string corrupt - contains characters outside 0-255"));
5879                         }
5880                         if (asbytes != orig) {
5881                                 /* String has been converted.
5882                                    There is no need to keep any reference to
5883                                    the old string.  */
5884                                 in = sv_newmortal();
5885                                 /* We donate the SV the malloc()ed string
5886                                    bytes_from_utf8 returned us.  */
5887                                 SvUPGRADE(in, SVt_PV);
5888                                 SvPOK_on(in);
5889                                 SvPVX(in) = asbytes;
5890                                 SvLEN(in) = klen_tmp;
5891                                 SvCUR(in) = klen_tmp - 1;
5892                         }
5893                 }
5894 #endif
5895                 MBUF_SAVE_AND_LOAD(in);
5896         }
5897
5898         /*
5899          * Magic number verifications.
5900          *
5901          * This needs to be done before calling init_retrieve_context()
5902          * since the format indication in the file are necessary to conduct
5903          * some of the initializations.
5904          */
5905
5906         cxt->fio = f;                           /* Where I/O are performed */
5907
5908         if (!magic_check(aTHX_ cxt))
5909                 CROAK(("Magic number checking on storable %s failed",
5910                         cxt->fio ? "file" : "string"));
5911
5912         TRACEME(("data stored in %s format",
5913                 cxt->netorder ? "net order" : "native"));
5914
5915         /*
5916          * Check whether input source is tainted, so that we don't wrongly
5917          * taint perfectly good values...
5918          *
5919          * We assume file input is always tainted.  If both `f' and `in' are
5920          * NULL, then we come from dclone, and tainted is already filled in
5921          * the context.  That's a kludge, but the whole dclone() thing is
5922          * already quite a kludge anyway! -- RAM, 15/09/2000.
5923          */
5924
5925         is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
5926         TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
5927         init_retrieve_context(aTHX_ cxt, optype, is_tainted);
5928
5929         ASSERT(is_retrieving(), ("within retrieve operation"));
5930
5931         sv = retrieve(aTHX_ cxt, 0);            /* Recursively retrieve object, get root SV */
5932
5933         /*
5934          * Final cleanup.
5935          */
5936
5937         if (!f && in)
5938                 MBUF_RESTORE();
5939
5940         pre_06_fmt = cxt->hseen != NULL;        /* Before we clean context */
5941
5942         /*
5943          * The "root" context is never freed.
5944          */
5945
5946         clean_retrieve_context(aTHX_ cxt);
5947         if (cxt->prev)                          /* This context was stacked */
5948                 free_context(aTHX_ cxt);                /* It was not the "root" context */
5949
5950         /*
5951          * Prepare returned value.
5952          */
5953
5954         if (!sv) {
5955                 TRACEME(("retrieve ERROR"));
5956 #if (PATCHLEVEL <= 4)
5957                 /* perl 5.00405 seems to screw up at this point with an
5958                    'attempt to modify a read only value' error reported in the
5959                    eval { $self = pretrieve(*FILE) } in _retrieve.
5960                    I can't see what the cause of this error is, but I suspect a
5961                    bug in 5.004, as it seems to be capable of issuing spurious
5962                    errors or core dumping with matches on $@. I'm not going to
5963                    spend time on what could be a fruitless search for the cause,
5964                    so here's a bodge. If you're running 5.004 and don't like
5965                    this inefficiency, either upgrade to a newer perl, or you are
5966                    welcome to find the problem and send in a patch.
5967                  */
5968                 return newSV(0);
5969 #else
5970                 return &PL_sv_undef;            /* Something went wrong, return undef */
5971 #endif
5972         }
5973
5974         TRACEME(("retrieve got %s(0x%"UVxf")",
5975                 sv_reftype(sv, FALSE), PTR2UV(sv)));
5976
5977         /*
5978          * Backward compatibility with Storable-0.5@9 (which we know we
5979          * are retrieving if hseen is non-null): don't create an extra RV
5980          * for objects since we special-cased it at store time.
5981          *
5982          * Build a reference to the SV returned by pretrieve even if it is
5983          * already one and not a scalar, for consistency reasons.
5984          */
5985
5986         if (pre_06_fmt) {                       /* Was not handling overloading by then */
5987                 SV *rv;
5988                 TRACEME(("fixing for old formats -- pre 0.6"));
5989                 if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
5990                         TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
5991                         return sv;
5992                 }
5993         }
5994
5995         /*
5996          * If reference is overloaded, restore behaviour.
5997          *
5998          * NB: minor glitch here: normally, overloaded refs are stored specially
5999          * so that we can croak when behaviour cannot be re-installed, and also
6000          * avoid testing for overloading magic at each reference retrieval.
6001          *
6002          * Unfortunately, the root reference is implicitely stored, so we must
6003          * check for possible overloading now.  Furthermore, if we don't restore
6004          * overloading, we cannot croak as if the original ref was, because we
6005          * have no way to determine whether it was an overloaded ref or not in
6006          * the first place.
6007          *
6008          * It's a pity that overloading magic is attached to the rv, and not to
6009          * the underlying sv as blessing is.
6010          */
6011
6012         if (SvOBJECT(sv)) {
6013                 HV *stash = (HV *) SvSTASH(sv);
6014                 SV *rv = newRV_noinc(sv);
6015                 if (stash && Gv_AMG(stash)) {
6016                         SvAMAGIC_on(rv);
6017                         TRACEME(("restored overloading on root reference"));
6018                 }
6019                 TRACEME(("ended do_retrieve() with an object"));
6020                 return rv;
6021         }
6022
6023         TRACEME(("regular do_retrieve() end"));
6024
6025         return newRV_noinc(sv);
6026 }
6027
6028 /*
6029  * pretrieve
6030  *
6031  * Retrieve data held in file and return the root object, undef on error.
6032  */
6033 SV *pretrieve(pTHX_ PerlIO *f)
6034 {
6035         TRACEME(("pretrieve"));
6036         return do_retrieve(aTHX_ f, Nullsv, 0);
6037 }
6038
6039 /*
6040  * mretrieve
6041  *
6042  * Retrieve data held in scalar and return the root object, undef on error.
6043  */
6044 SV *mretrieve(pTHX_ SV *sv)
6045 {
6046         TRACEME(("mretrieve"));
6047         return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
6048 }
6049
6050 /***
6051  *** Deep cloning
6052  ***/
6053
6054 /*
6055  * dclone
6056  *
6057  * Deep clone: returns a fresh copy of the original referenced SV tree.
6058  *
6059  * This is achieved by storing the object in memory and restoring from
6060  * there. Not that efficient, but it should be faster than doing it from
6061  * pure perl anyway.
6062  */
6063 SV *dclone(pTHX_ SV *sv)
6064 {
6065         dSTCXT;
6066         int size;
6067         stcxt_t *real_context;
6068         SV *out;
6069
6070         TRACEME(("dclone"));
6071
6072         /*
6073          * Workaround for CROAK leak: if they enter with a "dirty" context,
6074          * free up memory for them now.
6075          */
6076
6077         if (cxt->s_dirty)
6078                 clean_context(aTHX_ cxt);
6079
6080         /*
6081          * do_store() optimizes for dclone by not freeing its context, should
6082          * we need to allocate one because we're deep cloning from a hook.
6083          */
6084
6085         if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
6086                 return &PL_sv_undef;                            /* Error during store */
6087
6088         /*
6089          * Because of the above optimization, we have to refresh the context,
6090          * since a new one could have been allocated and stacked by do_store().
6091          */
6092
6093         { dSTCXT; real_context = cxt; }         /* Sub-block needed for macro */
6094         cxt = real_context;                                     /* And we need this temporary... */
6095
6096         /*
6097          * Now, `cxt' may refer to a new context.
6098          */
6099
6100         ASSERT(!cxt->s_dirty, ("clean context"));
6101         ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
6102
6103         size = MBUF_SIZE();
6104         TRACEME(("dclone stored %d bytes", size));
6105         MBUF_INIT(size);
6106
6107         /*
6108          * Since we're passing do_retrieve() both a NULL file and sv, we need
6109          * to pre-compute the taintedness of the input by setting cxt->tainted
6110          * to whatever state our own input string was.  -- RAM, 15/09/2000
6111          *
6112          * do_retrieve() will free non-root context.
6113          */
6114
6115         cxt->s_tainted = SvTAINTED(sv);
6116         out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
6117
6118         TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
6119
6120         return out;
6121 }
6122
6123 /***
6124  *** Glue with perl.
6125  ***/
6126
6127 /*
6128  * The Perl IO GV object distinguishes between input and output for sockets
6129  * but not for plain files. To allow Storable to transparently work on
6130  * plain files and sockets transparently, we have to ask xsubpp to fetch the
6131  * right object for us. Hence the OutputStream and InputStream declarations.
6132  *
6133  * Before perl 5.004_05, those entries in the standard typemap are not
6134  * defined in perl include files, so we do that here.
6135  */
6136
6137 #ifndef OutputStream
6138 #define OutputStream    PerlIO *
6139 #define InputStream             PerlIO *
6140 #endif  /* !OutputStream */
6141
6142 MODULE = Storable       PACKAGE = Storable::Cxt
6143
6144 void
6145 DESTROY(self)
6146     SV *self
6147 PREINIT:
6148         stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
6149 PPCODE:
6150         if (kbuf)
6151                 Safefree(kbuf);
6152         if (!cxt->membuf_ro && mbase)
6153                 Safefree(mbase);
6154         if (cxt->membuf_ro && (cxt->msaved).arena)
6155                 Safefree((cxt->msaved).arena);
6156
6157
6158 MODULE = Storable       PACKAGE = Storable
6159
6160 PROTOTYPES: ENABLE
6161
6162 BOOT:
6163     init_perinterp(aTHX);
6164     gv_fetchpv("Storable::drop_utf8",   GV_ADDMULTI, SVt_PV);
6165 #ifdef DEBUGME
6166     /* Only disable the used only once warning if we are in debugging mode.  */
6167     gv_fetchpv("Storable::DEBUGME",   GV_ADDMULTI, SVt_PV);
6168 #endif
6169 #ifdef USE_56_INTERWORK_KLUDGE
6170     gv_fetchpv("Storable::interwork_56_64bit",   GV_ADDMULTI, SVt_PV);
6171 #endif
6172
6173 void
6174 init_perinterp()
6175  CODE:
6176   init_perinterp(aTHX);
6177
6178 int
6179 pstore(f,obj)
6180 OutputStream    f
6181 SV *    obj
6182  CODE:
6183   RETVAL = pstore(aTHX_ f, obj);
6184  OUTPUT:
6185   RETVAL
6186
6187 int
6188 net_pstore(f,obj)
6189 OutputStream    f
6190 SV *    obj
6191  CODE:
6192   RETVAL = net_pstore(aTHX_ f, obj);
6193  OUTPUT:
6194   RETVAL
6195
6196 SV *
6197 mstore(obj)
6198 SV *    obj
6199  CODE:
6200   RETVAL = mstore(aTHX_ obj);
6201  OUTPUT:
6202   RETVAL
6203
6204 SV *
6205 net_mstore(obj)
6206 SV *    obj
6207  CODE:
6208   RETVAL = net_mstore(aTHX_ obj);
6209  OUTPUT:
6210   RETVAL
6211
6212 SV *
6213 pretrieve(f)
6214 InputStream     f
6215  CODE:
6216   RETVAL = pretrieve(aTHX_ f);
6217  OUTPUT:
6218   RETVAL
6219
6220 SV *
6221 mretrieve(sv)
6222 SV *    sv
6223  CODE:
6224   RETVAL = mretrieve(aTHX_ sv);
6225  OUTPUT:
6226   RETVAL
6227
6228 SV *
6229 dclone(sv)
6230 SV *    sv
6231  CODE:
6232   RETVAL = dclone(aTHX_ sv);
6233  OUTPUT:
6234   RETVAL
6235
6236 int
6237 last_op_in_netorder()
6238  CODE:
6239   RETVAL = last_op_in_netorder(aTHX);
6240  OUTPUT:
6241   RETVAL
6242
6243 int
6244 is_storing()
6245  CODE:
6246   RETVAL = is_storing(aTHX);
6247  OUTPUT:
6248   RETVAL
6249
6250 int
6251 is_retrieving()
6252  CODE:
6253   RETVAL = is_retrieving(aTHX);
6254  OUTPUT:
6255   RETVAL