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