This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document UTF8_SKIP()
[perl5.git] / dist / Storable / ChangeLog
1 2019-08-08 11:48:00 TonyC
2     version 3.17
3         * correct a data type to ensure the check for too large results from
4           STORABLE_freeze() are detected correctly (detected by Coverity)
5         * removed remains of stack size detection from the build process.
6         * moved CAN_FLOCK detection into XS to simplify the build process.
7
8 2019-06-11 10:43:00 TonyC
9     version 3.16
10         * (perl #134179) fix self-referencing structures that include regexps
11         * bless regexps to preserve bless qr//, "Foo"
12
13 2019-04-23 16:00:00 xsawyerx
14     version 3.15
15     * Fix leaking.
16
17 unreleased
18     version 3.14
19         * (perl #133708) don't build-time probe for stack limits at all
20
21 unreleased
22     version 3.12
23         * (perl #133411) don't probe for stack limits with -Dusecrosscompile
24
25 2018-04-27 20:40:00 xsawyerx
26     version 3.11
27         * Fix Strawberry Perl build failures.
28
29 2018-04-21 22:00:00 xsawyerx
30     Version 3.10
31         * Fix binary artifacts from distribution.
32
33 2018-04-21 16:49:00 xsawyerx
34     Version 3.09
35         * Fix "provides" in metadata (META.yml/META.json) to use the Storable
36           template instead of a small other file (which also didn't exist).
37
38 2018-04-21 11:23:00 xsawyerx
39     Version 3.08
40         * (perl #132849) try to disable core files when deliberatly segfaulting.
41         * (perl #127743) don't probe Storable limits so much.
42         * (perl #132893) don't probe for Storable recursion limits on old Win32.
43         * (perl #132870) workaround VC2017 compiler bug.
44         * (perl #127743) re-work for debugging builds with MSVC.
45         * (perl #133039) dont build a Storable.so/.dll with a static perl build.
46
47 2018-02-07 15:08:00 tonyc
48     Version 3.06
49
50         * support large object ids.  The code in theory supported arrays
51         with more than 2**32 elements, but references to the elements
52         emitted at the end of the array with be retrieved as references to
53         the wrong elements.
54         * 32-bit object ids over 2**31-1 weren't correctly handled.
55         * hook object id generation now supports 64-bit ids where needed
56         * writing 64-bit lengths in network order now works
57         * reading 64-bit lengths in network order now reads the components
58         in the correct order.
59         * retrieving large object tags are now only handled on 64-bit
60         platforms, large object tags should only be emitted for objects
61         that are too large for the 32-bit address space, so it was only
62         wasted code.
63         * reading 32-bit lengths for LSCALAR and LUTF8STR as unsigned
64         (perl #131990)
65         * reading flagged large object hashes didn't read the flags
66         * treat the 32-bit size of hook data as unsigned, values over 2GB
67         were treated as large (close to 2**64) parameters to NEWSV().
68         (perl #131999)
69         * added support for hook data over 4GB in size
70         * zero length data receievd from STORABLE_freeze() no longer
71         results in an invalid SV being passed to STORABLE_thaw/_attach()
72         (perl #118551)
73         * where practical, padding is now cleared when emitting a long
74         double (perl #131136)
75         * cache the value of $Storable::DEBUGME (since cperl enabled
76         Storable TRACEME builds for all -DDEBUGGING builds)
77         * no longer discard exceptions thrown by
78         STORABLE_freeze/_thaw/attach() (perl #25933)
79         * fix dependencies used to build Storable.pm from __Storable__.pm
80         * add experimental support for freezing/thawing regular
81         expressions (perl #50608)
82         * re-work recursion limiting to store the limit in a perl variable
83         instead of baked into Storable.$so.  This allows static Storable
84         builds to work, and avoids the kind of circular reference on
85         Storable.$so.
86
87 2017-07-24 13:57:13 rurban
88     Version 3.05_13
89
90         * mingw fix: use safe defaults, not segfaulting defaults.
91         mingw fails on the stacksize binary search, leaving it empty.
92
93 Wed Apr 19 09:11:07 2017 +0200 Reini Urban <rurban@cpan.org>
94     Version 3.05_12
95
96         * enhance stack reserve from 8 to 16
97         * fix LD_LIBRARY_PATH usage for CORE
98         * fixed some coverity warnings and leaks
99         * added a release make target
100
101 Wed Mar 29 21:04:28 2017 +0200 Reini Urban <rurban@cpan.org>
102     Version 3.05_11
103
104         * croak on sizes read > I32_MAX
105         * simplify last_op_in_netorder
106         * protect from empty retrieve_vstring
107         * protect store_other error buf, potential static
108         buffer overflow.
109
110 Tue Mar 14 09:52:20 2017 +0100 Reini Urban <rurban@cpan.org>
111     Version 3.05_10
112
113         * CORE-only improvements to stacksize
114
115 Thu Mar 9 19:20:19 2017 +0100 Reini Urban <rurban@cpan.org>
116     Version 3.05_09
117
118         * compute the stacksizes, improve cleanup within croak
119         from stack exhaustion.
120         * added stack_depth and stack_depth_hash getters.
121
122 Wed Mar  8 21:03:43 CET 2017 Reini Urban <rurban@cpan.org>
123     Version 3.05_08
124
125         * finetune the max stack limit, for C++, DEBUGGING and 32bit.
126         * fix t/blessed.t for cperl5.22
127
128 Sun Mar 5 13:36:47 2017 +0100 Reini Urban <rurban@cpan.org>
129     Version 3.05_07
130
131         * Fixed a podchecker issue
132
133 Sun Mar 5 11:42:04 2017 +0100 Reini Urban <rurban@cpan.org>
134     Version 3.05_06
135
136         * Fixed wrong recursion depth error with large arrays containing
137         another array.
138         L<[cperl #257]|https://github.com/perl11/cperl/issues/257>
139
140 Thu Feb 2 12:40:44 2017 +0100 Reini Urban <rurban@cpanel.net>
141     Version 3.05_05
142
143         * Add leak tests for [cpan #97316], [perl #121928]
144         * Limit the max recursion depth to 1200 on 32bit systems.
145         We have no max_depth option yet, as in JSON::XS.
146
147 Thu Feb 2 11:59:21 2017 +0100 Reini Urban <rurban@cpanel.net>
148     Version 3.05_04
149
150         * Fix retrieve_tied_array which fails since 5.16
151         [cpan #84705]
152         * Improve t/blessed.t in the creation of sv_yes/sv_no
153         with threaded perls.
154
155 Tue Jan 31 02:55:30 2017 +0100 Reini Urban <rurban@cpanel.net>
156     Version 3.05_03
157
158         * Tune t/recurse.t stack-overflow limit more.
159
160 Mon Jan 30 19:50:29 2017 +0100 Reini Urban <rurban@cpanel.net>
161     Version 3.05_02
162
163         * Tune t/recurse.t stack-overflow limit. Small 64bit systems overflow
164         even with depth 3000, where 32bit are ok.
165
166 Mon Jan 30 15:13:38 2017 +0100 Reini Urban <rurban@cpanel.net>
167     Version 3.05_01
168
169         * Protect against stack overflows with nested arrays and hashes
170         [cpan #97526]. This imposes a new limit to your nested structures,
171         but JSON::XS has a limit of 512. We use a max_depth of 3000 for the
172         typical stack limit of 8k.
173
174
175 Sun Jan 29 11:36:43 2017 +0100 Reini Urban <rurban@cpanel.net>
176     Version 3.05
177
178         * Protect against classname len overflow on the stack
179         and 2x on the heap with retrieve_bless and retrieve_hook.
180         A serious security issue with malcrafted storable files or buffers,
181         but p5p accepts no CVE on Storable attacks. See RT #130635
182         (reported by JD).
183         * Fix NULL ptr SEGVs with retrieve_code and retrieve_other.
184         See RT #130098 (reported and fixed by JD)
185         * Fix wrong huge LOBJECT support, broken since 3.00c.
186         Repro with `export PERL_TEST_MEMORY=8`
187         * Fix the few remaining 2-arg open calls.
188         * Portability and backport fixes back to 5.6.2
189
190 Sat Jan 7 09:01:29 2017 +0100 Reini Urban <rurban@cpanel.net>
191     Version 3.04c
192
193         * fix printf types and warnings, esp. for 32bit use64bitint
194         * Change sv_setpvn(…, "…", …) to sv_setpvs(…, "…")
195
196 Tue Jul 26 11:49:33 2016 +1000 Tony Cook <tony@develop-help.com>
197     Version 3.03c
198
199         * remove . from @INC when loading optional modules
200
201 Sun Nov 20 18:06:45 2016 +0100 Reini Urban <rurban@cpanel.net>
202     Version 3.02c
203
204         * Fix -Wc++11-compat warnings, fix -Wchar-subscripts
205
206 Fri Sep 16 01:32:59 2016 +0200 Reini Urban <rurban@cpanel.net>
207     Version 3.01c
208
209         * Added warn_security("Movable-Type CVE-2015-1592 Storable metasploit attack")
210           when detecting the third destructive metasploit vector,
211           thawing bless \"mt-config.cgi", "CGITempFile".
212
213 Thu Mar 31 17:10:27 2016 +0200 Reini Urban <rurban@cpanel.net>
214     Version 3.00c
215
216         * Added support for u64 strings, arrays and hashes >2G
217           via a new LOBJECT tag. This is for 32bit systems and lengths
218           between 2GB and 4GB (I32-U32), and 64bit (>I32).
219         * Bumped STORABLE_BIN_MINOR and STORABLE_BIN_WRITE_MINOR from 10 to 11
220         * fix parallel tests, use unique filenames.
221         * fixed 2 instances of 2arg open,
222         * added optional flag arguments to skip tie and bless on retrieve/thaw,
223         * added SECURITY WARNING and Large data support to docs
224         * compute CAN_FLOCK at compile-time
225         * reformat everything consistently
226         * enable DEBUGME tracing and asserts with -DDEBUGGING
227         * fix all 64 bit compiler warnings
228         * added some abstraction methods to avoid code duplication
229
230 ?????? p5p <perl5-porters@perl.org>
231     Version 2.65
232
233         * Replace multiple 'use vars' by 'our'
234         * remove Config dependency
235
236 Wed Jul  2 16:25:25 IST 2014   Abhijit Menon-Sen <ams@toroid.org>
237     Version 2.51
238
239         * [perl #121928] Fix memory leak for dclone inside freeze hook
240           (Alex Solovey)
241         * Do not call DESTROY for empty objects
242           (Vladimir Timofeev)
243         * Other bugfixes
244
245 Sat Jul 13 18:34:27 IST 2013   Abhijit Menon-Sen <ams@toroid.org>
246     Version 2.45
247
248        * [perl #118829] Memory leaks in STORABLE_attach
249          (Vladimir Timofeev)
250        * [perl #118139] Don't SEGV during global destruction
251          (Nicholas Clark, report/test from Reini Urban)
252        * Added security warnings section (Steffen Mueller)
253        * Update INSTALLDIRS to favour installation in 'site'
254          (James E Keenan)
255
256 Tue 11 Sep 06:51:11 IST 2012   Abhijit Menon-Sen <ams@toroid.org>
257     Version 2.39
258
259         Various bugfixes, including compatibility fixes for older
260         versions of Perl and vstring handling.
261
262 Sun  3 Jul 09:10:11 IST 2011   Abhijit Menon-Sen <ams@toroid.org>
263     Version 2.29
264
265         Various bugfixes, notably including preventing nfreeze from
266         incorrectly stringifying integers.
267
268 Fri  3 Dec 14:12:32 GMT 2010   David Leadbeater <dgl@dgl.cx>
269     Version 2.25
270
271         Support for serializing coderefs containing UTF-8.
272
273 Fri Nov 12 10:52:19 IST 2010   Abhijit Menon-Sen <ams@toroid.org>
274
275     Version 2.24
276
277         Performance improvement for overloaded classes from Benjamin
278         Holzman.
279
280 Fri Nov 12 10:36:22 IST 2010   Abhijit Menon-Sen <ams@toroid.org>
281
282     Version 2.23
283
284         Release the latest version from the Perl repository.
285
286 Thu Aug  6 10:55:50 IST 2009   Abhijit Menon-Sen <ams@toroid.org>
287
288     Version 2.21
289
290         Includes hints/hpux.pl that was inadvertently left out of 2.20.
291
292 Mon May 18 09:38:20 IST 2009   Abhijit Menon-Sen <ams@toroid.org>
293
294     Version 2.20
295
296         Fix bug handling blessed references to overloaded objects, plus
297         other miscellaneous fixes.
298
299         (Version 2.19 was released with 5.8.9.)
300
301 Thu Nov 22 13:24:18 IST 2007   Abhijit Menon-Sen <ams@toroid.org>
302
303     Version 2.18
304
305         Compile fixes for older Perls. (No functional changes.)
306
307 Sat Nov 17 02:12:12 IST 2007   Abhijit Menon-Sen <ams@toroid.org>
308
309     Version 2.17
310
311         Various broken tests fixed. (No functional changes.)
312
313 Sat Mar 31 06:11:06 IST 2007   Abhijit Menon-Sen <ams@toroid.org>
314
315     Version 2.16
316
317         1. Fixes to Storable::dclone, read_magic, retrieve_lscalar
318         2. Storable 0.1 compatibility
319         3. Miscellaneous compile/leak/test/portability fixes
320
321 Mon May 23 22:48:49 IST 2005   Abhijit Menon-Sen <ams@wiw.org>
322
323     Version 2.15
324
325         Minor changes to address a couple of compile problems.
326
327 Mon Apr 25 07:29:14 IST 2005   Abhijit Menon-Sen <ams@wiw.org>
328
329     Version 2.14
330
331         1. Store weak references
332         2. Add STORABLE_attach hook.
333
334 Thu Jun 17 12:26:43 BST 2004   Nicholas Clark <nick@ccl4.org>
335
336     Version 2.13
337
338         1. Don't change the type of top level overloaded references to RV -
339            they are perfectly correct as PVMG
340         2. Storable needs to cope with incoming frozen data that happens to be
341            utf8 encoded.
342
343 Wed Mar 17 15:40:29 GMT 2004   Nicholas Clark <nick@ccl4.org>
344
345     Version 2.12
346
347         1. Add regression tests for the auto-require of STORABLE_thaw
348         2. Add auto-require of modules to restore overloading (and tests)
349         3. Change to no context (should give speedup with ithreads)
350
351 Sat Mar 13 20:11:03 GMT 2004   Nicholas Clark <nick@ccl4.org>
352         
353     Version 2.11
354
355         1. Storing restricted hashes in canonical order would SEGV. Fixed.
356         2. It was impossible to retrieve references to PL_sv_no and and
357            PL_sv_undef from STORABLE_thaw hooks.
358         3. restrict.t was failing on 5.8.0, due to 5.8.0's unique
359            implementation of restricted hashes using PL_sv_undef
360         4. These changes allow a space optimisation for restricted hashes.
361
362 Sat Jan 24 16:22:32 IST 2004   Abhijit Menon-Sen <ams@wiw.org>
363
364     Version 2.10
365
366         1. Thread safety: Storable::CLONE/init_perlinterp() now create
367            a new Perl context for each new ithread.
368            (From Stas Bekman and Jan Dubois.)
369         2. Fix a tag count mismatch with $Storable::Deparse that caused
370            all back-references after a stored sub to be off-by-N (where
371            N was the number of code references in between).
372            (From Sam Vilain.)
373         3. Prevent CODE references from turning into SCALAR references.
374            (From Slaven Rezic.)
375
376 Sat Jan  3 18:49:18 GMT 2004   Nicholas Clark <nick@ccl4.org>
377
378     Version 2.09
379
380         Fix minor problems with the CPAN release
381         1: Make Storable.xs work on 5.8.2 and later (already in the core)
382         2: Ship the linux hints file
383         3: Ship Test::More for the benefit of Perls pre 5.6.2
384         4: Correct Makefile.PL to only install in core for 5.8.0 and later
385
386 Sat Sep  6 01:08:20 IST 2003   Abhijit Menon-Sen <ams@wiw.org>
387
388     Version 2.08
389
390         This release works around a 5.8.0 bug which caused hashes to not
391         be marked as having key flags even though an HEK had HEK_WASUTF8
392         set. (Note that the only reasonable solution is to silently drop
393         the flag from the affected key.)
394
395         Users of RT 3 who were seeing assertion failures should upgrade.
396         (Perl 5.8.1 will have the bug fixed.)
397
398 Mon May  5 10:24:16 IST 2003   Abhijit Menon-Sen <ams@wiw.org>
399
400     Version 2.07
401
402         Minor bugfixes (self-tied objects are now correctly stored, as
403         are the results of additions larger than INT_MAX).
404
405 Mon Oct  7 21:56:38 BST 2002   Nicholas Clark  <nick@ccl4.org>
406
407     Version 2.06
408
409         Remove qr// from t/downgrade.t so that it will run on 5.004
410         Mention $File::Spec::VERSION a second time in t/forgive.t so that it
411         runs without warnings in 5.004 (this may be a 5.00405 bug I'm working
412         round)
413         Fix t/integer.t initialisation to actually generate 64 bits of 9c
414         Fix comparison tests to use eval to get around 64 bit IV conversion
415         issues on 5.6.x, following my t/integer.t ^ precedence bug found by
416         Rafael Garcia-Suarez
417         Alter t/malice.t to work with Test/More.pm in t/, and skip individual
418         subtests that use $Config{ptrsize}, so that the rest of the test can
419         now be run with 5.004
420         Change t/malice.t and the error message in check_magic in Storable.xs
421         from "Pointer integer size" to "Pointer size"
422         Remove prerequisite of Test::More from Makefile.PL
423         Ship Test::Builder, Test::Simple and Test::More in t
424
425 Thu Oct  3 08:57:22 IST 2002   Abhijit Menon-Sen <ams@wiw.org>
426
427     Version 2.05
428
429         Adds support for CODE references from Slaven Rezic
430         <slaven.rezic@berlin.de>.
431
432 Fri Jun  7 23:55:41 BST 2002   Nicholas Clark
433
434     Version 2.04
435
436         Bug fix from Radu Greab <radu@netsoft.ro> (plus regression test)
437         to fix a recently introduced bug detected by Dave Rolsky.
438         Bug was that for a non threaded build, the class information was
439         being lost at freeze time on the first object with a STORABLE_freeze
440         hook. Consequentially the object was not blessed at all when thawed.
441         (The presence (or lack) of STORABLE_thaw was irrelevant; this was
442         a store-time data lost bug, caused by failure to initialize internal
443         context)
444         The bug was introduced as development perl change 16442 (on
445         2002/05/07), so has been present since 2.00.
446         Patches to introduce more regression tests to reduce the chance of
447         a reoccurrence of this sort of goof are always welcome.
448         
449 Thu May 30 20:31:08 BST 2002   Nicholas Clark <nick@ccl4.org>
450
451     Version 2.03        Header changes on 5.6.x on Unix where IV is long long
452
453         5.6.x introduced the ability to have IVs as long long.  However,
454         Configure still defined BYTEORDER based on the size of a long.
455         Storable uses the BYTEORDER value as part of the header, but
456         doesn't explicitly store sizeof(IV) anywhere in the header.
457         Hence on 5.6.x built with IV as long long on a platform that
458         uses Configure (ie most things except VMS and Windows) headers
459         are identical for the different IV sizes, despite the files
460         containing some fields based on sizeof(IV)
461
462         5.8.0 is consistent; all platforms have BYTEORDER in config.h
463         based on sizeof(IV) rather than sizeof(long).  This means that
464         the value of BYTEORDER will change from (say) 4321 to 87654321
465         between 5.6.1 and 5.8.0 built with the same options to Configure
466         on the same machine.  This means that the Storable header will
467         differ, and the two versions will wrongly thing that they are
468         incompatible.
469
470         For the benefit of long term consistency, Storable now
471         implements the 5.8.0 BYTEORDER policy on 5.6.x.  This means that
472         2.03 onwards default to be incompatible with 2.02 and earlier
473         (ie the large 1.0.x installed base) on the same 5.6.x perl.
474
475         To allow interworking, a new variable
476         $Storable::interwork_56_64bit is introduced. It defaults to
477         false. Set it to true to read and write old format files. Don't
478         use it unless you have existing stored data written with 5.6.x
479         that you couldn't otherwise read, or you need to interwork with
480         a machine running older Storable on a 5.6.x with long long IVs
481         (i.e., you probably don't need to use it).
482
483 Sat May 25 22:38:39 BST 2002   Nicholas Clark <nick@ccl4.org>
484
485     Version 2.02
486                 
487         Rewrite Storable.xs so that the file header structure for write_magic
488         is built at compile time, and check_magic attempts to the header in
489         blocks rather than byte per byte. These changes make the compiled
490         extension 2.25% smaller, but are not significant enough to give a
491         noticeable speed up.
492
493 Thu May 23 22:50:41 BST 2002   Nicholas Clark <nick@ccl4.org>
494
495     Version 2.01
496
497         - New regression tests integer.t
498         - Add code to safely store large unsigned integers.
499         - Change code not to attempt to store large integers (ie > 32 bits)
500           in network order as 32 bits.
501         
502         *Never* underestimate the value of a pathological test suite carefully
503         crafted with maximum malice before writing a line of real code. It
504         prevents crafty bugs from stowing away in your released code.
505         It's much less embarrassing to find them before you ship.
506         (Well, never underestimate it if you ever want to work for me)
507         
508 Fri May 17 22:48:59 BST 2002   Nicholas Clark <nick@ccl4.org>
509
510     Version 2.0, binary format 2.5 (but writes format 2.4 on pre 5.7.3)
511
512         The perl5 porters have decided to make sure that Storable still
513         builds on pre-5.8 perls, and make the 5.8 version available on CPAN.
514         The VERSION is now 2.0, and it passes all tests on 5.005_03, 5.6.1
515         and 5.6.1 with threads. On 5.6.0 t/downgrade.t fails tests 34 and 37,
516         due to a bug in 5.6.0 - upgrade to 5.6.1.
517
518         Jarkko and I have collated the list of changes the perl5 porters have
519         from the perl5 Changes file:
520
521         - data features of upcoming perl 5.8.0 are supported: Unicode hash
522           keys (Unicode hash values have been supported since Storable 1.0.1)
523           and "restricted hashes" (readonly hashes and hash entries)
524         - a newer version of perl can now be used to serialize data which is
525           not supported in earlier perls: Storable will attempt to do the
526           right thing for as long as possible, croaking only when safe data
527           conversion simply isn't possible. Alternatively earlier perls can
528           opt to have a lossy downgrade data instead of croaking
529         - when built with perls pre 5.7.3 this Storable writes out files
530           with binary format 2.4, the same format as Storable 1.0.8 onwards.
531           This should mean that this Storable will inter-operate seamlessly
532           with any Storable 1.0.8 or newer on perls pre 5.7.3
533         - dclone() now works with empty string scalar objects
534         - retrieving of large hashes is now more efficient
535         - more routines autosplit out of the main module, so Storable should
536           load slightly more quickly
537         - better documentation
538         - the internal context objects are now freed explicitly, rather than
539           relying on thread or process exit
540         - bugs fixed in debugging trace code affecting builds made with 64 bit
541           IVs
542         - code tidy-ups to allow clean compiles with more warning options
543           turned on avoid problems with $@ getting corrupted on 5.005_03 if
544           Carp wasn't already loaded
545         - added &show_file_magic, so you can add to /etc/magic and teach
546           Unix's file command about Storable files
547
548         We plan to keep Storable on CPAN in sync with the Perl core, so
549         if you encounter bugs or other problems building or using Storable,
550         please let us know at perl5-porters@perl.org
551         Patches welcome!
552         
553 Sat Dec  1 14:37:54 MET 2001   Raphael Manfredi <Raphael_Manfredi@pobox.com>
554
555         This is the LAST maintenance release of the Storable module.
556         Indeed, Storable is now part of perl 5.8, and will be maintained
557         as part of Perl.  The CPAN module will remain available there
558         for people running pre-5.8 perls.
559
560         Avoid requiring Fcntl upfront, useful to embedded runtimes.
561         Use an eval {} for testing, instead of making Storable.pm
562         simply fail its compilation in the BEGIN block.
563
564         store_fd() will now correctly autoflush file if needed.
565
566 Tue Aug 28 23:53:20 MEST 2001   Raphael Manfredi <Raphael_Manfredi@pobox.com>
567
568         Fixed truncation race with lock_retrieve() in lock_store().
569         The file has to be truncated only once the exclusive lock is held.
570
571         Removed spurious debugging messages in .xs file.
572
573 Sun Jul  1 13:27:32 MEST 2001   Raphael Manfredi <Raphael_Manfredi@pobox.com>
574
575         Systematically use "=over 4" for POD linters.
576         Apparently, POD linters are much stricter than would
577         otherwise be needed, but that's OK.
578
579         Fixed memory corruption on croaks during thaw().  Thanks
580         to Claudio Garcia for reproducing this bug and providing the
581         code to exercise it.  Added test cases for this bug, adapted
582         from Claudio's code.
583
584         Made code compile cleanly with -Wall (from Jarkko Hietaniemi).
585
586         Changed tagnum and classnum from I32 to IV in context.  Also
587         from Jarkko.
588
589 Thu Mar 15 01:22:32 MET 2001   Raphael Manfredi <Raphael_Manfredi@pobox.com>
590
591         Last version was wrongly compiling with assertions on, due
592         to an edit glitch.  That did not cause any problem (apart from
593         a slight performance loss) excepted on Win* platforms, where the
594         assertion code does not compile.
595
596 Sat Feb 17 13:37:37 MET 2001   Raphael Manfredi <Raphael_Manfredi@pobox.com>
597
598     Version 1.0.10.
599
600         Forgot to increase version number at previous patch (there were
601         two of them, which is why we jump from 1.0.8 to 1.0.10).
602
603 Sat Feb 17 13:35:00 MET 2001   Raphael Manfredi <Raphael_Manfredi@pobox.com>
604
605     Version 1.0.8, binary format 2.4.
606
607         Fixed incorrect error message.
608
609         Now bless objects ASAP at retrieve time, which is meant to fix
610         two bugs:
611
612         * Indirect references to overloaded object were not able to
613           restore overloading if the object was not blessed yet,
614           which was possible since blessing occurred only after the
615           recursive retrieval.
616
617         * Storable hooks asking for serialization of blessed ref could
618           get un-blessed refs at retrieval time, for the very same
619           reason.
620
621         The fix implemented here was suggested by Nick Ing-Simmons.
622
623         Added support for blessed ref to tied structures.  This is the
624         cause for the binary format change.
625
626         Added EBCDIC version of the compatibility test with 0.6.11,
627         from Peter Prymmer
628
629         Added tests for the new features, and to make sure the bugs they
630         are meant to fix are indeed fixed.
631
632 Wed Jan  3 10:43:18 MET 2001   Raphael Manfredi <Raphael_Manfredi@pobox.com>
633
634         Removed spurious 'clean' entry in Makefile.PL.
635
636         Added CAN_FLOCK to determine whether we can flock() or not,
637         by inspecting Perl's configuration parameters, as determined
638         by Configure.
639
640         Trace offending package when overloading cannot be restored
641         on a scalar.
642
643         Made context cleanup safer to avoid dup freeing, mostly in the
644         presence of repeated exceptions during store/retrieve (which can
645         cause memory leaks anyway, so it's just additional safety, not a
646         definite fix).
647
648 Sun Nov  5 18:23:48 MET 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
649
650     Version 1.0.6.
651
652         Fixed severe "object lost" bug for STORABLE_freeze returns,
653         when refs to lexicals, taken within the hook, were to be
654         serialized by Storable.  Enhanced the t/recurse.t test to
655         stress hook a little more with refs to lexicals.
656
657 Thu Oct 26 19:14:38 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
658
659     Version 1.0.5.
660
661         Documented that store() and retrieve() can return undef.
662         That is, the error reporting is not always made via exceptions,
663         as the paragraph on error reporting was implying.
664
665         Auto requires module of blessed ref when STORABLE_thaw misses.
666         When the Storable engine looks for the STORABLE_thaw hook and
667         does not find it, it now tries to require the package into which
668         the blessed reference is.
669
670         Just check $^O, in t/lock.t: there's no need to pull the whole
671         Config module for that.
672
673 Mon Oct 23 20:03:49 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
674
675     Version 1.0.4.
676
677         Protected calls to flock() for DOS platform: apparently, the
678         flock/fcnlt emulation is reported to be broken on that
679         platform.
680
681         Added logcarp emulation if they don't have Log::Agent, since
682         we now use it to carp when lock_store/lock_retrieve is used
683         on DOS.
684
685 Fri Sep 29 21:52:29 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
686
687     Version 1.0.3.
688
689         Avoid using "tainted" and "dirty" since Perl remaps them via
690         cpp (i.e. #define).  This is deeply harmful when threading
691         is enabled.  This concerned both the context structure and
692         local variable and argument names.  Brrr..., scary!
693
694 Thu Sep 28 23:46:39 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
695
696     Version 1.0.2.
697
698         Fixed spelling in README.
699
700         Added lock_store, lock_nstore, and lock_retrieve (advisory locking)
701         after a proposal from Erik Haugan <erik@solbors.no>.
702
703         Perls before 5.004_04 lack newSVpvn, added remapping in XS.
704
705         Fixed stupid typo in the t/utf8.t test.
706
707 Sun Sep 17 18:51:10 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
708
709     Version 1.0.1, binary format 2.3.
710
711         Documented that doubles are stored stringified by nstore().
712
713         Added Salvador Ortiz Garcia in CREDITS section,  He identified
714         a bug in the store hooks and proposed the right fix: the class
715         id was allocated too soon.  His bug case was also added to
716         the regression test suite.
717
718         Now only taint retrieved data when source was tainted.  A bug
719         discovered by Marc Lehmann.
720
721         Added support for UTF-8 strings, a contribution of Marc Lehmann.
722         This is normally only activated in post-5.6 perls.
723
724 Thu Aug 31 23:06:06 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
725
726         First official release Storable 1.0, for inclusion in perl 5.7.0.
727         The license scheme is now compatible with Perl's.
728
729 Thu Aug 24 01:02:02 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
730
731         ANSI-fied most of the code, preparing for Perl core integration.
732         The next version of Storable will be 0.8, and will be integrated
733         into the Perl core (development branch).
734
735         Dispatch tables were moved upfront to relieve some compilers,
736         especially on AIX and Windows platforms.
737
738         Merged 64-bit fixes from perl5-porters.
739
740 Mon Aug 14 09:22:04 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
741
742         Added a refcnt dec in retrieve_tied_key(): sv_magic() increases
743         the refcnt on the mg_ptr as well.
744
745         Removed spurious dependency to Devel::Peek, which was used for
746         testing only in t/tied_items.t.  Thanks to Conrad Heiney
747         <conrad@fringehead.org> for spotting it first.
748
749 Sun Aug 13 22:12:59 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
750
751         Marc Lehmann kindly contributed code to add overloading support
752         and to handle references to tied variables.
753
754         Rewrote leading blurb about compatibility to make it clearer what
755         "backward compatibility" is about: when I say 0.7 is backward
756         compatible with 0.6, it means the revision 0.7 can read files
757         produced by 0.6.
758
759         Mention new Clone(3) extension in SEE ALSO.
760
761         Was wrongly optimizing for "undef" values in hashes by not
762         fully recursing: as a result, tied "undef" values were incorrectly
763         serialized.
764
765 Sun Jul 30 12:59:17 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
766
767     First revision of Storable 0.7.
768
769         The serializing format is new, known as version 2.0.  It is fully
770         backward compatible with 0.6.  Earlier formats are deprecated and
771         have not even been tested: next version will drop pre-0.6 format.
772
773         Changes since 0.6@11:
774
775         - Moved interface to the "beta" status.  Some tiny parts are still
776           subject to change, but nothing important enough to warrant an "alpha"
777           status any longer.
778
779         - Slightly reduced the size of the Storable image by factorizing
780           object class names and removing final object storage notification due
781           to a redesign of the blessed object storing.
782
783         - Classes can now redefine how they wish their instances to be serialized
784           and/or deep cloned.  Serializing hooks are written in Perl code.
785
786         - The engine is now fully re-entrant.
787
788 Sun Apr  2 23:47:50 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
789
790         Added provision to detect more recent binary formats, since
791         the new upcoming Storable-0.7 will use a different format.
792         In order to prevent attempting the de-serialization of newer
793         formats by older versions, I'm adding this now to the 0.6 series.
794
795         I'm expecting this revision to be the last of the 0.6 series.
796         Unless it does not work with perl 5.6, which I don't use yet,
797         and therefore against which I cannot test.
798
799 Wed Mar 29 19:55:21 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
800
801         Added note about format incompatibilities with old versions
802         (i.e. pre 0.5@9 formats, which cannot be understood as there
803         was no versionning information in the file by then).
804
805         Protect all $@ variables when eval {} used, to avoid corrupting
806         it when store/retrieve is called within an exception handler.
807
808         Mistakenly included "patchlevel.h" instead of <patchlevel.h>,
809         preventing Perl's patchlevel from being included, which is
810         needed starting from 5.6.
811
812 Tue May 12 09:15:15 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
813
814         Fixed shared "undef" bug in hashes, which did not remain shared
815         through store/retrieve.
816
817 Thu Feb 10 19:48:16 MET 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
818
819         added last_op_in_netorder() predicate
820         documented last_op_in_netorder()
821         added tests for the new last_op_in_netorder() predicate
822
823 Wed Oct 20 19:07:36 MEST 1999   Raphael Manfredi <Raphael_Manfredi@pobox.com>
824
825         Forgot to update VERSION
826
827 Tue Oct 19 21:25:02 MEST 1999   Raphael Manfredi <Raphael_Manfredi@pobox.com>
828
829         Added mention of japanese translation for the manual page.
830
831         Fixed typo in macro that made threaded code not compilable,
832         especially on Win32 platforms.
833
834         Changed detection of older perls (pre-5.005) by testing PATCHLEVEL
835         directly instead of relying on internal symbols.
836
837 Tue Sep 14 22:13:28 MEST 1999   Raphael Manfredi <Raphael_Manfredi@pobox.com>
838
839         Integrated "thread-safe" patch from Murray Nesbitt.
840         Note that this may not be very efficient for threaded code,
841         see comment in the code.
842
843         Try to avoid compilation warning on 64-bit CPUs. Can't test it,
844         since I don't have access to such machines.
845
846 Mon Jul 12 14:37:19 METDST 1999   Raphael Manfredi <Raphael_Manfredi@pobox.com>
847
848         changed my e-mail to pobox.
849
850         mentioned it is not thread-safe.
851
852         updated version number.
853
854         uses new internal PL_* naming convention.
855
856 Fri Jul  3 13:38:16 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
857
858         Updated benchmark figures due to recent optimizations done in
859         store(): tagnums are now stored as-is in the hash table, so
860         no surrounding SV is created. And the "shared keys" mode for
861         hash table was turned off.
862
863         Fixed backward compatibility (wrt 0.5@9) for retrieval of
864         blessed refs. That old version did something wrong, but the
865         bugfix prevented correct retrieval of the old format.
866
867 Mon Jun 22 11:00:48 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
868
869         Changed benchmark figures.
870
871         Adjust refcnt of tied objects after calling sv_magic() to avoid
872         memory leaks.  Contributed by Jeff Gresham.
873
874 Fri Jun 12 11:50:04 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
875
876         Added workaround for persistent LVALUE-ness in perl5.004. All
877         scalars tagged as being an lvalue are handled as if they were
878         not an lvalue at all.  Added test for that LVALUE bug workaround.
879
880         Now handles Perl immortal scalars explicitly, by storing &sv_yes
881         as such, explicitly.
882
883         Retrieval of non-immortal undef cannot be shared. Previous
884         version was over-optimizing by not creating a separate SV for
885         all undefined scalars seen.
886
887 Thu Jun  4 17:21:51 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
888
889     Baseline for Storable-0.6@0.
890
891         This version introduces a binary incompatibility in the generated
892         binary image, which is more compact than older ones by approximatively
893         15%, depending on the exact degree of sharing in your structures.
894
895         The good news is that your older images can still be retrieved with
896         this version, i.e. backward compatibility is preserved. This version
897         of Storable can only generate new binaries however.
898
899         Another good news is that the retrieval of data structure is
900         significantly quicker than before, because a Perl array is used
901         instead of a hash table to keep track of retrieved objects, and
902         also because the image being smaller, less I/O function calls are
903         made.
904
905 Tue May 12 09:15:15 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
906
907         Version number now got from Storable.pm directly.
908
909         Fixed overzealous sv_type() optimization, which would make
910         Storable fail when faced with an "upgraded" SV to the PVIV
911         or PVNV kind containing a reference.
912
913 Thu Apr 30 15:11:30 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
914
915         Extended the SYNOPSIS section to give quick overview of the
916         routines and their signature.
917
918         Optimized sv_type() to avoid flags checking when not needed, i.e.
919         when their type makes it impossible for them to be refs or tied.
920         This slightly increases throughput by a few percents when refs
921         and tied variables are marginal occurrences in your data.
922
923         Stubs for XS now use OutputStream and InputStream file types to
924         make it work when the given file is actually a socket. Perl
925         makes a distinction for sockets in its internal I/O structures
926         by having both a read and a write structure, whereas plain files
927         share the same one.
928
929 Tue Jun  3 09:41:33 METDST 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
930
931         Thanks to a contribution from Benjamin A. Holzman, Storable is now
932         able to correctly serialize tied SVs, i.e. tied arrays, hashes
933         and scalars.
934
935 Thu Apr  9 18:07:51 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
936
937         I said SvPOK() had changed to SvPOKp(), but that was a lie...
938
939 Wed Apr  8 13:14:29 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
940
941         Wrote sizeof(SV *) instead of sizeof(I32) when portable, which
942         in effect mangled the object tags and prevented portability
943         across 32/64 bit architectures!
944
945 Wed Mar 25 14:57:02 MET 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
946
947         Added code example for store_fd() and retrieve_fd() in the
948         man page, to emphasize that file descriptors must be passed as
949         globs, not as plain strings.
950
951         Cannot use SV addresses as tag when using nstore() on LP64. This
952         was the cause of problems when creating a storable image on an
953         LP64 machine and retrieving it on an ILP32 system, which is
954         exactly what nstore() is meant for...
955
956         However, we continue to use SV addresses as tags for plain store(),
957         because benchmarking shows that it saves up to 8% of the store
958         time, and store() is meant to be fast at the expense of lack
959         of portability.
960
961         This means there will be approximately an 8% degradation of
962         performance for nstore(), but it's now working as expected.
963         That cost may vary on your machine of course, since it is
964         solely caused by the memory allocation overhead used to create
965         unique SV tags for each distinct stored SV.
966
967 Tue Jan 20 09:21:53 MET 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
968
969         Don't use any '_' in version number.
970
971 Tue Jan 13 17:51:50 MET 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
972
973         Updated version number.
974
975         added binmode() calls for systems where it matters.
976
977         Be sure to pass globs, not plain file strings, to C routines,
978         so that Storable can be used under the Perl debugger.
979
980 Wed Nov  5 10:53:22 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
981
982         Fix memory leaks on seen hash table and returned SV refs.
983
984         Storable did not work properly when tainting enabled.
985
986         Fixed "Allocation too large" messages in freeze/thaw and added.
987         proper regression test in t/freeze.t.
988
989 Tue Jun  3 09:41:33 METDST 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
990
991         Updated version number
992
993         Added freeze/thaw interface and dclone.
994
995 Fri May 16 10:45:47 METDST 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
996
997         Forgot that AutoLoader does not export its own AUTOLOAD.
998         I could use
999
1000                 use AutoLoader 'AUTOLOAD';
1001         
1002         but that would not be backward compatible. So the export is
1003         done by hand...
1004
1005 Tue Mar 25 11:21:32 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
1006
1007         Empty scalar strings are now "defined" at retrieval time.
1008
1009         New test to ensure an empty string is defined when retrieved.
1010
1011 Thu Feb 27 16:32:44 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
1012
1013         Updated version number
1014
1015         Declare VERSION as being used
1016
1017         Fixed a typo in the PerlIO_putc remapping.
1018         PerlIO_read and perlIO_write inverted size/nb_items.
1019         (only relevant for pre-perl5.004 versions)
1020
1021 Thu Feb 27 15:58:31 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
1022
1023         Updated version number
1024
1025         Added VERSION identification
1026
1027         Allow build with perl5.003, which is ante perlIO time
1028
1029 Mon Jan 13 17:53:18 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
1030
1031         Random code fixes.
1032
1033 Wed Jan 22 15:19:56 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
1034
1035         Updated version number in Makefile.PL.
1036
1037         Added "thanks to" section to README.
1038
1039         Documented new forgive_me variable.
1040
1041         Made 64-bit clean.
1042
1043         Added forgive_me support to allow store() of data structures
1044         containing non-storable items like CODE refs.