ext/Storable/Storable.xs

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