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