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