ext/Storable/Storable.xs

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