src/gnu/usr.bin/perl/regen/reentr.pl

1239 lines
37 KiB
Perl

#!/usr/bin/perl -w
#
# Regenerate (overwriting only if changed):
#
# reentr.h
# reentr.c
#
# from information stored in the DATA section of this file.
#
# With the -U option, it also unconditionally regenerates the relevant
# metaconfig units:
#
# d_${func}_r.U
#
# Also accepts the standard regen_lib -q and -v args.
#
# This script is normally invoked from regen.pl.
BEGIN {
# Get function prototypes
require './regen/regen_lib.pl';
}
use strict;
use Getopt::Std;
my %opts;
getopts('Uv', \%opts);
my %map = (
V => "void",
A => "char*", # as an input argument
B => "char*", # as an output argument
C => "const char*", # as a read-only input argument
I => "int",
L => "long",
W => "size_t",
H => "FILE**",
E => "int*",
);
# (See the definitions after __DATA__.)
# In func|inc|type|... a "S" means "type*", and a "R" means "type**".
# (The "types" are often structs, such as "struct passwd".)
#
# After the prototypes one can have |X=...|Y=... to define more types.
# A commonly used extra type is to define D to be equal to "type_data",
# for example "struct_hostent_data to" go with "struct hostent".
#
# Example #1: I_XSBWR means int func_r(X, type, char*, size_t, type**)
# Example #2: S_SBIE means type func_r(type, char*, int, int*)
# Example #3: S_CBI means type func_r(const char*, char*, int)
sub open_print_header {
my ($file, $quote) = @_;
return open_new($file, '>',
{ by => 'regen/reentr.pl',
from => 'data in regen/reentr.pl',
file => $file, style => '*',
copyright => [2002, 2003, 2005 .. 2007],
quote => $quote });
}
my $h = open_print_header('reentr.h');
print $h <<EOF;
#ifndef PERL_REENTR_H_
#define PERL_REENTR_H_
/* If compiling for a threaded perl, we will macro-wrap the system/library
* interfaces (e.g. getpwent()) which have threaded versions
* (e.g. getpwent_r()), which will handle things correctly for
* the Perl interpreter. This is done automatically for the perl core and
* extensions, but not generally for XS modules unless they
* #define PERL_REENTRANT
* See L<perlxs/Thread-aware system interfaces>.
*
* For a function 'foo', use the compile-time directive
* #ifdef PERL_REENTR_USING_FOO_R
* to test if the function actually did get replaced by the reentrant version.
* (If it isn't getting replaced, it might mean it uses a different prototype
* on the given platform than any we are expecting. To fix that, add the
* prototype to the __DATA__ section of regen/reentr.pl.)
*/
#ifndef PERL_REENTR_API
# if defined(PERL_CORE) || defined(PERL_EXT) || defined(PERL_REENTRANT)
# define PERL_REENTR_API 1
# else
# define PERL_REENTR_API 0
# endif
#endif
#ifdef USE_REENTRANT_API
/* For thread-safe builds, alternative methods are used to make calls to this
* safe. */
#ifdef USE_THREAD_SAFE_LOCALE
# undef HAS_SETLOCALE_R
#endif
/* Deprecations: some platforms have the said reentrant interfaces
* but they are declared obsolete and are not to be used. Often this
* means that the platform has threadsafed the interfaces (hopefully).
* All this is OS version dependent, so we are of course fooling ourselves.
* If you know of more deprecations on some platforms, please add your own
* (by editing reentr.pl, mind!) */
# ifdef __hpux
# undef HAS_CRYPT_R
# undef HAS_ENDGRENT_R
# undef HAS_ENDPWENT_R
# undef HAS_GETGRENT_R
# undef HAS_GETPWENT_R
# undef HAS_SETLOCALE_R
# undef HAS_STRERROR_R
# define NETDB_R_OBSOLETE
# endif
# if defined(__osf__) && defined(__alpha) /* Tru64 aka Digital UNIX */
# undef HAS_CRYPT_R
# undef HAS_STRERROR_R
# define NETDB_R_OBSOLETE
# endif
# if defined(__GLIBC__) && (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 24))
# undef HAS_READDIR_R
# undef HAS_READDIR64_R
# endif
/*
* As of OpenBSD 3.7, reentrant functions are now working, they just are
* incompatible with everyone else. To make OpenBSD happy, we have to
* memzero out certain structures before calling the functions.
*/
# if defined(__OpenBSD__) || defined(__SecBSD__)
# define REENTR_MEMZERO(a,b) memzero(a,b)
# else
# define REENTR_MEMZERO(a,b) 0
# endif
# ifdef NETDB_R_OBSOLETE
# undef HAS_ENDHOSTENT_R
# undef HAS_ENDNETENT_R
# undef HAS_ENDPROTOENT_R
# undef HAS_ENDSERVENT_R
# undef HAS_GETHOSTBYADDR_R
# undef HAS_GETHOSTBYNAME_R
# undef HAS_GETHOSTENT_R
# undef HAS_GETNETBYADDR_R
# undef HAS_GETNETBYNAME_R
# undef HAS_GETNETENT_R
# undef HAS_GETPROTOBYNAME_R
# undef HAS_GETPROTOBYNUMBER_R
# undef HAS_GETPROTOENT_R
# undef HAS_GETSERVBYNAME_R
# undef HAS_GETSERVBYPORT_R
# undef HAS_GETSERVENT_R
# undef HAS_SETHOSTENT_R
# undef HAS_SETNETENT_R
# undef HAS_SETPROTOENT_R
# undef HAS_SETSERVENT_R
# endif
# ifdef I_PWD
# include <pwd.h>
# endif
# ifdef I_GRP
# include <grp.h>
# endif
# ifdef I_NETDB
# include <netdb.h>
# endif
# ifdef I_CRYPT
# ifdef I_CRYPT
# include <crypt.h>
# endif
# endif
# ifdef HAS_GETSPNAM_R
# ifdef I_SHADOW
# include <shadow.h>
# endif
# endif
EOF
my %seenh; # the different prototypes signatures for this function
my %seena; # the different prototypes signatures for this function in order
my @seenf; # all the seen functions
my %seenp; # the different prototype signatures for all functions
my %seent; # the return type of this function
my %seens; # the type of this function's "S"
my %seend; # the type of this function's "D"
my %seenm; # all the types
my %seenu; # the length of the argument list of this function
while (<DATA>) { # Read in the prototypes.
next if /^\s+$/;
chomp;
my ($func, $hdr, $type, @p) = split(/\s*\|\s*/, $_, -1);
my $u;
# Split off the real function name and the argument list.
($func, $u) = split(' ', $func);
$seenu{$func} = defined $u ? length $u : 0;
my $FUNC = uc $func; # for output.
push @seenf, $func;
my %m = %map;
if ($type) {
$m{S} = "$type*";
$m{R} = "$type**";
}
# Set any special mapping variables (like X=x_t)
if (@p) {
while ($p[-1] =~ /=/) {
my ($k, $v) = ($p[-1] =~ /^([A-Za-z])\s*=\s*(.*)/);
$m{$k} = $v;
pop @p;
}
}
# If given the -U option open up the metaconfig unit for this function.
if ($opts{U} && open(U, ">", "d_${func}_r.U")) {
binmode U;
}
if ($opts{U}) {
# The metaconfig units needs prerequisite dependencies.
my $prereqs = '';
my $prereqh = '';
my $prereqsh = '';
if ($hdr ne 'stdio') { # There's no i_stdio.
$prereqs = "i_$hdr";
$prereqh = "$hdr.h";
$prereqsh = "\$$prereqs $prereqh";
}
my @prereq = qw(Inlibc Protochk Hasproto i_systypes usethreads);
push @prereq, $prereqs;
my $hdrs = "\$i_systypes sys/types.h define stdio.h $prereqsh";
if ($hdr eq 'time') {
$hdrs .= " \$i_systime sys/time.h";
push @prereq, 'i_systime';
}
# Output the metaconfig unit header.
print U <<"EOF";
?RCS: \$Id: d_${func}_r.U,v $
?RCS:
?RCS: Copyright (c) 2002,2003 Jarkko Hietaniemi
?RCS:
?RCS: You may distribute under the terms of either the GNU General Public
?RCS: License or the Artistic License, as specified in the README file.
?RCS:
?RCS: Generated by the reentr.pl from the Perl 5.8 distribution.
?RCS:
?MAKE:d_${func}_r ${func}_r_proto: @prereq
?MAKE: -pick add \$@ %<
?S:d_${func}_r:
?S: This variable conditionally defines the HAS_${FUNC}_R symbol,
?S: which indicates to the C program that the ${func}_r()
?S: routine is available.
?S:.
?S:${func}_r_proto:
?S: This variable encodes the prototype of ${func}_r.
?S: It is zero if d_${func}_r is undef, and one of the
?S: REENTRANT_PROTO_T_ABC macros of reentr.h if d_${func}_r
?S: is defined.
?S:.
?C:HAS_${FUNC}_R:
?C: This symbol, if defined, indicates that the ${func}_r routine
?C: is available to ${func} re-entrantly.
?C:.
?C:${FUNC}_R_PROTO:
?C: This symbol encodes the prototype of ${func}_r.
?C: It is zero if d_${func}_r is undef, and one of the
?C: REENTRANT_PROTO_T_ABC macros of reentr.h if d_${func}_r
?C: is defined.
?C:.
?H:#\$d_${func}_r HAS_${FUNC}_R /**/
?H:#define ${FUNC}_R_PROTO \$${func}_r_proto /**/
?H:.
?T:try hdrs d_${func}_r_proto
?LINT:set d_${func}_r
?LINT:set ${func}_r_proto
: see if ${func}_r exists
set ${func}_r d_${func}_r
eval \$inlibc
case "\$d_${func}_r" in
"\$define")
EOF
print U <<"EOF";
hdrs="$hdrs"
case "\$d_${func}_r_proto:\$usethreads" in
":define") d_${func}_r_proto=define
set d_${func}_r_proto ${func}_r \$hdrs
eval \$hasproto ;;
*) ;;
esac
case "\$d_${func}_r_proto" in
define)
EOF
}
for my $p (@p) {
my ($r, $a) = ($p =~ /^(.)_(.+)/);
my $v = join(", ", map { $m{$_} } split '', $a);
if ($opts{U}) {
print U <<"EOF";
case "\$${func}_r_proto" in
''|0) try='$m{$r} ${func}_r($v);'
./protochk "extern \$try" \$hdrs && ${func}_r_proto=$p ;;
esac
EOF
}
$seenh{$func}->{$p}++;
push @{$seena{$func}}, $p;
$seenp{$p}++;
$seent{$func} = $type;
$seens{$func} = $m{S};
$seend{$func} = $m{D};
$seenm{$func} = \%m;
}
if ($opts{U}) {
print U <<"EOF";
case "\$${func}_r_proto" in
''|0) d_${func}_r=undef
${func}_r_proto=0
echo "Disabling ${func}_r, cannot determine prototype." >&4 ;;
* ) case "\$${func}_r_proto" in
REENTRANT_PROTO*) ;;
*) ${func}_r_proto="REENTRANT_PROTO_\$${func}_r_proto" ;;
esac
echo "Prototype: \$try" ;;
esac
;;
*) case "\$usethreads" in
define) echo "${func}_r has no prototype, not using it." >&4 ;;
esac
d_${func}_r=undef
${func}_r_proto=0
;;
esac
;;
*) ${func}_r_proto=0
;;
esac
EOF
close(U);
}
}
close DATA;
{
# Write out all the known prototype signatures.
my $i = 1;
for my $p (sort keys %seenp) {
print $h "# define REENTRANT_PROTO_${p} ${i}\n";
$i++;
}
}
my @struct; # REENTR struct members
my @size; # struct member buffer size initialization code
my @init; # struct member buffer initialization (malloc) code
my @free; # struct member buffer release (free) code
my @wrap; # the wrapper (foo(a) -> foo_r(a,...)) cpp code
my @define; # defines for optional features
sub ifprotomatch {
my $FUNC = shift;
join " || ", map { "${FUNC}_R_PROTO == REENTRANT_PROTO_$_" } @_;
}
sub pushssif {
push @struct, @_;
push @size, @_;
push @init, @_;
push @free, @_;
}
sub pushinitfree {
my $func = shift;
push @init, <<EOF;
Newx(PL_reentrant_buffer->_${func}_buffer, PL_reentrant_buffer->_${func}_size, char);
EOF
push @free, <<EOF;
Safefree(PL_reentrant_buffer->_${func}_buffer);
EOF
}
sub define {
my ($n, $p, @F) = @_;
my @H;
my $H = uc $F[0];
push @define, <<EOF;
/* The @F using \L$n? */
EOF
my $GENFUNC;
for my $func (@F) {
my $FUNC = uc $func;
my $HAS = "${FUNC}_R_HAS_$n";
push @H, $HAS;
my @h = grep { /$p/ } @{$seena{$func}};
unless (defined $GENFUNC) {
$GENFUNC = $FUNC;
$GENFUNC =~ s/^GET//;
}
if (@h) {
push @define, "# if defined(HAS_${FUNC}_R) && (" . join(" || ", map { "${FUNC}_R_PROTO == REENTRANT_PROTO_$_" } @h) . ")\n";
push @define, <<EOF;
# define $HAS
# else
# undef $HAS
# endif
EOF
}
}
return if @F == 1;
push @define, <<EOF;
/* Any of the @F using \L$n? */
EOF
push @define, "# if (" . join(" || ", map { "defined($_)" } @H) . ")\n";
push @define, <<EOF;
# define USE_${GENFUNC}_$n
# else
# undef USE_${GENFUNC}_$n
# endif
EOF
}
define('BUFFER', 'B',
qw(getgrent getgrgid getgrnam));
define('PTR', 'R',
qw(getgrent getgrgid getgrnam));
define('PTR', 'R',
qw(getpwent getpwnam getpwuid));
define('PTR', 'R',
qw(getspent getspnam));
define('FPTR', 'H',
qw(getgrent getgrgid getgrnam setgrent endgrent));
define('FPTR', 'H',
qw(getpwent getpwnam getpwuid setpwent endpwent));
define('BUFFER', 'B',
qw(getpwent getpwgid getpwnam));
define('BUFFER', 'B',
qw(getspent getspnam));
define('PTR', 'R',
qw(gethostent gethostbyaddr gethostbyname));
define('PTR', 'R',
qw(getnetent getnetbyaddr getnetbyname));
define('PTR', 'R',
qw(getprotoent getprotobyname getprotobynumber));
define('PTR', 'R',
qw(getservent getservbyname getservbyport));
define('BUFFER', 'B',
qw(gethostent gethostbyaddr gethostbyname));
define('BUFFER', 'B',
qw(getnetent getnetbyaddr getnetbyname));
define('BUFFER', 'B',
qw(getprotoent getprotobyname getprotobynumber));
define('BUFFER', 'B',
qw(getservent getservbyname getservbyport));
define('ERRNO', 'E',
qw(gethostent gethostbyaddr gethostbyname));
define('ERRNO', 'E',
qw(getnetent getnetbyaddr getnetbyname));
# The following loop accumulates the "ssif" (struct, size, init, free)
# sections that declare the struct members (in reentr.h), and the buffer
# size initialization, buffer initialization (malloc), and buffer
# release (free) code (in reentr.c).
#
# The loop also contains a lot of intrinsic logic about groups of
# functions (since functions of certain kind operate the same way).
for my $func (@seenf) {
my $FUNC = uc $func;
my $ifdef = "# ifdef HAS_${FUNC}_R\n";
my $endif = "# endif /* HAS_${FUNC}_R */\n\n";
if (exists $seena{$func}) {
my @p = @{$seena{$func}};
if ($func =~ /^(asctime|ctime|getlogin|setlocale|strerror|ttyname)$/) {
pushssif $ifdef;
push @struct, <<EOF;
char* _${func}_buffer;
size_t _${func}_size;
EOF
my $size = ($func =~ /^(asctime|ctime)$/)
? 26
: "REENTRANTSMALLSIZE";
push @size, <<EOF;
PL_reentrant_buffer->_${func}_size = $size;
EOF
pushinitfree $func;
pushssif $endif;
}
elsif ($func =~ /^(gm|local)time$/) {
pushssif $ifdef;
push @struct, <<EOF; # Fixed size
$seent{$func} _${func}_struct;
EOF
pushssif $endif;
}
elsif ($func =~ /^(crypt)$/) {
pushssif $ifdef;
push @struct, <<EOF;
# if CRYPT_R_PROTO == REENTRANT_PROTO_B_CCD
$seend{$func} _${func}_data;
# else
$seent{$func} *_${func}_struct_buffer;
# endif
EOF
push @init, <<EOF;
# if CRYPT_R_PROTO != REENTRANT_PROTO_B_CCD
PL_reentrant_buffer->_${func}_struct_buffer = 0;
# endif
EOF
push @free, <<EOF;
# if CRYPT_R_PROTO != REENTRANT_PROTO_B_CCD
Safefree(PL_reentrant_buffer->_${func}_struct_buffer);
# endif
EOF
pushssif $endif;
}
elsif ($func =~ /^(getgrnam|getpwnam|getspnam)$/) {
pushssif $ifdef;
# 'genfunc' can be read either as 'generic' or 'genre',
# it represents a group of functions.
my $genfunc = $func;
$genfunc =~ s/nam/ent/g;
$genfunc =~ s/^get//;
my $GENFUNC = uc $genfunc;
push @struct, <<EOF;
$seent{$func} _${genfunc}_struct;
char* _${genfunc}_buffer;
size_t _${genfunc}_size;
EOF
push @struct, <<EOF;
# ifdef USE_${GENFUNC}_PTR
$seent{$func}* _${genfunc}_ptr;
# endif
EOF
push @struct, <<EOF;
# ifdef USE_${GENFUNC}_FPTR
FILE* _${genfunc}_fptr;
# endif
EOF
push @init, <<EOF;
# ifdef USE_${GENFUNC}_FPTR
PL_reentrant_buffer->_${genfunc}_fptr = NULL;
# endif
EOF
my $sc = $genfunc eq 'grent' ?
'_SC_GETGR_R_SIZE_MAX' : '_SC_GETPW_R_SIZE_MAX';
my $sz = "_${genfunc}_size";
push @size, <<EOF;
# if defined(HAS_SYSCONF) && defined($sc) && !defined(__GLIBC__)
PL_reentrant_buffer->$sz = sysconf($sc);
if (PL_reentrant_buffer->$sz == (size_t) -1)
PL_reentrant_buffer->$sz = REENTRANTUSUALSIZE;
# elif defined(__osf__) && defined(__alpha) && defined(SIABUFSIZ)
PL_reentrant_buffer->$sz = SIABUFSIZ;
# elif defined(__sgi)
PL_reentrant_buffer->$sz = BUFSIZ;
# else
PL_reentrant_buffer->$sz = REENTRANTUSUALSIZE;
# endif
EOF
pushinitfree $genfunc;
pushssif $endif;
}
elsif ($func =~ /^(gethostbyname|getnetbyname|getservbyname|getprotobyname)$/) {
pushssif $ifdef;
my $genfunc = $func;
$genfunc =~ s/byname/ent/;
$genfunc =~ s/^get//;
my $GENFUNC = uc $genfunc;
my $D = ifprotomatch($FUNC, grep {/D/} @p);
my $d = $seend{$func};
$d =~ s/\*$//; # snip: we need the base type.
push @struct, <<EOF;
$seent{$func} _${genfunc}_struct;
# if $D
$d _${genfunc}_data;
# else
char* _${genfunc}_buffer;
size_t _${genfunc}_size;
# endif
# ifdef USE_${GENFUNC}_PTR
$seent{$func}* _${genfunc}_ptr;
# endif
EOF
push @struct, <<EOF;
# ifdef USE_${GENFUNC}_ERRNO
int _${genfunc}_errno;
# endif
EOF
push @size, <<EOF;
# if !($D)
PL_reentrant_buffer->_${genfunc}_size = REENTRANTUSUALSIZE;
# endif
EOF
push @init, <<EOF;
# if !($D)
Newx(PL_reentrant_buffer->_${genfunc}_buffer, PL_reentrant_buffer->_${genfunc}_size, char);
# endif
EOF
push @free, <<EOF;
# if !($D)
Safefree(PL_reentrant_buffer->_${genfunc}_buffer);
# endif
EOF
pushssif $endif;
}
elsif ($func =~ /^(readdir|readdir64)$/) {
pushssif $ifdef;
my $R = ifprotomatch($FUNC, grep {/R/} @p);
push @struct, <<EOF;
$seent{$func}* _${func}_struct;
size_t _${func}_size;
# if $R
$seent{$func}* _${func}_ptr;
# endif
EOF
push @size, <<EOF;
/* This is the size Solaris recommends.
* (though we go static, should use pathconf() instead) */
PL_reentrant_buffer->_${func}_size = sizeof($seent{$func}) + MAXPATHLEN + 1;
EOF
push @init, <<EOF;
PL_reentrant_buffer->_${func}_struct = ($seent{$func}*)safemalloc(PL_reentrant_buffer->_${func}_size);
EOF
push @free, <<EOF;
Safefree(PL_reentrant_buffer->_${func}_struct);
EOF
pushssif $endif;
}
push @wrap, $ifdef;
push @wrap, <<EOF;
# if defined(PERL_REENTR_API) && (PERL_REENTR_API+0 == 1)
# undef $func
EOF
# Write out what we have learned.
my @v = 'a'..'z';
my $v = join(", ", @v[0..$seenu{$func}-1]);
for my $p (@p) {
my ($r, $a) = split '_', $p;
my $test = $r eq 'I' ? ' == 0' : '';
my $true = 1;
my $genfunc = $func;
if ($genfunc =~ /^(?:get|set|end)(pw|gr|host|net|proto|serv|sp)/) {
$genfunc = "${1}ent";
}
my $b = $a;
my $w = '';
substr($b, 0, $seenu{$func}) = '';
if ($b =~ /R/) {
$true = "PL_reentrant_buffer->_${genfunc}_ptr";
} elsif ($b =~ /S/) {
if ($func =~ /^readdir/) {
$true = "PL_reentrant_buffer->_${genfunc}_struct";
} else {
$true = "&PL_reentrant_buffer->_${genfunc}_struct";
}
} elsif ($b =~ /B/) {
$true = "PL_reentrant_buffer->_${genfunc}_buffer";
}
if (length $b) {
$w = join ", ",
map { $_ eq 'R'
? "&PL_reentrant_buffer->_${genfunc}_ptr"
: $_ eq 'E'
? "&PL_reentrant_buffer->_${genfunc}_errno"
: $_ eq 'B'
? "PL_reentrant_buffer->_${genfunc}_buffer"
: $_ =~ /^[WI]$/
? "PL_reentrant_buffer->_${genfunc}_size"
: $_ eq 'H'
? "&PL_reentrant_buffer->_${genfunc}_fptr"
: $_ eq 'D'
? "&PL_reentrant_buffer->_${genfunc}_data"
: $_ eq 'S'
? ($func =~ /^readdir\d*$/
? "PL_reentrant_buffer->_${genfunc}_struct"
: $func =~ /^crypt$/
? "PL_reentrant_buffer->_${genfunc}_struct_buffer"
: "&PL_reentrant_buffer->_${genfunc}_struct")
: $_
} split '', $b;
$w = ", $w" if length $v;
}
# This needs a special case, see its definition in config.h
my $setup = ($func eq 'localtime') ? "L_R_TZSET " : "";
my $call = "$setup${func}_r($v$w)";
# Must make OpenBSD happy
my $memzero = '';
if($p =~ /D$/ &&
($genfunc eq 'protoent' || $genfunc eq 'servent')) {
$memzero = 'REENTR_MEMZERO(&PL_reentrant_buffer->_' . $genfunc . '_data, sizeof(PL_reentrant_buffer->_' . $genfunc . '_data)),';
}
push @wrap, <<EOF;
# if !defined($func) && ${FUNC}_R_PROTO == REENTRANT_PROTO_$p
EOF
if ($r eq 'V' || $r eq 'B') {
push @wrap, <<EOF;
# define $func($v) $call
EOF
} else {
if ($func =~ /^get/) {
my $rv = $v ? ", $v" : "";
if ($r eq 'I') {
push @wrap, <<EOF;
# define $func($v) ($memzero(PL_reentrant_retint = $call)$test ? $true : ((PL_reentrant_retint == ERANGE) ? ($seent{$func} *) Perl_reentrant_retry("$func"$rv) : 0))
EOF
} else {
push @wrap, <<EOF;
# define $func($v) ($call$test ? $true : ((errno == ERANGE) ? ($seent{$func} *) Perl_reentrant_retry("$func"$rv) : 0))
EOF
}
} else {
push @wrap, <<EOF;
# define $func($v) ($call$test ? $true : 0)
EOF
}
}
push @wrap, <<EOF; # !defined(xxx) && XXX_R_PROTO == REENTRANT_PROTO_Y_TS
# endif
EOF
}
push @wrap, <<EOF;
# if defined($func)
# define PERL_REENTR_USING_${FUNC}_R
# endif
EOF
push @wrap, <<EOF; # defined(PERL_REENTR_API) && (PERL_REENTR_API+0 == 1)
# endif
EOF
push @wrap, $endif, "\n";
}
}
local $" = '';
print $h <<EOF;
/* Defines for indicating which special features are supported. */
@define
typedef struct {
@struct
int dummy; /* cannot have empty structs */
} REENTR;
/* The wrappers. */
@wrap
/* Special case this; if others came along, could automate it */
# ifdef HAS_GETSPNAM_R
# define KEY_getspnam -1
# endif
#endif /* USE_REENTRANT_API */
#endif
EOF
read_only_bottom_close_and_rename($h);
# Prepare to write the reentr.c.
my $c = open_print_header('reentr.c', <<'EOQ');
*/
/*
* "Saruman," I said, standing away from him, "only one hand at a time can
* wield the One, and you know that well, so do not trouble to say we!"
*
* [p.260 of _The Lord of the Rings_, II/ii: "The Council of Elrond"]
*/
/*
* This file contains a collection of automatically created wrappers
* (created by running reentr.pl) for reentrant (thread-safe) versions of
* various library calls, such as getpwent_r. The wrapping is done so
* that other files like pp_sys.c calling those library functions need not
* care about the differences between various platforms' idiosyncrasies
* regarding these reentrant interfaces.
*/
EOQ
print $c <<"EOF";
#include "EXTERN.h"
#define PERL_IN_REENTR_C
#include "perl.h"
#include "reentr.h"
#include "keywords.h"
#define RenewDouble(data_pointer, size_pointer, type) \\
STMT_START { \\
const size_t size = MAX(*(size_pointer), 1) * 2; \\
Renew((data_pointer), (size), type); \\
*(size_pointer) = size; \\
} STMT_END
void
Perl_reentrant_size(pTHX) {
PERL_UNUSED_CONTEXT;
/* Set the sizes of the reentrant buffers */
#ifdef USE_REENTRANT_API
# define REENTRANTSMALLSIZE 256 /* Make something up. */
# define REENTRANTUSUALSIZE 4096 /* Make something up. */
@size
#endif /* USE_REENTRANT_API */
}
void
Perl_reentrant_init(pTHX) {
PERL_UNUSED_CONTEXT;
/* Initialize the whole thing */
#ifdef USE_REENTRANT_API
Newx(PL_reentrant_buffer, 1, REENTR);
Perl_reentrant_size(aTHX);
@init
#endif /* USE_REENTRANT_API */
}
void
Perl_reentrant_free(pTHX) {
PERL_UNUSED_CONTEXT;
/* Tear down */
#ifdef USE_REENTRANT_API
@free
Safefree(PL_reentrant_buffer);
#endif /* USE_REENTRANT_API */
}
void*
Perl_reentrant_retry(const char *f, ...)
{
/* This function is set up to be called if the normal function returns
* failure with errno ERANGE, which indicates the buffer is too small.
* This function calls the failing one again with a larger buffer.
*
* What has happened is that, due to the magic of C preprocessor macro
* expansion, when the original code called function 'foo(args)', it was
* instead compiled into something like a call of 'foo_r(args, buffer)'
* Below we retry with 'foo', but the preprocessor has changed that into
* 'foo_r', so this function will end up calling itself recursively, each
* time with a larger buffer. If PERL_REENTRANT_MAXSIZE is defined, it
* won't increase beyond that, instead failing. */
void *retptr = NULL;
va_list ap;
I32 key = 0;
#ifdef USE_REENTRANT_API
dTHX;
key = Perl_keyword (aTHX_ f, strlen(f), FALSE /* not feature enabled */);
/* Easier to special case this here than in embed.pl. (Look at what it
generates for proto.h) */
PERL_ARGS_ASSERT_REENTRANT_RETRY;
#endif
if (key == 0) {
#ifdef HAS_GETSPNAM_R
/* This is a #define as has no corresponding keyword */
if (strEQ(f, "getspnam")) {
key = KEY_getspnam;
}
#endif
}
else if (key < 0) {
key = -key;
}
va_start(ap, f);
#ifdef USE_REENTRANT_API
switch (key) {
# ifdef USE_HOSTENT_BUFFER
case KEY_gethostbyaddr:
case KEY_gethostbyname:
case KEY_endhostent:
{
char * host_addr;
Size_t asize;
char * host_name;
int anint;
# ifdef PERL_REENTRANT_MAXSIZE
if (PL_reentrant_buffer->_hostent_size <=
PERL_REENTRANT_MAXSIZE / 2)
# endif
RenewDouble(PL_reentrant_buffer->_hostent_buffer,
&PL_reentrant_buffer->_hostent_size, char);
switch (key) {
case KEY_gethostbyaddr:
host_addr = va_arg(ap, char *);
asize = va_arg(ap, Size_t);
anint = va_arg(ap, int);
/* socklen_t is what Posix 2001 says this should be */
retptr = gethostbyaddr(host_addr, (socklen_t) asize, anint); break;
case KEY_gethostbyname:
host_name = va_arg(ap, char *);
retptr = gethostbyname(host_name); break;
case KEY_endhostent:
retptr = gethostent(); break;
default:
SETERRNO(ERANGE, LIB_INVARG);
break;
}
}
break;
# endif
# ifdef USE_GRENT_BUFFER
case KEY_getgrent:
case KEY_getgrgid:
case KEY_getgrnam:
{
char * name;
Gid_t gid;
# ifdef PERL_REENTRANT_MAXSIZE
if (PL_reentrant_buffer->_grent_size <=
PERL_REENTRANT_MAXSIZE / 2)
# endif
RenewDouble(PL_reentrant_buffer->_grent_buffer,
&PL_reentrant_buffer->_grent_size, char);
switch (key) {
case KEY_getgrnam:
name = va_arg(ap, char *);
retptr = getgrnam(name); break;
case KEY_getgrgid:
# if Gid_t_size < INTSIZE
gid = (Gid_t)va_arg(ap, int);
# else
gid = va_arg(ap, Gid_t);
# endif
retptr = getgrgid(gid); break;
case KEY_getgrent:
retptr = getgrent(); break;
default:
SETERRNO(ERANGE, LIB_INVARG);
break;
}
}
break;
# endif
# ifdef USE_NETENT_BUFFER
case KEY_getnetbyaddr:
case KEY_getnetbyname:
case KEY_getnetent:
{
char * name;
Netdb_net_t net;
int anint;
# ifdef PERL_REENTRANT_MAXSIZE
if (PL_reentrant_buffer->_netent_size <=
PERL_REENTRANT_MAXSIZE / 2)
# endif
RenewDouble(PL_reentrant_buffer->_netent_buffer,
&PL_reentrant_buffer->_netent_size, char);
switch (key) {
case KEY_getnetbyaddr:
net = va_arg(ap, Netdb_net_t);
anint = va_arg(ap, int);
retptr = getnetbyaddr(net, anint); break;
case KEY_getnetbyname:
name = va_arg(ap, char *);
retptr = getnetbyname(name); break;
case KEY_getnetent:
retptr = getnetent(); break;
default:
SETERRNO(ERANGE, LIB_INVARG);
break;
}
}
break;
# endif
# ifdef USE_PWENT_BUFFER
case KEY_getpwnam:
case KEY_getpwuid:
case KEY_getpwent:
{
Uid_t uid;
char * name;
# ifdef PERL_REENTRANT_MAXSIZE
if (PL_reentrant_buffer->_pwent_size <=
PERL_REENTRANT_MAXSIZE / 2)
# endif
RenewDouble(PL_reentrant_buffer->_pwent_buffer,
&PL_reentrant_buffer->_pwent_size, char);
switch (key) {
case KEY_getpwnam:
name = va_arg(ap, char *);
retptr = getpwnam(name); break;
case KEY_getpwuid:
# if Uid_t_size < INTSIZE
uid = (Uid_t)va_arg(ap, int);
# else
uid = va_arg(ap, Uid_t);
# endif
retptr = getpwuid(uid); break;
# if defined(HAS_GETPWENT) || defined(HAS_GETPWENT_R)
case KEY_getpwent:
retptr = getpwent(); break;
# endif
default:
SETERRNO(ERANGE, LIB_INVARG);
break;
}
}
break;
# endif
# ifdef USE_SPENT_BUFFER
case KEY_getspnam:
{
char * name;
# ifdef PERL_REENTRANT_MAXSIZE
if (PL_reentrant_buffer->_spent_size <=
PERL_REENTRANT_MAXSIZE / 2)
# endif
RenewDouble(PL_reentrant_buffer->_spent_buffer,
&PL_reentrant_buffer->_spent_size, char);
switch (key) {
case KEY_getspnam:
name = va_arg(ap, char *);
retptr = getspnam(name); break;
default:
SETERRNO(ERANGE, LIB_INVARG);
break;
}
}
break;
# endif
# ifdef USE_PROTOENT_BUFFER
case KEY_getprotobyname:
case KEY_getprotobynumber:
case KEY_getprotoent:
{
char * name;
int anint;
# ifdef PERL_REENTRANT_MAXSIZE
if (PL_reentrant_buffer->_protoent_size <=
PERL_REENTRANT_MAXSIZE / 2)
# endif
RenewDouble(PL_reentrant_buffer->_protoent_buffer,
&PL_reentrant_buffer->_protoent_size, char);
switch (key) {
case KEY_getprotobyname:
name = va_arg(ap, char *);
retptr = getprotobyname(name); break;
case KEY_getprotobynumber:
anint = va_arg(ap, int);
retptr = getprotobynumber(anint); break;
case KEY_getprotoent:
retptr = getprotoent(); break;
default:
SETERRNO(ERANGE, LIB_INVARG);
break;
}
}
break;
# endif
# ifdef USE_SERVENT_BUFFER
case KEY_getservbyname:
case KEY_getservbyport:
case KEY_getservent:
{
char * name;
char * proto;
int anint;
# ifdef PERL_REENTRANT_MAXSIZE
if (PL_reentrant_buffer->_servent_size <=
PERL_REENTRANT_MAXSIZE / 2)
# endif
RenewDouble(PL_reentrant_buffer->_servent_buffer,
&PL_reentrant_buffer->_servent_size, char);
switch (key) {
case KEY_getservbyname:
name = va_arg(ap, char *);
proto = va_arg(ap, char *);
retptr = getservbyname(name, proto); break;
case KEY_getservbyport:
anint = va_arg(ap, int);
name = va_arg(ap, char *);
retptr = getservbyport(anint, name); break;
case KEY_getservent:
retptr = getservent(); break;
default:
SETERRNO(ERANGE, LIB_INVARG);
break;
}
}
break;
# endif
default:
/* Not known how to retry, so just fail. */
break;
}
#else
PERL_UNUSED_ARG(f);
#endif
va_end(ap);
return retptr;
}
EOF
read_only_bottom_close_and_rename($c);
# As of March 2020, the config.h entries that have reentrant prototypes that
# aren't in this file are:
# drand48
# random
# srand48
# srandom
# The meanings of the flags are derivable from %map above
# Fnc, arg flags| hdr | ? struct type | prototypes...
__DATA__
asctime S |time |const struct tm|B_SB|B_SBI|I_SB|I_SBI
crypt CC |crypt |struct crypt_data|B_CCS|B_CCD|D=CRYPTD*
ctermid B |stdio | |B_B
ctime S |time |const time_t |B_SB|B_SBI|I_SB|I_SBI
endgrent |grp | |I_H|V_H
endhostent |netdb | |I_D|V_D|D=struct hostent_data*
endnetent |netdb | |I_D|V_D|D=struct netent_data*
endprotoent |netdb | |I_D|V_D|D=struct protoent_data*
endpwent |pwd | |I_H|V_H
endservent |netdb | |I_D|V_D|D=struct servent_data*
getgrent |grp |struct group |I_SBWR|I_SBIR|S_SBW|S_SBI|I_SBI|I_SBIH
getgrgid T |grp |struct group |I_TSBWR|I_TSBIR|I_TSBI|S_TSBI|T=gid_t
getgrnam C |grp |struct group |I_CSBWR|I_CSBIR|S_CBI|I_CSBI|S_CSBI
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
gethostbyname C |netdb |struct hostent |I_CSBWRE|S_CSBIE|I_CSD|D=struct hostent_data*
gethostent |netdb |struct hostent |I_SBWRE|I_SBIE|S_SBIE|S_SBI|I_SBI|I_SD|D=struct hostent_data*
getlogin |unistd |char |I_BW|I_BI|B_BW|B_BI
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
getnetbyname C |netdb |struct netent |I_CSBWRE|I_CSBI|S_CSBI|I_CSD|D=struct netent_data*
getnetent |netdb |struct netent |I_SBWRE|I_SBIE|S_SBIE|S_SBI|I_SBI|I_SD|D=struct netent_data*
getprotobyname C|netdb |struct protoent|I_CSBWR|S_CSBI|I_CSD|D=struct protoent_data*
getprotobynumber I |netdb |struct protoent|I_ISBWR|S_ISBI|I_ISD|D=struct protoent_data*
getprotoent |netdb |struct protoent|I_SBWR|I_SBI|S_SBI|I_SD|D=struct protoent_data*
getpwent |pwd |struct passwd |I_SBWR|I_SBIR|S_SBW|S_SBI|I_SBI|I_SBIH
getpwnam C |pwd |struct passwd |I_CSBWR|I_CSBIR|S_CSBI|I_CSBI
getpwuid T |pwd |struct passwd |I_TSBWR|I_TSBIR|I_TSBI|S_TSBI|T=uid_t
getservbyname CC|netdb |struct servent |I_CCSBWR|S_CCSBI|I_CCSD|D=struct servent_data*
getservbyport IC|netdb |struct servent |I_ICSBWR|S_ICSBI|I_ICSD|D=struct servent_data*
getservent |netdb |struct servent |I_SBWR|I_SBI|S_SBI|I_SD|D=struct servent_data*
getspnam C |shadow |struct spwd |I_CSBWR|S_CSBI
gmtime T |time |struct tm |S_TS|T=time_t*
localtime T |time |struct tm |S_TS|T=time_t*
readdir T |dirent |struct dirent |I_TSR|I_TS|T=DIR*
readdir64 T |dirent |struct dirent64|I_TSR|I_TS|T=DIR*
setgrent |grp | |I_H|V_H
sethostent I |netdb | |I_ID|V_ID|D=struct hostent_data*
setlocale IC |locale | |I_ICBI
setnetent I |netdb | |I_ID|V_ID|D=struct netent_data*
setprotoent I |netdb | |I_ID|V_ID|D=struct protoent_data*
setpwent |pwd | |I_H|V_H
setservent I |netdb | |I_ID|V_ID|D=struct servent_data*
strerror I |string | |I_IBW|I_IBI|B_IBW
tmpnam B |stdio | |B_B
ttyname I |unistd | |I_IBW|I_IBI|B_IBI