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