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