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