perlio.c

   1 /*
   2  * perlio.c Copyright (c) 1996-2006, Nick Ing-Simmons You may distribute
   3  * under the terms of either the GNU General Public License or the
   4  * Artistic License, as specified in the README file.
   5  */
   6
   7 /*
   8  * Hour after hour for nearly three weary days he had jogged up and down,
   9  * over passes, and through long dales, and across many streams.
  10  */
  11
  12 /* This file contains the functions needed to implement PerlIO, which
  13  * is Perl's private replacement for the C stdio library. This is used
  14  * by default unless you compile with -Uuseperlio or run with
  15  * PERLIO=:stdio (but don't do this unless you know what you're doing)
  16  */
  17
  18 /*
  19  * If we have ActivePerl-like PERL_IMPLICIT_SYS then we need a dTHX to get
  20  * at the dispatch tables, even when we do not need it for other reasons.
  21  * Invent a dSYS macro to abstract this out
  22  */
  23 #ifdef PERL_IMPLICIT_SYS
  24 #define dSYS dTHX
  25 #else
  26 #define dSYS dNOOP
  27 #endif
  28
  29 #define VOIDUSED 1
  30 #ifdef PERL_MICRO
  31 #   include "uconfig.h"
  32 #else
  33 #   ifndef USE_CROSS_COMPILE
  34 #       include "config.h"
  35 #   else
  36 #       include "xconfig.h"
  37 #   endif
  38 #endif
  39
  40 #define PERLIO_NOT_STDIO 0
  41 #if !defined(PERLIO_IS_STDIO) && !defined(USE_SFIO)
  42 /*
  43  * #define PerlIO FILE
  44  */
  45 #endif
  46 /*
  47  * This file provides those parts of PerlIO abstraction
  48  * which are not #defined in perlio.h.
  49  * Which these are depends on various Configure #ifdef's
  50  */
  51
  52 #include "EXTERN.h"
  53 #define PERL_IN_PERLIO_C
  54 #include "perl.h"
  55
  56 #ifdef PERL_IMPLICIT_CONTEXT
  57 #undef dSYS
  58 #define dSYS dTHX
  59 #endif
  60
  61 #include "XSUB.h"
  62
  63 #ifdef __Lynx__
  64 /* Missing proto on LynxOS */
  65 int mkstemp(char*);
  66 #endif
  67
  68 /* Call the callback or PerlIOBase, and return failure. */
  69 #define Perl_PerlIO_or_Base(f, callback, base, failure, args)   \
  70         if (PerlIOValid(f)) {                                   \
  71                 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
  72                 if (tab && tab->callback)                       \
  73                         return (*tab->callback) args;           \
  74                 else                                            \
  75                         return PerlIOBase_ ## base args;        \
  76         }                                                       \
  77         else                                                    \
  78                 SETERRNO(EBADF, SS_IVCHAN);                     \
  79         return failure
  80
  81 /* Call the callback or fail, and return failure. */
  82 #define Perl_PerlIO_or_fail(f, callback, failure, args)         \
  83         if (PerlIOValid(f)) {                                   \
  84                 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
  85                 if (tab && tab->callback)                       \
  86                         return (*tab->callback) args;           \
  87                 SETERRNO(EINVAL, LIB_INVARG);                   \
  88         }                                                       \
  89         else                                                    \
  90                 SETERRNO(EBADF, SS_IVCHAN);                     \
  91         return failure
  92
  93 /* Call the callback or PerlIOBase, and be void. */
  94 #define Perl_PerlIO_or_Base_void(f, callback, base, args)       \
  95         if (PerlIOValid(f)) {                                   \
  96                 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
  97                 if (tab && tab->callback)                       \
  98                         (*tab->callback) args;                  \
  99                 else                                            \
 100                         PerlIOBase_ ## base args;               \
 101         }                                                       \
 102         else                                                    \
 103                 SETERRNO(EBADF, SS_IVCHAN)
 104
 105 /* Call the callback or fail, and be void. */
 106 #define Perl_PerlIO_or_fail_void(f, callback, args)             \
 107         if (PerlIOValid(f)) {                                   \
 108                 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
 109                 if (tab && tab->callback)                       \
 110                         (*tab->callback) args;                  \
 111                 else                                            \
 112                         SETERRNO(EINVAL, LIB_INVARG);           \
 113         }                                                       \
 114         else                                                    \
 115                 SETERRNO(EBADF, SS_IVCHAN)
 116
 117 #if defined(__osf__) && _XOPEN_SOURCE < 500
 118 extern int   fseeko(FILE *, off_t, int);
 119 extern off_t ftello(FILE *);
 120 #endif
 121
 122 #ifndef USE_SFIO
 123
 124 EXTERN_C int perlsio_binmode(FILE *fp, int iotype, int mode);
 125
 126 int
 127 perlsio_binmode(FILE *fp, int iotype, int mode)
 128 {
 129     /*
 130      * This used to be contents of do_binmode in doio.c
 131      */
 132 #ifdef DOSISH
 133 #  if defined(atarist) || defined(__MINT__)
 134     if (!fflush(fp)) {
 135         if (mode & O_BINARY)
 136             ((FILE *) fp)->_flag |= _IOBIN;
 137         else
 138             ((FILE *) fp)->_flag &= ~_IOBIN;
 139         return 1;
 140     }
 141     return 0;
 142 #  else
 143     dTHX;
 144 #ifdef NETWARE
 145     if (PerlLIO_setmode(fp, mode) != -1) {
 146 #else
 147     if (PerlLIO_setmode(fileno(fp), mode) != -1) {
 148 #endif
 149 #    if defined(WIN32) && defined(__BORLANDC__)
 150         /*
 151          * The translation mode of the stream is maintained independent
 152 of
 153          * the translation mode of the fd in the Borland RTL (heavy
 154          * digging through their runtime sources reveal).  User has to
 155 set
 156          * the mode explicitly for the stream (though they don't
 157 document
 158          * this anywhere). GSAR 97-5-24
 159          */
 160         fseek(fp, 0L, 0);
 161         if (mode & O_BINARY)
 162             fp->flags |= _F_BIN;
 163         else
 164             fp->flags &= ~_F_BIN;
 165 #    endif
 166         return 1;
 167     }
 168     else
 169         return 0;
 170 #  endif
 171 #else
 172 #  if defined(USEMYBINMODE)
 173     dTHX;
 174     if (my_binmode(fp, iotype, mode) != FALSE)
 175         return 1;
 176     else
 177         return 0;
 178 #  else
 179     PERL_UNUSED_ARG(fp);
 180     PERL_UNUSED_ARG(iotype);
 181     PERL_UNUSED_ARG(mode);
 182     return 1;
 183 #  endif
 184 #endif
 185 }
 186 #endif /* sfio */
 187
 188 #ifndef O_ACCMODE
 189 #define O_ACCMODE 3             /* Assume traditional implementation */
 190 #endif
 191
 192 int
 193 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
 194 {
 195     const int result = rawmode & O_ACCMODE;
 196     int ix = 0;
 197     int ptype;
 198     switch (result) {
 199     case O_RDONLY:
 200         ptype = IoTYPE_RDONLY;
 201         break;
 202     case O_WRONLY:
 203         ptype = IoTYPE_WRONLY;
 204         break;
 205     case O_RDWR:
 206     default:
 207         ptype = IoTYPE_RDWR;
 208         break;
 209     }
 210     if (writing)
 211         *writing = (result != O_RDONLY);
 212
 213     if (result == O_RDONLY) {
 214         mode[ix++] = 'r';
 215     }
 216 #ifdef O_APPEND
 217     else if (rawmode & O_APPEND) {
 218         mode[ix++] = 'a';
 219         if (result != O_WRONLY)
 220             mode[ix++] = '+';
 221     }
 222 #endif
 223     else {
 224         if (result == O_WRONLY)
 225             mode[ix++] = 'w';
 226         else {
 227             mode[ix++] = 'r';
 228             mode[ix++] = '+';
 229         }
 230     }
 231     if (rawmode & O_BINARY)
 232         mode[ix++] = 'b';
 233     mode[ix] = '\0';
 234     return ptype;
 235 }
 236
 237 #ifndef PERLIO_LAYERS
 238 int
 239 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
 240 {
 241     if (!names || !*names
 242         || strEQ(names, ":crlf")
 243         || strEQ(names, ":raw")
 244         || strEQ(names, ":bytes")
 245        ) {
 246         return 0;
 247     }
 248     Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
 249     /*
 250      * NOTREACHED
 251      */
 252     return -1;
 253 }
 254
 255 void
 256 PerlIO_destruct(pTHX)
 257 {
 258 }
 259
 260 int
 261 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
 262 {
 263 #ifdef USE_SFIO
 264     PERL_UNUSED_ARG(iotype);
 265     PERL_UNUSED_ARG(mode);
 266     PERL_UNUSED_ARG(names);
 267     return 1;
 268 #else
 269     return perlsio_binmode(fp, iotype, mode);
 270 #endif
 271 }
 272
 273 PerlIO *
 274 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
 275 {
 276 #if defined(PERL_MICRO) || defined(__SYMBIAN32__)
 277     return NULL;
 278 #else
 279 #ifdef PERL_IMPLICIT_SYS
 280     return PerlSIO_fdupopen(f);
 281 #else
 282 #ifdef WIN32
 283     return win32_fdupopen(f);
 284 #else
 285     if (f) {
 286         const int fd = PerlLIO_dup(PerlIO_fileno(f));
 287         if (fd >= 0) {
 288             char mode[8];
 289 #ifdef DJGPP
 290             const int omode = djgpp_get_stream_mode(f);
 291 #else
 292             const int omode = fcntl(fd, F_GETFL);
 293 #endif
 294             PerlIO_intmode2str(omode,mode,NULL);
 295             /* the r+ is a hack */
 296             return PerlIO_fdopen(fd, mode);
 297         }
 298         return NULL;
 299     }
 300     else {
 301         SETERRNO(EBADF, SS_IVCHAN);
 302     }
 303 #endif
 304     return NULL;
 305 #endif
 306 #endif
 307 }
 308
 309
 310 /*
 311  * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
 312  */
 313
 314 PerlIO *
 315 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
 316              int imode, int perm, PerlIO *old, int narg, SV **args)
 317 {
 318     if (narg) {
 319         if (narg > 1) {
 320             Perl_croak(aTHX_ "More than one argument to open");
 321         }
 322         if (*args == &PL_sv_undef)
 323             return PerlIO_tmpfile();
 324         else {
 325             const char *name = SvPV_nolen_const(*args);
 326             if (*mode == IoTYPE_NUMERIC) {
 327                 fd = PerlLIO_open3(name, imode, perm);
 328                 if (fd >= 0)
 329                     return PerlIO_fdopen(fd, mode + 1);
 330             }
 331             else if (old) {
 332                 return PerlIO_reopen(name, mode, old);
 333             }
 334             else {
 335                 return PerlIO_open(name, mode);
 336             }
 337         }
 338     }
 339     else {
 340         return PerlIO_fdopen(fd, (char *) mode);
 341     }
 342     return NULL;
 343 }
 344
 345 XS(XS_PerlIO__Layer__find)
 346 {
 347     dXSARGS;
 348     if (items < 2)
 349         Perl_croak(aTHX_ "Usage class->find(name[,load])");
 350     else {
 351         const char * const name = SvPV_nolen_const(ST(1));
 352         ST(0) = (strEQ(name, "crlf")
 353                  || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
 354         XSRETURN(1);
 355     }
 356 }
 357
 358
 359 void
 360 Perl_boot_core_PerlIO(pTHX)
 361 {
 362     newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
 363 }
 364
 365 #endif
 366
 367
 368 #ifdef PERLIO_IS_STDIO
 369
 370 void
 371 PerlIO_init(pTHX)
 372 {
 373     PERL_UNUSED_CONTEXT;
 374     /*
 375      * Does nothing (yet) except force this file to be included in perl
 376      * binary. That allows this file to force inclusion of other functions
 377      * that may be required by loadable extensions e.g. for
 378      * FileHandle::tmpfile
 379      */
 380 }
 381
 382 #undef PerlIO_tmpfile
 383 PerlIO *
 384 PerlIO_tmpfile(void)
 385 {
 386     return tmpfile();
 387 }
 388
 389 #else                           /* PERLIO_IS_STDIO */
 390
 391 #ifdef USE_SFIO
 392
 393 #undef HAS_FSETPOS
 394 #undef HAS_FGETPOS
 395
 396 /*
 397  * This section is just to make sure these functions get pulled in from
 398  * libsfio.a
 399  */
 400
 401 #undef PerlIO_tmpfile
 402 PerlIO *
 403 PerlIO_tmpfile(void)
 404 {
 405     return sftmp(0);
 406 }
 407
 408 void
 409 PerlIO_init(pTHX)
 410 {
 411     PERL_UNUSED_CONTEXT;
 412     /*
 413      * Force this file to be included in perl binary. Which allows this
 414      * file to force inclusion of other functions that may be required by
 415      * loadable extensions e.g. for FileHandle::tmpfile
 416      */
 417
 418     /*
 419      * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
 420      * results in a lot of lseek()s to regular files and lot of small
 421      * writes to pipes.
 422      */
 423     sfset(sfstdout, SF_SHARE, 0);
 424 }
 425
 426 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
 427 PerlIO *
 428 PerlIO_importFILE(FILE *stdio, const char *mode)
 429 {
 430     const int fd = fileno(stdio);
 431     if (!mode || !*mode) {
 432         mode = "r+";
 433     }
 434     return PerlIO_fdopen(fd, mode);
 435 }
 436
 437 FILE *
 438 PerlIO_findFILE(PerlIO *pio)
 439 {
 440     const int fd = PerlIO_fileno(pio);
 441     FILE * const f = fdopen(fd, "r+");
 442     PerlIO_flush(pio);
 443     if (!f && errno == EINVAL)
 444         f = fdopen(fd, "w");
 445     if (!f && errno == EINVAL)
 446         f = fdopen(fd, "r");
 447     return f;
 448 }
 449
 450
 451 #else                           /* USE_SFIO */
 452 /*======================================================================================*/
 453 /*
 454  * Implement all the PerlIO interface ourselves.
 455  */
 456
 457 #include "perliol.h"
 458
 459 /*
 460  * We _MUST_ have <unistd.h> if we are using lseek() and may have large
 461  * files
 462  */
 463 #ifdef I_UNISTD
 464 #include <unistd.h>
 465 #endif
 466 #ifdef HAS_MMAP
 467 #include <sys/mman.h>
 468 #endif
 469
 470 void
 471 PerlIO_debug(const char *fmt, ...)
 472 {
 473     va_list ap;
 474     dSYS;
 475     va_start(ap, fmt);
 476     if (!PL_perlio_debug_fd) {
 477         if (!PL_tainting && PL_uid == PL_euid && PL_gid == PL_egid) {
 478             const char * const s = PerlEnv_getenv("PERLIO_DEBUG");
 479             if (s && *s)
 480                 PL_perlio_debug_fd
 481                     = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
 482             else
 483                 PL_perlio_debug_fd = -1;
 484         } else {
 485             /* tainting or set*id, so ignore the environment, and ensure we
 486                skip these tests next time through.  */
 487             PL_perlio_debug_fd = -1;
 488         }
 489     }
 490     if (PL_perlio_debug_fd > 0) {
 491         dTHX;
 492 #ifdef USE_ITHREADS
 493         const char * const s = CopFILE(PL_curcop);
 494         /* Use fixed buffer as sv_catpvf etc. needs SVs */
 495         char buffer[1024];
 496         const STRLEN len1 = my_snprintf(buffer, sizeof(buffer), "%.40s:%" IVdf " ", s ? s : "(none)", (IV) CopLINE(PL_curcop));
 497         const STRLEN len2 = my_vsnprintf(buffer + len1, sizeof(buffer) - len1, fmt, ap);
 498         PerlLIO_write(PL_perlio_debug_fd, buffer, len1 + len2);
 499 #else
 500         const char *s = CopFILE(PL_curcop);
 501         STRLEN len;
 502         SV * const sv = newSVpvs("");
 503         Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s ? s : "(none)",
 504                        (IV) CopLINE(PL_curcop));
 505         Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
 506
 507         s = SvPV_const(sv, len);
 508         PerlLIO_write(PL_perlio_debug_fd, s, len);
 509         SvREFCNT_dec(sv);
 510 #endif
 511     }
 512     va_end(ap);
 513 }
 514
 515 /*--------------------------------------------------------------------------------------*/
 516
 517 /*
 518  * Inner level routines
 519  */
 520
 521 /*
 522  * Table of pointers to the PerlIO structs (malloc'ed)
 523  */
 524 #define PERLIO_TABLE_SIZE 64
 525
 526 PerlIO *
 527 PerlIO_allocate(pTHX)
 528 {
 529     dVAR;
 530     /*
 531      * Find a free slot in the table, allocating new table as necessary
 532      */
 533     PerlIO **last;
 534     PerlIO *f;
 535     last = &PL_perlio;
 536     while ((f = *last)) {
 537         int i;
 538         last = (PerlIO **) (f);
 539         for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
 540             if (!*++f) {
 541                 return f;
 542             }
 543         }
 544     }
 545     Newxz(f,PERLIO_TABLE_SIZE,PerlIO);
 546     if (!f) {
 547         return NULL;
 548     }
 549     *last = f;
 550     return f + 1;
 551 }
 552
 553 #undef PerlIO_fdupopen
 554 PerlIO *
 555 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
 556 {
 557     if (PerlIOValid(f)) {
 558         const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
 559         PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
 560         if (tab && tab->Dup)
 561              return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
 562         else {
 563              return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
 564         }
 565     }
 566     else
 567          SETERRNO(EBADF, SS_IVCHAN);
 568
 569     return NULL;
 570 }
 571
 572 void
 573 PerlIO_cleantable(pTHX_ PerlIO **tablep)
 574 {
 575     PerlIO * const table = *tablep;
 576     if (table) {
 577         int i;
 578         PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
 579         for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
 580             PerlIO * const f = table + i;
 581             if (*f) {
 582                 PerlIO_close(f);
 583             }
 584         }
 585         Safefree(table);
 586         *tablep = NULL;
 587     }
 588 }
 589
 590
 591 PerlIO_list_t *
 592 PerlIO_list_alloc(pTHX)
 593 {
 594     PerlIO_list_t *list;
 595     PERL_UNUSED_CONTEXT;
 596     Newxz(list, 1, PerlIO_list_t);
 597     list->refcnt = 1;
 598     return list;
 599 }
 600
 601 void
 602 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
 603 {
 604     if (list) {
 605         if (--list->refcnt == 0) {
 606             if (list->array) {
 607                 IV i;
 608                 for (i = 0; i < list->cur; i++) {
 609                     if (list->array[i].arg)
 610                         SvREFCNT_dec(list->array[i].arg);
 611                 }
 612                 Safefree(list->array);
 613             }
 614             Safefree(list);
 615         }
 616     }
 617 }
 618
 619 void
 620 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
 621 {
 622     dVAR;
 623     PerlIO_pair_t *p;
 624     PERL_UNUSED_CONTEXT;
 625
 626     if (list->cur >= list->len) {
 627         list->len += 8;
 628         if (list->array)
 629             Renew(list->array, list->len, PerlIO_pair_t);
 630         else
 631             Newx(list->array, list->len, PerlIO_pair_t);
 632     }
 633     p = &(list->array[list->cur++]);
 634     p->funcs = funcs;
 635     if ((p->arg = arg)) {
 636         SvREFCNT_inc_simple_void_NN(arg);
 637     }
 638 }
 639
 640 PerlIO_list_t *
 641 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
 642 {
 643     PerlIO_list_t *list = NULL;
 644     if (proto) {
 645         int i;
 646         list = PerlIO_list_alloc(aTHX);
 647         for (i=0; i < proto->cur; i++) {
 648             SV *arg = NULL;
 649             if (proto->array[i].arg)
 650                 arg = PerlIO_sv_dup(aTHX_ proto->array[i].arg,param);
 651             PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
 652         }
 653     }
 654     return list;
 655 }
 656
 657 void
 658 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
 659 {
 660 #ifdef USE_ITHREADS
 661     PerlIO **table = &proto->Iperlio;
 662     PerlIO *f;
 663     PL_perlio = NULL;
 664     PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
 665     PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
 666     PerlIO_allocate(aTHX); /* root slot is never used */
 667     PerlIO_debug("Clone %p from %p\n",(void*)aTHX,(void*)proto);
 668     while ((f = *table)) {
 669             int i;
 670             table = (PerlIO **) (f++);
 671             for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
 672                 if (*f) {
 673                     (void) fp_dup(f, 0, param);
 674                 }
 675                 f++;
 676             }
 677         }
 678 #else
 679     PERL_UNUSED_CONTEXT;
 680     PERL_UNUSED_ARG(proto);
 681     PERL_UNUSED_ARG(param);
 682 #endif
 683 }
 684
 685 void
 686 PerlIO_destruct(pTHX)
 687 {
 688     dVAR;
 689     PerlIO **table = &PL_perlio;
 690     PerlIO *f;
 691 #ifdef USE_ITHREADS
 692     PerlIO_debug("Destruct %p\n",(void*)aTHX);
 693 #endif
 694     while ((f = *table)) {
 695         int i;
 696         table = (PerlIO **) (f++);
 697         for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
 698             PerlIO *x = f;
 699             const PerlIOl *l;
 700             while ((l = *x)) {
 701                 if (l->tab->kind & PERLIO_K_DESTRUCT) {
 702                     PerlIO_debug("Destruct popping %s\n", l->tab->name);
 703                     PerlIO_flush(x);
 704                     PerlIO_pop(aTHX_ x);
 705                 }
 706                 else {
 707                     x = PerlIONext(x);
 708                 }
 709             }
 710             f++;
 711         }
 712     }
 713 }
 714
 715 void
 716 PerlIO_pop(pTHX_ PerlIO *f)
 717 {
 718     const PerlIOl *l = *f;
 719     if (l) {
 720         PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
 721         if (l->tab->Popped) {
 722             /*
 723              * If popped returns non-zero do not free its layer structure
 724              * it has either done so itself, or it is shared and still in
 725              * use
 726              */
 727             if ((*l->tab->Popped) (aTHX_ f) != 0)
 728                 return;
 729         }
 730         *f = l->next;
 731         Safefree(l);
 732     }
 733 }
 734
 735 /* Return as an array the stack of layers on a filehandle.  Note that
 736  * the stack is returned top-first in the array, and there are three
 737  * times as many array elements as there are layers in the stack: the
 738  * first element of a layer triplet is the name, the second one is the
 739  * arguments, and the third one is the flags. */
 740
 741 AV *
 742 PerlIO_get_layers(pTHX_ PerlIO *f)
 743 {
 744     dVAR;
 745     AV * const av = newAV();
 746
 747     if (PerlIOValid(f)) {
 748         PerlIOl *l = PerlIOBase(f);
 749
 750         while (l) {
 751             SV * const name = l->tab && l->tab->name ?
 752             newSVpv(l->tab->name, 0) : &PL_sv_undef;
 753             SV * const arg = l->tab && l->tab->Getarg ?
 754             (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
 755             av_push(av, name);
 756             av_push(av, arg);
 757             av_push(av, newSViv((IV)l->flags));
 758             l = l->next;
 759         }
 760     }
 761
 762     return av;
 763 }
 764
 765 /*--------------------------------------------------------------------------------------*/
 766 /*
 767  * XS Interface for perl code
 768  */
 769
 770 PerlIO_funcs *
 771 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
 772 {
 773     dVAR;
 774     IV i;
 775     if ((SSize_t) len <= 0)
 776         len = strlen(name);
 777     for (i = 0; i < PL_known_layers->cur; i++) {
 778         PerlIO_funcs * const f = PL_known_layers->array[i].funcs;
 779         if (memEQ(f->name, name, len) && f->name[len] == 0) {
 780             PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
 781             return f;
 782         }
 783     }
 784     if (load && PL_subname && PL_def_layerlist
 785         && PL_def_layerlist->cur >= 2) {
 786         if (PL_in_load_module) {
 787             Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
 788             return NULL;
 789         } else {
 790             SV * const pkgsv = newSVpvs("PerlIO");
 791             SV * const layer = newSVpvn(name, len);
 792             CV * const cv    = get_cv("PerlIO::Layer::NoWarnings", FALSE);
 793             ENTER;
 794             SAVEINT(PL_in_load_module);
 795             if (cv) {
 796                 SAVEGENERICSV(PL_warnhook);
 797                 PL_warnhook = (SV *) (SvREFCNT_inc_simple_NN(cv));
 798             }
 799             PL_in_load_module++;
 800             /*
 801              * The two SVs are magically freed by load_module
 802              */
 803             Perl_load_module(aTHX_ 0, pkgsv, NULL, layer, NULL);
 804             PL_in_load_module--;
 805             LEAVE;
 806             return PerlIO_find_layer(aTHX_ name, len, 0);
 807         }
 808     }
 809     PerlIO_debug("Cannot find %.*s\n", (int) len, name);
 810     return NULL;
 811 }
 812
 813 #ifdef USE_ATTRIBUTES_FOR_PERLIO
 814
 815 static int
 816 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
 817 {
 818     if (SvROK(sv)) {
 819         IO * const io = GvIOn((GV *) SvRV(sv));
 820         PerlIO * const ifp = IoIFP(io);
 821         PerlIO * const ofp = IoOFP(io);
 822         Perl_warn(aTHX_ "set %" SVf " %p %p %p",
 823                   SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
 824     }
 825     return 0;
 826 }
 827
 828 static int
 829 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
 830 {
 831     if (SvROK(sv)) {
 832         IO * const io = GvIOn((GV *) SvRV(sv));
 833         PerlIO * const ifp = IoIFP(io);
 834         PerlIO * const ofp = IoOFP(io);
 835         Perl_warn(aTHX_ "get %" SVf " %p %p %p",
 836                   SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
 837     }
 838     return 0;
 839 }
 840
 841 static int
 842 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
 843 {
 844     Perl_warn(aTHX_ "clear %" SVf, SVfARG(sv));
 845     return 0;
 846 }
 847
 848 static int
 849 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
 850 {
 851     Perl_warn(aTHX_ "free %" SVf, SVfARG(sv));
 852     return 0;
 853 }
 854
 855 MGVTBL perlio_vtab = {
 856     perlio_mg_get,
 857     perlio_mg_set,
 858     NULL,                       /* len */
 859     perlio_mg_clear,
 860     perlio_mg_free
 861 };
 862
 863 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
 864 {
 865     dXSARGS;
 866     SV * const sv = SvRV(ST(1));
 867     AV * const av = newAV();
 868     MAGIC *mg;
 869     int count = 0;
 870     int i;
 871     sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
 872     SvRMAGICAL_off(sv);
 873     mg = mg_find(sv, PERL_MAGIC_ext);
 874     mg->mg_virtual = &perlio_vtab;
 875     mg_magical(sv);
 876     Perl_warn(aTHX_ "attrib %" SVf, SVfARG(sv));
 877     for (i = 2; i < items; i++) {
 878         STRLEN len;
 879         const char * const name = SvPV_const(ST(i), len);
 880         SV * const layer = PerlIO_find_layer(aTHX_ name, len, 1);
 881         if (layer) {
 882             av_push(av, SvREFCNT_inc_simple_NN(layer));
 883         }
 884         else {
 885             ST(count) = ST(i);
 886             count++;
 887         }
 888     }
 889     SvREFCNT_dec(av);
 890     XSRETURN(count);
 891 }
 892
 893 #endif                          /* USE_ATTIBUTES_FOR_PERLIO */
 894
 895 SV *
 896 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
 897 {
 898     HV * const stash = gv_stashpvs("PerlIO::Layer", TRUE);
 899     SV * const sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
 900     return sv;
 901 }
 902
 903 XS(XS_PerlIO__Layer__NoWarnings)
 904 {
 905     /* This is used as a %SIG{__WARN__} handler to supress warnings
 906        during loading of layers.
 907      */
 908     dVAR;
 909     dXSARGS;
 910     if (items)
 911         PerlIO_debug("warning:%s\n",SvPV_nolen_const(ST(0)));
 912     XSRETURN(0);
 913 }
 914
 915 XS(XS_PerlIO__Layer__find)
 916 {
 917     dVAR;
 918     dXSARGS;
 919     if (items < 2)
 920         Perl_croak(aTHX_ "Usage class->find(name[,load])");
 921     else {
 922         STRLEN len;
 923         const char * const name = SvPV_const(ST(1), len);
 924         const bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
 925         PerlIO_funcs * const layer = PerlIO_find_layer(aTHX_ name, len, load);
 926         ST(0) =
 927             (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
 928             &PL_sv_undef;
 929         XSRETURN(1);
 930     }
 931 }
 932
 933 void
 934 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
 935 {
 936     dVAR;
 937     if (!PL_known_layers)
 938         PL_known_layers = PerlIO_list_alloc(aTHX);
 939     PerlIO_list_push(aTHX_ PL_known_layers, tab, NULL);
 940     PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
 941 }
 942
 943 int
 944 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
 945 {
 946     dVAR;
 947     if (names) {
 948         const char *s = names;
 949         while (*s) {
 950             while (isSPACE(*s) || *s == ':')
 951                 s++;
 952             if (*s) {
 953                 STRLEN llen = 0;
 954                 const char *e = s;
 955                 const char *as = NULL;
 956                 STRLEN alen = 0;
 957                 if (!isIDFIRST(*s)) {
 958                     /*
 959                      * Message is consistent with how attribute lists are
 960                      * passed. Even though this means "foo : : bar" is
 961                      * seen as an invalid separator character.
 962                      */
 963                     const char q = ((*s == '\'') ? '"' : '\'');
 964                     if (ckWARN(WARN_LAYER))
 965                         Perl_warner(aTHX_ packWARN(WARN_LAYER),
 966                               "Invalid separator character %c%c%c in PerlIO layer specification %s",
 967                               q, *s, q, s);
 968                     SETERRNO(EINVAL, LIB_INVARG);
 969                     return -1;
 970                 }
 971                 do {
 972                     e++;
 973                 } while (isALNUM(*e));
 974                 llen = e - s;
 975                 if (*e == '(') {
 976                     int nesting = 1;
 977                     as = ++e;
 978                     while (nesting) {
 979                         switch (*e++) {
 980                         case ')':
 981                             if (--nesting == 0)
 982                                 alen = (e - 1) - as;
 983                             break;
 984                         case '(':
 985                             ++nesting;
 986                             break;
 987                         case '\\':
 988                             /*
 989                              * It's a nul terminated string, not allowed
 990                              * to \ the terminating null. Anything other
 991                              * character is passed over.
 992                              */
 993                             if (*e++) {
 994                                 break;
 995                             }
 996                             /*
 997                              * Drop through
 998                              */
 999                         case '\0':
1000                             e--;
1001                             if (ckWARN(WARN_LAYER))
1002                                 Perl_warner(aTHX_ packWARN(WARN_LAYER),
1003                                       "Argument list not closed for PerlIO layer \"%.*s\"",
1004                                       (int) (e - s), s);
1005                             return -1;
1006                         default:
1007                             /*
1008                              * boring.
1009                              */
1010                             break;
1011                         }
1012                     }
1013                 }
1014                 if (e > s) {
1015                     PerlIO_funcs * const layer =
1016                         PerlIO_find_layer(aTHX_ s, llen, 1);
1017                     if (layer) {
1018                         PerlIO_list_push(aTHX_ av, layer,
1019                                          (as) ? newSVpvn(as,
1020                                                          alen) :
1021                                          &PL_sv_undef);
1022                     }
1023                     else {
1024                         if (ckWARN(WARN_LAYER))
1025                             Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
1026                                   (int) llen, s);
1027                         return -1;
1028                     }
1029                 }
1030                 s = e;
1031             }
1032         }
1033     }
1034     return 0;
1035 }
1036
1037 void
1038 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
1039 {
1040     dVAR;
1041     PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
1042 #ifdef PERLIO_USING_CRLF
1043     tab = &PerlIO_crlf;
1044 #else
1045     if (PerlIO_stdio.Set_ptrcnt)
1046         tab = &PerlIO_stdio;
1047 #endif
1048     PerlIO_debug("Pushing %s\n", tab->name);
1049     PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1050                      &PL_sv_undef);
1051 }
1052
1053 SV *
1054 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1055 {
1056     return av->array[n].arg;
1057 }
1058
1059 PerlIO_funcs *
1060 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1061 {
1062     if (n >= 0 && n < av->cur) {
1063         PerlIO_debug("Layer %" IVdf " is %s\n", n,
1064                      av->array[n].funcs->name);
1065         return av->array[n].funcs;
1066     }
1067     if (!def)
1068         Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1069     return def;
1070 }
1071
1072 IV
1073 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1074 {
1075     PERL_UNUSED_ARG(mode);
1076     PERL_UNUSED_ARG(arg);
1077     PERL_UNUSED_ARG(tab);
1078     if (PerlIOValid(f)) {
1079         PerlIO_flush(f);
1080         PerlIO_pop(aTHX_ f);
1081         return 0;
1082     }
1083     return -1;
1084 }
1085
1086 PERLIO_FUNCS_DECL(PerlIO_remove) = {
1087     sizeof(PerlIO_funcs),
1088     "pop",
1089     0,
1090     PERLIO_K_DUMMY | PERLIO_K_UTF8,
1091     PerlIOPop_pushed,
1092     NULL,
1093     NULL,
1094     NULL,
1095     NULL,
1096     NULL,
1097     NULL,
1098     NULL,
1099     NULL,
1100     NULL,
1101     NULL,
1102     NULL,
1103     NULL,
1104     NULL,                       /* flush */
1105     NULL,                       /* fill */
1106     NULL,
1107     NULL,
1108     NULL,
1109     NULL,
1110     NULL,                       /* get_base */
1111     NULL,                       /* get_bufsiz */
1112     NULL,                       /* get_ptr */
1113     NULL,                       /* get_cnt */
1114     NULL,                       /* set_ptrcnt */
1115 };
1116
1117 PerlIO_list_t *
1118 PerlIO_default_layers(pTHX)
1119 {
1120     dVAR;
1121     if (!PL_def_layerlist) {
1122         const char * const s = (PL_tainting) ? NULL : PerlEnv_getenv("PERLIO");
1123         PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1124         PL_def_layerlist = PerlIO_list_alloc(aTHX);
1125         PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1126 #if defined(WIN32)
1127         PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1128 #if 0
1129         osLayer = &PerlIO_win32;
1130 #endif
1131 #endif
1132         PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1133         PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1134         PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1135         PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1136 #ifdef HAS_MMAP
1137         PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_mmap));
1138 #endif
1139         PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1140         PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1141         PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1142         PerlIO_list_push(aTHX_ PL_def_layerlist,
1143                          PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1144                          &PL_sv_undef);
1145         if (s) {
1146             PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1147         }
1148         else {
1149             PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1150         }
1151     }
1152     if (PL_def_layerlist->cur < 2) {
1153         PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1154     }
1155     return PL_def_layerlist;
1156 }
1157
1158 void
1159 Perl_boot_core_PerlIO(pTHX)
1160 {
1161 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1162     newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1163           __FILE__);
1164 #endif
1165     newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1166     newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1167 }
1168
1169 PerlIO_funcs *
1170 PerlIO_default_layer(pTHX_ I32 n)
1171 {
1172     dVAR;
1173     PerlIO_list_t * const av = PerlIO_default_layers(aTHX);
1174     if (n < 0)
1175         n += av->cur;
1176     return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1177 }
1178
1179 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1180 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1181
1182 void
1183 PerlIO_stdstreams(pTHX)
1184 {
1185     dVAR;
1186     if (!PL_perlio) {
1187         PerlIO_allocate(aTHX);
1188         PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1189         PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1190         PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1191     }
1192 }
1193
1194 PerlIO *
1195 PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1196 {
1197     if (tab->fsize != sizeof(PerlIO_funcs)) {
1198       mismatch:
1199         Perl_croak(aTHX_ "Layer does not match this perl");
1200     }
1201     if (tab->size) {
1202         PerlIOl *l;
1203         if (tab->size < sizeof(PerlIOl)) {
1204             goto mismatch;
1205         }
1206         /* Real layer with a data area */
1207         if (f) {
1208             char *temp;
1209             Newxz(temp, tab->size, char);
1210             l = (PerlIOl*)temp;
1211             if (l) {
1212                 l->next = *f;
1213                 l->tab = (PerlIO_funcs*) tab;
1214                 *f = l;
1215                 PerlIO_debug("PerlIO_push f=%p %s %s %p\n",
1216                              (void*)f, tab->name,
1217                              (mode) ? mode : "(Null)", (void*)arg);
1218                 if (*l->tab->Pushed &&
1219                     (*l->tab->Pushed)
1220                       (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1221                     PerlIO_pop(aTHX_ f);
1222                     return NULL;
1223                 }
1224             }
1225             else
1226                 return NULL;
1227         }
1228     }
1229     else if (f) {
1230         /* Pseudo-layer where push does its own stack adjust */
1231         PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1232                      (mode) ? mode : "(Null)", (void*)arg);
1233         if (tab->Pushed &&
1234             (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1235              return NULL;
1236         }
1237     }
1238     return f;
1239 }
1240
1241 IV
1242 PerlIOBase_binmode(pTHX_ PerlIO *f)
1243 {
1244    if (PerlIOValid(f)) {
1245         /* Is layer suitable for raw stream ? */
1246         if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1247             /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1248             PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1249         }
1250         else {
1251             /* Not suitable - pop it */
1252             PerlIO_pop(aTHX_ f);
1253         }
1254         return 0;
1255    }
1256    return -1;
1257 }
1258
1259 IV
1260 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1261 {
1262     PERL_UNUSED_ARG(mode);
1263     PERL_UNUSED_ARG(arg);
1264     PERL_UNUSED_ARG(tab);
1265
1266     if (PerlIOValid(f)) {
1267         PerlIO *t;
1268         const PerlIOl *l;
1269         PerlIO_flush(f);
1270         /*
1271          * Strip all layers that are not suitable for a raw stream
1272          */
1273         t = f;
1274         while (t && (l = *t)) {
1275             if (l->tab->Binmode) {
1276                 /* Has a handler - normal case */
1277                 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1278                     if (*t == l) {
1279                         /* Layer still there - move down a layer */
1280                         t = PerlIONext(t);
1281                     }
1282                 }
1283                 else {
1284                     return -1;
1285                 }
1286             }
1287             else {
1288                 /* No handler - pop it */
1289                 PerlIO_pop(aTHX_ t);
1290             }
1291         }
1292         if (PerlIOValid(f)) {
1293             PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1294             return 0;
1295         }
1296     }
1297     return -1;
1298 }
1299
1300 int
1301 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1302                     PerlIO_list_t *layers, IV n, IV max)
1303 {
1304     int code = 0;
1305     while (n < max) {
1306         PerlIO_funcs * const tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1307         if (tab) {
1308             if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1309                 code = -1;
1310                 break;
1311             }
1312         }
1313         n++;
1314     }
1315     return code;
1316 }
1317
1318 int
1319 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1320 {
1321     int code = 0;
1322     if (f && names) {
1323         PerlIO_list_t * const layers = PerlIO_list_alloc(aTHX);
1324         code = PerlIO_parse_layers(aTHX_ layers, names);
1325         if (code == 0) {
1326             code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1327         }
1328         PerlIO_list_free(aTHX_ layers);
1329     }
1330     return code;
1331 }
1332
1333
1334 /*--------------------------------------------------------------------------------------*/
1335 /*
1336  * Given the abstraction above the public API functions
1337  */
1338
1339 int
1340 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1341 {
1342     PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n", (void*)f,
1343                  (PerlIOBase(f)) ? PerlIOBase(f)->tab->name : "(Null)",
1344                  iotype, mode, (names) ? names : "(Null)");
1345
1346     if (names) {
1347         /* Do not flush etc. if (e.g.) switching encodings.
1348            if a pushed layer knows it needs to flush lower layers
1349            (for example :unix which is never going to call them)
1350            it can do the flush when it is pushed.
1351          */
1352         return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1353     }
1354     else {
1355         /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1356 #ifdef PERLIO_USING_CRLF
1357         /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1358            O_BINARY so we can look for it in mode.
1359          */
1360         if (!(mode & O_BINARY)) {
1361             /* Text mode */
1362             /* FIXME?: Looking down the layer stack seems wrong,
1363                but is a way of reaching past (say) an encoding layer
1364                to flip CRLF-ness of the layer(s) below
1365              */
1366             while (*f) {
1367                 /* Perhaps we should turn on bottom-most aware layer
1368                    e.g. Ilya's idea that UNIX TTY could serve
1369                  */
1370                 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1371                     if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1372                         /* Not in text mode - flush any pending stuff and flip it */
1373                         PerlIO_flush(f);
1374                         PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1375                     }
1376                     /* Only need to turn it on in one layer so we are done */
1377                     return TRUE;
1378                 }
1379                 f = PerlIONext(f);
1380             }
1381             /* Not finding a CRLF aware layer presumably means we are binary
1382                which is not what was requested - so we failed
1383                We _could_ push :crlf layer but so could caller
1384              */
1385             return FALSE;
1386         }
1387 #endif
1388         /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1389            So code that used to be here is now in PerlIORaw_pushed().
1390          */
1391         return PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), NULL, NULL) ? TRUE : FALSE;
1392     }
1393 }
1394
1395 int
1396 PerlIO__close(pTHX_ PerlIO *f)
1397 {
1398     if (PerlIOValid(f)) {
1399         PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1400         if (tab && tab->Close)
1401             return (*tab->Close)(aTHX_ f);
1402         else
1403             return PerlIOBase_close(aTHX_ f);
1404     }
1405     else {
1406         SETERRNO(EBADF, SS_IVCHAN);
1407         return -1;
1408     }
1409 }
1410
1411 int
1412 Perl_PerlIO_close(pTHX_ PerlIO *f)
1413 {
1414     const int code = PerlIO__close(aTHX_ f);
1415     while (PerlIOValid(f)) {
1416         PerlIO_pop(aTHX_ f);
1417     }
1418     return code;
1419 }
1420
1421 int
1422 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1423 {
1424     dVAR;
1425      Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1426 }
1427
1428
1429 static PerlIO_funcs *
1430 PerlIO_layer_from_ref(pTHX_ SV *sv)
1431 {
1432     dVAR;
1433     /*
1434      * For any scalar type load the handler which is bundled with perl
1435      */
1436     if (SvTYPE(sv) < SVt_PVAV) {
1437         PerlIO_funcs *f = PerlIO_find_layer(aTHX_ STR_WITH_LEN("scalar"), 1);
1438         /* This isn't supposed to happen, since PerlIO::scalar is core,
1439          * but could happen anyway in smaller installs or with PAR */
1440         if (!f && ckWARN(WARN_LAYER))
1441             Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"scalar\"");
1442         return f;
1443     }
1444
1445     /*
1446      * For other types allow if layer is known but don't try and load it
1447      */
1448     switch (SvTYPE(sv)) {
1449     case SVt_PVAV:
1450         return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Array"), 0);
1451     case SVt_PVHV:
1452         return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Hash"), 0);
1453     case SVt_PVCV:
1454         return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Code"), 0);
1455     case SVt_PVGV:
1456         return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Glob"), 0);
1457     default:
1458         return NULL;
1459     }
1460 }
1461
1462 PerlIO_list_t *
1463 PerlIO_resolve_layers(pTHX_ const char *layers,
1464                       const char *mode, int narg, SV **args)
1465 {
1466     dVAR;
1467     PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1468     int incdef = 1;
1469     if (!PL_perlio)
1470         PerlIO_stdstreams(aTHX);
1471     if (narg) {
1472         SV * const arg = *args;
1473         /*
1474          * If it is a reference but not an object see if we have a handler
1475          * for it
1476          */
1477         if (SvROK(arg) && !sv_isobject(arg)) {
1478             PerlIO_funcs * const handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1479             if (handler) {
1480                 def = PerlIO_list_alloc(aTHX);
1481                 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1482                 incdef = 0;
1483             }
1484             /*
1485              * Don't fail if handler cannot be found :via(...) etc. may do
1486              * something sensible else we will just stringfy and open
1487              * resulting string.
1488              */
1489         }
1490     }
1491     if (!layers || !*layers)
1492         layers = Perl_PerlIO_context_layers(aTHX_ mode);
1493     if (layers && *layers) {
1494         PerlIO_list_t *av;
1495         if (incdef) {
1496             IV i;
1497             av = PerlIO_list_alloc(aTHX);
1498             for (i = 0; i < def->cur; i++) {
1499                 PerlIO_list_push(aTHX_ av, def->array[i].funcs,
1500                                  def->array[i].arg);
1501             }
1502         }
1503         else {
1504             av = def;
1505         }
1506         if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1507              return av;
1508         }
1509         else {
1510             PerlIO_list_free(aTHX_ av);
1511             return NULL;
1512         }
1513     }
1514     else {
1515         if (incdef)
1516             def->refcnt++;
1517         return def;
1518     }
1519 }
1520
1521 PerlIO *
1522 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1523              int imode, int perm, PerlIO *f, int narg, SV **args)
1524 {
1525     dVAR;
1526     if (!f && narg == 1 && *args == &PL_sv_undef) {
1527         if ((f = PerlIO_tmpfile())) {
1528             if (!layers || !*layers)
1529                 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1530             if (layers && *layers)
1531                 PerlIO_apply_layers(aTHX_ f, mode, layers);
1532         }
1533     }
1534     else {
1535         PerlIO_list_t *layera;
1536         IV n;
1537         PerlIO_funcs *tab = NULL;
1538         if (PerlIOValid(f)) {
1539             /*
1540              * This is "reopen" - it is not tested as perl does not use it
1541              * yet
1542              */
1543             PerlIOl *l = *f;
1544             layera = PerlIO_list_alloc(aTHX);
1545             while (l) {
1546                 SV * const arg = (l->tab->Getarg)
1547                         ? (*l->tab->Getarg) (aTHX_ &l, NULL, 0)
1548                         : &PL_sv_undef;
1549                 PerlIO_list_push(aTHX_ layera, l->tab, arg);
1550                 l = *PerlIONext(&l);
1551             }
1552         }
1553         else {
1554             layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1555             if (!layera) {
1556                 return NULL;
1557             }
1558         }
1559         /*
1560          * Start at "top" of layer stack
1561          */
1562         n = layera->cur - 1;
1563         while (n >= 0) {
1564             PerlIO_funcs * const t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1565             if (t && t->Open) {
1566                 tab = t;
1567                 break;
1568             }
1569             n--;
1570         }
1571         if (tab) {
1572             /*
1573              * Found that layer 'n' can do opens - call it
1574              */
1575             if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1576                 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1577             }
1578             PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1579                          tab->name, layers ? layers : "(Null)", mode, fd,
1580                          imode, perm, (void*)f, narg, (void*)args);
1581             if (tab->Open)
1582                  f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1583                                    f, narg, args);
1584             else {
1585                  SETERRNO(EINVAL, LIB_INVARG);
1586                  f = NULL;
1587             }
1588             if (f) {
1589                 if (n + 1 < layera->cur) {
1590                     /*
1591                      * More layers above the one that we used to open -
1592                      * apply them now
1593                      */
1594                     if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1595                         /* If pushing layers fails close the file */
1596                         PerlIO_close(f);
1597                         f = NULL;
1598                     }
1599                 }
1600             }
1601         }
1602         PerlIO_list_free(aTHX_ layera);
1603     }
1604     return f;
1605 }
1606
1607
1608 SSize_t
1609 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1610 {
1611      Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1612 }
1613
1614 SSize_t
1615 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1616 {
1617      Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1618 }
1619
1620 SSize_t
1621 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1622 {
1623      Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1624 }
1625
1626 int
1627 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1628 {
1629      Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1630 }
1631
1632 Off_t
1633 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1634 {
1635      Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1636 }
1637
1638 int
1639 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1640 {
1641     dVAR;
1642     if (f) {
1643         if (*f) {
1644             const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1645
1646             if (tab && tab->Flush)
1647                 return (*tab->Flush) (aTHX_ f);
1648             else
1649                  return 0; /* If no Flush defined, silently succeed. */
1650         }
1651         else {
1652             PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1653             SETERRNO(EBADF, SS_IVCHAN);
1654             return -1;
1655         }
1656     }
1657     else {
1658         /*
1659          * Is it good API design to do flush-all on NULL, a potentially
1660          * errorneous input? Maybe some magical value (PerlIO*
1661          * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1662          * things on fflush(NULL), but should we be bound by their design
1663          * decisions? --jhi
1664          */
1665         PerlIO **table = &PL_perlio;
1666         int code = 0;
1667         while ((f = *table)) {
1668             int i;
1669             table = (PerlIO **) (f++);
1670             for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1671                 if (*f && PerlIO_flush(f) != 0)
1672                     code = -1;
1673                 f++;
1674             }
1675         }
1676         return code;
1677     }
1678 }
1679
1680 void
1681 PerlIOBase_flush_linebuf(pTHX)
1682 {
1683     dVAR;
1684     PerlIO **table = &PL_perlio;
1685     PerlIO *f;
1686     while ((f = *table)) {
1687         int i;
1688         table = (PerlIO **) (f++);
1689         for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1690             if (*f
1691                 && (PerlIOBase(f)->
1692                     flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1693                 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1694                 PerlIO_flush(f);
1695             f++;
1696         }
1697     }
1698 }
1699
1700 int
1701 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1702 {
1703      Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1704 }
1705
1706 int
1707 PerlIO_isutf8(PerlIO *f)
1708 {
1709      if (PerlIOValid(f))
1710           return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1711      else
1712           SETERRNO(EBADF, SS_IVCHAN);
1713
1714      return -1;
1715 }
1716
1717 int
1718 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1719 {
1720      Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1721 }
1722
1723 int
1724 Perl_PerlIO_error(pTHX_ PerlIO *f)
1725 {
1726      Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1727 }
1728
1729 void
1730 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1731 {
1732      Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1733 }
1734
1735 void
1736 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1737 {
1738      Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1739 }
1740
1741 int
1742 PerlIO_has_base(PerlIO *f)
1743 {
1744      if (PerlIOValid(f)) {
1745           const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1746
1747           if (tab)
1748                return (tab->Get_base != NULL);
1749           SETERRNO(EINVAL, LIB_INVARG);
1750      }
1751      else
1752           SETERRNO(EBADF, SS_IVCHAN);
1753
1754      return 0;
1755 }
1756
1757 int
1758 PerlIO_fast_gets(PerlIO *f)
1759 {
1760     if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1761          const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1762
1763          if (tab)
1764               return (tab->Set_ptrcnt != NULL);
1765          SETERRNO(EINVAL, LIB_INVARG);
1766     }
1767     else
1768          SETERRNO(EBADF, SS_IVCHAN);
1769
1770     return 0;
1771 }
1772
1773 int
1774 PerlIO_has_cntptr(PerlIO *f)
1775 {
1776     if (PerlIOValid(f)) {
1777         const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1778
1779         if (tab)
1780              return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1781           SETERRNO(EINVAL, LIB_INVARG);
1782     }
1783     else
1784          SETERRNO(EBADF, SS_IVCHAN);
1785
1786     return 0;
1787 }
1788
1789 int
1790 PerlIO_canset_cnt(PerlIO *f)
1791 {
1792     if (PerlIOValid(f)) {
1793           const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1794
1795           if (tab)
1796                return (tab->Set_ptrcnt != NULL);
1797           SETERRNO(EINVAL, LIB_INVARG);
1798     }
1799     else
1800          SETERRNO(EBADF, SS_IVCHAN);
1801
1802     return 0;
1803 }
1804
1805 STDCHAR *
1806 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1807 {
1808      Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1809 }
1810
1811 int
1812 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1813 {
1814      Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1815 }
1816
1817 STDCHAR *
1818 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1819 {
1820      Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1821 }
1822
1823 int
1824 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1825 {
1826      Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1827 }
1828
1829 void
1830 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1831 {
1832      Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1833 }
1834
1835 void
1836 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1837 {
1838      Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1839 }
1840
1841
1842 /*--------------------------------------------------------------------------------------*/
1843 /*
1844  * utf8 and raw dummy layers
1845  */
1846
1847 IV
1848 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1849 {
1850     PERL_UNUSED_CONTEXT;
1851     PERL_UNUSED_ARG(mode);
1852     PERL_UNUSED_ARG(arg);
1853     if (PerlIOValid(f)) {
1854         if (tab->kind & PERLIO_K_UTF8)
1855             PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1856         else
1857             PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1858         return 0;
1859     }
1860     return -1;
1861 }
1862
1863 PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1864     sizeof(PerlIO_funcs),
1865     "utf8",
1866     0,
1867     PERLIO_K_DUMMY | PERLIO_K_UTF8,
1868     PerlIOUtf8_pushed,
1869     NULL,
1870     NULL,
1871     NULL,
1872     NULL,
1873     NULL,
1874     NULL,
1875     NULL,
1876     NULL,
1877     NULL,
1878     NULL,
1879     NULL,
1880     NULL,
1881     NULL,                       /* flush */
1882     NULL,                       /* fill */
1883     NULL,
1884     NULL,
1885     NULL,
1886     NULL,
1887     NULL,                       /* get_base */
1888     NULL,                       /* get_bufsiz */
1889     NULL,                       /* get_ptr */
1890     NULL,                       /* get_cnt */
1891     NULL,                       /* set_ptrcnt */
1892 };
1893
1894 PERLIO_FUNCS_DECL(PerlIO_byte) = {
1895     sizeof(PerlIO_funcs),
1896     "bytes",
1897     0,
1898     PERLIO_K_DUMMY,
1899     PerlIOUtf8_pushed,
1900     NULL,
1901     NULL,
1902     NULL,
1903     NULL,
1904     NULL,
1905     NULL,
1906     NULL,
1907     NULL,
1908     NULL,
1909     NULL,
1910     NULL,
1911     NULL,
1912     NULL,                       /* flush */
1913     NULL,                       /* fill */
1914     NULL,
1915     NULL,
1916     NULL,
1917     NULL,
1918     NULL,                       /* get_base */
1919     NULL,                       /* get_bufsiz */
1920     NULL,                       /* get_ptr */
1921     NULL,                       /* get_cnt */
1922     NULL,                       /* set_ptrcnt */
1923 };
1924
1925 PerlIO *
1926 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1927                IV n, const char *mode, int fd, int imode, int perm,
1928                PerlIO *old, int narg, SV **args)
1929 {
1930     PerlIO_funcs * const tab = PerlIO_default_btm();
1931     PERL_UNUSED_ARG(self);
1932     if (tab && tab->Open)
1933          return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1934                               old, narg, args);
1935     SETERRNO(EINVAL, LIB_INVARG);
1936     return NULL;
1937 }
1938
1939 PERLIO_FUNCS_DECL(PerlIO_raw) = {
1940     sizeof(PerlIO_funcs),
1941     "raw",
1942     0,
1943     PERLIO_K_DUMMY,
1944     PerlIORaw_pushed,
1945     PerlIOBase_popped,
1946     PerlIORaw_open,
1947     NULL,
1948     NULL,
1949     NULL,
1950     NULL,
1951     NULL,
1952     NULL,
1953     NULL,
1954     NULL,
1955     NULL,
1956     NULL,
1957     NULL,                       /* flush */
1958     NULL,                       /* fill */
1959     NULL,
1960     NULL,
1961     NULL,
1962     NULL,
1963     NULL,                       /* get_base */
1964     NULL,                       /* get_bufsiz */
1965     NULL,                       /* get_ptr */
1966     NULL,                       /* get_cnt */
1967     NULL,                       /* set_ptrcnt */
1968 };
1969 /*--------------------------------------------------------------------------------------*/
1970 /*--------------------------------------------------------------------------------------*/
1971 /*
1972  * "Methods" of the "base class"
1973  */
1974
1975 IV
1976 PerlIOBase_fileno(pTHX_ PerlIO *f)
1977 {
1978     return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1979 }
1980
1981 char *
1982 PerlIO_modestr(PerlIO * f, char *buf)
1983 {
1984     char *s = buf;
1985     if (PerlIOValid(f)) {
1986         const IV flags = PerlIOBase(f)->flags;
1987         if (flags & PERLIO_F_APPEND) {
1988             *s++ = 'a';
1989             if (flags & PERLIO_F_CANREAD) {
1990                 *s++ = '+';
1991             }
1992         }
1993         else if (flags & PERLIO_F_CANREAD) {
1994             *s++ = 'r';
1995             if (flags & PERLIO_F_CANWRITE)
1996                 *s++ = '+';
1997         }
1998         else if (flags & PERLIO_F_CANWRITE) {
1999             *s++ = 'w';
2000             if (flags & PERLIO_F_CANREAD) {
2001                 *s++ = '+';
2002             }
2003         }
2004 #ifdef PERLIO_USING_CRLF
2005         if (!(flags & PERLIO_F_CRLF))
2006             *s++ = 'b';
2007 #endif
2008     }
2009     *s = '\0';
2010     return buf;
2011 }
2012
2013
2014 IV
2015 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2016 {
2017     PerlIOl * const l = PerlIOBase(f);
2018     PERL_UNUSED_CONTEXT;
2019     PERL_UNUSED_ARG(arg);
2020
2021     l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
2022                   PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
2023     if (tab->Set_ptrcnt != NULL)
2024         l->flags |= PERLIO_F_FASTGETS;
2025     if (mode) {
2026         if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
2027             mode++;
2028         switch (*mode++) {
2029         case 'r':
2030             l->flags |= PERLIO_F_CANREAD;
2031             break;
2032         case 'a':
2033             l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
2034             break;
2035         case 'w':
2036             l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
2037             break;
2038         default:
2039             SETERRNO(EINVAL, LIB_INVARG);
2040             return -1;
2041         }
2042         while (*mode) {
2043             switch (*mode++) {
2044             case '+':
2045                 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2046                 break;
2047             case 'b':
2048                 l->flags &= ~PERLIO_F_CRLF;
2049                 break;
2050             case 't':
2051                 l->flags |= PERLIO_F_CRLF;
2052                 break;
2053             default:
2054                 SETERRNO(EINVAL, LIB_INVARG);
2055                 return -1;
2056             }
2057         }
2058     }
2059     else {
2060         if (l->next) {
2061             l->flags |= l->next->flags &
2062                 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2063                  PERLIO_F_APPEND);
2064         }
2065     }
2066 #if 0
2067     PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2068                  (void*)f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2069                  l->flags, PerlIO_modestr(f, temp));
2070 #endif
2071     return 0;
2072 }
2073
2074 IV
2075 PerlIOBase_popped(pTHX_ PerlIO *f)
2076 {
2077     PERL_UNUSED_CONTEXT;
2078     PERL_UNUSED_ARG(f);
2079     return 0;
2080 }
2081
2082 SSize_t
2083 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2084 {
2085     /*
2086      * Save the position as current head considers it
2087      */
2088     const Off_t old = PerlIO_tell(f);
2089     PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", NULL);
2090     PerlIOSelf(f, PerlIOBuf)->posn = old;
2091     return PerlIOBuf_unread(aTHX_ f, vbuf, count);
2092 }
2093
2094 SSize_t
2095 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2096 {
2097     STDCHAR *buf = (STDCHAR *) vbuf;
2098     if (f) {
2099         if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2100             PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2101             SETERRNO(EBADF, SS_IVCHAN);
2102             return 0;
2103         }
2104         while (count > 0) {
2105          get_cnt:
2106           {
2107             SSize_t avail = PerlIO_get_cnt(f);
2108             SSize_t take = 0;
2109             if (avail > 0)
2110                 take = ((SSize_t)count < avail) ? (SSize_t)count : avail;
2111             if (take > 0) {
2112                 STDCHAR *ptr = PerlIO_get_ptr(f);
2113                 Copy(ptr, buf, take, STDCHAR);
2114                 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2115                 count -= take;
2116                 buf += take;
2117                 if (avail == 0)         /* set_ptrcnt could have reset avail */
2118                     goto get_cnt;
2119             }
2120             if (count > 0 && avail <= 0) {
2121                 if (PerlIO_fill(f) != 0)
2122                     break;
2123             }
2124           }
2125         }
2126         return (buf - (STDCHAR *) vbuf);
2127     }
2128     return 0;
2129 }
2130
2131 IV
2132 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2133 {
2134     PERL_UNUSED_CONTEXT;
2135     PERL_UNUSED_ARG(f);
2136     return 0;
2137 }
2138
2139 IV
2140 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2141 {
2142     PERL_UNUSED_CONTEXT;
2143     PERL_UNUSED_ARG(f);
2144     return -1;
2145 }
2146
2147 IV
2148 PerlIOBase_close(pTHX_ PerlIO *f)
2149 {
2150     IV code = -1;
2151     if (PerlIOValid(f)) {
2152         PerlIO *n = PerlIONext(f);
2153         code = PerlIO_flush(f);
2154         PerlIOBase(f)->flags &=
2155            ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2156         while (PerlIOValid(n)) {
2157             const PerlIO_funcs * const tab = PerlIOBase(n)->tab;
2158             if (tab && tab->Close) {
2159                 if ((*tab->Close)(aTHX_ n) != 0)
2160                     code = -1;
2161                 break;
2162             }
2163             else {
2164                 PerlIOBase(n)->flags &=
2165                     ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2166             }
2167             n = PerlIONext(n);
2168         }
2169     }
2170     else {
2171         SETERRNO(EBADF, SS_IVCHAN);
2172     }
2173     return code;
2174 }
2175
2176 IV
2177 PerlIOBase_eof(pTHX_ PerlIO *f)
2178 {
2179     PERL_UNUSED_CONTEXT;
2180     if (PerlIOValid(f)) {
2181         return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2182     }
2183     return 1;
2184 }
2185
2186 IV
2187 PerlIOBase_error(pTHX_ PerlIO *f)
2188 {
2189     PERL_UNUSED_CONTEXT;
2190     if (PerlIOValid(f)) {
2191         return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2192     }
2193     return 1;
2194 }
2195
2196 void
2197 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2198 {
2199     if (PerlIOValid(f)) {
2200         PerlIO * const n = PerlIONext(f);
2201         PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2202         if (PerlIOValid(n))
2203             PerlIO_clearerr(n);
2204     }
2205 }
2206
2207 void
2208 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2209 {
2210     PERL_UNUSED_CONTEXT;
2211     if (PerlIOValid(f)) {
2212         PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2213     }
2214 }
2215
2216 SV *
2217 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2218 {
2219     if (!arg)
2220         return NULL;
2221 #ifdef sv_dup
2222     if (param) {
2223         return sv_dup(arg, param);
2224     }
2225     else {
2226         return newSVsv(arg);
2227     }
2228 #else
2229     PERL_UNUSED_ARG(param);
2230     return newSVsv(arg);
2231 #endif
2232 }
2233
2234 PerlIO *
2235 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2236 {
2237     PerlIO * const nexto = PerlIONext(o);
2238     if (PerlIOValid(nexto)) {
2239         const PerlIO_funcs * const tab = PerlIOBase(nexto)->tab;
2240         if (tab && tab->Dup)
2241             f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2242         else
2243             f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2244     }
2245     if (f) {
2246         PerlIO_funcs * const self = PerlIOBase(o)->tab;
2247         SV *arg;
2248         char buf[8];
2249         PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2250                      self->name, (void*)f, (void*)o, (void*)param);
2251         if (self->Getarg)
2252             arg = (*self->Getarg)(aTHX_ o, param, flags);
2253         else {
2254             arg = NULL;
2255         }
2256         f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2257         if (arg) {
2258             SvREFCNT_dec(arg);
2259         }
2260     }
2261     return f;
2262 }
2263
2264 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2265
2266 /* Must be called with PL_perlio_mutex locked. */
2267 static void
2268 S_more_refcounted_fds(pTHX_ const int new_fd) {
2269     dVAR;
2270     const int old_max = PL_perlio_fd_refcnt_size;
2271     const int new_max = 16 + (new_fd & ~15);
2272     int *new_array;
2273
2274     PerlIO_debug("More fds - old=%d, need %d, new=%d\n",
2275                  old_max, new_fd, new_max);
2276
2277     if (new_fd < old_max) {
2278         return;
2279     }
2280
2281     assert (new_max > new_fd);
2282
2283     /* Use plain realloc() since we need this memory to be really
2284      * global and visible to all the interpreters and/or threads. */
2285     new_array = (int*) realloc(PL_perlio_fd_refcnt, new_max * sizeof(int));
2286
2287     if (!new_array) {
2288 #ifdef USE_ITHREADS
2289         MUTEX_UNLOCK(&PL_perlio_mutex);
2290 #endif
2291         /* Can't use PerlIO to write as it allocates memory */
2292         PerlLIO_write(PerlIO_fileno(Perl_error_log),
2293                       PL_no_mem, strlen(PL_no_mem));
2294         my_exit(1);
2295     }
2296
2297     PL_perlio_fd_refcnt_size = new_max;
2298     PL_perlio_fd_refcnt = new_array;
2299
2300     PerlIO_debug("Zeroing %p, %d\n",
2301                  (void*)(new_array + old_max),
2302                  new_max - old_max);
2303
2304     Zero(new_array + old_max, new_max - old_max, int);
2305 }
2306
2307
2308 void
2309 PerlIO_init(pTHX)
2310 {
2311     /* MUTEX_INIT(&PL_perlio_mutex) is done in PERL_SYS_INIT3(). */
2312     PERL_UNUSED_CONTEXT;
2313 }
2314
2315 void
2316 PerlIOUnix_refcnt_inc(int fd)
2317 {
2318     dTHX;
2319     if (fd >= 0) {
2320         dVAR;
2321
2322 #ifdef USE_ITHREADS
2323         MUTEX_LOCK(&PL_perlio_mutex);
2324 #endif
2325         if (fd >= PL_perlio_fd_refcnt_size)
2326             S_more_refcounted_fds(aTHX_ fd);
2327
2328         PL_perlio_fd_refcnt[fd]++;
2329         if (PL_perlio_fd_refcnt[fd] <= 0) {
2330             Perl_croak(aTHX_ "refcnt_inc: fd %d: %d <= 0\n",
2331                        fd, PL_perlio_fd_refcnt[fd]);
2332         }
2333         PerlIO_debug("refcnt_inc: fd %d refcnt=%d\n",
2334                      fd, PL_perlio_fd_refcnt[fd]);
2335
2336 #ifdef USE_ITHREADS
2337         MUTEX_UNLOCK(&PL_perlio_mutex);
2338 #endif
2339     } else {
2340         Perl_croak(aTHX_ "refcnt_inc: fd %d < 0\n", fd);
2341     }
2342 }
2343
2344 int
2345 PerlIOUnix_refcnt_dec(int fd)
2346 {
2347     dTHX;
2348     int cnt = 0;
2349     if (fd >= 0) {
2350         dVAR;
2351 #ifdef USE_ITHREADS
2352         MUTEX_LOCK(&PL_perlio_mutex);
2353 #endif
2354         if (fd >= PL_perlio_fd_refcnt_size) {
2355             Perl_croak(aTHX_ "refcnt_dec: fd %d >= refcnt_size %d\n",
2356                        fd, PL_perlio_fd_refcnt_size);
2357         }
2358         if (PL_perlio_fd_refcnt[fd] <= 0) {
2359             Perl_croak(aTHX_ "refcnt_dec: fd %d: %d <= 0\n",
2360                        fd, PL_perlio_fd_refcnt[fd]);
2361         }
2362         cnt = --PL_perlio_fd_refcnt[fd];
2363         PerlIO_debug("refcnt_dec: fd %d refcnt=%d\n", fd, cnt);
2364 #ifdef USE_ITHREADS
2365         MUTEX_UNLOCK(&PL_perlio_mutex);
2366 #endif
2367     } else {
2368         Perl_croak(aTHX_ "refcnt_dec: fd %d < 0\n", fd);
2369     }
2370     return cnt;
2371 }
2372
2373 void
2374 PerlIO_cleanup(pTHX)
2375 {
2376     dVAR;
2377     int i;
2378 #ifdef USE_ITHREADS
2379     PerlIO_debug("Cleanup layers for %p\n",(void*)aTHX);
2380 #else
2381     PerlIO_debug("Cleanup layers\n");
2382 #endif
2383
2384     /* Raise STDIN..STDERR refcount so we don't close them */
2385     for (i=0; i < 3; i++)
2386         PerlIOUnix_refcnt_inc(i);
2387     PerlIO_cleantable(aTHX_ &PL_perlio);
2388     /* Restore STDIN..STDERR refcount */
2389     for (i=0; i < 3; i++)
2390         PerlIOUnix_refcnt_dec(i);
2391
2392     if (PL_known_layers) {
2393         PerlIO_list_free(aTHX_ PL_known_layers);
2394         PL_known_layers = NULL;
2395     }
2396     if (PL_def_layerlist) {
2397         PerlIO_list_free(aTHX_ PL_def_layerlist);
2398         PL_def_layerlist = NULL;
2399     }
2400 }
2401
2402 void PerlIO_teardown(pTHX) /* Call only from PERL_SYS_TERM(). */
2403 {
2404     dVAR;
2405 #ifdef DEBUGGING
2406     {
2407         /* By now all filehandles should have been closed, so any
2408          * stray (non-STD-)filehandles indicate *possible* (PerlIO)
2409          * errors. */
2410         int i;
2411         for (i = 3; i < PL_perlio_fd_refcnt_size; i++) {
2412             if (PL_perlio_fd_refcnt[i])
2413                 PerlIO_debug("PerlIO_cleanup: fd %d refcnt=%d\n",
2414                              i, PL_perlio_fd_refcnt[i]);
2415         }
2416     }
2417 #endif
2418     /* Not bothering with PL_perlio_mutex since by now
2419      * all the interpreters are gone. */
2420     if (PL_perlio_fd_refcnt_size /* Assuming initial size of zero. */
2421         && PL_perlio_fd_refcnt) {
2422         free(PL_perlio_fd_refcnt); /* To match realloc() in S_more_refcounted_fds(). */
2423         PL_perlio_fd_refcnt = NULL;
2424         PL_perlio_fd_refcnt_size = 0;
2425     }
2426 }
2427
2428 /*--------------------------------------------------------------------------------------*/
2429 /*
2430  * Bottom-most level for UNIX-like case
2431  */
2432
2433 typedef struct {
2434     struct _PerlIO base;        /* The generic part */
2435     int fd;                     /* UNIX like file descriptor */
2436     int oflags;                 /* open/fcntl flags */
2437 } PerlIOUnix;
2438
2439 int
2440 PerlIOUnix_oflags(const char *mode)
2441 {
2442     int oflags = -1;
2443     if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2444         mode++;
2445     switch (*mode) {
2446     case 'r':
2447         oflags = O_RDONLY;
2448         if (*++mode == '+') {
2449             oflags = O_RDWR;
2450             mode++;
2451         }
2452         break;
2453
2454     case 'w':
2455         oflags = O_CREAT | O_TRUNC;
2456         if (*++mode == '+') {
2457             oflags |= O_RDWR;
2458             mode++;
2459         }
2460         else
2461             oflags |= O_WRONLY;
2462         break;
2463
2464     case 'a':
2465         oflags = O_CREAT | O_APPEND;
2466         if (*++mode == '+') {
2467             oflags |= O_RDWR;
2468             mode++;
2469         }
2470         else
2471             oflags |= O_WRONLY;
2472         break;
2473     }
2474     if (*mode == 'b') {
2475         oflags |= O_BINARY;
2476         oflags &= ~O_TEXT;
2477         mode++;
2478     }
2479     else if (*mode == 't') {
2480         oflags |= O_TEXT;
2481         oflags &= ~O_BINARY;
2482         mode++;
2483     }
2484     /*
2485      * Always open in binary mode
2486      */
2487     oflags |= O_BINARY;
2488     if (*mode || oflags == -1) {
2489         SETERRNO(EINVAL, LIB_INVARG);
2490         oflags = -1;
2491     }
2492     return oflags;
2493 }
2494
2495 IV
2496 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2497 {
2498     PERL_UNUSED_CONTEXT;
2499     return PerlIOSelf(f, PerlIOUnix)->fd;
2500 }
2501
2502 static void
2503 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2504 {
2505     PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2506 #if defined(WIN32)
2507     Stat_t st;
2508     if (PerlLIO_fstat(fd, &st) == 0) {
2509         if (!S_ISREG(st.st_mode)) {
2510             PerlIO_debug("%d is not regular file\n",fd);
2511             PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2512         }
2513         else {
2514             PerlIO_debug("%d _is_ a regular file\n",fd);
2515         }
2516     }
2517 #endif
2518     s->fd = fd;
2519     s->oflags = imode;
2520     PerlIOUnix_refcnt_inc(fd);
2521     PERL_UNUSED_CONTEXT;
2522 }
2523
2524 IV
2525 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2526 {
2527     IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2528     if (*PerlIONext(f)) {
2529         /* We never call down so do any pending stuff now */
2530         PerlIO_flush(PerlIONext(f));
2531         /*
2532          * XXX could (or should) we retrieve the oflags from the open file
2533          * handle rather than believing the "mode" we are passed in? XXX
2534          * Should the value on NULL mode be 0 or -1?
2535          */
2536         PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2537                          mode ? PerlIOUnix_oflags(mode) : -1);
2538     }
2539     PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2540
2541     return code;
2542 }
2543
2544 IV
2545 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2546 {
2547     const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2548     Off_t new_loc;
2549     PERL_UNUSED_CONTEXT;
2550     if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2551 #ifdef  ESPIPE
2552         SETERRNO(ESPIPE, LIB_INVARG);
2553 #else
2554         SETERRNO(EINVAL, LIB_INVARG);
2555 #endif
2556         return -1;
2557     }
2558     new_loc = PerlLIO_lseek(fd, offset, whence);
2559     if (new_loc == (Off_t) - 1)
2560         return -1;
2561     PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2562     return  0;
2563 }
2564
2565 PerlIO *
2566 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2567                 IV n, const char *mode, int fd, int imode,
2568                 int perm, PerlIO *f, int narg, SV **args)
2569 {
2570     if (PerlIOValid(f)) {
2571         if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2572             (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2573     }
2574     if (narg > 0) {
2575         if (*mode == IoTYPE_NUMERIC)
2576             mode++;
2577         else {
2578             imode = PerlIOUnix_oflags(mode);
2579             perm = 0666;
2580         }
2581         if (imode != -1) {
2582             const char *path = SvPV_nolen_const(*args);
2583             fd = PerlLIO_open3(path, imode, perm);
2584         }
2585     }
2586     if (fd >= 0) {
2587         if (*mode == IoTYPE_IMPLICIT)
2588             mode++;
2589         if (!f) {
2590             f = PerlIO_allocate(aTHX);
2591         }
2592         if (!PerlIOValid(f)) {
2593             if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2594                 return NULL;
2595             }
2596         }
2597         PerlIOUnix_setfd(aTHX_ f, fd, imode);
2598         PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2599         if (*mode == IoTYPE_APPEND)
2600             PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2601         return f;
2602     }
2603     else {
2604         if (f) {
2605             NOOP;
2606             /*
2607              * FIXME: pop layers ???
2608              */
2609         }
2610         return NULL;
2611     }
2612 }
2613
2614 PerlIO *
2615 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2616 {
2617     const PerlIOUnix * const os = PerlIOSelf(o, PerlIOUnix);
2618     int fd = os->fd;
2619     if (flags & PERLIO_DUP_FD) {
2620         fd = PerlLIO_dup(fd);
2621     }
2622     if (fd >= 0) {
2623         f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2624         if (f) {
2625             /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2626             PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2627             return f;
2628         }
2629     }
2630     return NULL;
2631 }
2632
2633
2634 SSize_t
2635 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2636 {
2637     dVAR;
2638     const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2639 #ifdef PERLIO_STD_SPECIAL
2640     if (fd == 0)
2641         return PERLIO_STD_IN(fd, vbuf, count);
2642 #endif
2643     if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2644          PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2645         return 0;
2646     }
2647     while (1) {
2648         const SSize_t len = PerlLIO_read(fd, vbuf, count);
2649         if (len >= 0 || errno != EINTR) {
2650             if (len < 0) {
2651                 if (errno != EAGAIN) {
2652                     PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2653                 }
2654             }
2655             else if (len == 0 && count != 0) {
2656                 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2657                 SETERRNO(0,0);
2658             }
2659             return len;
2660         }
2661         PERL_ASYNC_CHECK();
2662     }
2663     /*NOTREACHED*/
2664 }
2665
2666 SSize_t
2667 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2668 {
2669     dVAR;
2670     const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2671 #ifdef PERLIO_STD_SPECIAL
2672     if (fd == 1 || fd == 2)
2673         return PERLIO_STD_OUT(fd, vbuf, count);
2674 #endif
2675     while (1) {
2676         const SSize_t len = PerlLIO_write(fd, vbuf, count);
2677         if (len >= 0 || errno != EINTR) {
2678             if (len < 0) {
2679                 if (errno != EAGAIN) {
2680                     PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2681                 }
2682             }
2683             return len;
2684         }
2685         PERL_ASYNC_CHECK();
2686     }
2687     /*NOTREACHED*/
2688 }
2689
2690 Off_t
2691 PerlIOUnix_tell(pTHX_ PerlIO *f)
2692 {
2693     PERL_UNUSED_CONTEXT;
2694
2695     return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2696 }
2697
2698
2699 IV
2700 PerlIOUnix_close(pTHX_ PerlIO *f)
2701 {
2702     dVAR;
2703     const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2704     int code = 0;
2705     if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2706         if (PerlIOUnix_refcnt_dec(fd) > 0) {
2707             PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2708             return 0;
2709         }
2710     }
2711     else {
2712         SETERRNO(EBADF,SS_IVCHAN);
2713         return -1;
2714     }
2715     while (PerlLIO_close(fd) != 0) {
2716         if (errno != EINTR) {
2717             code = -1;
2718             break;
2719         }
2720         PERL_ASYNC_CHECK();
2721     }
2722     if (code == 0) {
2723         PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2724     }
2725     return code;
2726 }
2727
2728 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2729     sizeof(PerlIO_funcs),
2730     "unix",
2731     sizeof(PerlIOUnix),
2732     PERLIO_K_RAW,
2733     PerlIOUnix_pushed,
2734     PerlIOBase_popped,
2735     PerlIOUnix_open,
2736     PerlIOBase_binmode,         /* binmode */
2737     NULL,
2738     PerlIOUnix_fileno,
2739     PerlIOUnix_dup,
2740     PerlIOUnix_read,
2741     PerlIOBase_unread,
2742     PerlIOUnix_write,
2743     PerlIOUnix_seek,
2744     PerlIOUnix_tell,
2745     PerlIOUnix_close,
2746     PerlIOBase_noop_ok,         /* flush */
2747     PerlIOBase_noop_fail,       /* fill */
2748     PerlIOBase_eof,
2749     PerlIOBase_error,
2750     PerlIOBase_clearerr,
2751     PerlIOBase_setlinebuf,
2752     NULL,                       /* get_base */
2753     NULL,                       /* get_bufsiz */
2754     NULL,                       /* get_ptr */
2755     NULL,                       /* get_cnt */
2756     NULL,                       /* set_ptrcnt */
2757 };
2758
2759 /*--------------------------------------------------------------------------------------*/
2760 /*
2761  * stdio as a layer
2762  */
2763
2764 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2765 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2766    broken by the last second glibc 2.3 fix
2767  */
2768 #define STDIO_BUFFER_WRITABLE
2769 #endif
2770
2771
2772 typedef struct {
2773     struct _PerlIO base;
2774     FILE *stdio;                /* The stream */
2775 } PerlIOStdio;
2776
2777 IV
2778 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2779 {
2780     PERL_UNUSED_CONTEXT;
2781
2782     if (PerlIOValid(f)) {
2783         FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
2784         if (s)
2785             return PerlSIO_fileno(s);
2786     }
2787     errno = EBADF;
2788     return -1;
2789 }
2790
2791 char *
2792 PerlIOStdio_mode(const char *mode, char *tmode)
2793 {
2794     char * const ret = tmode;
2795     if (mode) {
2796         while (*mode) {
2797             *tmode++ = *mode++;
2798         }
2799     }
2800 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2801     *tmode++ = 'b';
2802 #endif
2803     *tmode = '\0';
2804     return ret;
2805 }
2806
2807 IV
2808 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2809 {
2810     PerlIO *n;
2811     if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2812         PerlIO_funcs * const toptab = PerlIOBase(n)->tab;
2813         if (toptab == tab) {
2814             /* Top is already stdio - pop self (duplicate) and use original */
2815             PerlIO_pop(aTHX_ f);
2816             return 0;
2817         } else {
2818             const int fd = PerlIO_fileno(n);
2819             char tmode[8];
2820             FILE *stdio;
2821             if (fd >= 0 && (stdio  = PerlSIO_fdopen(fd,
2822                             mode = PerlIOStdio_mode(mode, tmode)))) {
2823                 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2824                 /* We never call down so do any pending stuff now */
2825                 PerlIO_flush(PerlIONext(f));
2826             }
2827             else {
2828                 return -1;
2829             }
2830         }
2831     }
2832     return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2833 }
2834
2835
2836 PerlIO *
2837 PerlIO_importFILE(FILE *stdio, const char *mode)
2838 {
2839     dTHX;
2840     PerlIO *f = NULL;
2841     if (stdio) {
2842         PerlIOStdio *s;
2843         if (!mode || !*mode) {
2844             /* We need to probe to see how we can open the stream
2845                so start with read/write and then try write and read
2846                we dup() so that we can fclose without loosing the fd.
2847
2848                Note that the errno value set by a failing fdopen
2849                varies between stdio implementations.
2850              */
2851             const int fd = PerlLIO_dup(fileno(stdio));
2852             FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2853             if (!f2) {
2854                 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2855             }
2856             if (!f2) {
2857                 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2858             }
2859             if (!f2) {
2860                 /* Don't seem to be able to open */
2861                 PerlLIO_close(fd);
2862                 return f;
2863             }
2864             fclose(f2);
2865         }
2866         if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, NULL))) {
2867             s = PerlIOSelf(f, PerlIOStdio);
2868             s->stdio = stdio;
2869         }
2870     }
2871     return f;
2872 }
2873
2874 PerlIO *
2875 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2876                  IV n, const char *mode, int fd, int imode,
2877                  int perm, PerlIO *f, int narg, SV **args)
2878 {
2879     char tmode[8];
2880     if (PerlIOValid(f)) {
2881         const char * const path = SvPV_nolen_const(*args);
2882         PerlIOStdio * const s = PerlIOSelf(f, PerlIOStdio);
2883         FILE *stdio;
2884         PerlIOUnix_refcnt_dec(fileno(s->stdio));
2885         stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2886                             s->stdio);
2887         if (!s->stdio)
2888             return NULL;
2889         s->stdio = stdio;
2890         PerlIOUnix_refcnt_inc(fileno(s->stdio));
2891         return f;
2892     }
2893     else {
2894         if (narg > 0) {
2895             const char * const path = SvPV_nolen_const(*args);
2896             if (*mode == IoTYPE_NUMERIC) {
2897                 mode++;
2898                 fd = PerlLIO_open3(path, imode, perm);
2899             }
2900             else {
2901                 FILE *stdio;
2902                 bool appended = FALSE;
2903 #ifdef __CYGWIN__
2904                 /* Cygwin wants its 'b' early. */
2905                 appended = TRUE;
2906                 mode = PerlIOStdio_mode(mode, tmode);
2907 #endif
2908                 stdio = PerlSIO_fopen(path, mode);
2909                 if (stdio) {
2910                     if (!f) {
2911                         f = PerlIO_allocate(aTHX);
2912                     }
2913                     if (!appended)
2914                         mode = PerlIOStdio_mode(mode, tmode);
2915                     f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2916                     if (f) {
2917                         PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2918                         PerlIOUnix_refcnt_inc(fileno(stdio));
2919                     } else {
2920                         PerlSIO_fclose(stdio);
2921                     }
2922                     return f;
2923                 }
2924                 else {
2925                     return NULL;
2926                 }
2927             }
2928         }
2929         if (fd >= 0) {
2930             FILE *stdio = NULL;
2931             int init = 0;
2932             if (*mode == IoTYPE_IMPLICIT) {
2933                 init = 1;
2934                 mode++;
2935             }
2936             if (init) {
2937                 switch (fd) {
2938                 case 0:
2939                     stdio = PerlSIO_stdin;
2940                     break;
2941                 case 1:
2942                     stdio = PerlSIO_stdout;
2943                     break;
2944                 case 2:
2945                     stdio = PerlSIO_stderr;
2946                     break;
2947                 }
2948             }
2949             else {
2950                 stdio = PerlSIO_fdopen(fd, mode =
2951                                        PerlIOStdio_mode(mode, tmode));
2952             }
2953             if (stdio) {
2954                 if (!f) {
2955                     f = PerlIO_allocate(aTHX);
2956                 }
2957                 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2958                     PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2959                     PerlIOUnix_refcnt_inc(fileno(stdio));
2960                 }
2961                 return f;
2962             }
2963         }
2964     }
2965     return NULL;
2966 }
2967
2968 PerlIO *
2969 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2970 {
2971     /* This assumes no layers underneath - which is what
2972        happens, but is not how I remember it. NI-S 2001/10/16
2973      */
2974     if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2975         FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2976         const int fd = fileno(stdio);
2977         char mode[8];
2978         if (flags & PERLIO_DUP_FD) {
2979             const int dfd = PerlLIO_dup(fileno(stdio));
2980             if (dfd >= 0) {
2981                 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2982                 goto set_this;
2983             }
2984             else {
2985                 NOOP;
2986                 /* FIXME: To avoid messy error recovery if dup fails
2987                    re-use the existing stdio as though flag was not set
2988                  */
2989             }
2990         }
2991         stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2992     set_this:
2993         PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2994         PerlIOUnix_refcnt_inc(fileno(stdio));
2995     }
2996     return f;
2997 }
2998
2999 static int
3000 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
3001 {
3002     PERL_UNUSED_CONTEXT;
3003
3004     /* XXX this could use PerlIO_canset_fileno() and
3005      * PerlIO_set_fileno() support from Configure
3006      */
3007 #  if defined(__UCLIBC__)
3008     /* uClibc must come before glibc because it defines __GLIBC__ as well. */
3009     f->__filedes = -1;
3010     return 1;
3011 #  elif defined(__GLIBC__)
3012     /* There may be a better way for GLIBC:
3013         - libio.h defines a flag to not close() on cleanup
3014      */
3015     f->_fileno = -1;
3016     return 1;
3017 #  elif defined(__sun__)
3018     PERL_UNUSED_ARG(f);
3019     return 0;
3020 #  elif defined(__hpux)
3021     f->__fileH = 0xff;
3022     f->__fileL = 0xff;
3023     return 1;
3024    /* Next one ->_file seems to be a reasonable fallback, i.e. if
3025       your platform does not have special entry try this one.
3026       [For OSF only have confirmation for Tru64 (alpha)
3027       but assume other OSFs will be similar.]
3028     */
3029 #  elif defined(_AIX) || defined(__osf__) || defined(__irix__)
3030     f->_file = -1;
3031     return 1;
3032 #  elif defined(__FreeBSD__)
3033     /* There may be a better way on FreeBSD:
3034         - we could insert a dummy func in the _close function entry
3035         f->_close = (int (*)(void *)) dummy_close;
3036      */
3037     f->_file = -1;
3038     return 1;
3039 #  elif defined(__OpenBSD__)
3040     /* There may be a better way on OpenBSD:
3041         - we could insert a dummy func in the _close function entry
3042         f->_close = (int (*)(void *)) dummy_close;
3043      */
3044     f->_file = -1;
3045     return 1;
3046 #  elif defined(__EMX__)
3047     /* f->_flags &= ~_IOOPEN; */        /* Will leak stream->_buffer */
3048     f->_handle = -1;
3049     return 1;
3050 #  elif defined(__CYGWIN__)
3051     /* There may be a better way on CYGWIN:
3052         - we could insert a dummy func in the _close function entry
3053         f->_close = (int (*)(void *)) dummy_close;
3054      */
3055     f->_file = -1;
3056     return 1;
3057 #  elif defined(WIN32)
3058 #    if defined(__BORLANDC__)
3059     f->fd = PerlLIO_dup(fileno(f));
3060 #    elif defined(UNDER_CE)
3061     /* WIN_CE does not have access to FILE internals, it hardly has FILE
3062        structure at all
3063      */
3064 #    else
3065     f->_file = -1;
3066 #    endif
3067     return 1;
3068 #  else
3069 #if 0
3070     /* Sarathy's code did this - we fall back to a dup/dup2 hack
3071        (which isn't thread safe) instead
3072      */
3073 #    error "Don't know how to set FILE.fileno on your platform"
3074 #endif
3075     PERL_UNUSED_ARG(f);
3076     return 0;
3077 #  endif
3078 }
3079
3080 IV
3081 PerlIOStdio_close(pTHX_ PerlIO *f)
3082 {
3083     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3084     if (!stdio) {
3085         errno = EBADF;
3086         return -1;
3087     }
3088     else {
3089         const int fd = fileno(stdio);
3090         int invalidate = 0;
3091         IV result = 0;
3092         int saveerr = 0;
3093         int dupfd = 0;
3094 #ifdef SOCKS5_VERSION_NAME
3095         /* Socks lib overrides close() but stdio isn't linked to
3096            that library (though we are) - so we must call close()
3097            on sockets on stdio's behalf.
3098          */
3099         int optval;
3100         Sock_size_t optlen = sizeof(int);
3101         if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0)
3102             invalidate = 1;
3103 #endif
3104         if (PerlIOUnix_refcnt_dec(fd) > 0) /* File descriptor still in use */
3105             invalidate = 1;
3106         if (invalidate) {
3107             /* For STD* handles, don't close stdio, since we shared the FILE *, too. */
3108             if (stdio == stdin) /* Some stdios are buggy fflush-ing inputs */
3109                 return 0;
3110             if (stdio == stdout || stdio == stderr)
3111                 return PerlIO_flush(f);
3112             /* Tricky - must fclose(stdio) to free memory but not close(fd)
3113                Use Sarathy's trick from maint-5.6 to invalidate the
3114                fileno slot of the FILE *
3115             */
3116             result = PerlIO_flush(f);
3117             saveerr = errno;
3118             invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio);
3119             if (!invalidate)
3120                 dupfd = PerlLIO_dup(fd);
3121         }
3122         result = PerlSIO_fclose(stdio);
3123         /* We treat error from stdio as success if we invalidated
3124            errno may NOT be expected EBADF
3125          */
3126         if (invalidate && result != 0) {
3127             errno = saveerr;
3128             result = 0;
3129         }
3130 #ifdef SOCKS5_VERSION_NAME
3131         /* in SOCKS' case, let close() determine return value */
3132         result = close(fd);
3133 #endif
3134         if (dupfd) {
3135             PerlLIO_dup2(dupfd,fd);
3136             PerlLIO_close(dupfd);
3137         }
3138         return result;
3139     }
3140 }
3141
3142 SSize_t
3143 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3144 {
3145     dVAR;
3146     FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3147     SSize_t got = 0;
3148     for (;;) {
3149         if (count == 1) {
3150             STDCHAR *buf = (STDCHAR *) vbuf;
3151             /*
3152              * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3153              * stdio does not do that for fread()
3154              */
3155             const int ch = PerlSIO_fgetc(s);
3156             if (ch != EOF) {
3157                 *buf = ch;
3158                 got = 1;
3159             }
3160         }
3161         else
3162             got = PerlSIO_fread(vbuf, 1, count, s);
3163         if (got == 0 && PerlSIO_ferror(s))
3164             got = -1;
3165         if (got >= 0 || errno != EINTR)
3166             break;
3167         PERL_ASYNC_CHECK();
3168         SETERRNO(0,0);  /* just in case */
3169     }
3170     return got;
3171 }
3172
3173 SSize_t
3174 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3175 {
3176     SSize_t unread = 0;
3177     FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3178
3179 #ifdef STDIO_BUFFER_WRITABLE
3180     if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3181         STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3182         STDCHAR *base = PerlIO_get_base(f);
3183         SSize_t cnt   = PerlIO_get_cnt(f);
3184         STDCHAR *ptr  = PerlIO_get_ptr(f);
3185         SSize_t avail = ptr - base;
3186         if (avail > 0) {
3187             if (avail > count) {
3188                 avail = count;
3189             }
3190             ptr -= avail;
3191             Move(buf-avail,ptr,avail,STDCHAR);
3192             count -= avail;
3193             unread += avail;
3194             PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3195             if (PerlSIO_feof(s) && unread >= 0)
3196                 PerlSIO_clearerr(s);
3197         }
3198     }
3199     else
3200 #endif
3201     if (PerlIO_has_cntptr(f)) {
3202         /* We can get pointer to buffer but not its base
3203            Do ungetc() but check chars are ending up in the
3204            buffer
3205          */
3206         STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3207         STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3208         while (count > 0) {
3209             const int ch = *--buf & 0xFF;
3210             if (ungetc(ch,s) != ch) {
3211                 /* ungetc did not work */
3212                 break;
3213             }
3214             if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3215                 /* Did not change pointer as expected */
3216                 fgetc(s);  /* get char back again */
3217                 break;
3218             }
3219             /* It worked ! */
3220             count--;
3221             unread++;
3222         }
3223     }
3224
3225     if (count > 0) {
3226         unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3227     }
3228     return unread;
3229 }
3230
3231 SSize_t
3232 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3233 {
3234     dVAR;
3235     SSize_t got;
3236     for (;;) {
3237         got = PerlSIO_fwrite(vbuf, 1, count,
3238                               PerlIOSelf(f, PerlIOStdio)->stdio);
3239         if (got >= 0 || errno != EINTR)
3240             break;
3241         PERL_ASYNC_CHECK();
3242         SETERRNO(0,0);  /* just in case */
3243     }
3244     return got;
3245 }
3246
3247 IV
3248 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3249 {
3250     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3251     PERL_UNUSED_CONTEXT;
3252
3253     return PerlSIO_fseek(stdio, offset, whence);
3254 }
3255
3256 Off_t
3257 PerlIOStdio_tell(pTHX_ PerlIO *f)
3258 {
3259     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3260     PERL_UNUSED_CONTEXT;
3261
3262     return PerlSIO_ftell(stdio);
3263 }
3264
3265 IV
3266 PerlIOStdio_flush(pTHX_ PerlIO *f)
3267 {
3268     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3269     PERL_UNUSED_CONTEXT;
3270
3271     if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3272         return PerlSIO_fflush(stdio);
3273     }
3274     else {
3275         NOOP;
3276 #if 0
3277         /*
3278          * FIXME: This discards ungetc() and pre-read stuff which is not
3279          * right if this is just a "sync" from a layer above Suspect right
3280          * design is to do _this_ but not have layer above flush this
3281          * layer read-to-read
3282          */
3283         /*
3284          * Not writeable - sync by attempting a seek
3285          */
3286         const int err = errno;
3287         if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3288             errno = err;
3289 #endif
3290     }
3291     return 0;
3292 }
3293
3294 IV
3295 PerlIOStdio_eof(pTHX_ PerlIO *f)
3296 {
3297     PERL_UNUSED_CONTEXT;
3298
3299     return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3300 }
3301
3302 IV
3303 PerlIOStdio_error(pTHX_ PerlIO *f)
3304 {
3305     PERL_UNUSED_CONTEXT;
3306
3307     return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3308 }
3309
3310 void
3311 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3312 {
3313     PERL_UNUSED_CONTEXT;
3314
3315     PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3316 }
3317
3318 void
3319 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3320 {
3321     PERL_UNUSED_CONTEXT;
3322
3323 #ifdef HAS_SETLINEBUF
3324     PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3325 #else
3326     PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, NULL, _IOLBF, 0);
3327 #endif
3328 }
3329
3330 #ifdef FILE_base
3331 STDCHAR *
3332 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3333 {
3334     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3335     return (STDCHAR*)PerlSIO_get_base(stdio);
3336 }
3337
3338 Size_t
3339 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3340 {
3341     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3342     return PerlSIO_get_bufsiz(stdio);
3343 }
3344 #endif
3345
3346 #ifdef USE_STDIO_PTR
3347 STDCHAR *
3348 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3349 {
3350     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3351     return (STDCHAR*)PerlSIO_get_ptr(stdio);
3352 }
3353
3354 SSize_t
3355 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3356 {
3357     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3358     return PerlSIO_get_cnt(stdio);
3359 }
3360
3361 void
3362 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3363 {
3364     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3365     if (ptr != NULL) {
3366 #ifdef STDIO_PTR_LVALUE
3367         PerlSIO_set_ptr(stdio, ptr); /* LHS STDCHAR* cast non-portable */
3368 #ifdef STDIO_PTR_LVAL_SETS_CNT
3369         if (PerlSIO_get_cnt(stdio) != (cnt)) {
3370             assert(PerlSIO_get_cnt(stdio) == (cnt));
3371         }
3372 #endif
3373 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3374         /*
3375          * Setting ptr _does_ change cnt - we are done
3376          */
3377         return;
3378 #endif
3379 #else                           /* STDIO_PTR_LVALUE */
3380         PerlProc_abort();
3381 #endif                          /* STDIO_PTR_LVALUE */
3382     }
3383     /*
3384      * Now (or only) set cnt
3385      */
3386 #ifdef STDIO_CNT_LVALUE
3387     PerlSIO_set_cnt(stdio, cnt);
3388 #else                           /* STDIO_CNT_LVALUE */
3389 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3390     PerlSIO_set_ptr(stdio,
3391                     PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3392                                               cnt));
3393 #else                           /* STDIO_PTR_LVAL_SETS_CNT */
3394     PerlProc_abort();
3395 #endif                          /* STDIO_PTR_LVAL_SETS_CNT */
3396 #endif                          /* STDIO_CNT_LVALUE */
3397 }
3398
3399
3400 #endif
3401
3402 IV
3403 PerlIOStdio_fill(pTHX_ PerlIO *f)
3404 {
3405     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3406     int c;
3407     PERL_UNUSED_CONTEXT;
3408
3409     /*
3410      * fflush()ing read-only streams can cause trouble on some stdio-s
3411      */
3412     if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3413         if (PerlSIO_fflush(stdio) != 0)
3414             return EOF;
3415     }
3416     c = PerlSIO_fgetc(stdio);
3417     if (c == EOF)
3418         return EOF;
3419
3420 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3421
3422 #ifdef STDIO_BUFFER_WRITABLE
3423     if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3424         /* Fake ungetc() to the real buffer in case system's ungetc
3425            goes elsewhere
3426          */
3427         STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3428         SSize_t cnt   = PerlSIO_get_cnt(stdio);
3429         STDCHAR *ptr  = (STDCHAR*)PerlSIO_get_ptr(stdio);
3430         if (ptr == base+1) {
3431             *--ptr = (STDCHAR) c;
3432             PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3433             if (PerlSIO_feof(stdio))
3434                 PerlSIO_clearerr(stdio);
3435             return 0;
3436         }
3437     }
3438     else
3439 #endif
3440     if (PerlIO_has_cntptr(f)) {
3441         STDCHAR ch = c;
3442         if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3443             return 0;
3444         }
3445     }
3446 #endif
3447
3448 #if defined(VMS)
3449     /* An ungetc()d char is handled separately from the regular
3450      * buffer, so we stuff it in the buffer ourselves.
3451      * Should never get called as should hit code above
3452      */
3453     *(--((*stdio)->_ptr)) = (unsigned char) c;
3454     (*stdio)->_cnt++;
3455 #else
3456     /* If buffer snoop scheme above fails fall back to
3457        using ungetc().
3458      */
3459     if (PerlSIO_ungetc(c, stdio) != c)
3460         return EOF;
3461 #endif
3462     return 0;
3463 }
3464
3465
3466
3467 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3468     sizeof(PerlIO_funcs),
3469     "stdio",
3470     sizeof(PerlIOStdio),
3471     PERLIO_K_BUFFERED|PERLIO_K_RAW,
3472     PerlIOStdio_pushed,
3473     PerlIOBase_popped,
3474     PerlIOStdio_open,
3475     PerlIOBase_binmode,         /* binmode */
3476     NULL,
3477     PerlIOStdio_fileno,
3478     PerlIOStdio_dup,
3479     PerlIOStdio_read,
3480     PerlIOStdio_unread,
3481     PerlIOStdio_write,
3482     PerlIOStdio_seek,
3483     PerlIOStdio_tell,
3484     PerlIOStdio_close,
3485     PerlIOStdio_flush,
3486     PerlIOStdio_fill,
3487     PerlIOStdio_eof,
3488     PerlIOStdio_error,
3489     PerlIOStdio_clearerr,
3490     PerlIOStdio_setlinebuf,
3491 #ifdef FILE_base
3492     PerlIOStdio_get_base,
3493     PerlIOStdio_get_bufsiz,
3494 #else
3495     NULL,
3496     NULL,
3497 #endif
3498 #ifdef USE_STDIO_PTR
3499     PerlIOStdio_get_ptr,
3500     PerlIOStdio_get_cnt,
3501 #   if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3502     PerlIOStdio_set_ptrcnt,
3503 #   else
3504     NULL,
3505 #   endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3506 #else
3507     NULL,
3508     NULL,
3509     NULL,
3510 #endif /* USE_STDIO_PTR */
3511 };
3512
3513 /* Note that calls to PerlIO_exportFILE() are reversed using
3514  * PerlIO_releaseFILE(), not importFILE. */
3515 FILE *
3516 PerlIO_exportFILE(PerlIO * f, const char *mode)
3517 {
3518     dTHX;
3519     FILE *stdio = NULL;
3520     if (PerlIOValid(f)) {
3521         char buf[8];
3522         PerlIO_flush(f);
3523         if (!mode || !*mode) {
3524             mode = PerlIO_modestr(f, buf);
3525         }
3526         stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3527         if (stdio) {
3528             PerlIOl *l = *f;
3529             PerlIO *f2;
3530             /* De-link any lower layers so new :stdio sticks */
3531             *f = NULL;
3532             if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, NULL))) {
3533                 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3534                 s->stdio = stdio;
3535                 /* Link previous lower layers under new one */
3536                 *PerlIONext(f) = l;
3537             }
3538             else {
3539                 /* restore layers list */
3540                 *f = l;
3541             }
3542         }
3543     }
3544     return stdio;
3545 }
3546
3547
3548 FILE *
3549 PerlIO_findFILE(PerlIO *f)
3550 {
3551     PerlIOl *l = *f;
3552     while (l) {
3553         if (l->tab == &PerlIO_stdio) {
3554             PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3555             return s->stdio;
3556         }
3557         l = *PerlIONext(&l);
3558     }
3559     /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3560     return PerlIO_exportFILE(f, NULL);
3561 }
3562
3563 /* Use this to reverse PerlIO_exportFILE calls. */
3564 void
3565 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3566 {
3567     dVAR;
3568     PerlIOl *l;
3569     while ((l = *p)) {
3570         if (l->tab == &PerlIO_stdio) {
3571             PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3572             if (s->stdio == f) {
3573                 dTHX;
3574                 PerlIO_pop(aTHX_ p);
3575                 return;
3576             }
3577         }
3578         p = PerlIONext(p);
3579     }
3580     return;
3581 }
3582
3583 /*--------------------------------------------------------------------------------------*/
3584 /*
3585  * perlio buffer layer
3586  */
3587
3588 IV
3589 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3590 {
3591     PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3592     const int fd = PerlIO_fileno(f);
3593     if (fd >= 0 && PerlLIO_isatty(fd)) {
3594         PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3595     }
3596     if (*PerlIONext(f)) {
3597         const Off_t posn = PerlIO_tell(PerlIONext(f));
3598         if (posn != (Off_t) - 1) {
3599             b->posn = posn;
3600         }
3601     }
3602     return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3603 }
3604
3605 PerlIO *
3606 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3607                IV n, const char *mode, int fd, int imode, int perm,
3608                PerlIO *f, int narg, SV **args)
3609 {
3610     if (PerlIOValid(f)) {
3611         PerlIO *next = PerlIONext(f);
3612         PerlIO_funcs *tab =
3613              PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3614         if (tab && tab->Open)
3615              next =
3616                   (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3617                                next, narg, args);
3618         if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3619             return NULL;
3620         }
3621     }
3622     else {
3623         PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3624         int init = 0;
3625         if (*mode == IoTYPE_IMPLICIT) {
3626             init = 1;
3627             /*
3628              * mode++;
3629              */
3630         }
3631         if (tab && tab->Open)
3632              f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3633                               f, narg, args);
3634         else
3635              SETERRNO(EINVAL, LIB_INVARG);
3636         if (f) {
3637             if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3638                 /*
3639                  * if push fails during open, open fails. close will pop us.
3640                  */
3641                 PerlIO_close (f);
3642                 return NULL;
3643             } else {
3644                 fd = PerlIO_fileno(f);
3645                 if (init && fd == 2) {
3646                     /*
3647                      * Initial stderr is unbuffered
3648                      */
3649                     PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3650                 }
3651 #ifdef PERLIO_USING_CRLF
3652 #  ifdef PERLIO_IS_BINMODE_FD
3653                 if (PERLIO_IS_BINMODE_FD(fd))
3654                     PerlIO_binmode(aTHX_ f,  '<'/*not used*/, O_BINARY, NULL);
3655                 else
3656 #  endif
3657                 /*
3658                  * do something about failing setmode()? --jhi
3659                  */
3660                 PerlLIO_setmode(fd, O_BINARY);
3661 #endif
3662             }
3663         }
3664     }
3665     return f;
3666 }
3667
3668 /*
3669  * This "flush" is akin to sfio's sync in that it handles files in either
3670  * read or write state.  For write state, we put the postponed data through
3671  * the next layers.  For read state, we seek() the next layers to the
3672  * offset given by current position in the buffer, and discard the buffer
3673  * state (XXXX supposed to be for seek()able buffers only, but now it is done
3674  * in any case?).  Then the pass the stick further in chain.
3675  */
3676 IV
3677 PerlIOBuf_flush(pTHX_ PerlIO *f)
3678 {
3679     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3680     int code = 0;
3681     PerlIO *n = PerlIONext(f);
3682     if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3683         /*
3684          * write() the buffer
3685          */
3686         const STDCHAR *buf = b->buf;
3687         const STDCHAR *p = buf;
3688         while (p < b->ptr) {
3689             SSize_t count = PerlIO_write(n, p, b->ptr - p);
3690             if (count > 0) {
3691                 p += count;
3692             }
3693             else if (count < 0 || PerlIO_error(n)) {
3694                 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3695                 code = -1;
3696                 break;
3697             }
3698         }
3699         b->posn += (p - buf);
3700     }
3701     else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3702         STDCHAR *buf = PerlIO_get_base(f);
3703         /*
3704          * Note position change
3705          */
3706         b->posn += (b->ptr - buf);
3707         if (b->ptr < b->end) {
3708             /* We did not consume all of it - try and seek downstream to
3709                our logical position
3710              */
3711             if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3712                 /* Reload n as some layers may pop themselves on seek */
3713                 b->posn = PerlIO_tell(n = PerlIONext(f));
3714             }
3715             else {
3716                 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3717                    data is lost for good - so return saying "ok" having undone
3718                    the position adjust
3719                  */
3720                 b->posn -= (b->ptr - buf);
3721                 return code;
3722             }
3723         }
3724     }
3725     b->ptr = b->end = b->buf;
3726     PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3727     /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3728     if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3729         code = -1;
3730     return code;
3731 }
3732
3733 /* This discards the content of the buffer after b->ptr, and rereads
3734  * the buffer from the position off in the layer downstream; here off
3735  * is at offset corresponding to b->ptr - b->buf.
3736  */
3737 IV
3738 PerlIOBuf_fill(pTHX_ PerlIO *f)
3739 {
3740     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3741     PerlIO *n = PerlIONext(f);
3742     SSize_t avail;
3743     /*
3744      * Down-stream flush is defined not to loose read data so is harmless.
3745      * we would not normally be fill'ing if there was data left in anycase.
3746      */
3747     if (PerlIO_flush(f) != 0)   /* XXXX Check that its seek() succeeded?! */
3748         return -1;
3749     if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3750         PerlIOBase_flush_linebuf(aTHX);
3751
3752     if (!b->buf)
3753         PerlIO_get_base(f);     /* allocate via vtable */
3754
3755     assert(b->buf); /* The b->buf does get allocated via the vtable system. */
3756
3757     b->ptr = b->end = b->buf;
3758
3759     if (!PerlIOValid(n)) {
3760         PerlIOBase(f)->flags |= PERLIO_F_EOF;
3761         return -1;
3762     }
3763
3764     if (PerlIO_fast_gets(n)) {
3765         /*
3766          * Layer below is also buffered. We do _NOT_ want to call its
3767          * ->Read() because that will loop till it gets what we asked for
3768          * which may hang on a pipe etc. Instead take anything it has to
3769          * hand, or ask it to fill _once_.
3770          */
3771         avail = PerlIO_get_cnt(n);
3772         if (avail <= 0) {
3773             avail = PerlIO_fill(n);
3774             if (avail == 0)
3775                 avail = PerlIO_get_cnt(n);
3776             else {
3777                 if (!PerlIO_error(n) && PerlIO_eof(n))
3778                     avail = 0;
3779             }
3780         }
3781         if (avail > 0) {
3782             STDCHAR *ptr = PerlIO_get_ptr(n);
3783             const SSize_t cnt = avail;
3784             if (avail > (SSize_t)b->bufsiz)
3785                 avail = b->bufsiz;
3786             Copy(ptr, b->buf, avail, STDCHAR);
3787             PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3788         }
3789     }
3790     else {
3791         avail = PerlIO_read(n, b->ptr, b->bufsiz);
3792     }
3793     if (avail <= 0) {
3794         if (avail == 0)
3795             PerlIOBase(f)->flags |= PERLIO_F_EOF;
3796         else
3797             PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3798         return -1;
3799     }
3800     b->end = b->buf + avail;
3801     PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3802     return 0;
3803 }
3804
3805 SSize_t
3806 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3807 {
3808     if (PerlIOValid(f)) {
3809         const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3810         if (!b->ptr)
3811             PerlIO_get_base(f);
3812         return PerlIOBase_read(aTHX_ f, vbuf, count);
3813     }
3814     return 0;
3815 }
3816
3817 SSize_t
3818 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3819 {
3820     const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3821     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3822     SSize_t unread = 0;
3823     SSize_t avail;
3824     if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3825         PerlIO_flush(f);
3826     if (!b->buf)
3827         PerlIO_get_base(f);
3828     if (b->buf) {
3829         if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3830             /*
3831              * Buffer is already a read buffer, we can overwrite any chars
3832              * which have been read back to buffer start
3833              */
3834             avail = (b->ptr - b->buf);
3835         }
3836         else {
3837             /*
3838              * Buffer is idle, set it up so whole buffer is available for
3839              * unread
3840              */
3841             avail = b->bufsiz;
3842             b->end = b->buf + avail;
3843             b->ptr = b->end;
3844             PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3845             /*
3846              * Buffer extends _back_ from where we are now
3847              */
3848             b->posn -= b->bufsiz;
3849         }
3850         if (avail > (SSize_t) count) {
3851             /*
3852              * If we have space for more than count, just move count
3853              */
3854             avail = count;
3855         }
3856         if (avail > 0) {
3857             b->ptr -= avail;
3858             buf -= avail;
3859             /*
3860              * In simple stdio-like ungetc() case chars will be already
3861              * there
3862              */
3863             if (buf != b->ptr) {
3864                 Copy(buf, b->ptr, avail, STDCHAR);
3865             }
3866             count -= avail;
3867             unread += avail;
3868             PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3869         }
3870     }
3871     if (count > 0) {
3872         unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3873     }
3874     return unread;
3875 }
3876
3877 SSize_t
3878 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3879 {
3880     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3881     const STDCHAR *buf = (const STDCHAR *) vbuf;
3882     const STDCHAR *flushptr = buf;
3883     Size_t written = 0;
3884     if (!b->buf)
3885         PerlIO_get_base(f);
3886     if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3887         return 0;
3888     if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3889         if (PerlIO_flush(f) != 0) {
3890             return 0;
3891         }
3892     }
3893     if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3894         flushptr = buf + count;
3895         while (flushptr > buf && *(flushptr - 1) != '\n')
3896             --flushptr;
3897     }
3898     while (count > 0) {
3899         SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3900         if ((SSize_t) count < avail)
3901             avail = count;
3902         if (flushptr > buf && flushptr <= buf + avail)
3903             avail = flushptr - buf;
3904         PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3905         if (avail) {
3906             Copy(buf, b->ptr, avail, STDCHAR);
3907             count -= avail;
3908             buf += avail;
3909             written += avail;
3910             b->ptr += avail;
3911             if (buf == flushptr)
3912                 PerlIO_flush(f);
3913         }
3914         if (b->ptr >= (b->buf + b->bufsiz))
3915             PerlIO_flush(f);
3916     }
3917     if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3918         PerlIO_flush(f);
3919     return written;
3920 }
3921
3922 IV
3923 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3924 {
3925     IV code;
3926     if ((code = PerlIO_flush(f)) == 0) {
3927         PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3928         code = PerlIO_seek(PerlIONext(f), offset, whence);
3929         if (code == 0) {
3930             PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3931             b->posn = PerlIO_tell(PerlIONext(f));
3932         }
3933     }
3934     return code;
3935 }
3936
3937 Off_t
3938 PerlIOBuf_tell(pTHX_ PerlIO *f)
3939 {
3940     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3941     /*
3942      * b->posn is file position where b->buf was read, or will be written
3943      */
3944     Off_t posn = b->posn;
3945     if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3946         (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3947 #if 1
3948         /* As O_APPEND files are normally shared in some sense it is better
3949            to flush :
3950          */
3951         PerlIO_flush(f);
3952 #else
3953         /* when file is NOT shared then this is sufficient */
3954         PerlIO_seek(PerlIONext(f),0, SEEK_END);
3955 #endif
3956         posn = b->posn = PerlIO_tell(PerlIONext(f));
3957     }
3958     if (b->buf) {
3959         /*
3960          * If buffer is valid adjust position by amount in buffer
3961          */
3962         posn += (b->ptr - b->buf);
3963     }
3964     return posn;
3965 }
3966
3967 IV
3968 PerlIOBuf_popped(pTHX_ PerlIO *f)
3969 {
3970     const IV code = PerlIOBase_popped(aTHX_ f);
3971     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3972     if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3973         Safefree(b->buf);
3974     }
3975     b->ptr = b->end = b->buf = NULL;
3976     PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3977     return code;
3978 }
3979
3980 IV
3981 PerlIOBuf_close(pTHX_ PerlIO *f)
3982 {
3983     const IV code = PerlIOBase_close(aTHX_ f);
3984     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3985     if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3986         Safefree(b->buf);
3987     }
3988     b->ptr = b->end = b->buf = NULL;
3989     PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3990     return code;
3991 }
3992
3993 STDCHAR *
3994 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
3995 {
3996     const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3997     if (!b->buf)
3998         PerlIO_get_base(f);
3999     return b->ptr;
4000 }
4001
4002 SSize_t
4003 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
4004 {
4005     const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4006     if (!b->buf)
4007         PerlIO_get_base(f);
4008     if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
4009         return (b->end - b->ptr);
4010     return 0;
4011 }
4012
4013 STDCHAR *
4014 PerlIOBuf_get_base(pTHX_ PerlIO *f)
4015 {
4016     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4017     PERL_UNUSED_CONTEXT;
4018
4019     if (!b->buf) {
4020         if (!b->bufsiz)
4021             b->bufsiz = 4096;
4022         b->buf = Newxz(b->buf,b->bufsiz, STDCHAR);
4023         if (!b->buf) {
4024             b->buf = (STDCHAR *) & b->oneword;
4025             b->bufsiz = sizeof(b->oneword);
4026         }
4027         b->end = b->ptr = b->buf;
4028     }
4029     return b->buf;
4030 }
4031
4032 Size_t
4033 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
4034 {
4035     const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4036     if (!b->buf)
4037         PerlIO_get_base(f);
4038     return (b->end - b->buf);
4039 }
4040
4041 void
4042 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4043 {
4044     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4045     if (!b->buf)
4046         PerlIO_get_base(f);
4047     b->ptr = ptr;
4048     if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
4049         assert(PerlIO_get_cnt(f) == cnt);
4050         assert(b->ptr >= b->buf);
4051     }
4052     PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4053 }
4054
4055 PerlIO *
4056 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4057 {
4058  return PerlIOBase_dup(aTHX_ f, o, param, flags);
4059 }
4060
4061
4062
4063 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
4064     sizeof(PerlIO_funcs),
4065     "perlio",
4066     sizeof(PerlIOBuf),
4067     PERLIO_K_BUFFERED|PERLIO_K_RAW,
4068     PerlIOBuf_pushed,
4069     PerlIOBuf_popped,
4070     PerlIOBuf_open,
4071     PerlIOBase_binmode,         /* binmode */
4072     NULL,
4073     PerlIOBase_fileno,
4074     PerlIOBuf_dup,
4075     PerlIOBuf_read,
4076     PerlIOBuf_unread,
4077     PerlIOBuf_write,
4078     PerlIOBuf_seek,
4079     PerlIOBuf_tell,
4080     PerlIOBuf_close,
4081     PerlIOBuf_flush,
4082     PerlIOBuf_fill,
4083     PerlIOBase_eof,
4084     PerlIOBase_error,
4085     PerlIOBase_clearerr,
4086     PerlIOBase_setlinebuf,
4087     PerlIOBuf_get_base,
4088     PerlIOBuf_bufsiz,
4089     PerlIOBuf_get_ptr,
4090     PerlIOBuf_get_cnt,
4091     PerlIOBuf_set_ptrcnt,
4092 };
4093
4094 /*--------------------------------------------------------------------------------------*/
4095 /*
4096  * Temp layer to hold unread chars when cannot do it any other way
4097  */
4098
4099 IV
4100 PerlIOPending_fill(pTHX_ PerlIO *f)
4101 {
4102     /*
4103      * Should never happen
4104      */
4105     PerlIO_flush(f);
4106     return 0;
4107 }
4108
4109 IV
4110 PerlIOPending_close(pTHX_ PerlIO *f)
4111 {
4112     /*
4113      * A tad tricky - flush pops us, then we close new top
4114      */
4115     PerlIO_flush(f);
4116     return PerlIO_close(f);
4117 }
4118
4119 IV
4120 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4121 {
4122     /*
4123      * A tad tricky - flush pops us, then we seek new top
4124      */
4125     PerlIO_flush(f);
4126     return PerlIO_seek(f, offset, whence);
4127 }
4128
4129
4130 IV
4131 PerlIOPending_flush(pTHX_ PerlIO *f)
4132 {
4133     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4134     if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4135         Safefree(b->buf);
4136         b->buf = NULL;
4137     }
4138     PerlIO_pop(aTHX_ f);
4139     return 0;
4140 }
4141
4142 void
4143 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4144 {
4145     if (cnt <= 0) {
4146         PerlIO_flush(f);
4147     }
4148     else {
4149         PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4150     }
4151 }
4152
4153 IV
4154 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4155 {
4156     const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4157     PerlIOl * const l = PerlIOBase(f);
4158     /*
4159      * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4160      * etc. get muddled when it changes mid-string when we auto-pop.
4161      */
4162     l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4163         (PerlIOBase(PerlIONext(f))->
4164          flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4165     return code;
4166 }
4167
4168 SSize_t
4169 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4170 {
4171     SSize_t avail = PerlIO_get_cnt(f);
4172     SSize_t got = 0;
4173     if ((SSize_t)count < avail)
4174         avail = count;
4175     if (avail > 0)
4176         got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4177     if (got >= 0 && got < (SSize_t)count) {
4178         const SSize_t more =
4179             PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4180         if (more >= 0 || got == 0)
4181             got += more;
4182     }
4183     return got;
4184 }
4185
4186 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4187     sizeof(PerlIO_funcs),
4188     "pending",
4189     sizeof(PerlIOBuf),
4190     PERLIO_K_BUFFERED|PERLIO_K_RAW,  /* not sure about RAW here */
4191     PerlIOPending_pushed,
4192     PerlIOBuf_popped,
4193     NULL,
4194     PerlIOBase_binmode,         /* binmode */
4195     NULL,
4196     PerlIOBase_fileno,
4197     PerlIOBuf_dup,
4198     PerlIOPending_read,
4199     PerlIOBuf_unread,
4200     PerlIOBuf_write,
4201     PerlIOPending_seek,
4202     PerlIOBuf_tell,
4203     PerlIOPending_close,
4204     PerlIOPending_flush,
4205     PerlIOPending_fill,
4206     PerlIOBase_eof,
4207     PerlIOBase_error,
4208     PerlIOBase_clearerr,
4209     PerlIOBase_setlinebuf,
4210     PerlIOBuf_get_base,
4211     PerlIOBuf_bufsiz,
4212     PerlIOBuf_get_ptr,
4213     PerlIOBuf_get_cnt,
4214     PerlIOPending_set_ptrcnt,
4215 };
4216
4217
4218
4219 /*--------------------------------------------------------------------------------------*/
4220 /*
4221  * crlf - translation On read translate CR,LF to "\n" we do this by
4222  * overriding ptr/cnt entries to hand back a line at a time and keeping a
4223  * record of which nl we "lied" about. On write translate "\n" to CR,LF
4224  *
4225  * c->nl points on the first byte of CR LF pair when it is temporarily
4226  * replaced by LF, or to the last CR of the buffer.  In the former case
4227  * the caller thinks that the buffer ends at c->nl + 1, in the latter
4228  * that it ends at c->nl; these two cases can be distinguished by
4229  * *c->nl.  c->nl is set during _getcnt() call, and unset during
4230  * _unread() and _flush() calls.
4231  * It only matters for read operations.
4232  */
4233
4234 typedef struct {
4235     PerlIOBuf base;             /* PerlIOBuf stuff */
4236     STDCHAR *nl;                /* Position of crlf we "lied" about in the
4237                                  * buffer */
4238 } PerlIOCrlf;
4239
4240 /* Inherit the PERLIO_F_UTF8 flag from previous layer.
4241  * Otherwise the :crlf layer would always revert back to
4242  * raw mode.
4243  */
4244 static void
4245 S_inherit_utf8_flag(PerlIO *f)
4246 {
4247     PerlIO *g = PerlIONext(f);
4248     if (PerlIOValid(g)) {
4249         if (PerlIOBase(g)->flags & PERLIO_F_UTF8) {
4250             PerlIOBase(f)->flags |= PERLIO_F_UTF8;
4251         }
4252     }
4253 }
4254
4255 IV
4256 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4257 {
4258     IV code;
4259     PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4260     code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4261 #if 0
4262     PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4263                  (void*)f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4264                  PerlIOBase(f)->flags);
4265 #endif
4266     {
4267       /* Enable the first CRLF capable layer you can find, but if none
4268        * found, the one we just pushed is fine.  This results in at
4269        * any given moment at most one CRLF-capable layer being enabled
4270        * in the whole layer stack. */
4271          PerlIO *g = PerlIONext(f);
4272          while (PerlIOValid(g)) {
4273               PerlIOl *b = PerlIOBase(g);
4274               if (b && b->tab == &PerlIO_crlf) {
4275                    if (!(b->flags & PERLIO_F_CRLF))
4276                         b->flags |= PERLIO_F_CRLF;
4277                    S_inherit_utf8_flag(g);
4278                    PerlIO_pop(aTHX_ f);
4279                    return code;
4280               }
4281               g = PerlIONext(g);
4282          }
4283     }
4284     S_inherit_utf8_flag(f);
4285     return code;
4286 }
4287
4288
4289 SSize_t
4290 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4291 {
4292     PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4293     if (c->nl) {        /* XXXX Shouldn't it be done only if b->ptr > c->nl? */
4294         *(c->nl) = 0xd;
4295         c->nl = NULL;
4296     }
4297     if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4298         return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4299     else {
4300         const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4301         PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4302         SSize_t unread = 0;
4303         if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4304             PerlIO_flush(f);
4305         if (!b->buf)
4306             PerlIO_get_base(f);
4307         if (b->buf) {
4308             if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4309                 b->end = b->ptr = b->buf + b->bufsiz;
4310                 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4311                 b->posn -= b->bufsiz;
4312             }
4313             while (count > 0 && b->ptr > b->buf) {
4314                 const int ch = *--buf;
4315                 if (ch == '\n') {
4316                     if (b->ptr - 2 >= b->buf) {
4317                         *--(b->ptr) = 0xa;
4318                         *--(b->ptr) = 0xd;
4319                         unread++;
4320                         count--;
4321                     }
4322                     else {
4323                     /* If b->ptr - 1 == b->buf, we are undoing reading 0xa */
4324                         *--(b->ptr) = 0xa;      /* Works even if 0xa == '\r' */
4325                         unread++;
4326                         count--;
4327                     }
4328                 }
4329                 else {
4330                     *--(b->ptr) = ch;
4331                     unread++;
4332                     count--;
4333                 }
4334             }
4335         }
4336         return unread;
4337     }
4338 }
4339
4340 /* XXXX This code assumes that buffer size >=2, but does not check it... */
4341 SSize_t
4342 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4343 {
4344     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4345     if (!b->buf)
4346         PerlIO_get_base(f);
4347     if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4348         PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4349         if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4350             STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4351           scan:
4352             while (nl < b->end && *nl != 0xd)
4353                 nl++;
4354             if (nl < b->end && *nl == 0xd) {
4355               test:
4356                 if (nl + 1 < b->end) {
4357                     if (nl[1] == 0xa) {
4358                         *nl = '\n';
4359                         c->nl = nl;
4360                     }
4361                     else {
4362                         /*
4363                          * Not CR,LF but just CR
4364                          */
4365                         nl++;
4366                         goto scan;
4367                     }
4368                 }
4369                 else {
4370                     /*
4371                      * Blast - found CR as last char in buffer
4372                      */
4373
4374                     if (b->ptr < nl) {
4375                         /*
4376                          * They may not care, defer work as long as
4377                          * possible
4378                          */
4379                         c->nl = nl;
4380                         return (nl - b->ptr);
4381                     }
4382                     else {
4383                         int code;
4384                         b->ptr++;       /* say we have read it as far as
4385                                          * flush() is concerned */
4386                         b->buf++;       /* Leave space in front of buffer */
4387                         /* Note as we have moved buf up flush's
4388                            posn += ptr-buf
4389                            will naturally make posn point at CR
4390                          */
4391                         b->bufsiz--;    /* Buffer is thus smaller */
4392                         code = PerlIO_fill(f);  /* Fetch some more */
4393                         b->bufsiz++;    /* Restore size for next time */
4394                         b->buf--;       /* Point at space */
4395                         b->ptr = nl = b->buf;   /* Which is what we hand
4396                                                  * off */
4397                         *nl = 0xd;      /* Fill in the CR */
4398                         if (code == 0)
4399                             goto test;  /* fill() call worked */
4400                         /*
4401                          * CR at EOF - just fall through
4402                          */
4403                         /* Should we clear EOF though ??? */
4404                     }
4405                 }
4406             }
4407         }
4408         return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4409     }
4410     return 0;
4411 }
4412
4413 void
4414 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4415 {
4416     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4417     PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4418     if (!b->buf)
4419         PerlIO_get_base(f);
4420     if (!ptr) {
4421         if (c->nl) {
4422             ptr = c->nl + 1;
4423             if (ptr == b->end && *c->nl == 0xd) {
4424                 /* Defered CR at end of buffer case - we lied about count */
4425                 ptr--;
4426             }
4427         }
4428         else {
4429             ptr = b->end;
4430         }
4431         ptr -= cnt;
4432     }
4433     else {
4434         NOOP;
4435 #if 0
4436         /*
4437          * Test code - delete when it works ...
4438          */
4439         IV flags = PerlIOBase(f)->flags;
4440         STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4441         if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4442           /* Defered CR at end of buffer case - we lied about count */
4443           chk--;
4444         }
4445         chk -= cnt;
4446
4447         if (ptr != chk ) {
4448             Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4449                        " nl=%p e=%p for %d", (void*)ptr, (void*)chk,
4450                        flags, c->nl, b->end, cnt);
4451         }
4452 #endif
4453     }
4454     if (c->nl) {
4455         if (ptr > c->nl) {
4456             /*
4457              * They have taken what we lied about
4458              */
4459             *(c->nl) = 0xd;
4460             c->nl = NULL;
4461             ptr++;
4462         }
4463     }
4464     b->ptr = ptr;
4465     PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4466 }
4467
4468 SSize_t
4469 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4470 {
4471     if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4472         return PerlIOBuf_write(aTHX_ f, vbuf, count);
4473     else {
4474         PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4475         const STDCHAR *buf = (const STDCHAR *) vbuf;
4476         const STDCHAR * const ebuf = buf + count;
4477         if (!b->buf)
4478             PerlIO_get_base(f);
4479         if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4480             return 0;
4481         while (buf < ebuf) {
4482             const STDCHAR * const eptr = b->buf + b->bufsiz;
4483             PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4484             while (buf < ebuf && b->ptr < eptr) {
4485                 if (*buf == '\n') {
4486                     if ((b->ptr + 2) > eptr) {
4487                         /*
4488                          * Not room for both
4489                          */
4490                         PerlIO_flush(f);
4491                         break;
4492                     }
4493                     else {
4494                         *(b->ptr)++ = 0xd;      /* CR */
4495                         *(b->ptr)++ = 0xa;      /* LF */
4496                         buf++;
4497                         if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4498                             PerlIO_flush(f);
4499                             break;
4500                         }
4501                     }
4502                 }
4503                 else {
4504                     *(b->ptr)++ = *buf++;
4505                 }
4506                 if (b->ptr >= eptr) {
4507                     PerlIO_flush(f);
4508                     break;
4509                 }
4510             }
4511         }
4512         if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4513             PerlIO_flush(f);
4514         return (buf - (STDCHAR *) vbuf);
4515     }
4516 }
4517
4518 IV
4519 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4520 {
4521     PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4522     if (c->nl) {
4523         *(c->nl) = 0xd;
4524         c->nl = NULL;
4525     }
4526     return PerlIOBuf_flush(aTHX_ f);
4527 }
4528
4529 IV
4530 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4531 {
4532     if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4533         /* In text mode - flush any pending stuff and flip it */
4534         PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4535 #ifndef PERLIO_USING_CRLF
4536         /* CRLF is unusual case - if this is just the :crlf layer pop it */
4537         if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4538                 PerlIO_pop(aTHX_ f);
4539         }
4540 #endif
4541     }
4542     return 0;
4543 }
4544
4545 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4546     sizeof(PerlIO_funcs),
4547     "crlf",
4548     sizeof(PerlIOCrlf),
4549     PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4550     PerlIOCrlf_pushed,
4551     PerlIOBuf_popped,         /* popped */
4552     PerlIOBuf_open,
4553     PerlIOCrlf_binmode,       /* binmode */
4554     NULL,
4555     PerlIOBase_fileno,
4556     PerlIOBuf_dup,
4557     PerlIOBuf_read,             /* generic read works with ptr/cnt lies */
4558     PerlIOCrlf_unread,          /* Put CR,LF in buffer for each '\n' */
4559     PerlIOCrlf_write,           /* Put CR,LF in buffer for each '\n' */
4560     PerlIOBuf_seek,
4561     PerlIOBuf_tell,
4562     PerlIOBuf_close,
4563     PerlIOCrlf_flush,
4564     PerlIOBuf_fill,
4565     PerlIOBase_eof,
4566     PerlIOBase_error,
4567     PerlIOBase_clearerr,
4568     PerlIOBase_setlinebuf,
4569     PerlIOBuf_get_base,
4570     PerlIOBuf_bufsiz,
4571     PerlIOBuf_get_ptr,
4572     PerlIOCrlf_get_cnt,
4573     PerlIOCrlf_set_ptrcnt,
4574 };
4575
4576 #ifdef HAS_MMAP
4577 /*--------------------------------------------------------------------------------------*/
4578 /*
4579  * mmap as "buffer" layer
4580  */
4581
4582 typedef struct {
4583     PerlIOBuf base;             /* PerlIOBuf stuff */
4584     Mmap_t mptr;                /* Mapped address */
4585     Size_t len;                 /* mapped length */
4586     STDCHAR *bbuf;              /* malloced buffer if map fails */
4587 } PerlIOMmap;
4588
4589 IV
4590 PerlIOMmap_map(pTHX_ PerlIO *f)
4591 {
4592     dVAR;
4593     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4594     const IV flags = PerlIOBase(f)->flags;
4595     IV code = 0;
4596     if (m->len)
4597         abort();
4598     if (flags & PERLIO_F_CANREAD) {
4599         PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4600         const int fd = PerlIO_fileno(f);
4601         Stat_t st;
4602         code = Fstat(fd, &st);
4603         if (code == 0 && S_ISREG(st.st_mode)) {
4604             SSize_t len = st.st_size - b->posn;
4605             if (len > 0) {
4606                 Off_t posn;
4607                 if (PL_mmap_page_size <= 0)
4608                   Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4609                              PL_mmap_page_size);
4610                 if (b->posn < 0) {
4611                     /*
4612                      * This is a hack - should never happen - open should
4613                      * have set it !
4614                      */
4615                     b->posn = PerlIO_tell(PerlIONext(f));
4616                 }
4617                 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4618                 len = st.st_size - posn;
4619                 m->mptr = (Mmap_t)mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4620                 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4621 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4622                     madvise(m->mptr, len, MADV_SEQUENTIAL);
4623 #endif
4624 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4625                     madvise(m->mptr, len, MADV_WILLNEED);
4626 #endif
4627                     PerlIOBase(f)->flags =
4628                         (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4629                     b->end = ((STDCHAR *) m->mptr) + len;
4630                     b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4631                     b->ptr = b->buf;
4632                     m->len = len;
4633                 }
4634                 else {
4635                     b->buf = NULL;
4636                 }
4637             }
4638             else {
4639                 PerlIOBase(f)->flags =
4640                     flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4641                 b->buf = NULL;
4642                 b->ptr = b->end = b->ptr;
4643                 code = -1;
4644             }
4645         }
4646     }
4647     return code;
4648 }
4649
4650 IV
4651 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4652 {
4653     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4654     IV code = 0;
4655     if (m->len) {
4656         PerlIOBuf * const b = &m->base;
4657         if (b->buf) {
4658             /* The munmap address argument is tricky: depending on the
4659              * standard it is either "void *" or "caddr_t" (which is
4660              * usually "char *" (signed or unsigned).  If we cast it
4661              * to "void *", those that have it caddr_t and an uptight
4662              * C++ compiler, will freak out.  But casting it as char*
4663              * should work.  Maybe.  (Using Mmap_t figured out by
4664              * Configure doesn't always work, apparently.) */
4665             code = munmap((char*)m->mptr, m->len);
4666             b->buf = NULL;
4667             m->len = 0;
4668             m->mptr = NULL;
4669             if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4670                 code = -1;
4671         }
4672         b->ptr = b->end = b->buf;
4673         PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4674     }
4675     return code;
4676 }
4677
4678 STDCHAR *
4679 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4680 {
4681     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4682     PerlIOBuf * const b = &m->base;
4683     if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4684         /*
4685          * Already have a readbuffer in progress
4686          */
4687         return b->buf;
4688     }
4689     if (b->buf) {
4690         /*
4691          * We have a write buffer or flushed PerlIOBuf read buffer
4692          */
4693         m->bbuf = b->buf;       /* save it in case we need it again */
4694         b->buf = NULL;          /* Clear to trigger below */
4695     }
4696     if (!b->buf) {
4697         PerlIOMmap_map(aTHX_ f);        /* Try and map it */
4698         if (!b->buf) {
4699             /*
4700              * Map did not work - recover PerlIOBuf buffer if we have one
4701              */
4702             b->buf = m->bbuf;
4703         }
4704     }
4705     b->ptr = b->end = b->buf;
4706     if (b->buf)
4707         return b->buf;
4708     return PerlIOBuf_get_base(aTHX_ f);
4709 }
4710
4711 SSize_t
4712 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4713 {
4714     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4715     PerlIOBuf * const b = &m->base;
4716     if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4717         PerlIO_flush(f);
4718     if (b->ptr && (b->ptr - count) >= b->buf
4719         && memEQ(b->ptr - count, vbuf, count)) {
4720         b->ptr -= count;
4721         PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4722         return count;
4723     }
4724     if (m->len) {
4725         /*
4726          * Loose the unwritable mapped buffer
4727          */
4728         PerlIO_flush(f);
4729         /*
4730          * If flush took the "buffer" see if we have one from before
4731          */
4732         if (!b->buf && m->bbuf)
4733             b->buf = m->bbuf;
4734         if (!b->buf) {
4735             PerlIOBuf_get_base(aTHX_ f);
4736             m->bbuf = b->buf;
4737         }
4738     }
4739     return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4740 }
4741
4742 SSize_t
4743 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4744 {
4745     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4746     PerlIOBuf * const b = &m->base;
4747
4748     if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4749         /*
4750          * No, or wrong sort of, buffer
4751          */
4752         if (m->len) {
4753             if (PerlIOMmap_unmap(aTHX_ f) != 0)
4754                 return 0;
4755         }
4756         /*
4757          * If unmap took the "buffer" see if we have one from before
4758          */
4759         if (!b->buf && m->bbuf)
4760             b->buf = m->bbuf;
4761         if (!b->buf) {
4762             PerlIOBuf_get_base(aTHX_ f);
4763             m->bbuf = b->buf;
4764         }
4765     }
4766     return PerlIOBuf_write(aTHX_ f, vbuf, count);
4767 }
4768
4769 IV
4770 PerlIOMmap_flush(pTHX_ PerlIO *f)
4771 {
4772     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4773     PerlIOBuf * const b = &m->base;
4774     IV code = PerlIOBuf_flush(aTHX_ f);
4775     /*
4776      * Now we are "synced" at PerlIOBuf level
4777      */
4778     if (b->buf) {
4779         if (m->len) {
4780             /*
4781              * Unmap the buffer
4782              */
4783             if (PerlIOMmap_unmap(aTHX_ f) != 0)
4784                 code = -1;
4785         }
4786         else {
4787             /*
4788              * We seem to have a PerlIOBuf buffer which was not mapped
4789              * remember it in case we need one later
4790              */
4791             m->bbuf = b->buf;
4792         }
4793     }
4794     return code;
4795 }
4796
4797 IV
4798 PerlIOMmap_fill(pTHX_ PerlIO *f)
4799 {
4800     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4801     IV code = PerlIO_flush(f);
4802     if (code == 0 && !b->buf) {
4803         code = PerlIOMmap_map(aTHX_ f);
4804     }
4805     if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4806         code = PerlIOBuf_fill(aTHX_ f);
4807     }
4808     return code;
4809 }
4810
4811 IV
4812 PerlIOMmap_close(pTHX_ PerlIO *f)
4813 {
4814     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4815     PerlIOBuf * const b = &m->base;
4816     IV code = PerlIO_flush(f);
4817     if (m->bbuf) {
4818         b->buf = m->bbuf;
4819         m->bbuf = NULL;
4820         b->ptr = b->end = b->buf;
4821     }
4822     if (PerlIOBuf_close(aTHX_ f) != 0)
4823         code = -1;
4824     return code;
4825 }
4826
4827 PerlIO *
4828 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4829 {
4830  return PerlIOBase_dup(aTHX_ f, o, param, flags);
4831 }
4832
4833
4834 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4835     sizeof(PerlIO_funcs),
4836     "mmap",
4837     sizeof(PerlIOMmap),
4838     PERLIO_K_BUFFERED|PERLIO_K_RAW,
4839     PerlIOBuf_pushed,
4840     PerlIOBuf_popped,
4841     PerlIOBuf_open,
4842     PerlIOBase_binmode,         /* binmode */
4843     NULL,
4844     PerlIOBase_fileno,
4845     PerlIOMmap_dup,
4846     PerlIOBuf_read,
4847     PerlIOMmap_unread,
4848     PerlIOMmap_write,
4849     PerlIOBuf_seek,
4850     PerlIOBuf_tell,
4851     PerlIOBuf_close,
4852     PerlIOMmap_flush,
4853     PerlIOMmap_fill,
4854     PerlIOBase_eof,
4855     PerlIOBase_error,
4856     PerlIOBase_clearerr,
4857     PerlIOBase_setlinebuf,
4858     PerlIOMmap_get_base,
4859     PerlIOBuf_bufsiz,
4860     PerlIOBuf_get_ptr,
4861     PerlIOBuf_get_cnt,
4862     PerlIOBuf_set_ptrcnt,
4863 };
4864
4865 #endif                          /* HAS_MMAP */
4866
4867 PerlIO *
4868 Perl_PerlIO_stdin(pTHX)
4869 {
4870     dVAR;
4871     if (!PL_perlio) {
4872         PerlIO_stdstreams(aTHX);
4873     }
4874     return &PL_perlio[1];
4875 }
4876
4877 PerlIO *
4878 Perl_PerlIO_stdout(pTHX)
4879 {
4880     dVAR;
4881     if (!PL_perlio) {
4882         PerlIO_stdstreams(aTHX);
4883     }
4884     return &PL_perlio[2];
4885 }
4886
4887 PerlIO *
4888 Perl_PerlIO_stderr(pTHX)
4889 {
4890     dVAR;
4891     if (!PL_perlio) {
4892         PerlIO_stdstreams(aTHX);
4893     }
4894     return &PL_perlio[3];
4895 }
4896
4897 /*--------------------------------------------------------------------------------------*/
4898
4899 char *
4900 PerlIO_getname(PerlIO *f, char *buf)
4901 {
4902     dTHX;
4903 #ifdef VMS
4904     char *name = NULL;
4905     bool exported = FALSE;
4906     FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4907     if (!stdio) {
4908         stdio = PerlIO_exportFILE(f,0);
4909         exported = TRUE;
4910     }
4911     if (stdio) {
4912         name = fgetname(stdio, buf);
4913         if (exported) PerlIO_releaseFILE(f,stdio);
4914     }
4915     return name;
4916 #else
4917     PERL_UNUSED_ARG(f);
4918     PERL_UNUSED_ARG(buf);
4919     Perl_croak(aTHX_ "Don't know how to get file name");
4920     return NULL;
4921 #endif
4922 }
4923
4924
4925 /*--------------------------------------------------------------------------------------*/
4926 /*
4927  * Functions which can be called on any kind of PerlIO implemented in
4928  * terms of above
4929  */
4930
4931 #undef PerlIO_fdopen
4932 PerlIO *
4933 PerlIO_fdopen(int fd, const char *mode)
4934 {
4935     dTHX;
4936     return PerlIO_openn(aTHX_ NULL, mode, fd, 0, 0, NULL, 0, NULL);
4937 }
4938
4939 #undef PerlIO_open
4940 PerlIO *
4941 PerlIO_open(const char *path, const char *mode)
4942 {
4943     dTHX;
4944     SV *name = sv_2mortal(newSVpv(path, 0));
4945     return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, NULL, 1, &name);
4946 }
4947
4948 #undef Perlio_reopen
4949 PerlIO *
4950 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4951 {
4952     dTHX;
4953     SV *name = sv_2mortal(newSVpv(path,0));
4954     return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, f, 1, &name);
4955 }
4956
4957 #undef PerlIO_getc
4958 int
4959 PerlIO_getc(PerlIO *f)
4960 {
4961     dTHX;
4962     STDCHAR buf[1];
4963     if ( 1 == PerlIO_read(f, buf, 1) ) {
4964         return (unsigned char) buf[0];
4965     }
4966     return EOF;
4967 }
4968
4969 #undef PerlIO_ungetc
4970 int
4971 PerlIO_ungetc(PerlIO *f, int ch)
4972 {
4973     dTHX;
4974     if (ch != EOF) {
4975         STDCHAR buf = ch;
4976         if (PerlIO_unread(f, &buf, 1) == 1)
4977             return ch;
4978     }
4979     return EOF;
4980 }
4981
4982 #undef PerlIO_putc
4983 int
4984 PerlIO_putc(PerlIO *f, int ch)
4985 {
4986     dTHX;
4987     STDCHAR buf = ch;
4988     return PerlIO_write(f, &buf, 1);
4989 }
4990
4991 #undef PerlIO_puts
4992 int
4993 PerlIO_puts(PerlIO *f, const char *s)
4994 {
4995     dTHX;
4996     return PerlIO_write(f, s, strlen(s));
4997 }
4998
4999 #undef PerlIO_rewind
5000 void
5001 PerlIO_rewind(PerlIO *f)
5002 {
5003     dTHX;
5004     PerlIO_seek(f, (Off_t) 0, SEEK_SET);
5005     PerlIO_clearerr(f);
5006 }
5007
5008 #undef PerlIO_vprintf
5009 int
5010 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
5011 {
5012     dTHX;
5013     SV * const sv = newSVpvs("");
5014     const char *s;
5015     STRLEN len;
5016     SSize_t wrote;
5017 #ifdef NEED_VA_COPY
5018     va_list apc;
5019     Perl_va_copy(ap, apc);
5020     sv_vcatpvf(sv, fmt, &apc);
5021 #else
5022     sv_vcatpvf(sv, fmt, &ap);
5023 #endif
5024     s = SvPV_const(sv, len);
5025     wrote = PerlIO_write(f, s, len);
5026     SvREFCNT_dec(sv);
5027     return wrote;
5028 }
5029
5030 #undef PerlIO_printf
5031 int
5032 PerlIO_printf(PerlIO *f, const char *fmt, ...)
5033 {
5034     va_list ap;
5035     int result;
5036     va_start(ap, fmt);
5037     result = PerlIO_vprintf(f, fmt, ap);
5038     va_end(ap);
5039     return result;
5040 }
5041
5042 #undef PerlIO_stdoutf
5043 int
5044 PerlIO_stdoutf(const char *fmt, ...)
5045 {
5046     dTHX;
5047     va_list ap;
5048     int result;
5049     va_start(ap, fmt);
5050     result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
5051     va_end(ap);
5052     return result;
5053 }
5054
5055 #undef PerlIO_tmpfile
5056 PerlIO *
5057 PerlIO_tmpfile(void)
5058 {
5059      dTHX;
5060      PerlIO *f = NULL;
5061 #ifdef WIN32
5062      const int fd = win32_tmpfd();
5063      if (fd >= 0)
5064           f = PerlIO_fdopen(fd, "w+b");
5065 #else /* WIN32 */
5066 #    if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
5067      SV * const sv = newSVpvs("/tmp/PerlIO_XXXXXX");
5068      /*
5069       * I have no idea how portable mkstemp() is ... NI-S
5070       */
5071      const int fd = mkstemp(SvPVX(sv));
5072      if (fd >= 0) {
5073           f = PerlIO_fdopen(fd, "w+");
5074           if (f)
5075                PerlIOBase(f)->flags |= PERLIO_F_TEMP;
5076           PerlLIO_unlink(SvPVX_const(sv));
5077           SvREFCNT_dec(sv);
5078      }
5079 #    else       /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
5080      FILE * const stdio = PerlSIO_tmpfile();
5081
5082      if (stdio)
5083           f = PerlIO_fdopen(fileno(stdio), "w+");
5084
5085 #    endif /* else HAS_MKSTEMP */
5086 #endif /* else WIN32 */
5087      return f;
5088 }
5089
5090 #undef HAS_FSETPOS
5091 #undef HAS_FGETPOS
5092
5093 #endif                          /* USE_SFIO */
5094 #endif                          /* PERLIO_IS_STDIO */
5095
5096 /*======================================================================================*/
5097 /*
5098  * Now some functions in terms of above which may be needed even if we are
5099  * not in true PerlIO mode
5100  */
5101 const char *
5102 Perl_PerlIO_context_layers(pTHX_ const char *mode)
5103 {
5104     dVAR;
5105     const char *type = NULL;
5106     /*
5107      * Need to supply default layer info from open.pm
5108      */
5109     if (PL_curcop && PL_curcop->cop_hints & HINT_LEXICAL_IO) {
5110         SV * const layers
5111             = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash, 0,
5112                                        "open", 4, 0, 0);
5113         assert(layers);
5114         if (SvOK(layers)) {
5115             STRLEN len;
5116             type = SvPV_const(layers, len);
5117             if (type && mode && mode[0] != 'r') {
5118                 /*
5119                  * Skip to write part, which is separated by a '\0'
5120                  */
5121                 STRLEN read_len = strlen(type);
5122                 if (read_len < len) {
5123                     type += read_len + 1;
5124                 }
5125             }
5126         }
5127     }
5128     return type;
5129 }
5130
5131
5132 #ifndef HAS_FSETPOS
5133 #undef PerlIO_setpos
5134 int
5135 PerlIO_setpos(PerlIO *f, SV *pos)
5136 {
5137     dTHX;
5138     if (SvOK(pos)) {
5139         STRLEN len;
5140         const Off_t * const posn = (Off_t *) SvPV(pos, len);
5141         if (f && len == sizeof(Off_t))
5142             return PerlIO_seek(f, *posn, SEEK_SET);
5143     }
5144     SETERRNO(EINVAL, SS_IVCHAN);
5145     return -1;
5146 }
5147 #else
5148 #undef PerlIO_setpos
5149 int
5150 PerlIO_setpos(PerlIO *f, SV *pos)
5151 {
5152     dTHX;
5153     if (SvOK(pos)) {
5154         STRLEN len;
5155         Fpos_t * const fpos = (Fpos_t *) SvPV(pos, len);
5156         if (f && len == sizeof(Fpos_t)) {
5157 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5158             return fsetpos64(f, fpos);
5159 #else
5160             return fsetpos(f, fpos);
5161 #endif
5162         }
5163     }
5164     SETERRNO(EINVAL, SS_IVCHAN);
5165     return -1;
5166 }
5167 #endif
5168
5169 #ifndef HAS_FGETPOS
5170 #undef PerlIO_getpos
5171 int
5172 PerlIO_getpos(PerlIO *f, SV *pos)
5173 {
5174     dTHX;
5175     Off_t posn = PerlIO_tell(f);
5176     sv_setpvn(pos, (char *) &posn, sizeof(posn));
5177     return (posn == (Off_t) - 1) ? -1 : 0;
5178 }
5179 #else
5180 #undef PerlIO_getpos
5181 int
5182 PerlIO_getpos(PerlIO *f, SV *pos)
5183 {
5184     dTHX;
5185     Fpos_t fpos;
5186     int code;
5187 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5188     code = fgetpos64(f, &fpos);
5189 #else
5190     code = fgetpos(f, &fpos);
5191 #endif
5192     sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
5193     return code;
5194 }
5195 #endif
5196
5197 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
5198
5199 int
5200 vprintf(char *pat, char *args)
5201 {
5202     _doprnt(pat, args, stdout);
5203     return 0;                   /* wrong, but perl doesn't use the return
5204                                  * value */
5205 }
5206
5207 int
5208 vfprintf(FILE *fd, char *pat, char *args)
5209 {
5210     _doprnt(pat, args, fd);
5211     return 0;                   /* wrong, but perl doesn't use the return
5212                                  * value */
5213 }
5214
5215 #endif
5216
5217 #ifndef PerlIO_vsprintf
5218 int
5219 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5220 {
5221     dTHX;
5222     const int val = my_vsnprintf(s, n > 0 ? n : 0, fmt, ap);
5223     PERL_UNUSED_CONTEXT;
5224
5225 #ifndef PERL_MY_VSNPRINTF_GUARDED
5226     if (val < 0 || (n > 0 ? val >= n : 0)) {
5227         Perl_croak(aTHX_ "panic: my_vsnprintf overflow in PerlIO_vsprintf\n");
5228     }
5229 #endif
5230     return val;
5231 }
5232 #endif
5233
5234 #ifndef PerlIO_sprintf
5235 int
5236 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5237 {
5238     va_list ap;
5239     int result;
5240     va_start(ap, fmt);
5241     result = PerlIO_vsprintf(s, n, fmt, ap);
5242     va_end(ap);
5243     return result;
5244 }
5245 #endif
5246
5247 /*
5248  * Local variables:
5249  * c-indentation-style: bsd
5250  * c-basic-offset: 4
5251  * indent-tabs-mode: t
5252  * End:
5253  *
5254  * ex: set ts=8 sts=4 sw=4 noet:
5255  */