This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add editor boilerplates to all C files
[perl5.git] / reentr.pl
CommitLineData
10bc17b6
JH
1#!/usr/bin/perl -w
2
3#
4# Generate the reentr.c and reentr.h,
5# and optionally also the relevant metaconfig units (-U option).
6#
7
8use strict;
9use Getopt::Std;
10my %opts;
11getopts('U', \%opts);
12
13my %map = (
14 V => "void",
15 A => "char*", # as an input argument
16 B => "char*", # as an output argument
17 C => "const char*", # as a read-only input argument
18 I => "int",
19 L => "long",
20 W => "size_t",
21 H => "FILE**",
22 E => "int*",
23 );
24
25# (See the definitions after __DATA__.)
26# In func|inc|type|... a "S" means "type*", and a "R" means "type**".
27# (The "types" are often structs, such as "struct passwd".)
28#
29# After the prototypes one can have |X=...|Y=... to define more types.
30# A commonly used extra type is to define D to be equal to "type_data",
31# for example "struct_hostent_data to" go with "struct hostent".
32#
33# Example #1: I_XSBWR means int func_r(X, type, char*, size_t, type**)
34# Example #2: S_SBIE means type func_r(type, char*, int, int*)
35# Example #3: S_CBI means type func_r(const char*, char*, int)
36
37
38die "reentr.h: $!" unless open(H, ">reentr.h");
39select H;
40print <<EOF;
41/*
42 * reentr.h
43 *
4bb101f2 44 * Copyright (C) 2002, 2003, by Larry Wall and others
10bc17b6
JH
45 *
46 * You may distribute under the terms of either the GNU General Public
47 * License or the Artistic License, as specified in the README file.
48 *
49 * !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
61296642 50 * This file is built by reentr.pl from data in reentr.pl.
10bc17b6
JH
51 */
52
53#ifndef REENTR_H
54#define REENTR_H
55
56#ifdef USE_REENTRANT_API
57
58/* Deprecations: some platforms have the said reentrant interfaces
59 * but they are declared obsolete and are not to be used. Often this
60 * means that the platform has threadsafed the interfaces (hopefully).
61 * All this is OS version dependent, so we are of course fooling ourselves.
62 * If you know of more deprecations on some platforms, please add your own. */
63
64#ifdef __hpux
65# undef HAS_CRYPT_R
66# undef HAS_DRAND48_R
efa45b01
JH
67# undef HAS_ENDGRENT_R
68# undef HAS_ENDPWENT_R
10bc17b6
JH
69# undef HAS_GETGRENT_R
70# undef HAS_GETPWENT_R
71# undef HAS_SETLOCALE_R
72# undef HAS_SRAND48_R
73# undef HAS_STRERROR_R
74# define NETDB_R_OBSOLETE
75#endif
76
77#if defined(__osf__) && defined(__alpha) /* Tru64 aka Digital UNIX */
78# undef HAS_CRYPT_R
79# undef HAS_STRERROR_R
80# define NETDB_R_OBSOLETE
81#endif
82
83#ifdef NETDB_R_OBSOLETE
84# undef HAS_ENDHOSTENT_R
85# undef HAS_ENDNETENT_R
86# undef HAS_ENDPROTOENT_R
87# undef HAS_ENDSERVENT_R
88# undef HAS_GETHOSTBYADDR_R
89# undef HAS_GETHOSTBYNAME_R
90# undef HAS_GETHOSTENT_R
91# undef HAS_GETNETBYADDR_R
92# undef HAS_GETNETBYNAME_R
93# undef HAS_GETNETENT_R
94# undef HAS_GETPROTOBYNAME_R
95# undef HAS_GETPROTOBYNUMBER_R
96# undef HAS_GETPROTOENT_R
97# undef HAS_GETSERVBYNAME_R
98# undef HAS_GETSERVBYPORT_R
99# undef HAS_GETSERVENT_R
100# undef HAS_SETHOSTENT_R
101# undef HAS_SETNETENT_R
102# undef HAS_SETPROTOENT_R
103# undef HAS_SETSERVENT_R
104#endif
105
106#ifdef I_PWD
107# include <pwd.h>
108#endif
109#ifdef I_GRP
110# include <grp.h>
111#endif
112#ifdef I_NETDB
113# include <netdb.h>
114#endif
115#ifdef I_STDLIB
116# include <stdlib.h> /* drand48_data */
117#endif
118#ifdef I_CRYPT
119# ifdef I_CRYPT
120# include <crypt.h>
121# endif
122#endif
123#ifdef HAS_GETSPNAM_R
124# ifdef I_SHADOW
125# include <shadow.h>
126# endif
127#endif
128
129EOF
130
aa418cf1
JH
131my %seenh; # the different prototypes signatures for this function
132my %seena; # the different prototypes signatures for this function in order
133my @seenf; # all the seen functions
134my %seenp; # the different prototype signatures for all functions
135my %seent; # the return type of this function
136my %seens; # the type of this function's "S"
137my %seend; # the type of this function's "D"
a845a0d4 138my %seenm; # all the types
aa418cf1
JH
139my %seenu; # the length of the argument list of this function
140
141while (<DATA>) { # Read in the protypes.
10bc17b6
JH
142 next if /^\s+$/;
143 chomp;
aa418cf1 144 my ($func, $hdr, $type, @p) = split(/\s*\|\s*/, $_, -1);
10bc17b6 145 my $u;
aa418cf1
JH
146 # Split off the real function name and the argument list.
147 ($func, $u) = split(' ', $func);
148 $seenu{$func} = defined $u ? length $u : 0;
149 my $FUNC = uc $func; # for output.
150 push @seenf, $func;
10bc17b6 151 my %m = %map;
aa418cf1
JH
152 if ($type) {
153 $m{S} = "$type*";
154 $m{R} = "$type**";
10bc17b6 155 }
aa418cf1
JH
156
157 # Set any special mapping variables (like X=x_t)
10bc17b6
JH
158 if (@p) {
159 while ($p[-1] =~ /=/) {
160 my ($k, $v) = ($p[-1] =~ /^([A-Za-z])\s*=\s*(.*)/);
161 $m{$k} = $v;
162 pop @p;
163 }
164 }
aa418cf1
JH
165
166 # If given the -U option open up the metaconfig unit for this function.
167 if ($opts{U} && open(U, ">d_${func}_r.U")) {
10bc17b6
JH
168 select U;
169 }
aa418cf1 170
d63eadf0 171 if ($opts{U}) {
aa418cf1
JH
172 # The metaconfig units needs prerequisite dependencies.
173 my $prereqs = '';
174 my $prereqh = '';
175 my $prereqsh = '';
176 if ($hdr ne 'stdio') { # There's no i_stdio.
177 $prereqs = "i_$hdr";
178 $prereqh = "$hdr.h";
179 $prereqsh = "\$$prereqs $prereqh";
180 }
1fdb6f84
JH
181 my @prereq = qw(Inlibc Protochk Hasproto i_systypes usethreads);
182 push @prereq, $prereqs;
183 my $hdrs = "\$i_systypes sys/types.h define stdio.h $prereqsh";
aa418cf1 184 if ($hdr eq 'time') {
1fdb6f84
JH
185 $hdrs .= " \$i_systime sys/time.h";
186 push @prereq, 'i_systime';
187 }
aa418cf1 188 # Output the metaconfig unit header.
d63eadf0 189 print <<EOF;
aa418cf1 190?RCS: \$Id: d_${func}_r.U,v $
10bc17b6 191?RCS:
a845a0d4 192?RCS: Copyright (c) 2002,2003 Jarkko Hietaniemi
10bc17b6
JH
193?RCS:
194?RCS: You may distribute under the terms of either the GNU General Public
195?RCS: License or the Artistic License, as specified in the README file.
196?RCS:
197?RCS: Generated by the reentr.pl from the Perl 5.8 distribution.
198?RCS:
aa418cf1 199?MAKE:d_${func}_r ${func}_r_proto: @prereq
10bc17b6 200?MAKE: -pick add \$@ %<
aa418cf1
JH
201?S:d_${func}_r:
202?S: This variable conditionally defines the HAS_${FUNC}_R symbol,
203?S: which indicates to the C program that the ${func}_r()
10bc17b6
JH
204?S: routine is available.
205?S:.
aa418cf1
JH
206?S:${func}_r_proto:
207?S: This variable encodes the prototype of ${func}_r.
39183afa
JH
208?S: It is zero if d_${func}_r is undef, and one of the
209?S: REENTRANT_PROTO_T_ABC macros of reentr.h if d_${func}_r
210?S: is defined.
10bc17b6 211?S:.
aa418cf1
JH
212?C:HAS_${FUNC}_R:
213?C: This symbol, if defined, indicates that the ${func}_r routine
214?C: is available to ${func} re-entrantly.
10bc17b6 215?C:.
aa418cf1
JH
216?C:${FUNC}_R_PROTO:
217?C: This symbol encodes the prototype of ${func}_r.
39183afa
JH
218?C: It is zero if d_${func}_r is undef, and one of the
219?C: REENTRANT_PROTO_T_ABC macros of reentr.h if d_${func}_r
220?C: is defined.
10bc17b6 221?C:.
aa418cf1
JH
222?H:#\$d_${func}_r HAS_${FUNC}_R /**/
223?H:#define ${FUNC}_R_PROTO \$${func}_r_proto /**/
10bc17b6 224?H:.
aa418cf1
JH
225?T:try hdrs d_${func}_r_proto
226?LINT:set d_${func}_r
227?LINT:set ${func}_r_proto
228: see if ${func}_r exists
229set ${func}_r d_${func}_r
10bc17b6 230eval \$inlibc
aa418cf1 231case "\$d_${func}_r" in
10bc17b6 232"\$define")
d63eadf0 233EOF
d63eadf0
JH
234 print <<EOF;
235 hdrs="$hdrs"
aa418cf1
JH
236 case "\$d_${func}_r_proto:\$usethreads" in
237 ":define") d_${func}_r_proto=define
238 set d_${func}_r_proto ${func}_r \$hdrs
a48ec845
JH
239 eval \$hasproto ;;
240 *) ;;
241 esac
aa418cf1 242 case "\$d_${func}_r_proto" in
a48ec845 243 define)
10bc17b6 244EOF
d63eadf0
JH
245 }
246 for my $p (@p) {
247 my ($r, $a) = ($p =~ /^(.)_(.+)/);
248 my $v = join(", ", map { $m{$_} } split '', $a);
249 if ($opts{U}) {
250 print <<EOF ;
aa418cf1
JH
251 case "\$${func}_r_proto" in
252 ''|0) try='$m{$r} ${func}_r($v);'
253 ./protochk "extern \$try" \$hdrs && ${func}_r_proto=$p ;;
10bc17b6
JH
254 esac
255EOF
d63eadf0 256 }
aa418cf1
JH
257 $seenh{$func}->{$p}++;
258 push @{$seena{$func}}, $p;
d63eadf0 259 $seenp{$p}++;
aa418cf1
JH
260 $seent{$func} = $type;
261 $seens{$func} = $m{S};
262 $seend{$func} = $m{D};
a845a0d4 263 $seenm{$func} = \%m;
d63eadf0
JH
264 }
265 if ($opts{U}) {
266 print <<EOF;
aa418cf1
JH
267 case "\$${func}_r_proto" in
268 ''|0) d_${func}_r=undef
269 ${func}_r_proto=0
270 echo "Disabling ${func}_r, cannot determine prototype." >&4 ;;
271 * ) case "\$${func}_r_proto" in
10bc17b6 272 REENTRANT_PROTO*) ;;
aa418cf1 273 *) ${func}_r_proto="REENTRANT_PROTO_\$${func}_r_proto" ;;
10bc17b6
JH
274 esac
275 echo "Prototype: \$try" ;;
276 esac
277 ;;
c18e646a 278 *) case "\$usethreads" in
aa418cf1 279 define) echo "${func}_r has no prototype, not using it." >&4 ;;
c18e646a 280 esac
aa418cf1
JH
281 d_${func}_r=undef
282 ${func}_r_proto=0
c18e646a 283 ;;
a48ec845
JH
284 esac
285 ;;
aa418cf1 286*) ${func}_r_proto=0
10bc17b6
JH
287 ;;
288esac
289
290EOF
291 close(U);
292 }
293}
294
295close DATA;
296
aa418cf1
JH
297# Prepare to continue writing the reentr.h.
298
10bc17b6
JH
299select H;
300
301{
aa418cf1 302 # Write out all the known prototype signatures.
10bc17b6
JH
303 my $i = 1;
304 for my $p (sort keys %seenp) {
305 print "#define REENTRANT_PROTO_${p} ${i}\n";
306 $i++;
307 }
308}
309
aa418cf1
JH
310my @struct; # REENTR struct members
311my @size; # struct member buffer size initialization code
312my @init; # struct member buffer initialization (malloc) code
313my @free; # struct member buffer release (free) code
314my @wrap; # the wrapper (foo(a) -> foo_r(a,...)) cpp code
315my @define; # defines for optional features
316
10bc17b6 317sub ifprotomatch {
aa418cf1
JH
318 my $FUNC = shift;
319 join " || ", map { "${FUNC}_R_PROTO == REENTRANT_PROTO_$_" } @_;
10bc17b6
JH
320}
321
10bc17b6
JH
322sub pushssif {
323 push @struct, @_;
324 push @size, @_;
325 push @init, @_;
326 push @free, @_;
327}
328
329sub pushinitfree {
aa418cf1 330 my $func = shift;
10bc17b6 331 push @init, <<EOF;
aa418cf1 332 New(31338, PL_reentrant_buffer->_${func}_buffer, PL_reentrant_buffer->_${func}_size, char);
10bc17b6
JH
333EOF
334 push @free, <<EOF;
aa418cf1 335 Safefree(PL_reentrant_buffer->_${func}_buffer);
10bc17b6
JH
336EOF
337}
338
339sub define {
340 my ($n, $p, @F) = @_;
341 my @H;
342 my $H = uc $F[0];
343 push @define, <<EOF;
344/* The @F using \L$n? */
345
346EOF
aa418cf1
JH
347 my $GENFUNC;
348 for my $func (@F) {
349 my $FUNC = uc $func;
350 my $HAS = "${FUNC}_R_HAS_$n";
351 push @H, $HAS;
352 my @h = grep { /$p/ } @{$seena{$func}};
353 unless (defined $GENFUNC) {
354 $GENFUNC = $FUNC;
355 $GENFUNC =~ s/^GET//;
f7937171 356 }
10bc17b6 357 if (@h) {
aa418cf1 358 push @define, "#if defined(HAS_${FUNC}_R) && (" . join(" || ", map { "${FUNC}_R_PROTO == REENTRANT_PROTO_$_" } @h) . ")\n";
10bc17b6
JH
359
360 push @define, <<EOF;
aa418cf1 361# define $HAS
10bc17b6 362#else
aa418cf1 363# undef $HAS
10bc17b6
JH
364#endif
365EOF
366 }
367 }
0891a229 368 return if @F == 1;
10bc17b6
JH
369 push @define, <<EOF;
370
371/* Any of the @F using \L$n? */
372
373EOF
374 push @define, "#if (" . join(" || ", map { "defined($_)" } @H) . ")\n";
375 push @define, <<EOF;
aa418cf1 376# define USE_${GENFUNC}_$n
10bc17b6 377#else
aa418cf1 378# undef USE_${GENFUNC}_$n
10bc17b6
JH
379#endif
380
381EOF
382}
383
edd309b7
JH
384define('BUFFER', 'B',
385 qw(getgrent getgrgid getgrnam));
386
10bc17b6
JH
387define('PTR', 'R',
388 qw(getgrent getgrgid getgrnam));
389define('PTR', 'R',
390 qw(getpwent getpwnam getpwuid));
391define('PTR', 'R',
392 qw(getspent getspnam));
393
394define('FPTR', 'H',
f7937171 395 qw(getgrent getgrgid getgrnam setgrent endgrent));
10bc17b6 396define('FPTR', 'H',
f7937171 397 qw(getpwent getpwnam getpwuid setpwent endpwent));
10bc17b6 398
edd309b7
JH
399define('BUFFER', 'B',
400 qw(getpwent getpwgid getpwnam));
401
10bc17b6
JH
402define('PTR', 'R',
403 qw(gethostent gethostbyaddr gethostbyname));
404define('PTR', 'R',
405 qw(getnetent getnetbyaddr getnetbyname));
406define('PTR', 'R',
407 qw(getprotoent getprotobyname getprotobynumber));
408define('PTR', 'R',
409 qw(getservent getservbyname getservbyport));
410
edd309b7
JH
411define('BUFFER', 'B',
412 qw(gethostent gethostbyaddr gethostbyname));
413define('BUFFER', 'B',
414 qw(getnetent getnetbyaddr getnetbyname));
415define('BUFFER', 'B',
416 qw(getprotoent getprotobyname getprotobynumber));
417define('BUFFER', 'B',
418 qw(getservent getservbyname getservbyport));
419
10bc17b6
JH
420define('ERRNO', 'E',
421 qw(gethostent gethostbyaddr gethostbyname));
422define('ERRNO', 'E',
423 qw(getnetent getnetbyaddr getnetbyname));
424
aa418cf1
JH
425# The following loop accumulates the "ssif" (struct, size, init, free)
426# sections that declare the struct members (in reentr.h), and the buffer
427# size initialization, buffer initialization (malloc), and buffer
428# release (free) code (in reentr.c).
429#
430# The loop also contains a lot of intrinsic logic about groups of
431# functions (since functions of certain kind operate the same way).
432
433for my $func (@seenf) {
434 my $FUNC = uc $func;
435 my $ifdef = "#ifdef HAS_${FUNC}_R\n";
436 my $endif = "#endif /* HAS_${FUNC}_R */\n";
437 if (exists $seena{$func}) {
438 my @p = @{$seena{$func}};
439 if ($func =~ /^(asctime|ctime|getlogin|setlocale|strerror|ttyname)$/) {
10bc17b6
JH
440 pushssif $ifdef;
441 push @struct, <<EOF;
aa418cf1
JH
442 char* _${func}_buffer;
443 size_t _${func}_size;
10bc17b6
JH
444EOF
445 push @size, <<EOF;
aa418cf1 446 PL_reentrant_buffer->_${func}_size = REENTRANTSMALLSIZE;
10bc17b6 447EOF
aa418cf1 448 pushinitfree $func;
10bc17b6
JH
449 pushssif $endif;
450 }
aa418cf1 451 elsif ($func =~ /^(crypt)$/) {
10bc17b6
JH
452 pushssif $ifdef;
453 push @struct, <<EOF;
b430fd04 454#if CRYPT_R_PROTO == REENTRANT_PROTO_B_CCD
aa418cf1 455 $seend{$func} _${func}_data;
b430fd04 456#else
05404ffe 457 $seent{$func} *_${func}_struct_buffer;
b430fd04 458#endif
10bc17b6 459EOF
b430fd04 460 push @init, <<EOF;
05404ffe
JH
461#if CRYPT_R_PROTO != REENTRANT_PROTO_B_CCD
462 PL_reentrant_buffer->_${func}_struct_buffer = 0;
463#endif
464EOF
465 push @free, <<EOF;
466#if CRYPT_R_PROTO != REENTRANT_PROTO_B_CCD
467 Safefree(PL_reentrant_buffer->_${func}_struct_buffer);
10bc17b6
JH
468#endif
469EOF
b430fd04
JH
470 pushssif $endif;
471 }
5cb13b8d 472 elsif ($func =~ /^(drand48|gmtime|localtime|random|srandom)$/) {
b430fd04
JH
473 pushssif $ifdef;
474 push @struct, <<EOF;
aa418cf1 475 $seent{$func} _${func}_struct;
b430fd04 476EOF
10bc17b6
JH
477 if ($1 eq 'drand48') {
478 push @struct, <<EOF;
aa418cf1 479 double _${func}_double;
10bc17b6 480EOF
a845a0d4
JH
481 } elsif ($1 eq 'random') {
482 push @struct, <<EOF;
b3b3b51f 483# if RANDOM_R_PROTO == REENTRANT_PROTO_I_iS
a845a0d4
JH
484 int _${func}_retval;
485# endif
b3b3b51f 486# if RANDOM_R_PROTO == REENTRANT_PROTO_I_lS
a845a0d4
JH
487 long _${func}_retval;
488# endif
b3b3b51f 489# if RANDOM_R_PROTO == REENTRANT_PROTO_I_St
a845a0d4
JH
490 int32_t _${func}_retval;
491# endif
492EOF
10bc17b6
JH
493 }
494 pushssif $endif;
495 }
aa418cf1 496 elsif ($func =~ /^(getgrnam|getpwnam|getspnam)$/) {
10bc17b6 497 pushssif $ifdef;
aa418cf1
JH
498 # 'genfunc' can be read either as 'generic' or 'genre',
499 # it represents a group of functions.
500 my $genfunc = $func;
501 $genfunc =~ s/nam/ent/g;
502 $genfunc =~ s/^get//;
503 my $GENFUNC = uc $genfunc;
10bc17b6 504 push @struct, <<EOF;
aa418cf1
JH
505 $seent{$func} _${genfunc}_struct;
506 char* _${genfunc}_buffer;
507 size_t _${genfunc}_size;
10bc17b6
JH
508EOF
509 push @struct, <<EOF;
aa418cf1
JH
510# ifdef USE_${GENFUNC}_PTR
511 $seent{$func}* _${genfunc}_ptr;
10bc17b6
JH
512# endif
513EOF
0de8cad8 514 push @struct, <<EOF;
aa418cf1
JH
515# ifdef USE_${GENFUNC}_FPTR
516 FILE* _${genfunc}_fptr;
10bc17b6
JH
517# endif
518EOF
0de8cad8 519 push @init, <<EOF;
aa418cf1
JH
520# ifdef USE_${GENFUNC}_FPTR
521 PL_reentrant_buffer->_${genfunc}_fptr = NULL;
10bc17b6
JH
522# endif
523EOF
0de8cad8 524 my $sc = $genfunc eq 'grent' ?
10bc17b6 525 '_SC_GETGR_R_SIZE_MAX' : '_SC_GETPW_R_SIZE_MAX';
0de8cad8
RGS
526 my $sz = "_${genfunc}_size";
527 push @size, <<EOF;
10bc17b6 528# if defined(HAS_SYSCONF) && defined($sc) && !defined(__GLIBC__)
0de8cad8 529 PL_reentrant_buffer->$sz = sysconf($sc);
e3410746
SR
530 if (PL_reentrant_buffer->$sz == -1)
531 PL_reentrant_buffer->$sz = REENTRANTUSUALSIZE;
10bc17b6
JH
532# else
533# if defined(__osf__) && defined(__alpha) && defined(SIABUFSIZ)
0de8cad8 534 PL_reentrant_buffer->$sz = SIABUFSIZ;
10bc17b6
JH
535# else
536# ifdef __sgi
0de8cad8 537 PL_reentrant_buffer->$sz = BUFSIZ;
10bc17b6 538# else
0de8cad8 539 PL_reentrant_buffer->$sz = REENTRANTUSUALSIZE;
10bc17b6
JH
540# endif
541# endif
542# endif
543EOF
aa418cf1 544 pushinitfree $genfunc;
10bc17b6
JH
545 pushssif $endif;
546 }
aa418cf1 547 elsif ($func =~ /^(gethostbyname|getnetbyname|getservbyname|getprotobyname)$/) {
10bc17b6 548 pushssif $ifdef;
aa418cf1
JH
549 my $genfunc = $func;
550 $genfunc =~ s/byname/ent/;
551 $genfunc =~ s/^get//;
552 my $GENFUNC = uc $genfunc;
553 my $D = ifprotomatch($FUNC, grep {/D/} @p);
554 my $d = $seend{$func};
31ee0cb7 555 $d =~ s/\*$//; # snip: we need need the base type.
10bc17b6 556 push @struct, <<EOF;
aa418cf1 557 $seent{$func} _${genfunc}_struct;
10bc17b6 558# if $D
aa418cf1 559 $d _${genfunc}_data;
10bc17b6 560# else
aa418cf1
JH
561 char* _${genfunc}_buffer;
562 size_t _${genfunc}_size;
10bc17b6 563# endif
aa418cf1
JH
564# ifdef USE_${GENFUNC}_PTR
565 $seent{$func}* _${genfunc}_ptr;
10bc17b6
JH
566# endif
567EOF
568 push @struct, <<EOF;
aa418cf1
JH
569# ifdef USE_${GENFUNC}_ERRNO
570 int _${genfunc}_errno;
10bc17b6
JH
571# endif
572EOF
573 push @size, <<EOF;
574#if !($D)
aa418cf1 575 PL_reentrant_buffer->_${genfunc}_size = REENTRANTUSUALSIZE;
10bc17b6
JH
576#endif
577EOF
578 push @init, <<EOF;
579#if !($D)
aa418cf1 580 New(31338, PL_reentrant_buffer->_${genfunc}_buffer, PL_reentrant_buffer->_${genfunc}_size, char);
10bc17b6
JH
581#endif
582EOF
583 push @free, <<EOF;
584#if !($D)
aa418cf1 585 Safefree(PL_reentrant_buffer->_${genfunc}_buffer);
10bc17b6
JH
586#endif
587EOF
588 pushssif $endif;
589 }
aa418cf1 590 elsif ($func =~ /^(readdir|readdir64)$/) {
10bc17b6 591 pushssif $ifdef;
aa418cf1 592 my $R = ifprotomatch($FUNC, grep {/R/} @p);
10bc17b6 593 push @struct, <<EOF;
aa418cf1
JH
594 $seent{$func}* _${func}_struct;
595 size_t _${func}_size;
10bc17b6 596# if $R
aa418cf1 597 $seent{$func}* _${func}_ptr;
10bc17b6
JH
598# endif
599EOF
600 push @size, <<EOF;
601 /* This is the size Solaris recommends.
602 * (though we go static, should use pathconf() instead) */
aa418cf1 603 PL_reentrant_buffer->_${func}_size = sizeof($seent{$func}) + MAXPATHLEN + 1;
10bc17b6
JH
604EOF
605 push @init, <<EOF;
aa418cf1 606 PL_reentrant_buffer->_${func}_struct = ($seent{$func}*)safemalloc(PL_reentrant_buffer->_${func}_size);
10bc17b6
JH
607EOF
608 push @free, <<EOF;
aa418cf1 609 Safefree(PL_reentrant_buffer->_${func}_struct);
10bc17b6
JH
610EOF
611 pushssif $endif;
612 }
613
614 push @wrap, $ifdef;
615
10bc17b6 616 push @wrap, <<EOF;
aa418cf1 617# undef $func
10bc17b6 618EOF
aa418cf1
JH
619
620 # Write out what we have learned.
621
10bc17b6 622 my @v = 'a'..'z';
aa418cf1 623 my $v = join(", ", @v[0..$seenu{$func}-1]);
10bc17b6
JH
624 for my $p (@p) {
625 my ($r, $a) = split '_', $p;
626 my $test = $r eq 'I' ? ' == 0' : '';
627 my $true = 1;
aa418cf1
JH
628 my $genfunc = $func;
629 if ($genfunc =~ /^(?:get|set|end)(pw|gr|host|net|proto|serv|sp)/) {
630 $genfunc = "${1}ent";
631 } elsif ($genfunc eq 'srand48') {
632 $genfunc = "drand48";
10bc17b6
JH
633 }
634 my $b = $a;
635 my $w = '';
aa418cf1 636 substr($b, 0, $seenu{$func}) = '';
a845a0d4
JH
637 if ($func =~ /^random$/) {
638 $true = "PL_reentrant_buffer->_random_retval";
639 } elsif ($b =~ /R/) {
aa418cf1
JH
640 $true = "PL_reentrant_buffer->_${genfunc}_ptr";
641 } elsif ($b =~ /T/ && $func eq 'drand48') {
642 $true = "PL_reentrant_buffer->_${genfunc}_double";
10bc17b6 643 } elsif ($b =~ /S/) {
aa418cf1
JH
644 if ($func =~ /^readdir/) {
645 $true = "PL_reentrant_buffer->_${genfunc}_struct";
10bc17b6 646 } else {
aa418cf1 647 $true = "&PL_reentrant_buffer->_${genfunc}_struct";
10bc17b6
JH
648 }
649 } elsif ($b =~ /B/) {
aa418cf1 650 $true = "PL_reentrant_buffer->_${genfunc}_buffer";
10bc17b6
JH
651 }
652 if (length $b) {
653 $w = join ", ",
654 map {
655 $_ eq 'R' ?
aa418cf1 656 "&PL_reentrant_buffer->_${genfunc}_ptr" :
10bc17b6 657 $_ eq 'E' ?
aa418cf1 658 "&PL_reentrant_buffer->_${genfunc}_errno" :
10bc17b6 659 $_ eq 'B' ?
aa418cf1 660 "PL_reentrant_buffer->_${genfunc}_buffer" :
10bc17b6 661 $_ =~ /^[WI]$/ ?
aa418cf1 662 "PL_reentrant_buffer->_${genfunc}_size" :
10bc17b6 663 $_ eq 'H' ?
aa418cf1 664 "&PL_reentrant_buffer->_${genfunc}_fptr" :
10bc17b6 665 $_ eq 'D' ?
aa418cf1 666 "&PL_reentrant_buffer->_${genfunc}_data" :
10bc17b6 667 $_ eq 'S' ?
05404ffe 668 ($func =~ /^readdir\d*$/ ?
aa418cf1 669 "PL_reentrant_buffer->_${genfunc}_struct" :
05404ffe
JH
670 $func =~ /^crypt$/ ?
671 "PL_reentrant_buffer->_${genfunc}_struct_buffer" :
672 "&PL_reentrant_buffer->_${genfunc}_struct") :
aa418cf1
JH
673 $_ eq 'T' && $func eq 'drand48' ?
674 "&PL_reentrant_buffer->_${genfunc}_double" :
a845a0d4
JH
675 $_ =~ /^[ilt]$/ && $func eq 'random' ?
676 "&PL_reentrant_buffer->_random_retval" :
10bc17b6
JH
677 $_
678 } split '', $b;
679 $w = ", $w" if length $v;
680 }
aa418cf1 681 my $call = "${func}_r($v$w)";
10bc17b6 682 push @wrap, <<EOF;
aa418cf1 683# if !defined($func) && ${FUNC}_R_PROTO == REENTRANT_PROTO_$p
10bc17b6
JH
684EOF
685 if ($r eq 'V' || $r eq 'B') {
686 push @wrap, <<EOF;
aa418cf1 687# define $func($v) $call
10bc17b6
JH
688EOF
689 } else {
aa418cf1 690 if ($func =~ /^get/) {
edd309b7 691 my $rv = $v ? ", $v" : "";
0891a229
JH
692 if ($r eq 'I') {
693 push @wrap, <<EOF;
f6f0b69b 694# define $func($v) ((PL_reentrant_retint = $call)$test ? $true : (((PL_reentrant_retint == ERANGE) || (errno == ERANGE)) ? ($seent{$func} *) Perl_reentrant_retry("$func"$rv) : 0))
0891a229
JH
695EOF
696 } else {
697 push @wrap, <<EOF;
f6f0b69b 698# define $func($v) ($call$test ? $true : ((errno == ERANGE) ? ($seent{$func} *) Perl_reentrant_retry("$func"$rv) : 0))
10bc17b6 699EOF
0891a229 700 }
edd309b7
JH
701 } else {
702 push @wrap, <<EOF;
aa418cf1 703# define $func($v) ($call$test ? $true : 0)
edd309b7
JH
704EOF
705 }
10bc17b6
JH
706 }
707 push @wrap, <<EOF;
708# endif
709EOF
710 }
711
712 push @wrap, $endif, "\n";
713 }
714}
715
716local $" = '';
717
718print <<EOF;
719
720/* Defines for indicating which special features are supported. */
721
722@define
723typedef struct {
724@struct
aa418cf1 725 int dummy; /* cannot have empty structs */
10bc17b6
JH
726} REENTR;
727
728/* The wrappers. */
729
730@wrap
0891a229 731
10bc17b6
JH
732#endif /* USE_REENTRANT_API */
733
734#endif
735
736EOF
737
738close(H);
739
aa418cf1
JH
740# Prepare to write the reentr.c.
741
10bc17b6
JH
742die "reentr.c: $!" unless open(C, ">reentr.c");
743select C;
744print <<EOF;
745/*
746 * reentr.c
747 *
4bb101f2 748 * Copyright (C) 2002, 2003, by Larry Wall and others
10bc17b6
JH
749 *
750 * You may distribute under the terms of either the GNU General Public
751 * License or the Artistic License, as specified in the README file.
752 *
753 * !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
61296642 754 * This file is built by reentr.pl from data in reentr.pl.
10bc17b6
JH
755 *
756 * "Saruman," I said, standing away from him, "only one hand at a time can
757 * wield the One, and you know that well, so do not trouble to say we!"
758 *
61296642
DM
759 * This file contains a collection of automatically created wrappers
760 * (created by running reentr.pl) for reentrant (thread-safe) versions of
761 * various library calls, such as getpwent_r. The wrapping is done so
762 * that other files like pp_sys.c calling those library functions need not
763 * care about the differences between various platforms' idiosyncrasies
764 * regarding these reentrant interfaces.
10bc17b6
JH
765 */
766
767#include "EXTERN.h"
768#define PERL_IN_REENTR_C
769#include "perl.h"
770#include "reentr.h"
771
772void
773Perl_reentrant_size(pTHX) {
774#ifdef USE_REENTRANT_API
8695fa85
SR
775#define REENTRANTSMALLSIZE 256 /* Make something up. */
776#define REENTRANTUSUALSIZE 4096 /* Make something up. */
10bc17b6
JH
777@size
778#endif /* USE_REENTRANT_API */
779}
780
781void
782Perl_reentrant_init(pTHX) {
783#ifdef USE_REENTRANT_API
784 New(31337, PL_reentrant_buffer, 1, REENTR);
785 Perl_reentrant_size(aTHX);
786@init
787#endif /* USE_REENTRANT_API */
788}
789
790void
791Perl_reentrant_free(pTHX) {
792#ifdef USE_REENTRANT_API
793@free
794 Safefree(PL_reentrant_buffer);
795#endif /* USE_REENTRANT_API */
796}
797
edd309b7
JH
798void*
799Perl_reentrant_retry(const char *f, ...)
800{
27da23d5 801 dVAR; dTHX;
edd309b7
JH
802 void *retptr = NULL;
803#ifdef USE_REENTRANT_API
0891a229 804# if defined(USE_HOSTENT_BUFFER) || defined(USE_GRENT_BUFFER) || defined(USE_NETENT_BUFFER) || defined(USE_PWENT_BUFFER) || defined(USE_PROTOENT_BUFFER) || defined(USE_SERVENT_BUFFER)
e3410746
SR
805 void *p0;
806# endif
f7937171 807# if defined(USE_SERVENT_BUFFER)
e3410746
SR
808 void *p1;
809# endif
f7937171 810# if defined(USE_HOSTENT_BUFFER)
edd309b7 811 size_t asize;
e3410746 812# endif
f7937171 813# if defined(USE_HOSTENT_BUFFER) || defined(USE_NETENT_BUFFER) || defined(USE_PROTOENT_BUFFER) || defined(USE_SERVENT_BUFFER)
edd309b7 814 int anint;
e3410746 815# endif
edd309b7
JH
816 va_list ap;
817
818 va_start(ap, f);
819
edd309b7 820 switch (PL_op->op_type) {
f7937171 821#ifdef USE_HOSTENT_BUFFER
edd309b7
JH
822 case OP_GHBYADDR:
823 case OP_GHBYNAME:
824 case OP_GHOSTENT:
825 {
af685957
JH
826#ifdef PERL_REENTRANT_MAXSIZE
827 if (PL_reentrant_buffer->_hostent_size <=
828 PERL_REENTRANT_MAXSIZE / 2)
829#endif
830 {
f7937171
JH
831 PL_reentrant_buffer->_hostent_size *= 2;
832 Renew(PL_reentrant_buffer->_hostent_buffer,
833 PL_reentrant_buffer->_hostent_size, char);
edd309b7
JH
834 switch (PL_op->op_type) {
835 case OP_GHBYADDR:
836 p0 = va_arg(ap, void *);
837 asize = va_arg(ap, size_t);
838 anint = va_arg(ap, int);
839 retptr = gethostbyaddr(p0, asize, anint); break;
840 case OP_GHBYNAME:
841 p0 = va_arg(ap, void *);
f6f0b69b 842 retptr = gethostbyname((char *)p0); break;
edd309b7
JH
843 case OP_GHOSTENT:
844 retptr = gethostent(); break;
845 default:
0de8cad8 846 SETERRNO(ERANGE, LIB_INVARG);
edd309b7
JH
847 break;
848 }
849 }
850 }
851 break;
852#endif
f7937171 853#ifdef USE_GRENT_BUFFER
edd309b7
JH
854 case OP_GGRNAM:
855 case OP_GGRGID:
856 case OP_GGRENT:
857 {
af685957
JH
858#ifdef PERL_REENTRANT_MAXSIZE
859 if (PL_reentrant_buffer->_grent_size <=
860 PERL_REENTRANT_MAXSIZE / 2)
861#endif
862 {
edd309b7 863 Gid_t gid;
f7937171
JH
864 PL_reentrant_buffer->_grent_size *= 2;
865 Renew(PL_reentrant_buffer->_grent_buffer,
866 PL_reentrant_buffer->_grent_size, char);
edd309b7
JH
867 switch (PL_op->op_type) {
868 case OP_GGRNAM:
869 p0 = va_arg(ap, void *);
f6f0b69b 870 retptr = getgrnam((char *)p0); break;
edd309b7 871 case OP_GGRGID:
ab2b559b
JH
872#if Gid_t_size < INTSIZE
873 gid = (Gid_t)va_arg(ap, int);
874#else
edd309b7 875 gid = va_arg(ap, Gid_t);
ab2b559b 876#endif
edd309b7
JH
877 retptr = getgrgid(gid); break;
878 case OP_GGRENT:
879 retptr = getgrent(); break;
880 default:
0de8cad8 881 SETERRNO(ERANGE, LIB_INVARG);
edd309b7
JH
882 break;
883 }
884 }
885 }
886 break;
887#endif
f7937171 888#ifdef USE_NETENT_BUFFER
edd309b7
JH
889 case OP_GNBYADDR:
890 case OP_GNBYNAME:
891 case OP_GNETENT:
892 {
af685957
JH
893#ifdef PERL_REENTRANT_MAXSIZE
894 if (PL_reentrant_buffer->_netent_size <=
895 PERL_REENTRANT_MAXSIZE / 2)
896#endif
897 {
edd309b7 898 Netdb_net_t net;
f7937171
JH
899 PL_reentrant_buffer->_netent_size *= 2;
900 Renew(PL_reentrant_buffer->_netent_buffer,
901 PL_reentrant_buffer->_netent_size, char);
edd309b7
JH
902 switch (PL_op->op_type) {
903 case OP_GNBYADDR:
904 net = va_arg(ap, Netdb_net_t);
905 anint = va_arg(ap, int);
906 retptr = getnetbyaddr(net, anint); break;
907 case OP_GNBYNAME:
908 p0 = va_arg(ap, void *);
f6f0b69b 909 retptr = getnetbyname((char *)p0); break;
edd309b7
JH
910 case OP_GNETENT:
911 retptr = getnetent(); break;
912 default:
0de8cad8 913 SETERRNO(ERANGE, LIB_INVARG);
edd309b7
JH
914 break;
915 }
916 }
917 }
918 break;
919#endif
f7937171 920#ifdef USE_PWENT_BUFFER
edd309b7
JH
921 case OP_GPWNAM:
922 case OP_GPWUID:
923 case OP_GPWENT:
924 {
af685957
JH
925#ifdef PERL_REENTRANT_MAXSIZE
926 if (PL_reentrant_buffer->_pwent_size <=
927 PERL_REENTRANT_MAXSIZE / 2)
928#endif
929 {
edd309b7 930 Uid_t uid;
f7937171
JH
931 PL_reentrant_buffer->_pwent_size *= 2;
932 Renew(PL_reentrant_buffer->_pwent_buffer,
933 PL_reentrant_buffer->_pwent_size, char);
edd309b7
JH
934 switch (PL_op->op_type) {
935 case OP_GPWNAM:
936 p0 = va_arg(ap, void *);
f6f0b69b 937 retptr = getpwnam((char *)p0); break;
edd309b7 938 case OP_GPWUID:
ab2b559b
JH
939#if Uid_t_size < INTSIZE
940 uid = (Uid_t)va_arg(ap, int);
941#else
edd309b7 942 uid = va_arg(ap, Uid_t);
ab2b559b 943#endif
edd309b7
JH
944 retptr = getpwuid(uid); break;
945 case OP_GPWENT:
946 retptr = getpwent(); break;
947 default:
0de8cad8 948 SETERRNO(ERANGE, LIB_INVARG);
edd309b7
JH
949 break;
950 }
951 }
952 }
953 break;
954#endif
f7937171 955#ifdef USE_PROTOENT_BUFFER
edd309b7
JH
956 case OP_GPBYNAME:
957 case OP_GPBYNUMBER:
958 case OP_GPROTOENT:
959 {
af685957
JH
960#ifdef PERL_REENTRANT_MAXSIZE
961 if (PL_reentrant_buffer->_protoent_size <=
962 PERL_REENTRANT_MAXSIZE / 2)
963#endif
964 {
f7937171
JH
965 PL_reentrant_buffer->_protoent_size *= 2;
966 Renew(PL_reentrant_buffer->_protoent_buffer,
967 PL_reentrant_buffer->_protoent_size, char);
edd309b7
JH
968 switch (PL_op->op_type) {
969 case OP_GPBYNAME:
970 p0 = va_arg(ap, void *);
f6f0b69b 971 retptr = getprotobyname((char *)p0); break;
edd309b7
JH
972 case OP_GPBYNUMBER:
973 anint = va_arg(ap, int);
974 retptr = getprotobynumber(anint); break;
975 case OP_GPROTOENT:
976 retptr = getprotoent(); break;
977 default:
0de8cad8 978 SETERRNO(ERANGE, LIB_INVARG);
edd309b7
JH
979 break;
980 }
981 }
982 }
983 break;
984#endif
f7937171 985#ifdef USE_SERVENT_BUFFER
edd309b7
JH
986 case OP_GSBYNAME:
987 case OP_GSBYPORT:
988 case OP_GSERVENT:
989 {
af685957
JH
990#ifdef PERL_REENTRANT_MAXSIZE
991 if (PL_reentrant_buffer->_servent_size <=
992 PERL_REENTRANT_MAXSIZE / 2)
993#endif
994 {
f7937171
JH
995 PL_reentrant_buffer->_servent_size *= 2;
996 Renew(PL_reentrant_buffer->_servent_buffer,
997 PL_reentrant_buffer->_servent_size, char);
edd309b7
JH
998 switch (PL_op->op_type) {
999 case OP_GSBYNAME:
1000 p0 = va_arg(ap, void *);
1001 p1 = va_arg(ap, void *);
f6f0b69b 1002 retptr = getservbyname((char *)p0, (char *)p1); break;
edd309b7
JH
1003 case OP_GSBYPORT:
1004 anint = va_arg(ap, int);
1005 p0 = va_arg(ap, void *);
f6f0b69b 1006 retptr = getservbyport(anint, (char *)p0); break;
edd309b7
JH
1007 case OP_GSERVENT:
1008 retptr = getservent(); break;
1009 default:
0de8cad8 1010 SETERRNO(ERANGE, LIB_INVARG);
edd309b7
JH
1011 break;
1012 }
1013 }
1014 }
1015 break;
1016#endif
1017 default:
1018 /* Not known how to retry, so just fail. */
1019 break;
1020 }
1021
1022 va_end(ap);
1023#endif
1024 return retptr;
1025}
1026
10bc17b6
JH
1027EOF
1028
1029__DATA__
1030asctime S |time |const struct tm|B_SB|B_SBI|I_SB|I_SBI
b430fd04 1031crypt CC |crypt |struct crypt_data|B_CCS|B_CCD|D=CRYPTD*
10bc17b6
JH
1032ctermid B |stdio | |B_B
1033ctime S |time |const time_t |B_SB|B_SBI|I_SB|I_SBI
1034drand48 |stdlib |struct drand48_data |I_ST|T=double*
1035endgrent |grp | |I_H|V_H
31ee0cb7
JH
1036endhostent |netdb | |I_D|V_D|D=struct hostent_data*
1037endnetent |netdb | |I_D|V_D|D=struct netent_data*
1038endprotoent |netdb | |I_D|V_D|D=struct protoent_data*
10bc17b6 1039endpwent |pwd | |I_H|V_H
31ee0cb7 1040endservent |netdb | |I_D|V_D|D=struct servent_data*
10bc17b6
JH
1041getgrent |grp |struct group |I_SBWR|I_SBIR|S_SBW|S_SBI|I_SBI|I_SBIH
1042getgrgid T |grp |struct group |I_TSBWR|I_TSBIR|I_TSBI|S_TSBI|T=gid_t
1043getgrnam C |grp |struct group |I_CSBWR|I_CSBIR|S_CBI|I_CSBI|S_CSBI
a845a0d4 1044gethostbyaddr 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
10bc17b6
JH
1045gethostbyname C |netdb |struct hostent |I_CSBWRE|S_CSBIE|I_CSD|D=struct hostent_data*
1046gethostent |netdb |struct hostent |I_SBWRE|I_SBIE|S_SBIE|S_SBI|I_SBI|I_SD|D=struct hostent_data*
f6f0b69b 1047getlogin |unistd |char |I_BW|I_BI|B_BW|B_BI
a845a0d4 1048getnetbyaddr 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
10bc17b6
JH
1049getnetbyname C |netdb |struct netent |I_CSBWRE|I_CSBI|S_CSBI|I_CSD|D=struct netent_data*
1050getnetent |netdb |struct netent |I_SBWRE|I_SBIE|S_SBIE|S_SBI|I_SBI|I_SD|D=struct netent_data*
1051getprotobyname C|netdb |struct protoent|I_CSBWR|S_CSBI|I_CSD|D=struct protoent_data*
1052getprotobynumber I |netdb |struct protoent|I_ISBWR|S_ISBI|I_ISD|D=struct protoent_data*
1053getprotoent |netdb |struct protoent|I_SBWR|I_SBI|S_SBI|I_SD|D=struct protoent_data*
1054getpwent |pwd |struct passwd |I_SBWR|I_SBIR|S_SBW|S_SBI|I_SBI|I_SBIH
1055getpwnam C |pwd |struct passwd |I_CSBWR|I_CSBIR|S_CSBI|I_CSBI
1056getpwuid T |pwd |struct passwd |I_TSBWR|I_TSBIR|I_TSBI|S_TSBI|T=uid_t
1057getservbyname CC|netdb |struct servent |I_CCSBWR|S_CCSBI|I_CCSD|D=struct servent_data*
1058getservbyport IC|netdb |struct servent |I_ICSBWR|S_ICSBI|I_ICSD|D=struct servent_data*
1059getservent |netdb |struct servent |I_SBWR|I_SBI|S_SBI|I_SD|D=struct servent_data*
1060getspnam C |shadow |struct spwd |I_CSBWR|S_CSBI
1061gmtime T |time |struct tm |S_TS|I_TS|T=const time_t*
1062localtime T |time |struct tm |S_TS|I_TS|T=const time_t*
a845a0d4 1063random |stdlib |struct random_data|I_iS|I_lS|I_St|i=int*|l=long*|t=int32_t*
10bc17b6
JH
1064readdir T |dirent |struct dirent |I_TSR|I_TS|T=DIR*
1065readdir64 T |dirent |struct dirent64|I_TSR|I_TS|T=DIR*
1066setgrent |grp | |I_H|V_H
1067sethostent I |netdb | |I_ID|V_ID|D=struct hostent_data*
1068setlocale IC |locale | |I_ICBI
1069setnetent I |netdb | |I_ID|V_ID|D=struct netent_data*
1070setprotoent I |netdb | |I_ID|V_ID|D=struct protoent_data*
1071setpwent |pwd | |I_H|V_H
1072setservent I |netdb | |I_ID|V_ID|D=struct servent_data*
1073srand48 L |stdlib |struct drand48_data |I_LS
1074srandom T |stdlib |struct random_data|I_TS|T=unsigned int
1075strerror I |string | |I_IBW|I_IBI|B_IBW
1076tmpnam B |stdio | |B_B
1077ttyname I |unistd | |I_IBW|I_IBI|B_IBI