This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
segfault on &Internals::* due to missing SvROK()
[perl5.git] / pod / perldelta.pod
1 =encoding utf8
2
3 =for release_engineer
4 * changelogged up to 26e1fc4
5 * the mauve module will not be part of the release, so it's not changelogged
6 yet. it also added some new api functions. those aren't covered either, as they
7 might go away again in case mauve gets rolled back for 5.13.5.
8
9 =head1 NAME
10
11 [ this is a template for a new perldelta file. Any text flagged as
12 XXX needs to be processed before release. ]
13
14 perldelta - what is new for perl v5.13.5
15
16 =head1 DESCRIPTION
17
18 This document describes differences between the 5.13.4 release and
19 the 5.13.5 release.
20
21 If you are upgrading from an earlier release such as 5.13.3, first read
22 L<perl5134delta>, which describes differences between 5.13.3 and
23 5.13.4.
24
25 =head1 Notice
26
27 XXX Any important notices here
28
29 =head1 Core Enhancements
30
31 XXX New core language features go here. Summarise user-visible core language
32 enhancements. Particularly prominent performance optimisations could go
33 here, but most should go in the L</Performance Enhancements> section.
34
35 =head2 Adjacent pairs of nextstate opcodes are now optimized away
36
37 Previously, in code such as
38
39     use constant DEBUG => 0;
40
41     sub GAK {
42         warn if DEBUG;
43         print "stuff\n";
44     }
45
46 the ops for C<warn if DEBUG;> would be folded to a C<null> op (C<ex-const>), but
47 the C<nextstate> op would remain, resulting in a runtime op dispatch of
48 C<nextstate>, C<nextstate>, ...
49
50 The execution of a sequence of C<nexstate> ops is indistinguishable from just
51 the last C<nextstate> op, so teach the peephole optimiser to eliminate the first
52 of a pair of C<nextstate> ops. (Except where the first carries a label, as
53 labels mustn't be eliminated by the optimiser, and label usage isn't
54 conclusively known at compile time.)
55
56 =head2 API function to parse statements
57
58 The C<parse_fullstmt> function has been added to allow parsing of a single
59 complete Perl statement. See L<perlapi> for details.
60
61 =head2 API functions for accessing the runtime hinthash
62
63 A new C API for introspecting the hinthash C<%^H> at runtime has been added. See
64 C<cop_hints_2hv>, C<cop_hints_fetchpvn>, C<cop_hints_fetchpvs>, and
65 C<cop_hints_fetchsv> in L<perlapi> for details.
66
67 =head2 C interface to C<caller()>
68
69 The C<caller_cx> function has been added as an XSUB-writer's equivalent of
70 C<caller()>. See L<perlapi> for details.
71
72 =head1 Security
73
74 XXX Any security-related notices go here.  In particular, any security
75 vulnerabilities closed should be noted here rather than in the
76 L</Selected Bug Fixes> section.
77
78 [ List each security issue as a =head2 entry ]
79
80 =head1 Incompatible Changes
81
82 =head2 Magic Variables Outside the Main Package
83
84 In previous versions of perl, magic variables like C<$!>, C<%SIG>, etc.  would
85 'leak' into other packages. So C<%foo::SIG> could be used to access signals,
86 C<${"foo::!"}> (with strict mode off) to access C's C<errno>, etc.
87
88 This was a bug, or an 'unintentional' feature, which caused various ill
89 effects, such as signal handlers being wiped when modules were loaded, etc.
90
91 This has been fixed (or the feature has been removed, depending on how you
92 see it).
93
94 =head2 Smart-matching against array slices
95
96 Previously, the following code resulted in a successful match:
97
98     my @a = qw(a y0 z);
99     my @b = qw(a x0 z);
100     $a[0 .. $#b] ~~ @b;
101
102 This odd behaviour has now been fixed [perl #77468].
103
104 =head2 C API changes
105
106 The first argument of the C API function C<Perl_fetch_cop_label> has changed
107 from C<struct refcounted he *> to C<COP *>, to better insulate the user from
108 implementation details.
109
110 This API function was marked as "may change", and likely isn't in use outside
111 the core. (Neither an unpacked CPAN, nor Google's codesearch, finds any other
112 references to it.)
113
114 =head1 Deprecations
115
116 XXX Any deprecated features, syntax, modules etc. should be listed here.
117 In particular, deprecated modules should be listed here even if they are
118 listed as an updated module in the L</Modules and Pragmata> section.
119
120 =head2 Use of qw(...) as parentheses
121
122 Historically the parser fooled itself into thinking that C<qw(...)> literals
123 were always enclosed in parentheses, and as a result you could sometimes omit
124 parentheses around them:
125
126     for $x qw(a b c) { ... }
127
128 The parser no longer lies to itself in this way.  Wrap the list literal in
129 parentheses, like:
130
131     for $x (qw(a b c)) { ... }
132
133 =head1 Performance Enhancements
134
135 XXX Changes which enhance performance without changing behaviour go here. There
136 may well be none in a stable release.
137
138 [ List each enhancement as a =item entry ]
139
140 =over 4
141
142 =item *
143
144 Scalars containing regular expressions now only allocate the part of the C<SV>
145 body they actually use, saving some space.
146
147 =back
148
149 =head1 Modules and Pragmata
150
151 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
152 go here.  If Module::CoreList is updated, generate an initial draft of the
153 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
154 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
155 below.  A paragraph summary for important changes should then be added by hand.
156 In an ideal world, dual-life modules would have a F<Changes> file that could be
157 cribbed.
158
159 [ Within each section, list entries as a =item entry ]
160
161 =head2 New Modules and Pragmata
162
163 =over 4
164
165 =item *
166
167 XXX
168
169 =back
170
171 =head2 Updated Modules and Pragmata
172
173 =over 4
174
175 =item *
176
177 C<blib> has been upgraded from version 1.05 to 1.06.
178
179 =item *
180
181 C<bignum>, C<bigint>, and C<bigrat> have been upgraded from version 0.23 to
182 0.24.
183
184 =item *
185
186 C<warnings> has been upgraded from version 1.10 to 1.11.
187
188 C<warnings::register> has been upgraded from version 1.01 to 1.02.
189
190 It is now possible to register warning categories other than the names of
191 packages using warnings::register.  See L<perllexwarn> for more information.
192
193 =item *
194
195 C<Data::Dumper> has been upgraded from version 2.126 to 2.128.
196
197 This fixes a crash when using custom sort functions that might cause the stack
198 to change.
199
200 =item *
201
202 C<Errno> has been upgraded from version 1.12 to 1.13.
203
204 On some platforms with unusual header files, like Win32/gcc using mingw64
205 headers, some constants which weren't actually error numbers have been exposed
206 by C<Errno>. This has been fixed (RT#77416).
207
208 =item *
209
210 C<ExtUtils::MakeMaker> has been upgraded from version 6.56 to 6.57_01.
211
212 =item *
213
214 C<Filter::Simple> has been upgraded from version 0.84 to 0.85.
215
216 =item *
217
218 C<Math::BigInt> has been upgraded from version 1.89_01 to 1.92.
219 C<Math::BigInt::Calc> has been upgraded from version 0.52 to 0.53.
220
221 This fixes incorrect results when computing binomial coefficients (RT#77640).
222
223 =item *
224
225 C<Math::BigInt::FastCalc> has been upgraded from version 0.19 to 0.21.
226
227 =item *
228
229 C<Module::CoreList> has been upgraded from version 2.37 to 2.38.
230
231 =item *
232
233 C<Tie::Hash> has been upgraded from version 1.03 to 1.04.
234
235 Calling C<< Tie::Hash->TIEHASH() >> used to loop forever. Now it C<croak>s.
236
237 =item *
238
239 C<Unicode::Collate> has been upgraded from version 0.56 to 0.59.
240
241 =item *
242
243 C<XSLoader> has been upgraded from version 0.10 to 0.11.
244
245 =back
246
247 =head2 Removed Modules and Pragmata
248
249 =over 4
250
251 =item *
252
253 XXX
254
255 =back
256
257 =head1 Documentation
258
259 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
260 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
261
262 =head2 New Documentation
263
264 XXX Changes which create B<new> files in F<pod/> go here.
265
266 =head3 L<XXX>
267
268 XXX Description of the purpose of the new file here
269
270 =head2 Changes to Existing Documentation
271
272 XXX Changes which significantly change existing files in F<pod/> go here.
273 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
274 section.
275
276 =head3 L<perlapi>
277
278 =over 4
279
280 =item *
281
282 Many of the optree construction functions are now documented.
283
284 =back
285
286 =head1 Diagnostics
287
288 The following additions or changes have been made to diagnostic output,
289 including warnings and fatal error messages.  For the complete list of
290 diagnostic messages, see L<perldiag>.
291
292 XXX New or changed warnings emitted by the core's C<C> code go here. Also
293 include any changes in L<perldiag> that reconcile it to the C<C> code.
294
295 [ Within each section, list entries as a =item entry ]
296
297 =head2 New Diagnostics
298
299 XXX Newly added diagnostic messages go here
300
301 =over 4
302
303 =item *
304
305 Use of qw(...) as parentheses is deprecated
306
307 =back
308
309 =head2 Changes to Existing Diagnostics
310
311 XXX Changes (i.e. rewording) of diagnostic messages go here
312
313 =over 4
314
315 =item *
316
317 XXX
318
319 =back
320
321 =head1 Utility Changes
322
323 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
324 here. Most of these are built within the directories F<utils> and F<x2p>.
325
326 [ List utility changes as a =head3 entry for each utility and =item
327 entries for each change
328 Use L<XXX> with program names to get proper documentation linking. ]
329
330 =head3 L<h2ph>
331
332 =over 4
333
334 =item *
335
336 The use of a deprecated C<goto> construct has been removed (RT#74404).
337
338 =back
339
340 =head1 Configuration and Compilation
341
342 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
343 go here.  Any other changes to the Perl build process should be listed here.
344 However, any platform-specific changes should be listed in the
345 L</Platform Support> section, instead.
346
347 [ List changes as a =item entry ].
348
349 =over 4
350
351 =item *
352
353 XXX
354
355 =back
356
357 =head1 Testing
358
359 XXX Any significant changes to the testing of a freshly built perl should be
360 listed here.  Changes which create B<new> files in F<t/> go here as do any
361 large changes to the testing harness (e.g. when parallel testing was added).
362 Changes to existing files in F<t/> aren't worth summarising, although the bugs
363 that they represent may be covered elsewhere.
364
365 [ List each test improvement as a =item entry ]
366
367 =over 4
368
369 =item *
370
371 A rare race condition in F<t/op/while_readdir.t> has been fixed, stopping it
372 from failing randomly when running tests in parallel.
373
374 =item *
375
376 The new F<t/op/leaky-magic.t> script tests that magic applied to variables in
377 the main packages does not affect other packages.
378
379 =back
380
381 =head1 Platform Support
382
383 XXX Any changes to platform support should be listed in the sections below.
384
385 [ Within the sections, list each platform as a =item entry with specific
386 changes as paragraphs below it. ]
387
388 =head2 New Platforms
389
390 XXX List any platforms that this version of perl compiles on, that previous
391 versions did not. These will either be enabled by new files in the F<hints/>
392 directories, or new subdirectories and F<README> files at the top level of the
393 source tree.
394
395 =over 4
396
397 =item XXX-some-platform
398
399 XXX
400
401 =back
402
403 =head2 Discontinued Platforms
404
405 XXX List any platforms that this version of perl no longer compiles on.
406
407 =over 4
408
409 =item XXX-some-platform
410
411 XXX
412
413 =back
414
415 =head2 Platform-Specific Notes
416
417 XXX List any changes for specific platforms. This could include configuration
418 and compilation changes or changes in portability/compatibility.  However,
419 changes within modules for platforms should generally be listed in the
420 L</Modules and Pragmata> section.
421
422 =over 4
423
424 =item VMS
425
426 =over 4
427
428 =item *
429
430 Make PerlIOUnix_open honor default permissions on VMS.
431
432 When perlio became the default and unixio became the default bottom layer, the
433 most common path for creating files from Perl became C<PerlIOUnix_open>, which
434 has always explicitly used C<0666> as the permission mask.
435
436 To avoid this, C<0777> is now passed as the permissions to C<open()>. In the VMS
437 CRTL, C<0777> has a special meaning over and above intersecting with the current
438 umask; specifically, it allows Unix syscalls to preserve native default
439 permissions.
440
441 =back
442
443 =back
444
445 =head1 Internal Changes
446
447 XXX Changes which affect the interface available to C<XS> code go here.
448 Other significant internal changes for future core maintainers should
449 be noted as well.
450
451 [ List each test improvement as a =item entry ]
452
453 =over 4
454
455 =item *
456
457 C<CALL_FPTR> and C<CPERLscope> have been removed deprecated.
458
459 Those are left from an old implementation of C<MULTIPLICITY> using C++ objects,
460 which has been removed in 5.8. Nowadays these macros do exactly nothing, so they
461 shouldn't be used anymore.
462
463 For compatibility, they are still defined for external C<XS> code. Only
464 extensions defining C<PERL_CORE> must be updated now.
465
466 =item *
467
468 C<lex_stuff_pvs()> has been added as a convenience macro wrapping
469 C<lex_stuff_pvn()> for literal strings.
470
471 =item *
472
473 The recursive part of the peephole optimizer is how hookable.
474
475 In addition to C<PL_peepp>, for hooking into the toplevel peephole optimizer, a
476 C<PL_rpeepp> is now available to hook into the optimizer recursing into
477 side-chains of the optree.
478
479 =back
480
481 =head1 Selected Bug Fixes
482
483 XXX Important bug fixes in the core language are summarised here.
484 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
485 L</Modules and Pragmata>.
486
487 [ List each fix as a =item entry ]
488
489 =over 4
490
491 =item *
492
493 A regression introduced in perl 5.12.0, making
494 C<< my $x = 3; $x = length(undef) >> result in C<$x> set to C<3> has been
495 fixed. C<$x> will now be C<undef>.
496
497 =item *
498
499 A fatal error in regular expressions when processing UTF-8 data has been fixed
500 (RT#75680).
501
502 =item *
503
504 An erroneous regular expression engine optimization, that caused regex verbs
505 like C<*COMMIT> to sometimes be ignored, has been removed.
506
507 =item *
508
509 The perl debugger now also works in taint mode (RT#76872).
510
511 =item *
512
513 Several memory leaks in cloning and freeing threaded perl interpreters have been
514 fixed (RT#77352).
515
516 =item *
517
518 A possible string corruption when doing regular expression matches on overloaded
519 objects has been fixed (RT#77084).
520
521 =item *
522
523 Magic applied to variables in the main package no longer affects other
524 packages. See L</Magic Variables Outside the Main Package>, above [perl #76138].
525
526 =item *
527
528 Opening a glob reference via C<< open $fh, ">", \*glob >> will no longer cause
529 the glob to be corrupted when the file handle is printed to. This would cause
530 perl to crash whenever the glob's contents were accessed [perl #77492].
531
532 =item *
533
534 The postincrement and postdecrement operators, C<++> and C<--> used to cause
535 leaks when being used on references. This has now been fixed.
536
537 =item *
538
539 A bug when replacing the glob of a loop variable within the loop has been
540 fixed [perl #21469]. This means the following code will no longer crash:
541
542     for $x (...) {
543         *x = *y;
544     }
545
546 =item *
547
548 Perl would segfault if the undocumented C<Internals> functions that
549 used reference prototypes were called with the C<&foo()> syntax,
550 e.g. C<&Internals::SvREADONLY(undef)> [perl #77776].
551
552 These functions now call C<SvROK> on their arguments before
553 dereferencing them with C<SvRV>, and we test for this case in
554 F<t/lib/universal.t>.
555
556 =back
557
558 =head1 Known Problems
559
560 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
561 tests that had to be C<TODO>ed for the release would be noted here, unless
562 they were specific to a particular platform (see below).
563
564 This is a list of some significant unfixed bugs, which are regressions
565 from either 5.XXX.XXX or 5.XXX.XXX.
566
567 [ List each fix as a =item entry ]
568
569 =over 4
570
571 =item *
572
573 XXX
574
575 =back
576
577 =head1 Obituary
578
579 XXX If any significant core contributor has died, we've added a short obituary
580 here.
581
582 =head1 Acknowledgements
583
584 XXX The list of people to thank goes here.
585
586 =head1 Reporting Bugs
587
588 If you find what you think is a bug, you might check the articles
589 recently posted to the comp.lang.perl.misc newsgroup and the perl
590 bug database at http://rt.perl.org/perlbug/ .  There may also be
591 information at http://www.perl.org/ , the Perl Home Page.
592
593 If you believe you have an unreported bug, please run the B<perlbug>
594 program included with your release.  Be sure to trim your bug down
595 to a tiny but sufficient test case.  Your bug report, along with the
596 output of C<perl -V>, will be sent off to perlbug@perl.org to be
597 analysed by the Perl porting team.
598
599 If the bug you are reporting has security implications, which make it
600 inappropriate to send to a publicly archived mailing list, then please send
601 it to perl5-security-report@perl.org. This points to a closed subscription
602 unarchived mailing list, which includes all the core committers, who be able
603 to help assess the impact of issues, figure out a resolution, and help
604 co-ordinate the release of patches to mitigate or fix the problem across all
605 platforms on which Perl is supported. Please only use this address for
606 security issues in the Perl core, not for modules independently
607 distributed on CPAN.
608
609 =head1 SEE ALSO
610
611 The F<Changes> file for an explanation of how to view exhaustive details
612 on what changed.
613
614 The F<INSTALL> file for how to build Perl.
615
616 The F<README> file for general stuff.
617
618 The F<Artistic> and F<Copying> files for copyright information.
619
620 =cut