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