This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Coderefs in @INC are done and documented.
[perl5.git] / pod / perltodo.pod
1 =head1 NAME
2
3 perltodo - Perl TO-DO List
4
5 =head1 DESCRIPTION
6
7 This is a list of wishes for Perl. The tasks we think are smaller or easier
8 are listed first. Anyone is welcome to work on any of these, but it's a good
9 idea to first contact I<perl5-porters@perl.org> to avoid duplication of
10 effort. By all means contact a pumpking privately first if you prefer.
11
12 Whilst patches to make the list shorter are most welcome, ideas to add to
13 the list are also encouraged. Check the perl5-porters archives for past
14 ideas, and any discussion about them. One set of archives may be found at:
15
16     http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/
17
18 What can we offer you in return? Fame, fortune, and everlasting glory? Maybe
19 not, but if your patch is incorporated, then we'll add your name to the
20 F<AUTHORS> file, which ships in the official distribution. How many other
21 programming languages offer you 1 line of immortality?
22
23 =head1 The roadmap to 5.10
24
25 The roadmap to 5.10 envisages feature based releases, as various items in this
26 TODO are completed.
27
28 =head2 Needed for a 5.9.4 release
29
30 =over
31
32 =item *
33
34 Review assertions. Review syntax to combine assertions. Assertions could take
35 advantage of the lexical pragmas work. L</What hooks would assertions need?>
36
37 =item *
38
39 C<encoding::warnings> should be turned into a lexical pragma.
40 C<encoding> should, too (probably).
41
42 =back
43
44 =head2 Needed for a 5.9.5 release
45
46 =over
47
48 =item *
49 Implement L</_ prototype character>
50
51 =item *
52 Implement L</state variables>
53
54 =back
55
56 =head2 Needed for a 5.9.6 release
57
58 Stabilisation. If all goes well, this will be the equivalent of a 5.10-beta.
59
60 =head1 Tasks that only need Perl knowledge
61
62 =head2 common test code for timed bail out
63
64 Write portable self destruct code for tests to stop them burning CPU in
65 infinite loops. This needs to avoid using alarm, as some of the tests are
66 testing alarm/sleep or timers.
67
68 =head2 POD -> HTML conversion in the core still sucks
69
70 Which is crazy given just how simple POD purports to be, and how simple HTML
71 can be. It's not actually I<as> simple as it sounds, particularly with the
72 flexibility POD allows for C<=item>, but it would be good to improve the
73 visual appeal of the HTML generated, and to avoid it having any validation
74 errors. See also L</make HTML install work>, as the layout of installation tree
75 is needed to improve the cross-linking.
76
77 The addition of C<Pod::Simple> and its related modules may make this task
78 easier to complete.
79
80 =head2 Parallel testing
81
82 The core regression test suite is getting ever more comprehensive, which has
83 the side effect that it takes longer to run. This isn't so good. Investigate
84 whether it would be feasible to give the harness script the B<option> of
85 running sets of tests in parallel. This would be useful for tests in
86 F<t/op/*.t> and F<t/uni/*.t> and maybe some sets of tests in F<lib/>.
87
88 Questions to answer
89
90 =over 4
91
92 =item 1
93
94 How does screen layout work when you're running more than one test?
95
96 =item 2
97
98 How does the caller of test specify how many tests to run in parallel?
99
100 =item 3
101
102 How do setup/teardown tests identify themselves?
103
104 =back
105
106 Pugs already does parallel testing - can their approach be re-used?
107
108 =head2 Make Schwern poorer
109
110 We should have for everything. When all the core's modules are tested,
111 Schwern has promised to donate to $500 to TPF. We may need volunteers to
112 hold him upside down and shake vigorously in order to actually extract the
113 cash.
114
115 See F<t/lib/1_compile.t> for the 3 remaining modules that need tests.
116
117 =head2 Improve the coverage of the core tests
118
119 Use Devel::Cover to ascertain the core's test coverage, then add tests that
120 are currently missing.
121
122 =head2 test B
123
124 A full test suite for the B module would be nice.
125
126 =head2 A decent benchmark
127
128 C<perlbench> seems impervious to any recent changes made to the perl core. It
129 would be useful to have a reasonable general benchmarking suite that roughly
130 represented what current perl programs do, and measurably reported whether
131 tweaks to the core improve, degrade or don't really affect performance, to
132 guide people attempting to optimise the guts of perl. Gisle would welcome
133 new tests for perlbench.
134
135 =head2 fix tainting bugs
136
137 Fix the bugs revealed by running the test suite with the C<-t> switch (via
138 C<make test.taintwarn>).
139
140 =head2 Dual life everything
141
142 As part of the "dists" plan, anything that doesn't belong in the smallest perl
143 distribution needs to be dual lifed. Anything else can be too. Figure out what
144 changes would be needed to package that module and its tests up for CPAN, and
145 do so. Test it with older perl releases, and fix the problems you find.
146
147 =head2 Improving C<threads::shared>
148
149 Investigate whether C<threads::shared> could share aggregates properly with
150 only Perl level changes to shared.pm
151
152 =head2 POSIX memory footprint
153
154 Ilya observed that use POSIX; eats memory like there's no tomorrow, and at
155 various times worked to cut it down. There is probably still fat to cut out -
156 for example POSIX passes Exporter some very memory hungry data structures.
157
158 =head2 embed.pl/makedef.pl
159
160 There is a script F<embed.pl> that generates several header files to prefix
161 all of Perl's symbols in a consistent way, to provide some semblance of
162 namespace support in C<C>. Functions are declared in F<embed.fnc>, variables
163 in F<interpvar.h> and F<thrdvar.h>. Quite a few of the functions and variables
164 are conditionally declared there, using C<#ifdef>. However, F<embed.pl>
165 doesn't understand the C macros, so the rules about which symbols are present
166 when is duplicated in F<makedef.pl>. Writing things twice is bad, m'kay.
167 It would be good to teach C<embed.pl> to understand the conditional
168 compilation, and hence remove the duplication, and the mistakes it has caused.
169
170
171
172
173
174
175 =head1 Tasks that need a little sysadmin-type knowledge
176
177 Or if you prefer, tasks that you would learn from, and broaden your skills
178 base...
179
180 =head2 Relocatable perl
181
182 The C level patches needed to create a relocatable perl binary are done, as
183 is the work on F<Config.pm>. All that's left to do is the C<Configure> tweaking
184 to let people specify how they want to do the install.
185
186 =head2 make HTML install work
187
188 There is an C<installhtml> target in the Makefile. It's marked as
189 "experimental". It would be good to get this tested, make it work reliably, and
190 remove the "experimental" tag. This would include
191
192 =over 4
193
194 =item 1
195
196 Checking that cross linking between various parts of the documentation works.
197 In particular that links work between the modules (files with POD in F<lib/>)
198 and the core documentation (files in F<pod/>)
199
200 =item 2
201
202 Work out how to split C<perlfunc> into chunks, preferably one per function
203 group, preferably with general case code that could be used elsewhere.
204 Challenges here are correctly identifying the groups of functions that go
205 together, and making the right named external cross-links point to the right
206 page. Things to be aware of are C<-X>, groups such as C<getpwnam> to
207 C<endservent>, two or more C<=items> giving the different parameter lists, such
208 as
209
210     =item substr EXPR,OFFSET,LENGTH,REPLACEMENT
211     
212     =item substr EXPR,OFFSET,LENGTH
213     
214     =item substr EXPR,OFFSET
215
216 and different parameter lists having different meanings. (eg C<select>)
217
218 =back
219
220 =head2 compressed man pages
221
222 Be able to install them. This would probably need a configure test to see how
223 the system does compressed man pages (same directory/different directory?
224 same filename/different filename), as well as tweaking the F<installman> script
225 to compress as necessary.
226
227 =head2 Add a code coverage target to the Makefile
228
229 Make it easy for anyone to run Devel::Cover on the core's tests. The steps
230 to do this manually are roughly
231
232 =over 4
233
234 =item *
235
236 do a normal C<Configure>, but include Devel::Cover as a module to install
237 (see F<INSTALL> for how to do this)
238
239 =item *
240
241     make perl
242
243 =item *
244
245     cd t; HARNESS_PERL_SWITCHES=-MDevel::Cover ./perl -I../lib harness
246
247 =item *
248
249 Process the resulting Devel::Cover database
250
251 =back
252
253 This just give you the coverage of the F<.pm>s. To also get the C level
254 coverage you need to
255
256 =over 4
257
258 =item *
259
260 Additionally tell C<Configure> to use the appropriate C compiler flags for
261 C<gcov>
262
263 =item *
264
265     make perl.gcov
266
267 (instead of C<make perl>)
268
269 =item *
270
271 After running the tests run C<gcov> to generate all the F<.gcov> files.
272 (Including down in the subdirectories of F<ext/>
273
274 =item *
275
276 (From the top level perl directory) run C<gcov2perl> on all the C<.gcov> files
277 to get their stats into the cover_db directory.
278
279 =item *
280
281 Then process the Devel::Cover database
282
283 =back
284
285 It would be good to add a single switch to C<Configure> to specify that you
286 wanted to perform perl level coverage, and another to specify C level
287 coverage, and have C<Configure> and the F<Makefile> do all the right things
288 automatically.
289
290 =head2 Make Config.pm cope with differences between build and installed perl
291
292 Quite often vendors ship a perl binary compiled with their (pay-for)
293 compilers.  People install a free compiler, such as gcc. To work out how to
294 build extensions, Perl interrogates C<%Config>, so in this situation
295 C<%Config> describes compilers that aren't there, and extension building
296 fails. This forces people into choosing between re-compiling perl themselves
297 using the compiler they have, or only using modules that the vendor ships.
298
299 It would be good to find a way teach C<Config.pm> about the installation setup,
300 possibly involving probing at install time or later, so that the C<%Config> in
301 a binary distribution better describes the installed machine, when the
302 installed machine differs from the build machine in some significant way.
303
304 =head2 make parallel builds work
305
306 Currently parallel builds (such as C<make -j3>) don't work reliably. We believe
307 that this is due to incomplete dependency specification in the F<Makefile>.
308 It would be good if someone were able to track down the causes of these
309 problems, so that parallel builds worked properly.
310
311 =head2 linker specification files
312
313 Some platforms mandate that you provide a list of a shared library's external
314 symbols to the linker, so the core already has the infrastructure in place to
315 do this for generating shared perl libraries. My understanding is that the
316 GNU toolchain can accept an optional linker specification file, and restrict
317 visibility just to symbols declared in that file. It would be good to extend
318 F<makedef.pl> to support this format, and to provide a means within
319 C<Configure> to enable it. This would allow Unix users to test that the
320 export list is correct, and to build a perl that does not pollute the global
321 namespace with private symbols.
322
323
324
325
326 =head1 Tasks that need a little C knowledge
327
328 These tasks would need a little C knowledge, but don't need any specific
329 background or experience with XS, or how the Perl interpreter works
330
331 =head2 Make it clear from -v if this is the exact official release
332
333 Currently perl from C<p4>/C<rsync> ships with a F<patchlevel.h> file that
334 usually defines one local patch, of the form "MAINT12345" or "RC1". The output
335 of perl -v doesn't report that a perl isn't an official release, and this
336 information can get lost in bugs reports. Because of this, the minor version
337 isn't bumped up until RC time, to minimise the possibility of versions of perl
338 escaping that believe themselves to be newer than they actually are.
339
340 It would be useful to find an elegant way to have the "this is an interim
341 maintenance release" or "this is a release candidate" in the terse -v output,
342 and have it so that it's easy for the pumpking to remove this just as the
343 release tarball is rolled up. This way the version pulled out of rsync would
344 always say "I'm a development release" and it would be safe to bump the
345 reported minor version as soon as a release ships, which would aid perl
346 developers.
347
348 This task is really about thinking of an elegant way to arrange the C source
349 such that it's trivial for the Pumpking to flag "this is an official release"
350 when making a tarball, yet leave the default source saying "I'm not the
351 official release".
352
353 =head2 Ordering of "global" variables.
354
355 F<thrdvar.h> and F<intrpvarh> define the "global" variables that need to be
356 per-thread under ithreads, where the variables are actually elements in a
357 structure. As C dictates, the variables must be laid out in order of
358 declaration. There is a comment
359 C</* Important ones in the first cache line (if alignment is done right) */>
360 which implies that at some point in the past the ordering was carefully chosen
361 (at least in part). However, it's clear that the ordering is less than perfect,
362 as currently there are things such as 7 C<bool>s in a row, then something
363 typically requiring 4 byte alignment, and then an odd C<bool> later on.
364 (C<bool>s are typically defined as C<char>s). So it would be good for someone
365 to review the ordering of the variables, to see how much alignment padding can
366 be removed.
367
368 It's also worth checking that all variables are actually used. Perl 5.8.0
369 shipped with C<PL_nrs> still defined in F<thrdvar.h>, despite it being unused
370 since a change over a year earlier. Had this been spotted before release, it
371 could have been removed, but now it has to remain in the 5.8.x releases to
372 keep the structure the same size, to retain binary compatibility.
373
374 It's probably worth checking if all need to be the types they are. For example
375
376     PERLVAR(Ierror_count, I32)  /* how many errors so far, max 10 */
377
378 might work as well if stored in a signed (or unsigned) 8 bit value, if the
379 comment is accurate. C<PL_multi_open> and C<PL_multi_close> can probably
380 become C<char>s. Finding variables to downsize coupled with rearrangement
381 could shrink the interpreter structure; a size saving which is multiplied by
382 the number of threads running.
383
384 =head2 am I hot or not?
385
386 The idea of F<pp_hot.c> is that it contains the I<hot> ops, the ops that are
387 most commonly used. The idea is that by grouping them, their object code will
388 be adjacent in the executable, so they have a greater chance of already being
389 in the CPU cache (or swapped in) due to being near another op already in use.
390
391 Except that it's not clear if these really are the most commonly used ops. So
392 anyone feeling like exercising their skill with coverage and profiling tools
393 might want to determine what ops I<really> are the most commonly used. And in
394 turn suggest evictions and promotions to achieve a better F<pp_hot.c>.
395
396 =head2 Shrink struct context
397
398 In F<cop.h>, we have
399
400     struct context {
401         U32             cx_type;        /* what kind of context this is */
402         union {
403         struct block    cx_blk;
404         struct subst    cx_subst;
405         } cx_u;
406     };
407
408 There are less than 256 values for C<cx_type>, and the constituent parts
409 C<struct block> and C<struct subst> both contain some C<U8> and C<U16> fields,
410 so it should be possible to move them to the first word, and share space with
411 a C<U8> C<cx_type>, saving 1 word.
412
413 =head2 Allocate OPs from arenas
414
415 Currently all new OP structures are individually malloc()ed and free()d.
416 All C<malloc> implementations have space overheads, and are now as fast as
417 custom allocates so it would both use less memory and less CPU to allocate
418 the various OP structures from arenas. The SV arena code can probably be
419 re-used for this.
420
421
422
423
424 =head1 Tasks that need a knowledge of XS
425
426 These tasks would need C knowledge, and roughly the level of knowledge of
427 the perl API that comes from writing modules that use XS to interface to
428 C.
429
430 =head2 shrink C<PVBM>s
431
432 By removing unused elements and careful re-ordering, the structures for C<AV>s,
433 C<HV>s, C<CV>s and C<GV>s have recently been shrunk considerably. C<PVIO>s
434 probably aren't worth it, as typical programs don't use more than 8, and
435 (at least) C<Filter::Util::Call> uses C<SvPVX>/C<SvCUR>/C<SvLEN> on a C<PVIO>,
436 so it would mean code changes to modules on CPAN. C<PVBM>s might have some
437 savings to win.
438
439 =head2 Implicit Latin 1 => Unicode translation
440
441 Conversions from byte strings to UTF-8 currently map high bit characters
442 to Unicode without translation (or, depending on how you look at it, by
443 implicitly assuming that the byte strings are in Latin-1). As perl assumes
444 the C locale by default, upgrading a string to UTF-8 may change the
445 meaning of its contents regarding character classes, case mapping, etc.
446 This should probably emit a warning (at least).
447
448 This task is incremental - even a little bit of work on it will help.
449
450 =head2 autovivification
451
452 Make all autovivification consistent w.r.t LVALUE/RVALUE and strict/no strict;
453
454 This task is incremental - even a little bit of work on it will help.
455
456 =head2 Unicode in Filenames
457
458 chdir, chmod, chown, chroot, exec, glob, link, lstat, mkdir, open,
459 opendir, qx, readdir, readlink, rename, rmdir, stat, symlink, sysopen,
460 system, truncate, unlink, utime, -X.  All these could potentially accept
461 Unicode filenames either as input or output (and in the case of system
462 and qx Unicode in general, as input or output to/from the shell).
463 Whether a filesystem - an operating system pair understands Unicode in
464 filenames varies.
465
466 Known combinations that have some level of understanding include
467 Microsoft NTFS, Apple HFS+ (In Mac OS 9 and X) and Apple UFS (in Mac
468 OS X), NFS v4 is rumored to be Unicode, and of course Plan 9.  How to
469 create Unicode filenames, what forms of Unicode are accepted and used
470 (UCS-2, UTF-16, UTF-8), what (if any) is the normalization form used,
471 and so on, varies.  Finding the right level of interfacing to Perl
472 requires some thought.  Remember that an OS does not implicate a
473 filesystem.
474
475 (The Windows -C command flag "wide API support" has been at least
476 temporarily retired in 5.8.1, and the -C has been repurposed, see
477 L<perlrun>.)
478
479 =head2 Unicode in %ENV
480
481 Currently the %ENV entries are always byte strings.
482
483 =head2 use less 'memory'
484
485 Investigate trade offs to switch out perl's choices on memory usage.
486 Particularly perl should be able to give memory back.
487
488 This task is incremental - even a little bit of work on it will help.
489
490 =head2 Re-implement C<:unique> in a way that is actually thread-safe
491
492 The old implementation made bad assumptions on several levels. A good 90%
493 solution might be just to make C<:unique> work to share the string buffer
494 of SvPVs. That way large constant strings can be shared between ithreads,
495 such as the configuration information in F<Config>.
496
497 =head2 Make tainting consistent
498
499 Tainting would be easier to use if it didn't take documented shortcuts and
500 allow taint to "leak" everywhere within an expression.
501
502 =head2 readpipe(LIST)
503
504 system() accepts a LIST syntax (and a PROGRAM LIST syntax) to avoid
505 running a shell. readpipe() (the function behind qx//) could be similarly
506 extended.
507
508
509
510
511
512 =head1 Tasks that need a knowledge of the interpreter
513
514 These tasks would need C knowledge, and knowledge of how the interpreter works,
515 or a willingness to learn.
516
517 =head2 lexical pragmas
518
519 Document the new support for lexical pragmas in 5.9.3 and how %^H works.
520 Maybe C<re>, C<encoding>, maybe other pragmas could be made lexical.
521
522 =head2 Attach/detach debugger from running program
523
524 The old perltodo notes "With C<gdb>, you can attach the debugger to a running
525 program if you pass the process ID. It would be good to do this with the Perl
526 debugger on a running Perl program, although I'm not sure how it would be
527 done." ssh and screen do this with named pipes in /tmp. Maybe we can too.
528
529 =head2 LVALUE functions for lists
530
531 The old perltodo notes that lvalue functions don't work for list or hash
532 slices. This would be good to fix.
533
534 =head2 LVALUE functions in the debugger
535
536 The old perltodo notes that lvalue functions don't work in the debugger. This
537 would be good to fix.
538
539 =head2 _ prototype character
540
541 Study the possibility of adding a new prototype character, C<_>, meaning
542 "this argument defaults to $_".
543
544 =head2 state variables
545
546 C<my $foo if 0;> is deprecated, and should be replaced with
547 C<state $x = "initial value\n";> the syntax from Perl 6.
548
549 =head2 regexp optimiser optional
550
551 The regexp optimiser is not optional. It should configurable to be, to allow
552 its performance to be measured, and its bugs to be easily demonstrated.
553
554 =head2 UNITCHECK
555
556 Introduce a new special block, UNITCHECK, which is run at the end of a
557 compilation unit (module, file, eval(STRING) block). This will correspond to
558 the Perl 6 CHECK. Perl 5's CHECK cannot be changed or removed because the
559 O.pm/B.pm backend framework depends on it.
560
561 =head2 optional optimizer
562
563 Make the peephole optimizer optional. Currently it performs two tasks as
564 it walks the optree - genuine peephole optimisations, and necessary fixups of
565 ops. It would be good to find an efficient way to switch out the
566 optimisations whilst keeping the fixups.
567
568 =head2 You WANT *how* many
569
570 Currently contexts are void, scalar and list. split has a special mechanism in
571 place to pass in the number of return values wanted. It would be useful to
572 have a general mechanism for this, backwards compatible and little speed hit.
573 This would allow proposals such as short circuiting sort to be implemented
574 as a module on CPAN.
575
576 =head2 lexical aliases
577
578 Allow lexical aliases (maybe via the syntax C<my \$alias = \$foo>.
579
580 =head2 entersub XS vs Perl
581
582 At the moment pp_entersub is huge, and has code to deal with entering both
583 perl and XS subroutines. Subroutine implementations rarely change between 
584 perl and XS at run time, so investigate using 2 ops to enter subs (one for
585 XS, one for perl) and swap between if a sub is redefined.
586
587 =head2 Self ties
588
589 self ties are currently illegal because they caused too many segfaults. Maybe
590 the causes of these could be tracked down and self-ties on all types re-
591 instated.
592
593 =head2 Optimize away @_
594
595 The old perltodo notes "Look at the "reification" code in C<av.c>".
596
597 =head2 What hooks would assertions need?
598
599 Assertions are in the core, and work. However, assertions needed to be added
600 as a core patch, rather than an XS module in ext, or a CPAN module, because
601 the core has no hooks in the necessary places. It would be useful to
602 investigate what hooks would need to be added to make it possible to provide
603 the full assertion support from a CPAN module, so that we aren't constraining
604 the imagination of future CPAN authors.
605
606
607
608
609
610 =head1 Big projects
611
612 Tasks that will get your name mentioned in the description of the "Highlights
613 of 5.10"
614
615 =head2 make ithreads more robust
616
617 Generally make ithreads more robust. See also L</iCOW>
618
619 This task is incremental - even a little bit of work on it will help, and
620 will be greatly appreciated.
621
622 One bit would be to write the missing code in sv.c:Perl_dirp_dup.
623
624 =head2 iCOW
625
626 Sarathy and Arthur have a proposal for an improved Copy On Write which
627 specifically will be able to COW new ithreads. If this can be implemented
628 it would be a good thing.
629
630 =head2 (?{...}) closures in regexps
631
632 Fix (or rewrite) the implementation of the C</(?{...})/> closures.
633
634 =head2 A re-entrant regexp engine
635
636 This will allow the use of a regex from inside (?{ }), (??{ }) and
637 (?(?{ })|) constructs.