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