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