perlio.c

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