ext/Storable/Storable.xs

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