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