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