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