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