ext/Storable/ChangeLog

   1 Sun Jul  1 13:27:32 MEST 2001   Raphael Manfredi <Raphael_Manfredi@pobox.com>
   2
   3 . Description:
   4
   5         Systematically use "=over 4" for POD linters.
   6         Apparently, POD linters are much stricter than would
   7         otherwise be needed, but that's OK.
   8
   9         Fixed memory corruption on croaks during thaw().  Thanks
  10         to Claudio Garcia for reproducing this bug and providing the
  11         code to exercise it.  Added test cases for this bug, adapted
  12         from Claudio's code.
  13
  14         Made code compile cleanly with -Wall (from Jarkko Hietaniemi).
  15
  16         Changed tagnum and classnum from I32 to IV in context.  Also
  17         from Jarkko.
  18
  19 Thu Mar 15 01:22:32 MET 2001   Raphael Manfredi <Raphael_Manfredi@pobox.com>
  20
  21 . Description:
  22
  23         Last version was wrongly compiling with assertions on, due
  24         to an edit glitch.  That did not cause any problem (apart from
  25         a slight performance loss) excepted on Win* platforms, where the
  26         assertion code does not compile.
  27
  28 Sat Feb 17 13:37:37 MET 2001   Raphael Manfredi <Raphael_Manfredi@pobox.com>
  29
  30 . Description:
  31
  32         Version 1.0.10.
  33
  34         Forgot to increase version number at previous patch (there were
  35         two of them, which is why we jump from 1.0.8 to 1.0.10).
  36
  37 Sat Feb 17 13:35:00 MET 2001   Raphael Manfredi <Raphael_Manfredi@pobox.com>
  38
  39 . Description:
  40
  41         Version 1.0.8, binary format 2.4.
  42
  43         Fixed incorrect error message.
  44
  45         Now bless objects ASAP at retrieve time, which is meant to fix
  46         two bugs:
  47
  48         * Indirect references to overloaded object were not able to
  49           restore overloading if the object was not blessed yet,
  50           which was possible since blessing occurred only after the
  51           recursive retrieval.
  52
  53         * Storable hooks asking for serialization of blessed ref could
  54           get un-blessed refs at retrieval time, for the very same
  55           reason.
  56
  57         The fix implemented here was suggested by Nick Ing-Simmons.
  58
  59         Added support for blessed ref to tied structures.  This is the
  60         cause for the binary format change.
  61
  62         Added EBCDIC version of the compatibility test with 0.6.11,
  63         from Peter Prymmer
  64
  65         Added tests for the new features, and to make sure the bugs they
  66         are meant to fix are indeed fixed.
  67
  68 Wed Jan  3 10:43:18 MET 2001   Raphael Manfredi <Raphael_Manfredi@pobox.com>
  69
  70 . Description:
  71
  72         Removed spurious 'clean' entry in Makefile.PL.
  73
  74         Added CAN_FLOCK to determine whether we can flock() or not,
  75         by inspecting Perl's configuration parameters, as determined
  76         by Configure.
  77
  78         Trace offending package when overloading cannot be restored
  79         on a scalar.
  80
  81         Made context cleanup safer to avoid dup freeing, mostly in the
  82         presence of repeated exceptions during store/retrieve (which can
  83         cause memory leaks anyway, so it's just additional safety, not a
  84         definite fix).
  85
  86 Sun Nov  5 18:23:48 MET 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
  87
  88 . Description:
  89
  90         Version 1.0.6.
  91
  92         Fixed severe "object lost" bug for STORABLE_freeze returns,
  93         when refs to lexicals, taken within the hook, were to be
  94         serialized by Storable.  Enhanced the t/recurse.t test to
  95         stress hook a little more with refs to lexicals.
  96
  97 Thu Oct 26 19:14:38 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
  98
  99 . Description:
 100
 101         Version 1.0.5.
 102
 103         Documented that store() and retrieve() can return undef.
 104         That is, the error reporting is not always made via exceptions,
 105         as the paragraph on error reporting was implying.
 106
 107         Auto requires module of blessed ref when STORABLE_thaw misses.
 108         When the Storable engine looks for the STORABLE_thaw hook and
 109         does not find it, it now tries to require the package into which
 110         the blessed reference is.
 111
 112         Just check $^O, in t/lock.t: there's no need to pull the whole
 113         Config module for that.
 114
 115 Mon Oct 23 20:03:49 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 116
 117 . Description:
 118
 119         Version 1.0.4.
 120
 121         Protected calls to flock() for DOS platform: apparently, the
 122         flock/fcnlt emulation is reported to be broken on that
 123         platform.
 124
 125         Added logcarp emulation if they don't have Log::Agent, since
 126         we now use it to carp when lock_store/lock_retrieve is used
 127         on DOS.
 128
 129 Fri Sep 29 21:52:29 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 130
 131 . Description:
 132
 133         Version 1.0.3.
 134
 135         Avoid using "tainted" and "dirty" since Perl remaps them via
 136         cpp (i.e. #define).  This is deeply harmful when threading
 137         is enabled.  This concerned both the context structure and
 138         local variable and argument names.  Brrr..., scary!
 139
 140 Thu Sep 28 23:46:39 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 141
 142 . Description:
 143
 144         Version 1.0.2.
 145
 146         Fixed spelling in README.
 147
 148         Added lock_store, lock_nstore, and lock_retrieve (advisory locking)
 149         after a proposal from Erik Haugan <erik@solbors.no>.
 150
 151         Perls before 5.004_04 lack newSVpvn, added remapping in XS.
 152
 153         Fixed stupid typo in the t/utf8.t test.
 154
 155 Sun Sep 17 18:51:10 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 156
 157 . Description:
 158
 159         Version 1.0.1, binary format 2.3.
 160
 161         Documented that doubles are stored stringified by nstore().
 162
 163         Added Salvador Ortiz Garcia in CREDITS section,  He identified
 164         a bug in the store hooks and proposed the right fix: the class
 165         id was allocated too soon.  His bug case was also added to
 166         the regression test suite.
 167
 168         Now only taint retrieved data when source was tainted.  A bug
 169         discovered by Marc Lehmann.
 170
 171         Added support for UTF-8 strings, a contribution of Marc Lehmann.
 172         This is normally only activated in post-5.6 perls.
 173
 174 Thu Aug 31 23:06:06 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 175
 176         First official release Storable 1.0, for inclusion in perl 5.7.0.
 177         The license scheme is now compatible with Perl's.
 178
 179 Thu Aug 24 01:02:02 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 180
 181 . Description:
 182
 183
 184         ANSI-fied most of the code, preparing for Perl core integration.
 185         The next version of Storable will be 0.8, and will be integrated
 186         into the Perl core (development branch).
 187
 188         Dispatch tables were moved upfront to relieve some compilers,
 189         especially on AIX and Windows platforms.
 190
 191         Merged 64-bit fixes from perl5-porters.
 192
 193 Mon Aug 14 09:22:04 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 194
 195 . Description:
 196
 197         Added a refcnt dec in retrieve_tied_key(): sv_magic() increases
 198         the refcnt on the mg_ptr as well.
 199
 200         Removed spurious dependency to Devel::Peek, which was used for
 201         testing only in t/tied_items.t.  Thanks to Conrad Heiney
 202         <conrad@fringehead.org> for spotting it first.
 203
 204 Sun Aug 13 22:12:59 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 205
 206 . Description:
 207
 208         Marc Lehmann kindly contributed code to add overloading support
 209         and to handle references to tied variables.
 210
 211         Rewrote leading blurb about compatibility to make it clearer what
 212         "backward compatibility" is about: when I say 0.7 is backward
 213         compatible with 0.6, it means the revision 0.7 can read files
 214         produced by 0.6.
 215
 216         Mention new Clone(3) extension in SEE ALSO.
 217
 218         Was wrongly optimizing for "undef" values in hashes by not
 219         fully recursing: as a result, tied "undef" values were incorrectly
 220         serialized.
 221
 222 Sun Jul 30 12:59:17 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 223
 224         First revision of Storable 0.7.
 225
 226         The serializing format is new, known as version 2.0.  It is fully
 227         backward compatible with 0.6.  Earlier formats are deprecated and
 228         have not even been tested: next version will drop pre-0.6 format.
 229
 230         Changes since 0.6@11:
 231
 232         - Moved interface to the "beta" status.  Some tiny parts are still
 233           subject to change, but nothing important enough to warrant an "alpha"
 234           status any longer.
 235
 236         - Slightly reduced the size of the Storable image by factorizing
 237           object class names and removing final object storage notification due
 238           to a redesign of the blessed object storing.
 239
 240         - Classes can now redefine how they wish their instances to be serialized
 241           and/or deep cloned.  Serializing hooks are written in Perl code.
 242
 243         - The engine is now fully re-entrant.
 244
 245 Sun Apr  2 23:47:50 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 246
 247 . Description:
 248
 249         Added provision to detect more recent binary formats, since
 250         the new upcoming Storable-0.7 will use a different format.
 251         In order to prevent attempting the de-serialization of newer
 252         formats by older versions, I'm adding this now to the 0.6 series.
 253
 254         I'm expecting this revision to be the last of the 0.6 series.
 255         Unless it does not work with perl 5.6, which I don't use yet,
 256         and therefore against which I cannot test.
 257
 258 Wed Mar 29 19:55:21 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 259
 260 . Description:
 261
 262         Added note about format incompatibilities with old versions
 263         (i.e. pre 0.5@9 formats, which cannot be understood as there
 264         was no versionning information in the file by then).
 265
 266         Protect all $@ variables when eval {} used, to avoid corrupting
 267         it when store/retrieve is called within an exception handler.
 268
 269         Mistakenly included "patchlevel.h" instead of <patchlevel.h>,
 270         preventing Perl's patchlevel from being included, which is
 271         needed starting from 5.6.
 272
 273 Tue May 12 09:15:15 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 274
 275 . Description:
 276
 277         Fixed shared "undef" bug in hashes, which did not remain shared
 278         through store/retrieve.
 279
 280 Thu Feb 10 19:48:16 MET 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 281
 282 . Description:
 283
 284         added last_op_in_netorder() predicate
 285         documented last_op_in_netorder()
 286         added tests for the new last_op_in_netorder() predicate
 287
 288 Wed Oct 20 19:07:36 MEST 1999   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 289
 290 . Description:
 291
 292         Forgot to update VERSION
 293
 294 Tue Oct 19 21:25:02 MEST 1999   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 295
 296 . Description:
 297
 298         Added mention of japanese translation for the manual page.
 299
 300         Fixed typo in macro that made threaded code not compilable,
 301         especially on Win32 platforms.
 302
 303         Changed detection of older perls (pre-5.005) by testing PATCHLEVEL
 304         directly instead of relying on internal symbols.
 305
 306 Tue Sep 14 22:13:28 MEST 1999   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 307
 308 . Description:
 309
 310         Integrated "thread-safe" patch from Murray Nesbitt.
 311         Note that this may not be very efficient for threaded code,
 312         see comment in the code.
 313
 314         Try to avoid compilation warning on 64-bit CPUs. Can't test it,
 315         since I don't have access to such machines.
 316
 317 Mon Jul 12 14:37:19 METDST 1999   Raphael Manfredi <Raphael_Manfredi@pobox.com>
 318
 319 . Description:
 320
 321         changed my e-mail to pobox.
 322
 323         mentionned it is not thread-safe.
 324
 325         updated version number.
 326
 327         uses new internal PL_* naming convention.
 328
 329 Fri Jul  3 13:38:16 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 330
 331 . Description:
 332
 333         Updated benchmark figures due to recent optimizations done in
 334         store(): tagnums are now stored as-is in the hash table, so
 335         no surrounding SV is created. And the "shared keys" mode for
 336         hash table was turned off.
 337
 338         Fixed backward compatibility (wrt 0.5@9) for retrieval of
 339         blessed refs. That old version did something wrong, but the
 340         bugfix prevented correct retrieval of the old format.
 341
 342 Mon Jun 22 11:00:48 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 343
 344 . Description:
 345
 346         Changed benchmark figures.
 347
 348         Adjust refcnt of tied objects after calling sv_magic() to avoid
 349         memory leaks.  Contributed by Jeff Gresham.
 350
 351 Fri Jun 12 11:50:04 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 352
 353 . Description:
 354
 355         Added workaround for persistent LVALUE-ness in perl5.004. All
 356         scalars tagged as being an lvalue are handled as if they were
 357         not an lvalue at all.  Added test for that LVALUE bug workaround.
 358
 359         Now handles Perl immortal scalars explicitely, by storing &sv_yes
 360         as such, explicitely.
 361
 362         Retrieval of non-immortal undef cannot be shared. Previous
 363         version was over-optimizing by not creating a separate SV for
 364         all undefined scalars seen.
 365
 366 Thu Jun  4 17:21:51 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 367
 368 . Description:
 369
 370         Baseline for Storable-0.6@0.
 371
 372         This version introduces a binary incompatibility in the generated
 373         binary image, which is more compact than older ones by approximatively
 374         15%, depending on the exact degree of sharing in your structures.
 375
 376         The good news is that your older images can still be retrieved with
 377         this version, i.e. backward compatibility is preserved. This version
 378         of Storable can only generate new binaries however.
 379
 380         Another good news is that the retrieval of data structure is
 381         significantly quicker than before, because a Perl array is used
 382         instead of a hash table to keep track of retrieved objects, and
 383         also because the image being smaller, less I/O function calls are
 384         made.
 385
 386 Tue May 12 09:15:15 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 387
 388 . Description:
 389
 390         Version number now got from Storable.pm directly.
 391
 392         Fixed overzealous sv_type() optimization, which would make
 393         Storable fail when faced with an "upgraded" SV to the PVIV
 394         or PVNV kind containing a reference.
 395
 396 Thu Apr 30 15:11:30 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 397
 398 . Description:
 399
 400         Extended the SYNOPSIS section to give quick overview of the
 401         routines and their signature.
 402
 403         Optimized sv_type() to avoid flags checking when not needed, i.e.
 404         when their type makes it impossible for them to be refs or tied.
 405         This slightly increases throughput by a few percents when refs
 406         and tied variables are marginal occurrences in your data.
 407
 408         Stubs for XS now use OutputStream and InputStream file types to
 409         make it work when the given file is actually a socket. Perl
 410         makes a distinction for sockets in its internal I/O structures
 411         by having both a read and a write structure, whereas plain files
 412         share the same one.
 413
 414 Tue Jun  3 09:41:33 METDST 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 415
 416 . Description:
 417
 418         Thanks to a contribution from Benjamin A. Holzman, Storable is now
 419         able to correctly serialize tied SVs, i.e. tied arrays, hashes
 420         and scalars.
 421
 422 Thu Apr  9 18:07:51 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 423
 424 . Description:
 425
 426         I said SvPOK() had changed to SvPOKp(), but that was a lie...
 427
 428 Wed Apr  8 13:14:29 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 429
 430 . Description:
 431
 432         Wrote sizeof(SV *) instead of sizeof(I32) when portable, which
 433         in effect mangled the object tags and prevented portability
 434         accross 32/64 bit architectures!
 435
 436 Wed Mar 25 14:57:02 MET 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 437
 438 . Description:
 439
 440         Added code example for store_fd() and retrieve_fd() in the
 441         man page, to emphasize that file descriptors must be passed as
 442         globs, not as plain strings.
 443
 444         Cannot use SV addresses as tag when using nstore() on LP64. This
 445         was the cause of problems when creating a storable image on an
 446         LP64 machine and retrieving it on an ILP32 system, which is
 447         exactly what nstore() is meant for...
 448
 449         However, we continue to use SV addresses as tags for plain store(),
 450         because benchamarking shows that it saves up to 8% of the store
 451         time, and store() is meant to be fast at the expense of lack
 452         of portability.
 453
 454         This means there will be approximately an 8% degradation of
 455         performance for nstore(), but it's now working as expected.
 456         That cost may vary on your machine of course, since it is
 457         solely caused by the memory allocation overhead used to create
 458         unique SV tags for each distinct stored SV.
 459
 460 Tue Jan 20 09:21:53 MET 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 461
 462 . Description:
 463
 464         Don't use any '_' in version number.
 465
 466 Tue Jan 13 17:51:50 MET 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 467
 468 . Description:
 469
 470         Updated version number.
 471
 472         added binmode() calls for systems where it matters.
 473
 474         Be sure to pass globs, not plain file strings, to C routines,
 475         so that Storable can be used under the Perl debugger.
 476
 477 Wed Nov  5 10:53:22 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 478
 479 . Description:
 480
 481         Fix memory leaks on seen hash table and returned SV refs.
 482
 483         Storable did not work properly when tainting enabled.
 484
 485         Fixed "Allocation too large" messages in freeze/thaw and added.
 486         proper regression test in t/freeze.t.
 487
 488 Tue Jun  3 09:41:33 METDST 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 489
 490 . Description:
 491
 492         Updated version number
 493
 494         Added freeze/thaw interface and dclone.
 495
 496 Fri May 16 10:45:47 METDST 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 497
 498 . Description:
 499
 500         Forgot that AutoLoader does not export its own AUTOLOAD.
 501         I could use
 502
 503                 use AutoLoader 'AUTOLOAD';
 504
 505         but that would not be backward compatible. So the export is
 506         done by hand...
 507
 508 Tue Mar 25 11:21:32 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 509
 510 . Description:
 511
 512         Empty scalar strings are now "defined" at retrieval time.
 513
 514         New test to ensure an empty string is defined when retrieved.
 515
 516 Thu Feb 27 16:32:44 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 517
 518 . Description:
 519
 520         Updated version number
 521
 522         Declare VERSION as being used
 523
 524         Fixed a typo in the PerlIO_putc remapping.
 525         PerlIO_read and perlIO_write inverted size/nb_items.
 526         (only relevant for pre-perl5.004 versions)
 527
 528 Thu Feb 27 15:58:31 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 529
 530 . Description:
 531
 532         Updated version number
 533
 534         Added VERSION identification
 535
 536         Allow build with perl5.003, which is ante perlIO time
 537
 538 Mon Jan 13 17:53:18 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 539
 540 . Description:
 541
 542         Random code fixes.
 543
 544 Wed Jan 22 15:19:56 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
 545
 546 . Description:
 547
 548         Updated version number in Makefile.PL.
 549
 550         Added "thanks to" section to README.
 551
 552         Documented new forgive_me variable.
 553
 554         Made 64-bit clean.
 555
 556         Added forgive_me support to allow store() of data structures
 557         containing non-storable items like CODE refs.
 558