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