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