This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
00effc392fb7f2bc9c13db1900f7576ac2bf7cc4
[perl5.git] / pod / perltodo.pod
1 =head1 NAME
2
3 perltodo - Perl TO-DO List
4
5 =head1 DESCRIPTION
6
7 This is a list of wishes for Perl. The tasks we think are smaller or
8 easier are listed first. Anyone is welcome to work on any of these,
9 but it's a good idea to first contact I<perl5-porters@perl.org> to
10 avoid duplication of effort, and to learn from any previous attempts.
11 By all means contact a pumpking privately first if you prefer.
12
13 Whilst patches to make the list shorter are most welcome, ideas to add to
14 the list are also encouraged. Check the perl5-porters archives for past
15 ideas, and any discussion about them. One set of archives may be found at:
16
17     http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/
18
19 What can we offer you in return? Fame, fortune, and everlasting glory? Maybe
20 not, but if your patch is incorporated, then we'll add your name to the
21 F<AUTHORS> file, which ships in the official distribution. How many other
22 programming languages offer you 1 line of immortality?
23
24 =head1 Tasks that only need Perl knowledge
25
26 =head2 Smartmatch design issues
27
28 In 5.10.0 the smartmatch operator C<~~> isn't working quite "right". But
29 before we can fix the implementation, we need to define what "right" is.
30 The first problem is that Robin Houston implemented the Perl 6 smart match
31 spec as of February 2006, when smart match was axiomatically symmetrical:
32 L<http://groups.google.com/group/perl.perl6.language/msg/bf2b486f089ad021>
33
34 Since then the Perl 6 target moved, but the Perl 5 implementation did not.
35
36 So it would be useful for someone to compare the Perl 6 smartmatch table
37 as of February 2006 L<http://svn.perl.org/viewvc/perl6/doc/trunk/design/syn/S03.pod?view=markup&pathrev=7615>
38 and the current table L<http://svn.perl.org/viewvc/perl6/doc/trunk/design/syn/S03.pod?revision=14556&view=markup>
39 and tabulate the differences in Perl 6. The annotated view of changes is
40 L<http://svn.perl.org/viewvc/perl6/doc/trunk/design/syn/S03.pod?view=annotate> and the diff is
41 C<svn diff -r7615:14556 http://svn.perl.org/perl6/doc/trunk/design/syn/S03.pod>
42 -- search for C<=head1 Smart matching>. (In theory F<viewvc> can generate that,
43 but in practice when I tried it hung forever, I assume "thinking")
44
45 With that done and published, someone (else) can then map any changed Perl 6
46 semantics back to Perl 5, based on how the existing semantics map to Perl 5:
47 L<http://search.cpan.org/~rgarcia/perl-5.10.0/pod/perlsyn.pod#Smart_matching_in_detail>
48
49
50 There are also some questions that need answering:
51
52 =over 4
53
54 =item *
55
56 How do you negate one?  (documentation issue)
57 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00071.html
58
59 =item *
60
61 Array behaviors
62 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2007-12/msg00799.html
63
64 * Should smart matches be symmetrical? (Perl 6 says no)
65
66 * Other differences between Perl 5 and Perl 6 smart match?
67
68 =item *
69
70 Objects and smart match
71 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2007-12/msg00865.html
72
73 =back
74
75 =head2 Remove duplication of test setup.
76
77 Schwern notes, that there's duplication of code - lots and lots of tests have
78 some variation on the big block of C<$Is_Foo> checks.  We can safely put this
79 into a file, change it to build an C<%Is> hash and require it.  Maybe just put
80 it into F<test.pl>. Throw in the handy tainting subroutines.
81
82 =head2 POD -E<gt> HTML conversion in the core still sucks
83
84 Which is crazy given just how simple POD purports to be, and how simple HTML
85 can be. It's not actually I<as> simple as it sounds, particularly with the
86 flexibility POD allows for C<=item>, but it would be good to improve the
87 visual appeal of the HTML generated, and to avoid it having any validation
88 errors. See also L</make HTML install work>, as the layout of installation tree
89 is needed to improve the cross-linking.
90
91 The addition of C<Pod::Simple> and its related modules may make this task
92 easier to complete.
93
94 =head2 Parallel testing
95
96 (This probably impacts much more than the core: also the Test::Harness
97 and TAP::* modules on CPAN.)
98
99 All of the tests in F<t/> can now be run in parallel, if C<$ENV{TEST_JOBS}>
100 is set. However, tests within each directory in F<ext> and F<lib> are still
101 run in series, with directories run in parallel. This is an adequate
102 heuristic, but it might be possible to relax it further, and get more
103 throughput. Specifically, it would be good to audit all of F<lib/*.t>, and
104 make them use C<File::Temp>.
105
106 =head2 Make Schwern poorer
107
108 We should have tests for everything. When all the core's modules are tested,
109 Schwern has promised to donate to $500 to TPF. We may need volunteers to
110 hold him upside down and shake vigorously in order to actually extract the
111 cash.
112
113 =head2 Improve the coverage of the core tests
114
115 Use Devel::Cover to ascertain the core modules's test coverage, then add
116 tests that are currently missing.
117
118 =head2 test B
119
120 A full test suite for the B module would be nice.
121
122 =head2 A decent benchmark
123
124 C<perlbench> seems impervious to any recent changes made to the perl core. It
125 would be useful to have a reasonable general benchmarking suite that roughly
126 represented what current perl programs do, and measurably reported whether
127 tweaks to the core improve, degrade or don't really affect performance, to
128 guide people attempting to optimise the guts of perl. Gisle would welcome
129 new tests for perlbench.
130
131 =head2 fix tainting bugs
132
133 Fix the bugs revealed by running the test suite with the C<-t> switch (via
134 C<make test.taintwarn>).
135
136 =head2 Dual life everything
137
138 As part of the "dists" plan, anything that doesn't belong in the smallest perl
139 distribution needs to be dual lifed. Anything else can be too. Figure out what
140 changes would be needed to package that module and its tests up for CPAN, and
141 do so. Test it with older perl releases, and fix the problems you find.
142
143 To make a minimal perl distribution, it's useful to look at
144 F<t/lib/commonsense.t>.
145
146 =head2 Bundle dual life modules in ext/
147
148 For maintenance (and branch merging) reasons, it would be useful to move
149 some architecture-independent dual-life modules from lib/ to ext/, if this
150 has no negative impact on the build of perl itself.
151
152 =head2 POSIX memory footprint
153
154 Ilya observed that use POSIX; eats memory like there's no tomorrow, and at
155 various times worked to cut it down. There is probably still fat to cut out -
156 for example POSIX passes Exporter some very memory hungry data structures.
157
158 =head2 embed.pl/makedef.pl
159
160 There is a script F<embed.pl> that generates several header files to prefix
161 all of Perl's symbols in a consistent way, to provide some semblance of
162 namespace support in C<C>. Functions are declared in F<embed.fnc>, variables
163 in F<interpvar.h>. Quite a few of the functions and variables
164 are conditionally declared there, using C<#ifdef>. However, F<embed.pl>
165 doesn't understand the C macros, so the rules about which symbols are present
166 when is duplicated in F<makedef.pl>. Writing things twice is bad, m'kay.
167 It would be good to teach C<embed.pl> to understand the conditional
168 compilation, and hence remove the duplication, and the mistakes it has caused.
169
170 =head2 use strict; and AutoLoad
171
172 Currently if you write
173
174     package Whack;
175     use AutoLoader 'AUTOLOAD';
176     use strict;
177     1;
178     __END__
179     sub bloop {
180         print join (' ', No, strict, here), "!\n";
181     }
182
183 then C<use strict;> isn't in force within the autoloaded subroutines. It would
184 be more consistent (and less surprising) to arrange for all lexical pragmas
185 in force at the __END__ block to be in force within each autoloaded subroutine.
186
187 There's a similar problem with SelfLoader.
188
189 =head2 profile installman
190
191 The F<installman> script is slow. All it is doing text processing, which we're
192 told is something Perl is good at. So it would be nice to know what it is doing
193 that is taking so much CPU, and where possible address it.
194
195
196 =head1 Tasks that need a little sysadmin-type knowledge
197
198 Or if you prefer, tasks that you would learn from, and broaden your skills
199 base...
200
201 =head2 make HTML install work
202
203 There is an C<installhtml> target in the Makefile. It's marked as
204 "experimental". It would be good to get this tested, make it work reliably, and
205 remove the "experimental" tag. This would include
206
207 =over 4
208
209 =item 1
210
211 Checking that cross linking between various parts of the documentation works.
212 In particular that links work between the modules (files with POD in F<lib/>)
213 and the core documentation (files in F<pod/>)
214
215 =item 2
216
217 Work out how to split C<perlfunc> into chunks, preferably one per function
218 group, preferably with general case code that could be used elsewhere.
219 Challenges here are correctly identifying the groups of functions that go
220 together, and making the right named external cross-links point to the right
221 page. Things to be aware of are C<-X>, groups such as C<getpwnam> to
222 C<endservent>, two or more C<=items> giving the different parameter lists, such
223 as
224
225     =item substr EXPR,OFFSET,LENGTH,REPLACEMENT
226     =item substr EXPR,OFFSET,LENGTH
227     =item substr EXPR,OFFSET
228
229 and different parameter lists having different meanings. (eg C<select>)
230
231 =back
232
233 =head2 compressed man pages
234
235 Be able to install them. This would probably need a configure test to see how
236 the system does compressed man pages (same directory/different directory?
237 same filename/different filename), as well as tweaking the F<installman> script
238 to compress as necessary.
239
240 =head2 Add a code coverage target to the Makefile
241
242 Make it easy for anyone to run Devel::Cover on the core's tests. The steps
243 to do this manually are roughly
244
245 =over 4
246
247 =item *
248
249 do a normal C<Configure>, but include Devel::Cover as a module to install
250 (see F<INSTALL> for how to do this)
251
252 =item *
253
254     make perl
255
256 =item *
257
258     cd t; HARNESS_PERL_SWITCHES=-MDevel::Cover ./perl -I../lib harness
259
260 =item *
261
262 Process the resulting Devel::Cover database
263
264 =back
265
266 This just give you the coverage of the F<.pm>s. To also get the C level
267 coverage you need to
268
269 =over 4
270
271 =item *
272
273 Additionally tell C<Configure> to use the appropriate C compiler flags for
274 C<gcov>
275
276 =item *
277
278     make perl.gcov
279
280 (instead of C<make perl>)
281
282 =item *
283
284 After running the tests run C<gcov> to generate all the F<.gcov> files.
285 (Including down in the subdirectories of F<ext/>
286
287 =item *
288
289 (From the top level perl directory) run C<gcov2perl> on all the C<.gcov> files
290 to get their stats into the cover_db directory.
291
292 =item *
293
294 Then process the Devel::Cover database
295
296 =back
297
298 It would be good to add a single switch to C<Configure> to specify that you
299 wanted to perform perl level coverage, and another to specify C level
300 coverage, and have C<Configure> and the F<Makefile> do all the right things
301 automatically.
302
303 =head2 Make Config.pm cope with differences between built and installed perl
304
305 Quite often vendors ship a perl binary compiled with their (pay-for)
306 compilers.  People install a free compiler, such as gcc. To work out how to
307 build extensions, Perl interrogates C<%Config>, so in this situation
308 C<%Config> describes compilers that aren't there, and extension building
309 fails. This forces people into choosing between re-compiling perl themselves
310 using the compiler they have, or only using modules that the vendor ships.
311
312 It would be good to find a way teach C<Config.pm> about the installation setup,
313 possibly involving probing at install time or later, so that the C<%Config> in
314 a binary distribution better describes the installed machine, when the
315 installed machine differs from the build machine in some significant way.
316
317 =head2 linker specification files
318
319 Some platforms mandate that you provide a list of a shared library's external
320 symbols to the linker, so the core already has the infrastructure in place to
321 do this for generating shared perl libraries. My understanding is that the
322 GNU toolchain can accept an optional linker specification file, and restrict
323 visibility just to symbols declared in that file. It would be good to extend
324 F<makedef.pl> to support this format, and to provide a means within
325 C<Configure> to enable it. This would allow Unix users to test that the
326 export list is correct, and to build a perl that does not pollute the global
327 namespace with private symbols.
328
329 =head2 Cross-compile support
330
331 Currently C<Configure> understands C<-Dusecrosscompile> option. This option
332 arranges for building C<miniperl> for TARGET machine, so this C<miniperl> is
333 assumed then to be copied to TARGET machine and used as a replacement of full
334 C<perl> executable.
335
336 This could be done little differently. Namely C<miniperl> should be built for
337 HOST and then full C<perl> with extensions should be compiled for TARGET.
338 This, however, might require extra trickery for %Config: we have one config
339 first for HOST and then another for TARGET.  Tools like MakeMaker will be
340 mightily confused.  Having around two different types of executables and
341 libraries (HOST and TARGET) makes life interesting for Makefiles and
342 shell (and Perl) scripts.  There is $Config{run}, normally empty, which
343 can be used as an execution wrapper.  Also note that in some
344 cross-compilation/execution environments the HOST and the TARGET do
345 not see the same filesystem(s), the $Config{run} may need to do some
346 file/directory copying back and forth.
347
348 =head2 roffitall
349
350 Make F<pod/roffitall> be updated by F<pod/buildtoc>.
351
352 =head2 Split "linker" from "compiler"
353
354 Right now, Configure probes for two commands, and sets two variables:
355
356 =over 4
357
358 =item * C<cc> (in F<cc.U>)
359
360 This variable holds the name of a command to execute a C compiler which
361 can resolve multiple global references that happen to have the same
362 name.  Usual values are F<cc> and F<gcc>.
363 Fervent ANSI compilers may be called F<c89>.  AIX has F<xlc>.
364
365 =item * C<ld> (in F<dlsrc.U>)
366
367 This variable indicates the program to be used to link
368 libraries for dynamic loading.  On some systems, it is F<ld>.
369 On ELF systems, it should be C<$cc>.  Mostly, we'll try to respect
370 the hint file setting.
371
372 =back
373
374 There is an implicit historical assumption from around Perl5.000alpha
375 something, that C<$cc> is also the correct command for linking object files
376 together to make an executable. This may be true on Unix, but it's not true
377 on other platforms, and there are a maze of work arounds in other places (such
378 as F<Makefile.SH>) to cope with this.
379
380 Ideally, we should create a new variable to hold the name of the executable
381 linker program, probe for it in F<Configure>, and centralise all the special
382 case logic there or in hints files.
383
384 A small bikeshed issue remains - what to call it, given that C<$ld> is already
385 taken (arguably for the wrong thing now, but on SunOS 4.1 it is the command
386 for creating dynamically-loadable modules) and C<$link> could be confused with
387 the Unix command line executable of the same name, which does something
388 completely different. Andy Dougherty makes the counter argument "In parrot, I
389 tried to call the command used to link object files and  libraries into an
390 executable F<link>, since that's what my vaguely-remembered DOS and VMS
391 experience suggested. I don't think any real confusion has ensued, so it's
392 probably a reasonable name for perl5 to use."
393
394 "Alas, I've always worried that introducing it would make things worse, 
395 since now the module building utilities would have to look for 
396 C<$Config{link}> and institute a fall-back plan if it weren't found."
397 Although I can see that as confusing, given that C<$Config{d_link}> is true
398 when (hard) links are available.
399
400 =head1 Tasks that need a little C knowledge
401
402 These tasks would need a little C knowledge, but don't need any specific
403 background or experience with XS, or how the Perl interpreter works
404
405 =head2 Weed out needless PERL_UNUSED_ARG
406
407 The C code uses the macro C<PERL_UNUSED_ARG> to stop compilers warning about
408 unused arguments. Often the arguments can't be removed, as there is an
409 external constraint that determines the prototype of the function, so this
410 approach is valid. However, there are some cases where C<PERL_UNUSED_ARG>
411 could be removed. Specifically
412
413 =over 4
414
415 =item *
416
417 The prototypes of (nearly all) static functions can be changed
418
419 =item *
420
421 Unused arguments generated by short cut macros are wasteful - the short cut
422 macro used can be changed.
423
424 =back
425
426 =head2 Modernize the order of directories in @INC
427
428 The way @INC is laid out by default, one cannot upgrade core (dual-life)
429 modules without overwriting files. This causes problems for binary
430 package builders.  One possible proposal is laid out in this
431 message:
432 L<http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2002-04/msg02380.html>.
433
434 =head2 -Duse32bit*
435
436 Natively 64-bit systems need neither -Duse64bitint nor -Duse64bitall.
437 On these systems, it might be the default compilation mode, and there
438 is currently no guarantee that passing no use64bitall option to the
439 Configure process will build a 32bit perl. Implementing -Duse32bit*
440 options would be nice for perl 5.12.
441
442 =head2 Make it clear from -v if this is the exact official release
443
444 Currently perl from C<p4>/C<rsync> ships with a F<patchlevel.h> file that
445 usually defines one local patch, of the form "MAINT12345" or "RC1". The output
446 of perl -v doesn't report that a perl isn't an official release, and this
447 information can get lost in bugs reports. Because of this, the minor version
448 isn't bumped up until RC time, to minimise the possibility of versions of perl
449 escaping that believe themselves to be newer than they actually are.
450
451 It would be useful to find an elegant way to have the "this is an interim
452 maintenance release" or "this is a release candidate" in the terse -v output,
453 and have it so that it's easy for the pumpking to remove this just as the
454 release tarball is rolled up. This way the version pulled out of rsync would
455 always say "I'm a development release" and it would be safe to bump the
456 reported minor version as soon as a release ships, which would aid perl
457 developers.
458
459 This task is really about thinking of an elegant way to arrange the C source
460 such that it's trivial for the Pumpking to flag "this is an official release"
461 when making a tarball, yet leave the default source saying "I'm not the
462 official release".
463
464 =head2 Profile Perl - am I hot or not?
465
466 The Perl source code is stable enough that it makes sense to profile it,
467 identify and optimise the hotspots. It would be good to measure the
468 performance of the Perl interpreter using free tools such as cachegrind,
469 gprof, and dtrace, and work to reduce the bottlenecks they reveal.
470
471 As part of this, the idea of F<pp_hot.c> is that it contains the I<hot> ops,
472 the ops that are most commonly used. The idea is that by grouping them, their
473 object code will be adjacent in the executable, so they have a greater chance
474 of already being in the CPU cache (or swapped in) due to being near another op
475 already in use.
476
477 Except that it's not clear if these really are the most commonly used ops. So
478 as part of exercising your skills with coverage and profiling tools you might
479 want to determine what ops I<really> are the most commonly used. And in turn
480 suggest evictions and promotions to achieve a better F<pp_hot.c>.
481
482 One piece of Perl code that might make a good testbed is F<installman>.
483
484 =head2 Allocate OPs from arenas
485
486 Currently all new OP structures are individually malloc()ed and free()d.
487 All C<malloc> implementations have space overheads, and are now as fast as
488 custom allocates so it would both use less memory and less CPU to allocate
489 the various OP structures from arenas. The SV arena code can probably be
490 re-used for this.
491
492 Note that Configuring perl with C<-Accflags=-DPL_OP_SLAB_ALLOC> will use
493 Perl_Slab_alloc() to pack optrees into a contiguous block, which is
494 probably superior to the use of OP arenas, esp. from a cache locality
495 standpoint.  See L<Profile Perl - am I hot or not?>.
496
497 =head2 Improve win32/wince.c
498
499 Currently, numerous functions look virtually, if not completely,
500 identical in both C<win32/wince.c> and C<win32/win32.c> files, which can't
501 be good.
502
503 =head2 Use secure CRT functions when building with VC8 on Win32
504
505 Visual C++ 2005 (VC++ 8.x) deprecated a number of CRT functions on the basis
506 that they were "unsafe" and introduced differently named secure versions of
507 them as replacements, e.g. instead of writing
508
509     FILE* f = fopen(__FILE__, "r");
510
511 one should now write
512
513     FILE* f;
514     errno_t err = fopen_s(&f, __FILE__, "r"); 
515
516 Currently, the warnings about these deprecations have been disabled by adding
517 -D_CRT_SECURE_NO_DEPRECATE to the CFLAGS. It would be nice to remove that
518 warning suppressant and actually make use of the new secure CRT functions.
519
520 There is also a similar issue with POSIX CRT function names like fileno having
521 been deprecated in favour of ISO C++ conformant names like _fileno. These
522 warnings are also currently suppressed by adding -D_CRT_NONSTDC_NO_DEPRECATE. It
523 might be nice to do as Microsoft suggest here too, although, unlike the secure
524 functions issue, there is presumably little or no benefit in this case.
525
526 =head2 Fix POSIX::access() and chdir() on Win32
527
528 These functions currently take no account of DACLs and therefore do not behave
529 correctly in situations where access is restricted by DACLs (as opposed to the
530 read-only attribute).
531
532 Furthermore, POSIX::access() behaves differently for directories having the
533 read-only attribute set depending on what CRT library is being used. For
534 example, the _access() function in the VC6 and VC7 CRTs (wrongly) claim that
535 such directories are not writable, whereas in fact all directories are writable
536 unless access is denied by DACLs. (In the case of directories, the read-only
537 attribute actually only means that the directory cannot be deleted.) This CRT
538 bug is fixed in the VC8 and VC9 CRTs (but, of course, the directory may still
539 not actually be writable if access is indeed denied by DACLs).
540
541 For the chdir() issue, see ActiveState bug #74552:
542 http://bugs.activestate.com/show_bug.cgi?id=74552
543
544 Therefore, DACLs should be checked both for consistency across CRTs and for
545 the correct answer.
546
547 (Note that perl's -w operator should not be modified to check DACLs. It has
548 been written so that it reflects the state of the read-only attribute, even
549 for directories (whatever CRT is being used), for symmetry with chmod().)
550
551 =head2 strcat(), strcpy(), strncat(), strncpy(), sprintf(), vsprintf()
552
553 Maybe create a utility that checks after each libperl.a creation that
554 none of the above (nor sprintf(), vsprintf(), or *SHUDDER* gets())
555 ever creep back to libperl.a.
556
557   nm libperl.a | ./miniperl -alne '$o = $F[0] if /:$/; print "$o $F[1]" if $F[0] eq "U" && $F[1] =~ /^(?:strn?c(?:at|py)|v?sprintf|gets)$/'
558
559 Note, of course, that this will only tell whether B<your> platform
560 is using those naughty interfaces.
561
562 =head2 -D_FORTIFY_SOURCE=2, -fstack-protector
563
564 Recent glibcs support C<-D_FORTIFY_SOURCE=2> and recent gcc
565 (4.1 onwards?) supports C<-fstack-protector>, both of which give
566 protection against various kinds of buffer overflow problems.
567 These should probably be used for compiling Perl whenever available,
568 Configure and/or hints files should be adjusted to probe for the
569 availability of these features and enable them as appropriate.
570
571 =head2 Arenas for GPs? For MAGIC?
572
573 C<struct gp> and C<struct magic> are both currently allocated by C<malloc>.
574 It might be a speed or memory saving to change to using arenas. Or it might
575 not. It would need some suitable benchmarking first. In particular, C<GP>s
576 can probably be changed with minimal compatibility impact (probably nothing
577 outside of the core, or even outside of F<gv.c> allocates them), but they
578 probably aren't allocated/deallocated often enough for a speed saving. Whereas
579 C<MAGIC> is allocated/deallocated more often, but in turn, is also something
580 more externally visible, so changing the rules here may bite external code.
581
582 =head2 Shared arenas
583
584 Several SV body structs are now the same size, notably PVMG and PVGV, PVAV and
585 PVHV, and PVCV and PVFM. It should be possible to allocate and return same
586 sized bodies from the same actual arena, rather than maintaining one arena for
587 each. This could save 4-6K per thread, of memory no longer tied up in the
588 not-yet-allocated part of an arena.
589
590
591 =head1 Tasks that need a knowledge of XS
592
593 These tasks would need C knowledge, and roughly the level of knowledge of
594 the perl API that comes from writing modules that use XS to interface to
595 C.
596
597 =head2 safely supporting POSIX SA_SIGINFO
598
599 Some years ago Jarkko supplied patches to provide support for the POSIX
600 SA_SIGINFO feature in Perl, passing the extra data to the Perl signal handler.
601
602 Unfortunately, it only works with "unsafe" signals, because under safe
603 signals, by the time Perl gets to run the signal handler, the extra
604 information has been lost. Moreover, it's not easy to store it somewhere,
605 as you can't call mutexs, or do anything else fancy, from inside a signal
606 handler.
607
608 So it strikes me that we could provide safe SA_SIGINFO support
609
610 =over 4
611
612 =item 1
613
614 Provide global variables for two file descriptors
615
616 =item 2
617
618 When the first request is made via C<sigaction> for C<SA_SIGINFO>, create a
619 pipe, store the reader in one, the writer in the other
620
621 =item 3
622
623 In the "safe" signal handler (C<Perl_csighandler()>/C<S_raise_signal()>), if
624 the C<siginfo_t> pointer non-C<NULL>, and the writer file handle is open,
625
626 =over 8
627
628 =item 1
629
630 serialise signal number, C<struct siginfo_t> (or at least the parts we care
631 about) into a small auto char buff
632
633 =item 2
634
635 C<write()> that (non-blocking) to the writer fd
636
637 =over 12
638
639 =item 1
640
641 if it writes 100%, flag the signal in a counter of "signals on the pipe" akin
642 to the current per-signal-number counts
643
644 =item 2
645
646 if it writes 0%, assume the pipe is full. Flag the data as lost?
647
648 =item 3
649
650 if it writes partially, croak a panic, as your OS is broken.
651
652 =back
653
654 =back
655
656 =item 4
657
658 in the regular C<PERL_ASYNC_CHECK()> processing, if there are "signals on
659 the pipe", read the data out, deserialise, build the Perl structures on
660 the stack (code in C<Perl_sighandler()>, the "unsafe" handler), and call as
661 usual.
662
663 =back
664
665 I think that this gets us decent C<SA_SIGINFO> support, without the current risk
666 of running Perl code inside the signal handler context. (With all the dangers
667 of things like C<malloc> corruption that that currently offers us)
668
669 For more information see the thread starting with this message:
670 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-03/msg00305.html
671
672 =head2 autovivification
673
674 Make all autovivification consistent w.r.t LVALUE/RVALUE and strict/no strict;
675
676 This task is incremental - even a little bit of work on it will help.
677
678 =head2 Unicode in Filenames
679
680 chdir, chmod, chown, chroot, exec, glob, link, lstat, mkdir, open,
681 opendir, qx, readdir, readlink, rename, rmdir, stat, symlink, sysopen,
682 system, truncate, unlink, utime, -X.  All these could potentially accept
683 Unicode filenames either as input or output (and in the case of system
684 and qx Unicode in general, as input or output to/from the shell).
685 Whether a filesystem - an operating system pair understands Unicode in
686 filenames varies.
687
688 Known combinations that have some level of understanding include
689 Microsoft NTFS, Apple HFS+ (In Mac OS 9 and X) and Apple UFS (in Mac
690 OS X), NFS v4 is rumored to be Unicode, and of course Plan 9.  How to
691 create Unicode filenames, what forms of Unicode are accepted and used
692 (UCS-2, UTF-16, UTF-8), what (if any) is the normalization form used,
693 and so on, varies.  Finding the right level of interfacing to Perl
694 requires some thought.  Remember that an OS does not implicate a
695 filesystem.
696
697 (The Windows -C command flag "wide API support" has been at least
698 temporarily retired in 5.8.1, and the -C has been repurposed, see
699 L<perlrun>.)
700
701 Most probably the right way to do this would be this:
702 L</"Virtualize operating system access">.
703
704 =head2 Unicode in %ENV
705
706 Currently the %ENV entries are always byte strings.
707 See L</"Virtualize operating system access">.
708
709 =head2 Unicode and glob()
710
711 Currently glob patterns and filenames returned from File::Glob::glob()
712 are always byte strings.  See L</"Virtualize operating system access">.
713
714 =head2 Unicode and lc/uc operators
715
716 Some built-in operators (C<lc>, C<uc>, etc.) behave differently, based on
717 what the internal encoding of their argument is. That should not be the
718 case. Maybe add a pragma to switch behaviour.
719
720 =head2 use less 'memory'
721
722 Investigate trade offs to switch out perl's choices on memory usage.
723 Particularly perl should be able to give memory back.
724
725 This task is incremental - even a little bit of work on it will help.
726
727 =head2 Re-implement C<:unique> in a way that is actually thread-safe
728
729 The old implementation made bad assumptions on several levels. A good 90%
730 solution might be just to make C<:unique> work to share the string buffer
731 of SvPVs. That way large constant strings can be shared between ithreads,
732 such as the configuration information in F<Config>.
733
734 =head2 Make tainting consistent
735
736 Tainting would be easier to use if it didn't take documented shortcuts and
737 allow taint to "leak" everywhere within an expression.
738
739 =head2 readpipe(LIST)
740
741 system() accepts a LIST syntax (and a PROGRAM LIST syntax) to avoid
742 running a shell. readpipe() (the function behind qx//) could be similarly
743 extended.
744
745 =head2 Audit the code for destruction ordering assumptions
746
747 Change 25773 notes
748
749     /* Need to check SvMAGICAL, as during global destruction it may be that
750        AvARYLEN(av) has been freed before av, and hence the SvANY() pointer
751        is now part of the linked list of SV heads, rather than pointing to
752        the original body.  */
753     /* FIXME - audit the code for other bugs like this one.  */
754
755 adding the C<SvMAGICAL> check to
756
757     if (AvARYLEN(av) && SvMAGICAL(AvARYLEN(av))) {
758         MAGIC *mg = mg_find (AvARYLEN(av), PERL_MAGIC_arylen);
759
760 Go through the core and look for similar assumptions that SVs have particular
761 types, as all bets are off during global destruction.
762
763 =head2 Extend PerlIO and PerlIO::Scalar
764
765 PerlIO::Scalar doesn't know how to truncate().  Implementing this
766 would require extending the PerlIO vtable.
767
768 Similarly the PerlIO vtable doesn't know about formats (write()), or
769 about stat(), or chmod()/chown(), utime(), or flock().
770
771 (For PerlIO::Scalar it's hard to see what e.g. mode bits or ownership
772 would mean.)
773
774 PerlIO doesn't do directories or symlinks, either: mkdir(), rmdir(),
775 opendir(), closedir(), seekdir(), rewinddir(), glob(); symlink(),
776 readlink().
777
778 See also L</"Virtualize operating system access">.
779
780 =head2 -C on the #! line
781
782 It should be possible to make -C work correctly if found on the #! line,
783 given that all perl command line options are strict ASCII, and -C changes
784 only the interpretation of non-ASCII characters, and not for the script file
785 handle. To make it work needs some investigation of the ordering of function
786 calls during startup, and (by implication) a bit of tweaking of that order.
787
788 =head2 Organize error messages
789
790 Perl's diagnostics (error messages, see L<perldiag>) could use
791 reorganizing and formalizing so that each error message has its
792 stable-for-all-eternity unique id, categorized by severity, type, and
793 subsystem.  (The error messages would be listed in a datafile outside
794 of the Perl source code, and the source code would only refer to the
795 messages by the id.)  This clean-up and regularizing should apply
796 for all croak() messages.
797
798 This would enable all sorts of things: easier translation/localization
799 of the messages (though please do keep in mind the caveats of
800 L<Locale::Maketext> about too straightforward approaches to
801 translation), filtering by severity, and instead of grepping for a
802 particular error message one could look for a stable error id.  (Of
803 course, changing the error messages by default would break all the
804 existing software depending on some particular error message...)
805
806 This kind of functionality is known as I<message catalogs>.  Look for
807 inspiration for example in the catgets() system, possibly even use it
808 if available-- but B<only> if available, all platforms will B<not>
809 have catgets().
810
811 For the really pure at heart, consider extending this item to cover
812 also the warning messages (see L<perllexwarn>, C<warnings.pl>).
813
814 =head1 Tasks that need a knowledge of the interpreter
815
816 These tasks would need C knowledge, and knowledge of how the interpreter works,
817 or a willingness to learn.
818
819 =head2 error reporting of [$a ; $b]
820
821 Using C<;> inside brackets is a syntax error, and we don't propose to change
822 that by giving it any meaning. However, it's not reported very helpfully:
823
824     $ perl -e '$a = [$b; $c];'
825     syntax error at -e line 1, near "$b;"
826     syntax error at -e line 1, near "$c]"
827     Execution of -e aborted due to compilation errors.
828
829 It should be possible to hook into the tokeniser or the lexer, so that when a
830 C<;> is parsed where it is not legal as a statement terminator (ie inside
831 C<{}> used as a hashref, C<[]> or C<()>) it issues an error something like
832 I<';' isn't legal inside an expression - if you need multiple statements use a
833 do {...} block>. See the thread starting at
834 http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-09/msg00573.html
835
836 =head2 lexicals used only once
837
838 This warns:
839
840     $ perl -we '$pie = 42'
841     Name "main::pie" used only once: possible typo at -e line 1.
842
843 This does not:
844
845     $ perl -we 'my $pie = 42'
846
847 Logically all lexicals used only once should warn, if the user asks for
848 warnings.  An unworked RT ticket (#5087) has been open for almost seven
849 years for this discrepancy.
850
851 =head2 UTF-8 revamp
852
853 The handling of Unicode is unclean in many places. For example, the regexp
854 engine matches in Unicode semantics whenever the string or the pattern is
855 flagged as UTF-8, but that should not be dependent on an internal storage
856 detail of the string. Likewise, case folding behaviour is dependent on the
857 UTF8 internal flag being on or off.
858
859 =head2 Properly Unicode safe tokeniser and pads.
860
861 The tokeniser isn't actually very UTF-8 clean. C<use utf8;> is a hack -
862 variable names are stored in stashes as raw bytes, without the utf-8 flag
863 set. The pad API only takes a C<char *> pointer, so that's all bytes too. The
864 tokeniser ignores the UTF-8-ness of C<PL_rsfp>, or any SVs returned from
865 source filters.  All this could be fixed.
866
867 =head2 state variable initialization in list context
868
869 Currently this is illegal:
870
871     state ($a, $b) = foo(); 
872
873 In Perl 6, C<state ($a) = foo();> and C<(state $a) = foo();> have different
874 semantics, which is tricky to implement in Perl 5 as currently they produce
875 the same opcode trees. The Perl 6 design is firm, so it would be good to
876 implement the necessary code in Perl 5. There are comments in
877 C<Perl_newASSIGNOP()> that show the code paths taken by various assignment
878 constructions involving state variables.
879
880 =head2 Implement $value ~~ 0 .. $range
881
882 It would be nice to extend the syntax of the C<~~> operator to also
883 understand numeric (and maybe alphanumeric) ranges.
884
885 =head2 A does() built-in
886
887 Like ref(), only useful. It would call the C<DOES> method on objects; it
888 would also tell whether something can be dereferenced as an
889 array/hash/etc., or used as a regexp, etc.
890 L<http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2007-03/msg00481.html>
891
892 =head2 Tied filehandles and write() don't mix
893
894 There is no method on tied filehandles to allow them to be called back by
895 formats.
896
897 =head2 Attach/detach debugger from running program
898
899 The old perltodo notes "With C<gdb>, you can attach the debugger to a running
900 program if you pass the process ID. It would be good to do this with the Perl
901 debugger on a running Perl program, although I'm not sure how it would be
902 done." ssh and screen do this with named pipes in /tmp. Maybe we can too.
903
904 =head2 Optimize away empty destructors
905
906 Defining an empty DESTROY method might be useful (notably in
907 AUTOLOAD-enabled classes), but it's still a bit expensive to call. That
908 could probably be optimized.
909
910 =head2 LVALUE functions for lists
911
912 The old perltodo notes that lvalue functions don't work for list or hash
913 slices. This would be good to fix.
914
915 =head2 regexp optimiser optional
916
917 The regexp optimiser is not optional. It should configurable to be, to allow
918 its performance to be measured, and its bugs to be easily demonstrated.
919
920 =head2 delete &function
921
922 Allow to delete functions. One can already undef them, but they're still
923 in the stash.
924
925 =head2 C</w> regex modifier
926
927 That flag would enable to match whole words, and also to interpolate
928 arrays as alternations. With it, C</P/w> would be roughly equivalent to:
929
930     do { local $"='|'; /\b(?:P)\b/ }
931
932 See L<http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2007-01/msg00400.html>
933 for the discussion.
934
935 =head2 optional optimizer
936
937 Make the peephole optimizer optional. Currently it performs two tasks as
938 it walks the optree - genuine peephole optimisations, and necessary fixups of
939 ops. It would be good to find an efficient way to switch out the
940 optimisations whilst keeping the fixups.
941
942 =head2 You WANT *how* many
943
944 Currently contexts are void, scalar and list. split has a special mechanism in
945 place to pass in the number of return values wanted. It would be useful to
946 have a general mechanism for this, backwards compatible and little speed hit.
947 This would allow proposals such as short circuiting sort to be implemented
948 as a module on CPAN.
949
950 =head2 lexical aliases
951
952 Allow lexical aliases (maybe via the syntax C<my \$alias = \$foo>.
953
954 =head2 entersub XS vs Perl
955
956 At the moment pp_entersub is huge, and has code to deal with entering both
957 perl and XS subroutines. Subroutine implementations rarely change between 
958 perl and XS at run time, so investigate using 2 ops to enter subs (one for
959 XS, one for perl) and swap between if a sub is redefined.
960
961 =head2 Self-ties
962
963 Self-ties are currently illegal because they caused too many segfaults. Maybe
964 the causes of these could be tracked down and self-ties on all types
965 reinstated.
966
967 =head2 Optimize away @_
968
969 The old perltodo notes "Look at the "reification" code in C<av.c>".
970
971 =head2 Virtualize operating system access
972
973 Implement a set of "vtables" that virtualizes operating system access
974 (open(), mkdir(), unlink(), readdir(), getenv(), etc.)  At the very
975 least these interfaces should take SVs as "name" arguments instead of
976 bare char pointers; probably the most flexible and extensible way
977 would be for the Perl-facing interfaces to accept HVs.  The system
978 needs to be per-operating-system and per-file-system
979 hookable/filterable, preferably both from XS and Perl level
980 (L<perlport/"Files and Filesystems"> is good reading at this point,
981 in fact, all of L<perlport> is.)
982
983 This has actually already been implemented (but only for Win32),
984 take a look at F<iperlsys.h> and F<win32/perlhost.h>.  While all Win32
985 variants go through a set of "vtables" for operating system access,
986 non-Win32 systems currently go straight for the POSIX/UNIX-style
987 system/library call.  Similar system as for Win32 should be
988 implemented for all platforms.  The existing Win32 implementation
989 probably does not need to survive alongside this proposed new
990 implementation, the approaches could be merged.
991
992 What would this give us?  One often-asked-for feature this would
993 enable is using Unicode for filenames, and other "names" like %ENV,
994 usernames, hostnames, and so forth.
995 (See L<perlunicode/"When Unicode Does Not Happen">.)
996
997 But this kind of virtualization would also allow for things like
998 virtual filesystems, virtual networks, and "sandboxes" (though as long
999 as dynamic loading of random object code is allowed, not very safe
1000 sandboxes since external code of course know not of Perl's vtables).
1001 An example of a smaller "sandbox" is that this feature can be used to
1002 implement per-thread working directories: Win32 already does this.
1003
1004 See also L</"Extend PerlIO and PerlIO::Scalar">.
1005
1006 =head2 Investigate PADTMP hash pessimisation
1007
1008 The peephole optimier converts constants used for hash key lookups to shared
1009 hash key scalars. Under ithreads, something is undoing this work.
1010 See http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2007-09/msg00793.html
1011
1012 =head2 Store the current pad in the OP slab allocator
1013
1014 =for clarification
1015 I hope that I got that "current pad" part correct
1016
1017 Currently we leak ops in various cases of parse failure. I suggested that we
1018 could solve this by always using the op slab allocator, and walking it to
1019 free ops. Dave comments that as some ops are already freed during optree
1020 creation one would have to mark which ops are freed, and not double free them
1021 when walking the slab. He notes that one problem with this is that for some ops
1022 you have to know which pad was current at the time of allocation, which does
1023 change. I suggested storing a pointer to the current pad in the memory allocated
1024 for the slab, and swapping to a new slab each time the pad changes. Dave thinks
1025 that this would work.
1026
1027 =head2 repack the optree
1028
1029 Repacking the optree after execution order is determined could allow
1030 removal of NULL ops, and optimal ordering of OPs with respect to cache-line
1031 filling.  The slab allocator could be reused for this purpose.  I think that
1032 the best way to do this is to make it an optional step just before the
1033 completed optree is attached to anything else, and to use the slab allocator
1034 unchanged, so that freeing ops is identical whether or not this step runs.
1035 Note that the slab allocator allocates ops downwards in memory, so one would
1036 have to actually "allocate" the ops in reverse-execution order to get them
1037 contiguous in memory in execution order.
1038
1039 See http://www.nntp.perl.org/group/perl.perl5.porters/2007/12/msg131975.html
1040
1041 Note that running this copy, and then freeing all the old location ops would
1042 cause their slabs to be freed, which would eliminate possible memory wastage if
1043 the previous suggestion is implemented, and we swap slabs more frequently.
1044
1045 =head2 eliminate incorrect line numbers in warnings
1046
1047 This code
1048
1049     use warnings;
1050     my $undef;
1051     
1052     if ($undef == 3) {
1053     } elsif ($undef == 0) {
1054     }
1055
1056 used to produce this output:
1057
1058     Use of uninitialized value in numeric eq (==) at wrong.pl line 4.
1059     Use of uninitialized value in numeric eq (==) at wrong.pl line 4.
1060
1061 where the line of the second warning was misreported - it should be line 5.
1062 Rafael fixed this - the problem arose because there was no nextstate OP
1063 between the execution of the C<if> and the C<elsif>, hence C<PL_curcop> still
1064 reports that the currently executing line is line 4. The solution was to inject
1065 a nextstate OPs for each C<elsif>, although it turned out that the nextstate
1066 OP needed to be a nulled OP, rather than a live nextstate OP, else other line
1067 numbers became misreported. (Jenga!)
1068
1069 The problem is more general than C<elsif> (although the C<elsif> case is the
1070 most common and the most confusing). Ideally this code
1071
1072     use warnings;
1073     my $undef;
1074     
1075     my $a = $undef + 1;
1076     my $b
1077       = $undef
1078       + 1;
1079
1080 would produce this output
1081
1082     Use of uninitialized value $undef in addition (+) at wrong.pl line 4.
1083     Use of uninitialized value $undef in addition (+) at wrong.pl line 7.
1084
1085 (rather than lines 4 and 5), but this would seem to require every OP to carry
1086 (at least) line number information.
1087
1088 What might work is to have an optional line number in memory just before the
1089 BASEOP structure, with a flag bit in the op to say whether it's present.
1090 Initially during compile every OP would carry its line number. Then add a late
1091 pass to the optimiser (potentially combined with L</repack the optree>) which
1092 looks at the two ops on every edge of the graph of the execution path. If
1093 the line number changes, flags the destination OP with this information.
1094 Once all paths are traced, replace every op with the flag with a
1095 nextstate-light op (that just updates C<PL_curcop>), which in turn then passes
1096 control on to the true op. All ops would then be replaced by variants that
1097 do not store the line number. (Which, logically, why it would work best in
1098 conjunction with L</repack the optree>, as that is already copying/reallocating
1099 all the OPs)
1100
1101 (Although I should note that we're not certain that doing this for the general
1102 case is worth it)
1103
1104 =head2 optimize tail-calls
1105
1106 Tail-calls present an opportunity for broadly applicable optimization;
1107 anywhere that C<< return foo(...) >> is called, the outer return can
1108 be replaced by a goto, and foo will return directly to the outer
1109 caller, saving (conservatively) 25% of perl's call&return cost, which
1110 is relatively higher than in C.  The scheme language is known to do
1111 this heavily.  B::Concise provides good insight into where this
1112 optimization is possible, ie anywhere entersub,leavesub op-sequence
1113 occurs.
1114
1115  perl -MO=Concise,-exec,a,b,-main -e 'sub a{ 1 }; sub b {a()}; b(2)'
1116
1117 Bottom line on this is probably a new pp_tailcall function which
1118 combines the code in pp_entersub, pp_leavesub.  This should probably
1119 be done 1st in XS, and using B::Generate to patch the new OP into the
1120 optrees.
1121
1122 =head1 Big projects
1123
1124 Tasks that will get your name mentioned in the description of the "Highlights
1125 of 5.12"
1126
1127 =head2 make ithreads more robust
1128
1129 Generally make ithreads more robust. See also L</iCOW>
1130
1131 This task is incremental - even a little bit of work on it will help, and
1132 will be greatly appreciated.
1133
1134 One bit would be to write the missing code in sv.c:Perl_dirp_dup.
1135
1136 Fix Perl_sv_dup, et al so that threads can return objects.
1137
1138 =head2 iCOW
1139
1140 Sarathy and Arthur have a proposal for an improved Copy On Write which
1141 specifically will be able to COW new ithreads. If this can be implemented
1142 it would be a good thing.
1143
1144 =head2 (?{...}) closures in regexps
1145
1146 Fix (or rewrite) the implementation of the C</(?{...})/> closures.
1147
1148 =head2 A re-entrant regexp engine
1149
1150 This will allow the use of a regex from inside (?{ }), (??{ }) and
1151 (?(?{ })|) constructs.
1152
1153 =head2 Add class set operations to regexp engine
1154
1155 Apparently these are quite useful. Anyway, Jeffery Friedl wants them.
1156
1157 demerphq has this on his todo list, but right at the bottom.