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