This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
No need to use locale_r with thread-safe locales
[perl5.git] / regen / reentr.pl
1 #!/usr/bin/perl -w
2 #
3 # Regenerate (overwriting only if changed):
4 #
5 #    reentr.h
6 #    reentr.c
7 #
8 # from information stored in the DATA section of this file.
9 #
10 # With the -U option, it also unconditionally regenerates the relevant
11 # metaconfig units:
12 #
13 #    d_${func}_r.U
14 #
15 # Also accepts the standard regen_lib -q and -v args.
16 #
17 # This script is normally invoked from regen.pl.
18
19 BEGIN {
20     # Get function prototypes
21     require './regen/regen_lib.pl';
22 }
23
24 use strict;
25 use Getopt::Std;
26 my %opts;
27 getopts('Uv', \%opts);
28
29 my %map = (
30            V => "void",
31            A => "char*",        # as an input argument
32            B => "char*",        # as an output argument
33            C => "const char*",  # as a read-only input argument
34            I => "int",
35            L => "long",
36            W => "size_t",
37            H => "FILE**",
38            E => "int*",
39           );
40
41 # (See the definitions after __DATA__.)
42 # In func|inc|type|... a "S" means "type*", and a "R" means "type**".
43 # (The "types" are often structs, such as "struct passwd".)
44 #
45 # After the prototypes one can have |X=...|Y=... to define more types.
46 # A commonly used extra type is to define D to be equal to "type_data",
47 # for example "struct_hostent_data to" go with "struct hostent".
48 #
49 # Example #1: I_XSBWR means int  func_r(X, type, char*, size_t, type**)
50 # Example #2: S_SBIE  means type func_r(type, char*, int, int*)
51 # Example #3: S_CBI   means type func_r(const char*, char*, int)
52
53 sub open_print_header {
54     my ($file, $quote) = @_;
55     return open_new($file, '>',
56                     { by => 'regen/reentr.pl',
57                       from => 'data in regen/reentr.pl',
58                       file => $file, style => '*',
59                       copyright => [2002, 2003, 2005 .. 2007],
60                       quote => $quote });
61 }
62
63 my $h = open_print_header('reentr.h');
64 print $h <<EOF;
65 #ifndef PERL_REENTR_H_
66 #define PERL_REENTR_H_
67
68 /* If compiling for a threaded perl, we will macro-wrap the system/library
69  * interfaces (e.g. getpwent()) which have threaded versions
70  * (e.g. getpwent_r()), which will handle things correctly for
71  * the Perl interpreter.  This is done automatically for the perl core and
72  * extensions, but not generally for XS modules unless they
73  *    #define PERL_REENTRANT
74  * See L<perlxs/Thread-aware system interfaces>.
75  *
76  * For a function 'foo', use the compile-time directive
77  *    #ifdef PERL_REENTR_USING_FOO_R
78  * to test if the function actually did get replaced by the reentrant version.
79  * (If it isn't getting replaced, it might mean it uses a different prototype
80  * on the given platform than any we are expecting.  To fix that, add the
81  * prototype to the __DATA__ section of regen/reentr.pl.)
82  */
83
84 #ifndef PERL_REENTR_API
85 #  if defined(PERL_CORE) || defined(PERL_EXT) || defined(PERL_REENTRANT)
86 #    define PERL_REENTR_API 1
87 #  else
88 #    define PERL_REENTR_API 0
89 #  endif
90 #endif
91
92 #ifdef USE_REENTRANT_API
93
94 /* For thread-safe builds, alternative methods are used to make calls to this
95  * safe. */
96 #ifdef USE_THREAD_SAFE_LOCALE
97 #   undef HAS_SETLOCALE_R
98 #endif
99  
100 /* Deprecations: some platforms have the said reentrant interfaces
101  * but they are declared obsolete and are not to be used.  Often this
102  * means that the platform has threadsafed the interfaces (hopefully).
103  * All this is OS version dependent, so we are of course fooling ourselves.
104  * If you know of more deprecations on some platforms, please add your own
105  * (by editing reentr.pl, mind!) */
106
107 #  ifdef __hpux
108 #    undef HAS_CRYPT_R
109 #    undef HAS_ENDGRENT_R
110 #    undef HAS_ENDPWENT_R
111 #    undef HAS_GETGRENT_R
112 #    undef HAS_GETPWENT_R
113 #    undef HAS_SETLOCALE_R
114 #    undef HAS_STRERROR_R
115 #    define NETDB_R_OBSOLETE
116 #  endif
117
118 #  if defined(__osf__) && defined(__alpha) /* Tru64 aka Digital UNIX */
119 #    undef HAS_CRYPT_R
120 #    undef HAS_STRERROR_R
121 #    define NETDB_R_OBSOLETE
122 #  endif
123
124 #  if defined(__GLIBC__) && (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 24))
125 #    undef HAS_READDIR_R
126 #    undef HAS_READDIR64_R
127 #  endif
128
129 /*
130  * As of OpenBSD 3.7, reentrant functions are now working, they just are
131  * incompatible with everyone else.  To make OpenBSD happy, we have to
132  * memzero out certain structures before calling the functions.
133  */
134 #  if defined(__OpenBSD__)
135 #    define REENTR_MEMZERO(a,b) memzero(a,b)
136 #  else
137 #    define REENTR_MEMZERO(a,b) 0
138 #  endif
139
140 #  ifdef NETDB_R_OBSOLETE
141 #    undef HAS_ENDHOSTENT_R
142 #    undef HAS_ENDNETENT_R
143 #    undef HAS_ENDPROTOENT_R
144 #    undef HAS_ENDSERVENT_R
145 #    undef HAS_GETHOSTBYADDR_R
146 #    undef HAS_GETHOSTBYNAME_R
147 #    undef HAS_GETHOSTENT_R
148 #    undef HAS_GETNETBYADDR_R
149 #    undef HAS_GETNETBYNAME_R
150 #    undef HAS_GETNETENT_R
151 #    undef HAS_GETPROTOBYNAME_R
152 #    undef HAS_GETPROTOBYNUMBER_R
153 #    undef HAS_GETPROTOENT_R
154 #    undef HAS_GETSERVBYNAME_R
155 #    undef HAS_GETSERVBYPORT_R
156 #    undef HAS_GETSERVENT_R
157 #    undef HAS_SETHOSTENT_R
158 #    undef HAS_SETNETENT_R
159 #    undef HAS_SETPROTOENT_R
160 #    undef HAS_SETSERVENT_R
161 #  endif
162
163 #  ifdef I_PWD
164 #    include <pwd.h>
165 #  endif
166 #  ifdef I_GRP
167 #    include <grp.h>
168 #  endif
169 #  ifdef I_NETDB
170 #    include <netdb.h>
171 #  endif
172 #  ifdef I_CRYPT
173 #    ifdef I_CRYPT
174 #      include <crypt.h>
175 #    endif
176 #  endif
177 #  ifdef HAS_GETSPNAM_R
178 #    ifdef I_SHADOW
179 #      include <shadow.h>
180 #    endif
181 #  endif
182
183 EOF
184
185 my %seenh; # the different prototypes signatures for this function
186 my %seena; # the different prototypes signatures for this function in order
187 my @seenf; # all the seen functions
188 my %seenp; # the different prototype signatures for all functions
189 my %seent; # the return type of this function
190 my %seens; # the type of this function's "S"
191 my %seend; # the type of this function's "D"
192 my %seenm; # all the types
193 my %seenu; # the length of the argument list of this function
194
195 while (<DATA>) { # Read in the protoypes.
196     next if /^\s+$/;
197     chomp;
198     my ($func, $hdr, $type, @p) = split(/\s*\|\s*/, $_, -1);
199     my $u;
200     # Split off the real function name and the argument list.
201     ($func, $u) = split(' ', $func);
202     $seenu{$func} = defined $u ? length $u : 0;
203     my $FUNC = uc $func; # for output.
204     push @seenf, $func;
205     my %m = %map;
206     if ($type) {
207         $m{S} = "$type*";
208         $m{R} = "$type**";
209     }
210
211     # Set any special mapping variables (like X=x_t)
212     if (@p) {
213         while ($p[-1] =~ /=/) {
214             my ($k, $v) = ($p[-1] =~ /^([A-Za-z])\s*=\s*(.*)/);
215             $m{$k} = $v;
216             pop @p;
217         }
218     }
219
220     # If given the -U option open up the metaconfig unit for this function.
221     if ($opts{U} && open(U, ">", "d_${func}_r.U"))  {
222         binmode U;
223     }
224
225     if ($opts{U}) {
226         # The metaconfig units needs prerequisite dependencies.
227         my $prereqs  = '';
228         my $prereqh  = '';
229         my $prereqsh = '';
230         if ($hdr ne 'stdio') { # There's no i_stdio.
231             $prereqs  = "i_$hdr";
232             $prereqh  = "$hdr.h";
233             $prereqsh = "\$$prereqs $prereqh";
234         }
235         my @prereq = qw(Inlibc Protochk Hasproto i_systypes usethreads);
236         push @prereq, $prereqs;
237         my $hdrs = "\$i_systypes sys/types.h define stdio.h $prereqsh";
238         if ($hdr eq 'time') {
239             $hdrs .= " \$i_systime sys/time.h";
240             push @prereq, 'i_systime';
241         }
242         # Output the metaconfig unit header.
243         print U <<"EOF";
244 ?RCS: \$Id: d_${func}_r.U,v $
245 ?RCS:
246 ?RCS: Copyright (c) 2002,2003 Jarkko Hietaniemi
247 ?RCS:
248 ?RCS: You may distribute under the terms of either the GNU General Public
249 ?RCS: License or the Artistic License, as specified in the README file.
250 ?RCS:
251 ?RCS: Generated by the reentr.pl from the Perl 5.8 distribution.
252 ?RCS:
253 ?MAKE:d_${func}_r ${func}_r_proto: @prereq
254 ?MAKE:  -pick add \$@ %<
255 ?S:d_${func}_r:
256 ?S:     This variable conditionally defines the HAS_${FUNC}_R symbol,
257 ?S:     which indicates to the C program that the ${func}_r()
258 ?S:     routine is available.
259 ?S:.
260 ?S:${func}_r_proto:
261 ?S:     This variable encodes the prototype of ${func}_r.
262 ?S:     It is zero if d_${func}_r is undef, and one of the
263 ?S:     REENTRANT_PROTO_T_ABC macros of reentr.h if d_${func}_r
264 ?S:     is defined.
265 ?S:.
266 ?C:HAS_${FUNC}_R:
267 ?C:     This symbol, if defined, indicates that the ${func}_r routine
268 ?C:     is available to ${func} re-entrantly.
269 ?C:.
270 ?C:${FUNC}_R_PROTO:
271 ?C:     This symbol encodes the prototype of ${func}_r.
272 ?C:     It is zero if d_${func}_r is undef, and one of the
273 ?C:     REENTRANT_PROTO_T_ABC macros of reentr.h if d_${func}_r
274 ?C:     is defined.
275 ?C:.
276 ?H:#\$d_${func}_r HAS_${FUNC}_R    /**/
277 ?H:#define ${FUNC}_R_PROTO \$${func}_r_proto       /**/
278 ?H:.
279 ?T:try hdrs d_${func}_r_proto
280 ?LINT:set d_${func}_r
281 ?LINT:set ${func}_r_proto
282 : see if ${func}_r exists
283 set ${func}_r d_${func}_r
284 eval \$inlibc
285 case "\$d_${func}_r" in
286 "\$define")
287 EOF
288         print U <<"EOF";
289         hdrs="$hdrs"
290         case "\$d_${func}_r_proto:\$usethreads" in
291         ":define")      d_${func}_r_proto=define
292                 set d_${func}_r_proto ${func}_r \$hdrs
293                 eval \$hasproto ;;
294         *)      ;;
295         esac
296         case "\$d_${func}_r_proto" in
297         define)
298 EOF
299     }
300     for my $p (@p) {
301         my ($r, $a) = ($p =~ /^(.)_(.+)/);
302         my $v = join(", ", map { $m{$_} } split '', $a);
303         if ($opts{U}) {
304             print U <<"EOF";
305         case "\$${func}_r_proto" in
306         ''|0) try='$m{$r} ${func}_r($v);'
307         ./protochk "extern \$try" \$hdrs && ${func}_r_proto=$p ;;
308         esac
309 EOF
310         }
311         $seenh{$func}->{$p}++;
312         push @{$seena{$func}}, $p;
313         $seenp{$p}++;
314         $seent{$func} = $type;
315         $seens{$func} = $m{S};
316         $seend{$func} = $m{D};
317         $seenm{$func} = \%m;
318     }
319     if ($opts{U}) {
320         print U <<"EOF";
321         case "\$${func}_r_proto" in
322         ''|0)   d_${func}_r=undef
323                 ${func}_r_proto=0
324                 echo "Disabling ${func}_r, cannot determine prototype." >&4 ;;
325         * )     case "\$${func}_r_proto" in
326                 REENTRANT_PROTO*) ;;
327                 *) ${func}_r_proto="REENTRANT_PROTO_\$${func}_r_proto" ;;
328                 esac
329                 echo "Prototype: \$try" ;;
330         esac
331         ;;
332         *)      case "\$usethreads" in
333                 define) echo "${func}_r has no prototype, not using it." >&4 ;;
334                 esac
335                 d_${func}_r=undef
336                 ${func}_r_proto=0
337                 ;;
338         esac
339         ;;
340 *)      ${func}_r_proto=0
341         ;;
342 esac
343
344 EOF
345         close(U);
346     }
347 }
348
349 close DATA;
350
351 {
352     # Write out all the known prototype signatures.
353     my $i = 1;
354     for my $p (sort keys %seenp) {
355         print $h "#  define REENTRANT_PROTO_${p}        ${i}\n";
356         $i++;
357     }
358 }
359
360 my @struct; # REENTR struct members
361 my @size;   # struct member buffer size initialization code
362 my @init;   # struct member buffer initialization (malloc) code
363 my @free;   # struct member buffer release (free) code
364 my @wrap;   # the wrapper (foo(a) -> foo_r(a,...)) cpp code
365 my @define; # defines for optional features
366
367 sub ifprotomatch {
368     my $FUNC = shift;
369     join " || ", map { "${FUNC}_R_PROTO == REENTRANT_PROTO_$_" } @_;
370 }
371
372 sub pushssif {
373     push @struct, @_;
374     push @size, @_;
375     push @init, @_;
376     push @free, @_;
377 }
378
379 sub pushinitfree {
380     my $func = shift;
381     push @init, <<EOF;
382         Newx(PL_reentrant_buffer->_${func}_buffer, PL_reentrant_buffer->_${func}_size, char);
383 EOF
384     push @free, <<EOF;
385         Safefree(PL_reentrant_buffer->_${func}_buffer);
386 EOF
387 }
388
389 sub define {
390     my ($n, $p, @F) = @_;
391     my @H;
392     my $H = uc $F[0];
393     push @define, <<EOF;
394 /* The @F using \L$n? */
395
396 EOF
397     my $GENFUNC;
398     for my $func (@F) {
399         my $FUNC = uc $func;
400         my $HAS = "${FUNC}_R_HAS_$n";
401         push @H, $HAS;
402         my @h = grep { /$p/ } @{$seena{$func}};
403         unless (defined $GENFUNC) {
404             $GENFUNC = $FUNC;
405             $GENFUNC =~ s/^GET//;
406         }
407         if (@h) {
408             push @define, "#  if defined(HAS_${FUNC}_R) && (" . join(" || ", map { "${FUNC}_R_PROTO == REENTRANT_PROTO_$_" } @h) . ")\n";
409
410             push @define, <<EOF;
411 #    define $HAS
412 #  else
413 #    undef  $HAS
414 #  endif
415 EOF
416         }
417     }
418     return if @F == 1;
419     push @define, <<EOF;
420
421 /* Any of the @F using \L$n? */
422
423 EOF
424     push @define, "#  if (" . join(" || ", map { "defined($_)" } @H) . ")\n";
425     push @define, <<EOF;
426 #    define USE_${GENFUNC}_$n
427 #  else
428 #    undef  USE_${GENFUNC}_$n
429 #  endif
430
431 EOF
432 }
433
434 define('BUFFER',  'B',
435        qw(getgrent getgrgid getgrnam));
436
437 define('PTR',  'R',
438        qw(getgrent getgrgid getgrnam));
439 define('PTR',  'R',
440        qw(getpwent getpwnam getpwuid));
441 define('PTR',  'R',
442        qw(getspent getspnam));
443
444 define('FPTR', 'H',
445        qw(getgrent getgrgid getgrnam setgrent endgrent));
446 define('FPTR', 'H',
447        qw(getpwent getpwnam getpwuid setpwent endpwent));
448
449 define('BUFFER',  'B',
450        qw(getpwent getpwgid getpwnam));
451
452 define('BUFFER',  'B',
453        qw(getspent getspnam));
454
455 define('PTR', 'R',
456        qw(gethostent gethostbyaddr gethostbyname));
457 define('PTR', 'R',
458        qw(getnetent getnetbyaddr getnetbyname));
459 define('PTR', 'R',
460        qw(getprotoent getprotobyname getprotobynumber));
461 define('PTR', 'R',
462        qw(getservent getservbyname getservbyport));
463
464 define('BUFFER', 'B',
465        qw(gethostent gethostbyaddr gethostbyname));
466 define('BUFFER', 'B',
467        qw(getnetent getnetbyaddr getnetbyname));
468 define('BUFFER', 'B',
469        qw(getprotoent getprotobyname getprotobynumber));
470 define('BUFFER', 'B',
471        qw(getservent getservbyname getservbyport));
472
473 define('ERRNO', 'E',
474        qw(gethostent gethostbyaddr gethostbyname));
475 define('ERRNO', 'E',
476        qw(getnetent getnetbyaddr getnetbyname));
477
478 # The following loop accumulates the "ssif" (struct, size, init, free)
479 # sections that declare the struct members (in reentr.h), and the buffer
480 # size initialization, buffer initialization (malloc), and buffer
481 # release (free) code (in reentr.c).
482 #
483 # The loop also contains a lot of intrinsic logic about groups of
484 # functions (since functions of certain kind operate the same way).
485
486 for my $func (@seenf) {
487     my $FUNC = uc $func;
488     my $ifdef = "#  ifdef HAS_${FUNC}_R\n";
489     my $endif = "#  endif /* HAS_${FUNC}_R */\n\n";
490     if (exists $seena{$func}) {
491         my @p = @{$seena{$func}};
492         if ($func =~ /^(asctime|ctime|getlogin|setlocale|strerror|ttyname)$/) {
493             pushssif $ifdef;
494             push @struct, <<EOF;
495         char*   _${func}_buffer;
496         size_t  _${func}_size;
497 EOF
498             push @size, <<EOF;
499         PL_reentrant_buffer->_${func}_size = REENTRANTSMALLSIZE;
500 EOF
501             pushinitfree $func;
502             pushssif $endif;
503         }
504         elsif ($func =~ /^(gm|local)time$/) {
505             pushssif $ifdef;
506             push @struct, <<EOF;    # Fixed size
507         $seent{$func} _${func}_struct;
508 EOF
509             pushssif $endif;
510         }
511         elsif ($func =~ /^(crypt)$/) {
512             pushssif $ifdef;
513             push @struct, <<EOF;
514 #  if CRYPT_R_PROTO == REENTRANT_PROTO_B_CCD
515         $seend{$func} _${func}_data;
516 #  else
517         $seent{$func} *_${func}_struct_buffer;
518 #  endif
519 EOF
520             push @init, <<EOF;
521 #  if CRYPT_R_PROTO != REENTRANT_PROTO_B_CCD
522         PL_reentrant_buffer->_${func}_struct_buffer = 0;
523 #  endif
524 EOF
525             push @free, <<EOF;
526 #  if CRYPT_R_PROTO != REENTRANT_PROTO_B_CCD
527         Safefree(PL_reentrant_buffer->_${func}_struct_buffer);
528 #  endif
529 EOF
530             pushssif $endif;
531         }
532         elsif ($func =~ /^(getgrnam|getpwnam|getspnam)$/) {
533             pushssif $ifdef;
534             # 'genfunc' can be read either as 'generic' or 'genre',
535             # it represents a group of functions.
536             my $genfunc = $func;
537             $genfunc =~ s/nam/ent/g;
538             $genfunc =~ s/^get//;
539             my $GENFUNC = uc $genfunc;
540             push @struct, <<EOF;
541         $seent{$func}   _${genfunc}_struct;
542         char*   _${genfunc}_buffer;
543         size_t  _${genfunc}_size;
544 EOF
545             push @struct, <<EOF;
546 #   ifdef USE_${GENFUNC}_PTR
547         $seent{$func}*  _${genfunc}_ptr;
548 #   endif
549 EOF
550             push @struct, <<EOF;
551 #   ifdef USE_${GENFUNC}_FPTR
552         FILE*   _${genfunc}_fptr;
553 #   endif
554 EOF
555             push @init, <<EOF;
556 #   ifdef USE_${GENFUNC}_FPTR
557         PL_reentrant_buffer->_${genfunc}_fptr = NULL;
558 #   endif
559 EOF
560             my $sc = $genfunc eq 'grent' ?
561                     '_SC_GETGR_R_SIZE_MAX' : '_SC_GETPW_R_SIZE_MAX';
562             my $sz = "_${genfunc}_size";
563             push @size, <<EOF;
564 #    if defined(HAS_SYSCONF) && defined($sc) && !defined(__GLIBC__)
565         PL_reentrant_buffer->$sz = sysconf($sc);
566         if (PL_reentrant_buffer->$sz == (size_t) -1)
567                 PL_reentrant_buffer->$sz = REENTRANTUSUALSIZE;
568 #    elif defined(__osf__) && defined(__alpha) && defined(SIABUFSIZ)
569         PL_reentrant_buffer->$sz = SIABUFSIZ;
570 #    elif defined(__sgi)
571         PL_reentrant_buffer->$sz = BUFSIZ;
572 #    else
573         PL_reentrant_buffer->$sz = REENTRANTUSUALSIZE;
574 #    endif
575 EOF
576             pushinitfree $genfunc;
577             pushssif $endif;
578         }
579         elsif ($func =~ /^(gethostbyname|getnetbyname|getservbyname|getprotobyname)$/) {
580             pushssif $ifdef;
581             my $genfunc = $func;
582             $genfunc =~ s/byname/ent/;
583             $genfunc =~ s/^get//;
584             my $GENFUNC = uc $genfunc;
585             my $D = ifprotomatch($FUNC, grep {/D/} @p);
586             my $d = $seend{$func};
587             $d =~ s/\*$//; # snip: we need the base type.
588             push @struct, <<EOF;
589         $seent{$func}   _${genfunc}_struct;
590 #   if $D
591         $d      _${genfunc}_data;
592 #   else
593         char*   _${genfunc}_buffer;
594         size_t  _${genfunc}_size;
595 #   endif
596 #   ifdef USE_${GENFUNC}_PTR
597         $seent{$func}*  _${genfunc}_ptr;
598 #   endif
599 EOF
600             push @struct, <<EOF;
601 #   ifdef USE_${GENFUNC}_ERRNO
602         int     _${genfunc}_errno;
603 #   endif
604 EOF
605             push @size, <<EOF;
606 #  if !($D)
607         PL_reentrant_buffer->_${genfunc}_size = REENTRANTUSUALSIZE;
608 #  endif
609 EOF
610             push @init, <<EOF;
611 #  if !($D)
612         Newx(PL_reentrant_buffer->_${genfunc}_buffer, PL_reentrant_buffer->_${genfunc}_size, char);
613 #  endif
614 EOF
615             push @free, <<EOF;
616 #  if !($D)
617         Safefree(PL_reentrant_buffer->_${genfunc}_buffer);
618 #  endif
619 EOF
620             pushssif $endif;
621         }
622         elsif ($func =~ /^(readdir|readdir64)$/) {
623             pushssif $ifdef;
624             my $R = ifprotomatch($FUNC, grep {/R/} @p);
625             push @struct, <<EOF;
626         $seent{$func}*  _${func}_struct;
627         size_t  _${func}_size;
628 #   if $R
629         $seent{$func}*  _${func}_ptr;
630 #   endif
631 EOF
632             push @size, <<EOF;
633         /* This is the size Solaris recommends.
634          * (though we go static, should use pathconf() instead) */
635         PL_reentrant_buffer->_${func}_size = sizeof($seent{$func}) + MAXPATHLEN + 1;
636 EOF
637             push @init, <<EOF;
638         PL_reentrant_buffer->_${func}_struct = ($seent{$func}*)safemalloc(PL_reentrant_buffer->_${func}_size);
639 EOF
640             push @free, <<EOF;
641         Safefree(PL_reentrant_buffer->_${func}_struct);
642 EOF
643             pushssif $endif;
644         }
645
646         push @wrap, $ifdef;
647
648         push @wrap, <<EOF;
649 #    if defined(PERL_REENTR_API) && (PERL_REENTR_API+0 == 1)
650 #      undef $func
651 EOF
652
653         # Write out what we have learned.
654         
655         my @v = 'a'..'z';
656         my $v = join(", ", @v[0..$seenu{$func}-1]);
657         for my $p (@p) {
658             my ($r, $a) = split '_', $p;
659             my $test = $r eq 'I' ? ' == 0' : '';
660             my $true  = 1;
661             my $genfunc = $func;
662             if ($genfunc =~ /^(?:get|set|end)(pw|gr|host|net|proto|serv|sp)/) {
663                 $genfunc = "${1}ent";
664             }
665             my $b = $a;
666             my $w = '';
667             substr($b, 0, $seenu{$func}) = '';
668             if ($b =~ /R/) {
669                 $true = "PL_reentrant_buffer->_${genfunc}_ptr";
670             } elsif ($b =~ /S/) {
671                 if ($func =~ /^readdir/) {
672                     $true = "PL_reentrant_buffer->_${genfunc}_struct";
673                 } else {
674                     $true = "&PL_reentrant_buffer->_${genfunc}_struct";
675                 }
676             } elsif ($b =~ /B/) {
677                 $true = "PL_reentrant_buffer->_${genfunc}_buffer";
678             }
679             if (length $b) {
680                 $w = join ", ",
681                    map { $_ eq 'R'
682                          ?  "&PL_reentrant_buffer->_${genfunc}_ptr"
683                          : $_ eq 'E'
684                            ? "&PL_reentrant_buffer->_${genfunc}_errno"
685                            : $_ eq 'B'
686                              ? "PL_reentrant_buffer->_${genfunc}_buffer"
687                              : $_ =~ /^[WI]$/
688                              ? "PL_reentrant_buffer->_${genfunc}_size"
689                              : $_ eq 'H'
690                              ? "&PL_reentrant_buffer->_${genfunc}_fptr"
691                              : $_ eq 'D'
692                                ? "&PL_reentrant_buffer->_${genfunc}_data"
693                                : $_ eq 'S'
694                                  ? ($func =~ /^readdir\d*$/
695                                    ? "PL_reentrant_buffer->_${genfunc}_struct"
696                                    : $func =~ /^crypt$/
697                                      ? "PL_reentrant_buffer->_${genfunc}_struct_buffer"
698                                      : "&PL_reentrant_buffer->_${genfunc}_struct")
699                                  : $_
700                        } split '', $b;
701                 $w = ", $w" if length $v;
702             }
703
704             # This needs a special case, see its definition in config.h
705             my $setup = ($func eq 'localtime') ? "L_R_TZSET " : "";
706
707             my $call = "$setup${func}_r($v$w)";
708
709             # Must make OpenBSD happy
710             my $memzero = '';
711             if($p =~ /D$/ &&
712                 ($genfunc eq 'protoent' || $genfunc eq 'servent')) {
713                 $memzero = 'REENTR_MEMZERO(&PL_reentrant_buffer->_' . $genfunc . '_data, sizeof(PL_reentrant_buffer->_' . $genfunc . '_data)),';
714             }
715             push @wrap, <<EOF;
716 #      if !defined($func) && ${FUNC}_R_PROTO == REENTRANT_PROTO_$p
717 EOF
718             if ($r eq 'V' || $r eq 'B') {
719                 push @wrap, <<EOF;
720 #        define $func($v) $call
721 EOF
722             } else {
723                 if ($func =~ /^get/) {
724                     my $rv = $v ? ", $v" : "";
725                     if ($r eq 'I') {
726                         push @wrap, <<EOF;
727 #        define $func($v) ($memzero(PL_reentrant_retint = $call)$test ? $true : ((PL_reentrant_retint == ERANGE) ? ($seent{$func} *) Perl_reentrant_retry("$func"$rv) : 0))
728 EOF
729                     } else {
730                         push @wrap, <<EOF;
731 #        define $func($v) ($call$test ? $true : ((errno == ERANGE) ? ($seent{$func} *) Perl_reentrant_retry("$func"$rv) : 0))
732 EOF
733                     }
734                 } else {
735                     push @wrap, <<EOF;
736 #        define $func($v) ($call$test ? $true : 0)
737 EOF
738                 }
739             }
740             push @wrap, <<EOF;  #  !defined(xxx) && XXX_R_PROTO == REENTRANT_PROTO_Y_TS
741 #      endif
742 EOF
743         }
744                     push @wrap, <<EOF;
745 #      if defined($func)
746 #        define PERL_REENTR_USING_${FUNC}_R
747 #      endif
748 EOF
749
750             push @wrap, <<EOF;  #  defined(PERL_REENTR_API) && (PERL_REENTR_API+0 == 1)
751 #    endif
752 EOF
753
754         push @wrap, $endif, "\n";
755     }
756 }
757
758 local $" = '';
759
760 print $h <<EOF;
761
762 /* Defines for indicating which special features are supported. */
763
764 @define
765 typedef struct {
766
767 @struct
768     int dummy; /* cannot have empty structs */
769 } REENTR;
770
771 /* The wrappers. */
772
773 @wrap
774
775 /* Special case this; if others came along, could automate it */
776 #  ifdef HAS_GETSPNAM_R
777 #    define KEY_getspnam -1
778 #  endif
779
780 #endif /* USE_REENTRANT_API */
781
782 #endif
783 EOF
784
785 read_only_bottom_close_and_rename($h);
786
787 # Prepare to write the reentr.c.
788
789 my $c = open_print_header('reentr.c', <<'EOQ');
790  */
791
792 /*
793  * "Saruman," I said, standing away from him, "only one hand at a time can
794  *  wield the One, and you know that well, so do not trouble to say we!"
795  *
796  *     [p.260 of _The Lord of the Rings_, II/ii: "The Council of Elrond"]
797  */
798
799 /*
800  * This file contains a collection of automatically created wrappers
801  * (created by running reentr.pl) for reentrant (thread-safe) versions of
802  * various library calls, such as getpwent_r.  The wrapping is done so
803  * that other files like pp_sys.c calling those library functions need not
804  * care about the differences between various platforms' idiosyncrasies
805  * regarding these reentrant interfaces.
806  */
807 EOQ
808
809 print $c <<"EOF";
810 #include "EXTERN.h"
811 #define PERL_IN_REENTR_C
812 #include "perl.h"
813 #include "reentr.h"
814 #include "keywords.h"
815
816 #define RenewDouble(data_pointer, size_pointer, type) \\
817     STMT_START { \\
818         const size_t size = *(size_pointer) * 2; \\
819         Renew((data_pointer), (size), type); \\
820         *(size_pointer) = size; \\
821     } STMT_END
822
823 void
824 Perl_reentrant_size(pTHX) {
825         PERL_UNUSED_CONTEXT;
826
827         /* Set the sizes of the reentrant buffers */
828
829 #ifdef USE_REENTRANT_API
830 #  define REENTRANTSMALLSIZE     256    /* Make something up. */
831 #  define REENTRANTUSUALSIZE    4096    /* Make something up. */
832
833 @size
834 #endif /* USE_REENTRANT_API */
835
836 }
837
838 void
839 Perl_reentrant_init(pTHX) {
840         PERL_UNUSED_CONTEXT;
841
842         /* Initialize the whole thing */
843
844 #ifdef USE_REENTRANT_API
845
846         Newx(PL_reentrant_buffer, 1, REENTR);
847         Perl_reentrant_size(aTHX);
848
849 @init
850 #endif /* USE_REENTRANT_API */
851
852 }
853
854 void
855 Perl_reentrant_free(pTHX) {
856         PERL_UNUSED_CONTEXT;
857
858         /* Tear down */
859
860 #ifdef USE_REENTRANT_API
861
862 @free
863         Safefree(PL_reentrant_buffer);
864
865 #endif /* USE_REENTRANT_API */
866 }
867
868 void*
869 Perl_reentrant_retry(const char *f, ...)
870 {
871     /* This function is set up to be called if the normal function returns
872      * failure with errno ERANGE, which indicates the buffer is too small.
873      * This function calls the failing one again with a larger buffer.
874      *
875      * What has happened is that, due to the magic of C preprocessor macro
876      * expansion, when the original code called function 'foo(args)', it was
877      * instead compiled into something like a call of 'foo_r(args, buffer)'
878      * Below we retry with 'foo', but the preprocessor has changed that into
879      * 'foo_r', so this function will end up calling itself recursively, each
880      * time with a larger buffer.  If PERL_REENTRANT_MAXSIZE is defined, it
881      * won't increase beyond that, instead failing. */
882
883     void *retptr = NULL;
884     va_list ap;
885
886     I32 key = 0;
887
888 #ifdef USE_REENTRANT_API
889
890     dTHX;
891
892     key = Perl_keyword (aTHX_ f, strlen(f), FALSE /* not feature enabled */);
893
894     /* Easier to special case this here than in embed.pl. (Look at what it
895        generates for proto.h) */
896     PERL_ARGS_ASSERT_REENTRANT_RETRY;
897
898 #endif
899
900     if (key == 0) {
901
902 #ifdef HAS_GETSPNAM_R
903
904         /* This is a #define as has no corresponding keyword */
905         if (strEQ(f, "getspnam")) {
906             key = KEY_getspnam;
907         }
908
909 #endif
910
911     }
912     else if (key < 0) {
913         key = -key;
914     }
915
916     va_start(ap, f);
917
918 #ifdef USE_REENTRANT_API
919
920     switch (key) {
921
922 #  ifdef USE_HOSTENT_BUFFER
923
924     case KEY_gethostbyaddr:
925     case KEY_gethostbyname:
926     case KEY_endhostent:
927         {
928             char * host_addr;
929             Size_t asize;
930             char * host_name;
931             int anint;
932
933 #    ifdef PERL_REENTRANT_MAXSIZE
934             if (PL_reentrant_buffer->_hostent_size <=
935                 PERL_REENTRANT_MAXSIZE / 2)
936 #    endif
937             RenewDouble(PL_reentrant_buffer->_hostent_buffer,
938                     &PL_reentrant_buffer->_hostent_size, char);
939             switch (key) {
940                 case KEY_gethostbyaddr:
941                     host_addr = va_arg(ap, char *);
942                     asize = va_arg(ap, Size_t);
943                     anint  = va_arg(ap, int);
944                     /* socklen_t is what Posix 2001 says this should be */
945                     retptr = gethostbyaddr(host_addr, (socklen_t) asize, anint); break;
946                 case KEY_gethostbyname:
947                     host_name = va_arg(ap, char *);
948                     retptr = gethostbyname(host_name); break;
949                 case KEY_endhostent:
950                     retptr = gethostent(); break;
951                 default:
952                     SETERRNO(ERANGE, LIB_INVARG);
953                     break;
954             }
955         }
956         break;
957
958 #  endif
959 #  ifdef USE_GRENT_BUFFER
960
961     case KEY_getgrent:
962     case KEY_getgrgid:
963     case KEY_getgrnam:
964         {
965             char * name;
966             Gid_t gid;
967
968 #    ifdef PERL_REENTRANT_MAXSIZE
969             if (PL_reentrant_buffer->_grent_size <=
970                 PERL_REENTRANT_MAXSIZE / 2)
971 #    endif
972             RenewDouble(PL_reentrant_buffer->_grent_buffer,
973                     &PL_reentrant_buffer->_grent_size, char);
974             switch (key) {
975                 case KEY_getgrnam:
976                     name = va_arg(ap, char *);
977                     retptr = getgrnam(name); break;
978                 case KEY_getgrgid:
979 #    if Gid_t_size < INTSIZE
980                     gid = (Gid_t)va_arg(ap, int);
981 #    else
982                     gid = va_arg(ap, Gid_t);
983 #    endif
984                     retptr = getgrgid(gid); break;
985                 case KEY_getgrent:
986                     retptr = getgrent(); break;
987                 default:
988                     SETERRNO(ERANGE, LIB_INVARG);
989                     break;
990             }
991         }
992         break;
993
994 #  endif
995 #  ifdef USE_NETENT_BUFFER
996
997     case KEY_getnetbyaddr:
998     case KEY_getnetbyname:
999     case KEY_getnetent:
1000         {
1001             char * name;
1002             Netdb_net_t net;
1003             int anint;
1004
1005 #    ifdef PERL_REENTRANT_MAXSIZE
1006             if (PL_reentrant_buffer->_netent_size <=
1007                 PERL_REENTRANT_MAXSIZE / 2)
1008 #    endif
1009             RenewDouble(PL_reentrant_buffer->_netent_buffer,
1010                     &PL_reentrant_buffer->_netent_size, char);
1011             switch (key) {
1012                 case KEY_getnetbyaddr:
1013                     net = va_arg(ap, Netdb_net_t);
1014                     anint = va_arg(ap, int);
1015                     retptr = getnetbyaddr(net, anint); break;
1016                 case KEY_getnetbyname:
1017                     name = va_arg(ap, char *);
1018                     retptr = getnetbyname(name); break;
1019                 case KEY_getnetent:
1020                     retptr = getnetent(); break;
1021                 default:
1022                     SETERRNO(ERANGE, LIB_INVARG);
1023                     break;
1024             }
1025         }
1026         break;
1027
1028 #  endif
1029 #  ifdef USE_PWENT_BUFFER
1030
1031     case  KEY_getpwnam:
1032     case  KEY_getpwuid:
1033     case  KEY_getpwent:
1034         {
1035             Uid_t uid;
1036             char * name;
1037
1038 #    ifdef PERL_REENTRANT_MAXSIZE
1039             if (PL_reentrant_buffer->_pwent_size <=
1040                 PERL_REENTRANT_MAXSIZE / 2)
1041
1042 #    endif
1043             RenewDouble(PL_reentrant_buffer->_pwent_buffer,
1044                     &PL_reentrant_buffer->_pwent_size, char);
1045             switch (key) {
1046                 case KEY_getpwnam:
1047                     name = va_arg(ap, char *);
1048                     retptr = getpwnam(name); break;
1049                 case KEY_getpwuid:
1050
1051 #    if Uid_t_size < INTSIZE
1052                     uid = (Uid_t)va_arg(ap, int);
1053 #    else
1054                     uid = va_arg(ap, Uid_t);
1055 #    endif
1056                     retptr = getpwuid(uid); break;
1057
1058 #  if defined(HAS_GETPWENT) || defined(HAS_GETPWENT_R)
1059
1060                 case KEY_getpwent:
1061                     retptr = getpwent(); break;
1062 #  endif
1063                 default:
1064                     SETERRNO(ERANGE, LIB_INVARG);
1065                     break;
1066             }
1067         }
1068         break;
1069
1070 #  endif
1071 #  ifdef USE_SPENT_BUFFER
1072
1073     case KEY_getspnam:
1074         {
1075             char * name;
1076
1077 #    ifdef PERL_REENTRANT_MAXSIZE
1078             if (PL_reentrant_buffer->_spent_size <=
1079                 PERL_REENTRANT_MAXSIZE / 2)
1080
1081 #    endif
1082             RenewDouble(PL_reentrant_buffer->_spent_buffer,
1083                     &PL_reentrant_buffer->_spent_size, char);
1084             switch (key) {
1085                 case KEY_getspnam:
1086                     name = va_arg(ap, char *);
1087                     retptr = getspnam(name); break;
1088                 default:
1089                     SETERRNO(ERANGE, LIB_INVARG);
1090                     break;
1091             }
1092         }
1093         break;
1094
1095 #  endif
1096 #  ifdef USE_PROTOENT_BUFFER
1097
1098     case KEY_getprotobyname:
1099     case KEY_getprotobynumber:
1100     case KEY_getprotoent:
1101         {
1102             char * name;
1103             int anint;
1104
1105 #    ifdef PERL_REENTRANT_MAXSIZE
1106             if (PL_reentrant_buffer->_protoent_size <=
1107                 PERL_REENTRANT_MAXSIZE / 2)
1108 #    endif
1109             RenewDouble(PL_reentrant_buffer->_protoent_buffer,
1110                     &PL_reentrant_buffer->_protoent_size, char);
1111             switch (key) {
1112                 case KEY_getprotobyname:
1113                     name = va_arg(ap, char *);
1114                     retptr = getprotobyname(name); break;
1115                 case KEY_getprotobynumber:
1116                     anint = va_arg(ap, int);
1117                     retptr = getprotobynumber(anint); break;
1118                 case KEY_getprotoent:
1119                     retptr = getprotoent(); break;
1120                 default:
1121                     SETERRNO(ERANGE, LIB_INVARG);
1122                     break;
1123             }
1124         }
1125         break;
1126
1127 #  endif
1128 #  ifdef USE_SERVENT_BUFFER
1129
1130     case KEY_getservbyname:
1131     case KEY_getservbyport:
1132     case KEY_getservent:
1133         {
1134             char * name;
1135             char * proto;
1136             int anint;
1137
1138 #    ifdef PERL_REENTRANT_MAXSIZE
1139             if (PL_reentrant_buffer->_servent_size <=
1140                 PERL_REENTRANT_MAXSIZE / 2)
1141 #    endif
1142             RenewDouble(PL_reentrant_buffer->_servent_buffer,
1143                     &PL_reentrant_buffer->_servent_size, char);
1144             switch (key) {
1145                 case KEY_getservbyname:
1146                     name = va_arg(ap, char *);
1147                     proto = va_arg(ap, char *);
1148                     retptr = getservbyname(name, proto); break;
1149                 case KEY_getservbyport:
1150                     anint = va_arg(ap, int);
1151                     name = va_arg(ap, char *);
1152                     retptr = getservbyport(anint, name); break;
1153                 case KEY_getservent:
1154                     retptr = getservent(); break;
1155                 default:
1156                     SETERRNO(ERANGE, LIB_INVARG);
1157                     break;
1158             }
1159         }
1160         break;
1161
1162 #  endif
1163
1164     default:
1165         /* Not known how to retry, so just fail. */
1166         break;
1167     }
1168
1169 #else
1170
1171     PERL_UNUSED_ARG(f);
1172
1173 #endif
1174
1175     va_end(ap);
1176     return retptr;
1177 }
1178 EOF
1179
1180 read_only_bottom_close_and_rename($c);
1181
1182 # As of March 2020, the config.h entries that have reentrant prototypes that
1183 # aren't in this file are:
1184 #       drand48
1185 #       random
1186 #       srand48
1187 #       srandom
1188
1189 # The meanings of the flags are derivable from %map above
1190 # Fnc, arg flags| hdr   | ? struct type | prototypes...
1191 __DATA__
1192 asctime S       |time   |const struct tm|B_SB|B_SBI|I_SB|I_SBI
1193 crypt CC        |crypt  |struct crypt_data|B_CCS|B_CCD|D=CRYPTD*
1194 ctermid B       |stdio  |               |B_B
1195 ctime S         |time   |const time_t   |B_SB|B_SBI|I_SB|I_SBI
1196 endgrent        |grp    |               |I_H|V_H
1197 endhostent      |netdb  |               |I_D|V_D|D=struct hostent_data*
1198 endnetent       |netdb  |               |I_D|V_D|D=struct netent_data*
1199 endprotoent     |netdb  |               |I_D|V_D|D=struct protoent_data*
1200 endpwent        |pwd    |               |I_H|V_H
1201 endservent      |netdb  |               |I_D|V_D|D=struct servent_data*
1202 getgrent        |grp    |struct group   |I_SBWR|I_SBIR|S_SBW|S_SBI|I_SBI|I_SBIH
1203 getgrgid T      |grp    |struct group   |I_TSBWR|I_TSBIR|I_TSBI|S_TSBI|T=gid_t
1204 getgrnam C      |grp    |struct group   |I_CSBWR|I_CSBIR|S_CBI|I_CSBI|S_CSBI
1205 gethostbyaddr CWI       |netdb  |struct hostent |I_CWISBWRE|S_CWISBWIE|S_CWISBIE|S_TWISBIE|S_CIISBIE|S_CSBIE|S_TSBIE|I_CWISD|I_CIISD|I_CII|I_TsISBWRE|D=struct hostent_data*|T=const void*|s=socklen_t
1206 gethostbyname C |netdb  |struct hostent |I_CSBWRE|S_CSBIE|I_CSD|D=struct hostent_data*
1207 gethostent      |netdb  |struct hostent |I_SBWRE|I_SBIE|S_SBIE|S_SBI|I_SBI|I_SD|D=struct hostent_data*
1208 getlogin        |unistd |char           |I_BW|I_BI|B_BW|B_BI
1209 getnetbyaddr LI |netdb  |struct netent  |I_UISBWRE|I_LISBI|S_TISBI|S_LISBI|I_TISD|I_LISD|I_IISD|I_uISBWRE|D=struct netent_data*|T=in_addr_t|U=unsigned long|u=uint32_t
1210 getnetbyname C  |netdb  |struct netent  |I_CSBWRE|I_CSBI|S_CSBI|I_CSD|D=struct netent_data*
1211 getnetent       |netdb  |struct netent  |I_SBWRE|I_SBIE|S_SBIE|S_SBI|I_SBI|I_SD|D=struct netent_data*
1212 getprotobyname C|netdb  |struct protoent|I_CSBWR|S_CSBI|I_CSD|D=struct protoent_data*
1213 getprotobynumber I      |netdb  |struct protoent|I_ISBWR|S_ISBI|I_ISD|D=struct protoent_data*
1214 getprotoent     |netdb  |struct protoent|I_SBWR|I_SBI|S_SBI|I_SD|D=struct protoent_data*
1215 getpwent        |pwd    |struct passwd  |I_SBWR|I_SBIR|S_SBW|S_SBI|I_SBI|I_SBIH
1216 getpwnam C      |pwd    |struct passwd  |I_CSBWR|I_CSBIR|S_CSBI|I_CSBI
1217 getpwuid T      |pwd    |struct passwd  |I_TSBWR|I_TSBIR|I_TSBI|S_TSBI|T=uid_t
1218 getservbyname CC|netdb  |struct servent |I_CCSBWR|S_CCSBI|I_CCSD|D=struct servent_data*
1219 getservbyport IC|netdb  |struct servent |I_ICSBWR|S_ICSBI|I_ICSD|D=struct servent_data*
1220 getservent      |netdb  |struct servent |I_SBWR|I_SBI|S_SBI|I_SD|D=struct servent_data*
1221 getspnam C      |shadow |struct spwd    |I_CSBWR|S_CSBI
1222 gmtime T        |time   |struct tm      |S_TS|T=time_t*
1223 localtime T     |time   |struct tm      |S_TS|T=time_t*
1224 readdir T       |dirent |struct dirent  |I_TSR|I_TS|T=DIR*
1225 readdir64 T     |dirent |struct dirent64|I_TSR|I_TS|T=DIR*
1226 setgrent        |grp    |               |I_H|V_H
1227 sethostent I    |netdb  |               |I_ID|V_ID|D=struct hostent_data*
1228 setlocale IC    |locale |               |I_ICBI
1229 setnetent I     |netdb  |               |I_ID|V_ID|D=struct netent_data*
1230 setprotoent I   |netdb  |               |I_ID|V_ID|D=struct protoent_data*
1231 setpwent        |pwd    |               |I_H|V_H
1232 setservent I    |netdb  |               |I_ID|V_ID|D=struct servent_data*
1233 strerror I      |string |               |I_IBW|I_IBI|B_IBW
1234 tmpnam B        |stdio  |               |B_B
1235 ttyname I       |unistd |               |I_IBW|I_IBI|B_IBI