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