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