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