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. */
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_ITHREADS
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     /* MUTEX_INIT(&PL_perlio_mutex) is done in PERL_SYS_INIT3(). */
2303     PERL_UNUSED_CONTEXT;
2304 }
2305
2306 void
2307 PerlIOUnix_refcnt_inc(int fd)
2308 {
2309     dTHX;
2310     if (fd >= 0) {
2311         dVAR;
2312
2313 #ifdef USE_ITHREADS
2314         MUTEX_LOCK(&PL_perlio_mutex);
2315 #endif
2316         if (fd >= PL_perlio_fd_refcnt_size)
2317             S_more_refcounted_fds(aTHX_ fd);
2318
2319         PL_perlio_fd_refcnt[fd]++;
2320         if (PL_perlio_fd_refcnt[fd] <= 0) {
2321             Perl_croak(aTHX_ "refcnt_inc: fd %d: %d <= 0\n",
2322                        fd, PL_perlio_fd_refcnt[fd]);
2323         }
2324         PerlIO_debug("refcnt_inc: fd %d refcnt=%d\n",
2325                      fd, PL_perlio_fd_refcnt[fd]);
2326
2327 #ifdef USE_ITHREADS
2328         MUTEX_UNLOCK(&PL_perlio_mutex);
2329 #endif
2330     } else {
2331         Perl_croak(aTHX_ "refcnt_inc: fd %d < 0\n", fd);
2332     }
2333 }
2334
2335 int
2336 PerlIOUnix_refcnt_dec(int fd)
2337 {
2338     dTHX;
2339     int cnt = 0;
2340     if (fd >= 0) {
2341         dVAR;
2342 #ifdef USE_ITHREADS
2343         MUTEX_LOCK(&PL_perlio_mutex);
2344 #endif
2345         if (fd >= PL_perlio_fd_refcnt_size) {
2346             Perl_croak(aTHX_ "refcnt_dec: fd %d >= refcnt_size %d\n",
2347                        fd, PL_perlio_fd_refcnt_size);
2348         }
2349         if (PL_perlio_fd_refcnt[fd] <= 0) {
2350             Perl_croak(aTHX_ "refcnt_dec: fd %d: %d <= 0\n",
2351                        fd, PL_perlio_fd_refcnt[fd]);
2352         }
2353         cnt = --PL_perlio_fd_refcnt[fd];
2354         PerlIO_debug("refcnt_dec: fd %d refcnt=%d\n", fd, cnt);
2355 #ifdef USE_ITHREADS
2356         MUTEX_UNLOCK(&PL_perlio_mutex);
2357 #endif
2358     } else {
2359         Perl_croak(aTHX_ "refcnt_dec: fd %d < 0\n", fd);
2360     }
2361     return cnt;
2362 }
2363
2364 void
2365 PerlIO_cleanup(pTHX)
2366 {
2367     dVAR;
2368     int i;
2369 #ifdef USE_ITHREADS
2370     PerlIO_debug("Cleanup layers for %p\n",(void*)aTHX);
2371 #else
2372     PerlIO_debug("Cleanup layers\n");
2373 #endif
2374
2375     /* Raise STDIN..STDERR refcount so we don't close them */
2376     for (i=0; i < 3; i++)
2377         PerlIOUnix_refcnt_inc(i);
2378     PerlIO_cleantable(aTHX_ &PL_perlio);
2379     /* Restore STDIN..STDERR refcount */
2380     for (i=0; i < 3; i++)
2381         PerlIOUnix_refcnt_dec(i);
2382
2383     if (PL_known_layers) {
2384         PerlIO_list_free(aTHX_ PL_known_layers);
2385         PL_known_layers = NULL;
2386     }
2387     if (PL_def_layerlist) {
2388         PerlIO_list_free(aTHX_ PL_def_layerlist);
2389         PL_def_layerlist = NULL;
2390     }
2391 }
2392
2393 void PerlIO_teardown(pTHX) /* Call only from PERL_SYS_TERM(). */
2394 {
2395 #ifdef DEBUGGING
2396     {
2397         /* By now all filehandles should have been closed, so any
2398          * stray (non-STD-)filehandles indicate *possible* (PerlIO)
2399          * errors. */
2400         int i;
2401         for (i = 3; i < PL_perlio_fd_refcnt_size; i++) {
2402             if (PL_perlio_fd_refcnt[i])
2403                 PerlIO_debug("PerlIO_cleanup: fd %d refcnt=%d\n",
2404                              i, PL_perlio_fd_refcnt[i]);
2405         }
2406     }
2407 #endif
2408 #ifdef USE_ITHREADS
2409     MUTEX_LOCK(&PL_perlio_mutex);
2410 #endif
2411     if (PL_perlio_fd_refcnt_size /* Assuming initial size of zero. */
2412         && PL_perlio_fd_refcnt) {
2413 #ifdef PERL_TRACK_MEMPOOL
2414         Malloc_t ptr = (Malloc_t)((char*)PL_perlio_fd_refcnt-sTHX);
2415         struct perl_memory_debug_header *const header
2416             = (struct perl_memory_debug_header *)ptr;
2417         /* Only the thread that allocated us can free us. */
2418         if (header->interpreter == aTHX)
2419 #endif
2420             {
2421                 PerlMemShared_free(PL_perlio_fd_refcnt); /* Not Safefree() because was allocated with PerlMemShared_realloc(). */
2422                 PL_perlio_fd_refcnt = NULL;
2423                 PL_perlio_fd_refcnt_size = 0;
2424             }
2425     }
2426 #ifdef USE_ITHREADS
2427     MUTEX_UNLOCK(&PL_perlio_mutex);
2428 #endif
2429 }
2430
2431
2432
2433 /*--------------------------------------------------------------------------------------*/
2434 /*
2435  * Bottom-most level for UNIX-like case
2436  */
2437
2438 typedef struct {
2439     struct _PerlIO base;        /* The generic part */
2440     int fd;                     /* UNIX like file descriptor */
2441     int oflags;                 /* open/fcntl flags */
2442 } PerlIOUnix;
2443
2444 int
2445 PerlIOUnix_oflags(const char *mode)
2446 {
2447     int oflags = -1;
2448     if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2449         mode++;
2450     switch (*mode) {
2451     case 'r':
2452         oflags = O_RDONLY;
2453         if (*++mode == '+') {
2454             oflags = O_RDWR;
2455             mode++;
2456         }
2457         break;
2458
2459     case 'w':
2460         oflags = O_CREAT | O_TRUNC;
2461         if (*++mode == '+') {
2462             oflags |= O_RDWR;
2463             mode++;
2464         }
2465         else
2466             oflags |= O_WRONLY;
2467         break;
2468
2469     case 'a':
2470         oflags = O_CREAT | O_APPEND;
2471         if (*++mode == '+') {
2472             oflags |= O_RDWR;
2473             mode++;
2474         }
2475         else
2476             oflags |= O_WRONLY;
2477         break;
2478     }
2479     if (*mode == 'b') {
2480         oflags |= O_BINARY;
2481         oflags &= ~O_TEXT;
2482         mode++;
2483     }
2484     else if (*mode == 't') {
2485         oflags |= O_TEXT;
2486         oflags &= ~O_BINARY;
2487         mode++;
2488     }
2489     /*
2490      * Always open in binary mode
2491      */
2492     oflags |= O_BINARY;
2493     if (*mode || oflags == -1) {
2494         SETERRNO(EINVAL, LIB_INVARG);
2495         oflags = -1;
2496     }
2497     return oflags;
2498 }
2499
2500 IV
2501 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2502 {
2503     PERL_UNUSED_CONTEXT;
2504     return PerlIOSelf(f, PerlIOUnix)->fd;
2505 }
2506
2507 static void
2508 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2509 {
2510     PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2511 #if defined(WIN32)
2512     Stat_t st;
2513     if (PerlLIO_fstat(fd, &st) == 0) {
2514         if (!S_ISREG(st.st_mode)) {
2515             PerlIO_debug("%d is not regular file\n",fd);
2516             PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2517         }
2518         else {
2519             PerlIO_debug("%d _is_ a regular file\n",fd);
2520         }
2521     }
2522 #endif
2523     s->fd = fd;
2524     s->oflags = imode;
2525     PerlIOUnix_refcnt_inc(fd);
2526     PERL_UNUSED_CONTEXT;
2527 }
2528
2529 IV
2530 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2531 {
2532     IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2533     if (*PerlIONext(f)) {
2534         /* We never call down so do any pending stuff now */
2535         PerlIO_flush(PerlIONext(f));
2536         /*
2537          * XXX could (or should) we retrieve the oflags from the open file
2538          * handle rather than believing the "mode" we are passed in? XXX
2539          * Should the value on NULL mode be 0 or -1?
2540          */
2541         PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2542                          mode ? PerlIOUnix_oflags(mode) : -1);
2543     }
2544     PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2545
2546     return code;
2547 }
2548
2549 IV
2550 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2551 {
2552     const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2553     Off_t new_loc;
2554     PERL_UNUSED_CONTEXT;
2555     if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2556 #ifdef  ESPIPE
2557         SETERRNO(ESPIPE, LIB_INVARG);
2558 #else
2559         SETERRNO(EINVAL, LIB_INVARG);
2560 #endif
2561         return -1;
2562     }
2563     new_loc = PerlLIO_lseek(fd, offset, whence);
2564     if (new_loc == (Off_t) - 1)
2565         return -1;
2566     PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2567     return  0;
2568 }
2569
2570 PerlIO *
2571 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2572                 IV n, const char *mode, int fd, int imode,
2573                 int perm, PerlIO *f, int narg, SV **args)
2574 {
2575     if (PerlIOValid(f)) {
2576         if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2577             (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2578     }
2579     if (narg > 0) {
2580         if (*mode == IoTYPE_NUMERIC)
2581             mode++;
2582         else {
2583             imode = PerlIOUnix_oflags(mode);
2584             perm = 0666;
2585         }
2586         if (imode != -1) {
2587             const char *path = SvPV_nolen_const(*args);
2588             fd = PerlLIO_open3(path, imode, perm);
2589         }
2590     }
2591     if (fd >= 0) {
2592         if (*mode == IoTYPE_IMPLICIT)
2593             mode++;
2594         if (!f) {
2595             f = PerlIO_allocate(aTHX);
2596         }
2597         if (!PerlIOValid(f)) {
2598             if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2599                 return NULL;
2600             }
2601         }
2602         PerlIOUnix_setfd(aTHX_ f, fd, imode);
2603         PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2604         if (*mode == IoTYPE_APPEND)
2605             PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2606         return f;
2607     }
2608     else {
2609         if (f) {
2610             NOOP;
2611             /*
2612              * FIXME: pop layers ???
2613              */
2614         }
2615         return NULL;
2616     }
2617 }
2618
2619 PerlIO *
2620 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2621 {
2622     const PerlIOUnix * const os = PerlIOSelf(o, PerlIOUnix);
2623     int fd = os->fd;
2624     if (flags & PERLIO_DUP_FD) {
2625         fd = PerlLIO_dup(fd);
2626     }
2627     if (fd >= 0) {
2628         f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2629         if (f) {
2630             /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2631             PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2632             return f;
2633         }
2634     }
2635     return NULL;
2636 }
2637
2638
2639 SSize_t
2640 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2641 {
2642     dVAR;
2643     const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2644 #ifdef PERLIO_STD_SPECIAL
2645     if (fd == 0)
2646         return PERLIO_STD_IN(fd, vbuf, count);
2647 #endif
2648     if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2649          PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2650         return 0;
2651     }
2652     while (1) {
2653         const SSize_t len = PerlLIO_read(fd, vbuf, count);
2654         if (len >= 0 || errno != EINTR) {
2655             if (len < 0) {
2656                 if (errno != EAGAIN) {
2657                     PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2658                 }
2659             }
2660             else if (len == 0 && count != 0) {
2661                 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2662                 SETERRNO(0,0);
2663             }
2664             return len;
2665         }
2666         PERL_ASYNC_CHECK();
2667     }
2668     /*NOTREACHED*/
2669 }
2670
2671 SSize_t
2672 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2673 {
2674     dVAR;
2675     const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2676 #ifdef PERLIO_STD_SPECIAL
2677     if (fd == 1 || fd == 2)
2678         return PERLIO_STD_OUT(fd, vbuf, count);
2679 #endif
2680     while (1) {
2681         const SSize_t len = PerlLIO_write(fd, vbuf, count);
2682         if (len >= 0 || errno != EINTR) {
2683             if (len < 0) {
2684                 if (errno != EAGAIN) {
2685                     PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2686                 }
2687             }
2688             return len;
2689         }
2690         PERL_ASYNC_CHECK();
2691     }
2692     /*NOTREACHED*/
2693 }
2694
2695 Off_t
2696 PerlIOUnix_tell(pTHX_ PerlIO *f)
2697 {
2698     PERL_UNUSED_CONTEXT;
2699
2700     return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2701 }
2702
2703
2704 IV
2705 PerlIOUnix_close(pTHX_ PerlIO *f)
2706 {
2707     dVAR;
2708     const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2709     int code = 0;
2710     if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2711         if (PerlIOUnix_refcnt_dec(fd) > 0) {
2712             PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2713             return 0;
2714         }
2715     }
2716     else {
2717         SETERRNO(EBADF,SS_IVCHAN);
2718         return -1;
2719     }
2720     while (PerlLIO_close(fd) != 0) {
2721         if (errno != EINTR) {
2722             code = -1;
2723             break;
2724         }
2725         PERL_ASYNC_CHECK();
2726     }
2727     if (code == 0) {
2728         PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2729     }
2730     return code;
2731 }
2732
2733 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2734     sizeof(PerlIO_funcs),
2735     "unix",
2736     sizeof(PerlIOUnix),
2737     PERLIO_K_RAW,
2738     PerlIOUnix_pushed,
2739     PerlIOBase_popped,
2740     PerlIOUnix_open,
2741     PerlIOBase_binmode,         /* binmode */
2742     NULL,
2743     PerlIOUnix_fileno,
2744     PerlIOUnix_dup,
2745     PerlIOUnix_read,
2746     PerlIOBase_unread,
2747     PerlIOUnix_write,
2748     PerlIOUnix_seek,
2749     PerlIOUnix_tell,
2750     PerlIOUnix_close,
2751     PerlIOBase_noop_ok,         /* flush */
2752     PerlIOBase_noop_fail,       /* fill */
2753     PerlIOBase_eof,
2754     PerlIOBase_error,
2755     PerlIOBase_clearerr,
2756     PerlIOBase_setlinebuf,
2757     NULL,                       /* get_base */
2758     NULL,                       /* get_bufsiz */
2759     NULL,                       /* get_ptr */
2760     NULL,                       /* get_cnt */
2761     NULL,                       /* set_ptrcnt */
2762 };
2763
2764 /*--------------------------------------------------------------------------------------*/
2765 /*
2766  * stdio as a layer
2767  */
2768
2769 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2770 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2771    broken by the last second glibc 2.3 fix
2772  */
2773 #define STDIO_BUFFER_WRITABLE
2774 #endif
2775
2776
2777 typedef struct {
2778     struct _PerlIO base;
2779     FILE *stdio;                /* The stream */
2780 } PerlIOStdio;
2781
2782 IV
2783 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2784 {
2785     PERL_UNUSED_CONTEXT;
2786
2787     if (PerlIOValid(f)) {
2788         FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
2789         if (s)
2790             return PerlSIO_fileno(s);
2791     }
2792     errno = EBADF;
2793     return -1;
2794 }
2795
2796 char *
2797 PerlIOStdio_mode(const char *mode, char *tmode)
2798 {
2799     char * const ret = tmode;
2800     if (mode) {
2801         while (*mode) {
2802             *tmode++ = *mode++;
2803         }
2804     }
2805 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2806     *tmode++ = 'b';
2807 #endif
2808     *tmode = '\0';
2809     return ret;
2810 }
2811
2812 IV
2813 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2814 {
2815     PerlIO *n;
2816     if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2817         PerlIO_funcs * const toptab = PerlIOBase(n)->tab;
2818         if (toptab == tab) {
2819             /* Top is already stdio - pop self (duplicate) and use original */
2820             PerlIO_pop(aTHX_ f);
2821             return 0;
2822         } else {
2823             const int fd = PerlIO_fileno(n);
2824             char tmode[8];
2825             FILE *stdio;
2826             if (fd >= 0 && (stdio  = PerlSIO_fdopen(fd,
2827                             mode = PerlIOStdio_mode(mode, tmode)))) {
2828                 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2829                 /* We never call down so do any pending stuff now */
2830                 PerlIO_flush(PerlIONext(f));
2831             }
2832             else {
2833                 return -1;
2834             }
2835         }
2836     }
2837     return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2838 }
2839
2840
2841 PerlIO *
2842 PerlIO_importFILE(FILE *stdio, const char *mode)
2843 {
2844     dTHX;
2845     PerlIO *f = NULL;
2846     if (stdio) {
2847         PerlIOStdio *s;
2848         if (!mode || !*mode) {
2849             /* We need to probe to see how we can open the stream
2850                so start with read/write and then try write and read
2851                we dup() so that we can fclose without loosing the fd.
2852
2853                Note that the errno value set by a failing fdopen
2854                varies between stdio implementations.
2855              */
2856             const int fd = PerlLIO_dup(fileno(stdio));
2857             FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2858             if (!f2) {
2859                 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2860             }
2861             if (!f2) {
2862                 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2863             }
2864             if (!f2) {
2865                 /* Don't seem to be able to open */
2866                 PerlLIO_close(fd);
2867                 return f;
2868             }
2869             fclose(f2);
2870         }
2871         if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, NULL))) {
2872             s = PerlIOSelf(f, PerlIOStdio);
2873             s->stdio = stdio;
2874         }
2875     }
2876     return f;
2877 }
2878
2879 PerlIO *
2880 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2881                  IV n, const char *mode, int fd, int imode,
2882                  int perm, PerlIO *f, int narg, SV **args)
2883 {
2884     char tmode[8];
2885     if (PerlIOValid(f)) {
2886         const char * const path = SvPV_nolen_const(*args);
2887         PerlIOStdio * const s = PerlIOSelf(f, PerlIOStdio);
2888         FILE *stdio;
2889         PerlIOUnix_refcnt_dec(fileno(s->stdio));
2890         stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2891                             s->stdio);
2892         if (!s->stdio)
2893             return NULL;
2894         s->stdio = stdio;
2895         PerlIOUnix_refcnt_inc(fileno(s->stdio));
2896         return f;
2897     }
2898     else {
2899         if (narg > 0) {
2900             const char * const path = SvPV_nolen_const(*args);
2901             if (*mode == IoTYPE_NUMERIC) {
2902                 mode++;
2903                 fd = PerlLIO_open3(path, imode, perm);
2904             }
2905             else {
2906                 FILE *stdio;
2907                 bool appended = FALSE;
2908 #ifdef __CYGWIN__
2909                 /* Cygwin wants its 'b' early. */
2910                 appended = TRUE;
2911                 mode = PerlIOStdio_mode(mode, tmode);
2912 #endif
2913                 stdio = PerlSIO_fopen(path, mode);
2914                 if (stdio) {
2915                     if (!f) {
2916                         f = PerlIO_allocate(aTHX);
2917                     }
2918                     if (!appended)
2919                         mode = PerlIOStdio_mode(mode, tmode);
2920                     f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2921                     if (f) {
2922                         PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2923                         PerlIOUnix_refcnt_inc(fileno(stdio));
2924                     } else {
2925                         PerlSIO_fclose(stdio);
2926                     }
2927                     return f;
2928                 }
2929                 else {
2930                     return NULL;
2931                 }
2932             }
2933         }
2934         if (fd >= 0) {
2935             FILE *stdio = NULL;
2936             int init = 0;
2937             if (*mode == IoTYPE_IMPLICIT) {
2938                 init = 1;
2939                 mode++;
2940             }
2941             if (init) {
2942                 switch (fd) {
2943                 case 0:
2944                     stdio = PerlSIO_stdin;
2945                     break;
2946                 case 1:
2947                     stdio = PerlSIO_stdout;
2948                     break;
2949                 case 2:
2950                     stdio = PerlSIO_stderr;
2951                     break;
2952                 }
2953             }
2954             else {
2955                 stdio = PerlSIO_fdopen(fd, mode =
2956                                        PerlIOStdio_mode(mode, tmode));
2957             }
2958             if (stdio) {
2959                 if (!f) {
2960                     f = PerlIO_allocate(aTHX);
2961                 }
2962                 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2963                     PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2964                     PerlIOUnix_refcnt_inc(fileno(stdio));
2965                 }
2966                 return f;
2967             }
2968         }
2969     }
2970     return NULL;
2971 }
2972
2973 PerlIO *
2974 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2975 {
2976     /* This assumes no layers underneath - which is what
2977        happens, but is not how I remember it. NI-S 2001/10/16
2978      */
2979     if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2980         FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2981         const int fd = fileno(stdio);
2982         char mode[8];
2983         if (flags & PERLIO_DUP_FD) {
2984             const int dfd = PerlLIO_dup(fileno(stdio));
2985             if (dfd >= 0) {
2986                 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2987                 goto set_this;
2988             }
2989             else {
2990                 NOOP;
2991                 /* FIXME: To avoid messy error recovery if dup fails
2992                    re-use the existing stdio as though flag was not set
2993                  */
2994             }
2995         }
2996         stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2997     set_this:
2998         PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2999         PerlIOUnix_refcnt_inc(fileno(stdio));
3000     }
3001     return f;
3002 }
3003
3004 static int
3005 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
3006 {
3007     PERL_UNUSED_CONTEXT;
3008
3009     /* XXX this could use PerlIO_canset_fileno() and
3010      * PerlIO_set_fileno() support from Configure
3011      */
3012 #  if defined(__UCLIBC__)
3013     /* uClibc must come before glibc because it defines __GLIBC__ as well. */
3014     f->__filedes = -1;
3015     return 1;
3016 #  elif defined(__GLIBC__)
3017     /* There may be a better way for GLIBC:
3018         - libio.h defines a flag to not close() on cleanup
3019      */
3020     f->_fileno = -1;
3021     return 1;
3022 #  elif defined(__sun__)
3023     PERL_UNUSED_ARG(f);
3024     return 0;
3025 #  elif defined(__hpux)
3026     f->__fileH = 0xff;
3027     f->__fileL = 0xff;
3028     return 1;
3029    /* Next one ->_file seems to be a reasonable fallback, i.e. if
3030       your platform does not have special entry try this one.
3031       [For OSF only have confirmation for Tru64 (alpha)
3032       but assume other OSFs will be similar.]
3033     */
3034 #  elif defined(_AIX) || defined(__osf__) || defined(__irix__)
3035     f->_file = -1;
3036     return 1;
3037 #  elif defined(__FreeBSD__)
3038     /* There may be a better way on FreeBSD:
3039         - we could insert a dummy func in the _close function entry
3040         f->_close = (int (*)(void *)) dummy_close;
3041      */
3042     f->_file = -1;
3043     return 1;
3044 #  elif defined(__OpenBSD__)
3045     /* There may be a better way on OpenBSD:
3046         - we could insert a dummy func in the _close function entry
3047         f->_close = (int (*)(void *)) dummy_close;
3048      */
3049     f->_file = -1;
3050     return 1;
3051 #  elif defined(__EMX__)
3052     /* f->_flags &= ~_IOOPEN; */        /* Will leak stream->_buffer */
3053     f->_handle = -1;
3054     return 1;
3055 #  elif defined(__CYGWIN__)
3056     /* There may be a better way on CYGWIN:
3057         - we could insert a dummy func in the _close function entry
3058         f->_close = (int (*)(void *)) dummy_close;
3059      */
3060     f->_file = -1;
3061     return 1;
3062 #  elif defined(WIN32)
3063 #    if defined(__BORLANDC__)
3064     f->fd = PerlLIO_dup(fileno(f));
3065 #    elif defined(UNDER_CE)
3066     /* WIN_CE does not have access to FILE internals, it hardly has FILE
3067        structure at all
3068      */
3069 #    else
3070     f->_file = -1;
3071 #    endif
3072     return 1;
3073 #  else
3074 #if 0
3075     /* Sarathy's code did this - we fall back to a dup/dup2 hack
3076        (which isn't thread safe) instead
3077      */
3078 #    error "Don't know how to set FILE.fileno on your platform"
3079 #endif
3080     PERL_UNUSED_ARG(f);
3081     return 0;
3082 #  endif
3083 }
3084
3085 IV
3086 PerlIOStdio_close(pTHX_ PerlIO *f)
3087 {
3088     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3089     if (!stdio) {
3090         errno = EBADF;
3091         return -1;
3092     }
3093     else {
3094         const int fd = fileno(stdio);
3095         int invalidate = 0;
3096         IV result = 0;
3097         int saveerr = 0;
3098         int dupfd = 0;
3099 #ifdef SOCKS5_VERSION_NAME
3100         /* Socks lib overrides close() but stdio isn't linked to
3101            that library (though we are) - so we must call close()
3102            on sockets on stdio's behalf.
3103          */
3104         int optval;
3105         Sock_size_t optlen = sizeof(int);
3106         if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0)
3107             invalidate = 1;
3108 #endif
3109         if (PerlIOUnix_refcnt_dec(fd) > 0) /* File descriptor still in use */
3110             invalidate = 1;
3111         if (invalidate) {
3112             /* For STD* handles, don't close stdio, since we shared the FILE *, too. */
3113             if (stdio == stdin) /* Some stdios are buggy fflush-ing inputs */
3114                 return 0;
3115             if (stdio == stdout || stdio == stderr)
3116                 return PerlIO_flush(f);
3117             /* Tricky - must fclose(stdio) to free memory but not close(fd)
3118                Use Sarathy's trick from maint-5.6 to invalidate the
3119                fileno slot of the FILE *
3120             */
3121             result = PerlIO_flush(f);
3122             saveerr = errno;
3123             invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio);
3124             if (!invalidate)
3125                 dupfd = PerlLIO_dup(fd);
3126         }
3127         result = PerlSIO_fclose(stdio);
3128         /* We treat error from stdio as success if we invalidated
3129            errno may NOT be expected EBADF
3130          */
3131         if (invalidate && result != 0) {
3132             errno = saveerr;
3133             result = 0;
3134         }
3135 #ifdef SOCKS5_VERSION_NAME
3136         /* in SOCKS' case, let close() determine return value */
3137         result = close(fd);
3138 #endif
3139         if (dupfd) {
3140             PerlLIO_dup2(dupfd,fd);
3141             PerlLIO_close(dupfd);
3142         }
3143         return result;
3144     }
3145 }
3146
3147 SSize_t
3148 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3149 {
3150     dVAR;
3151     FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3152     SSize_t got = 0;
3153     for (;;) {
3154         if (count == 1) {
3155             STDCHAR *buf = (STDCHAR *) vbuf;
3156             /*
3157              * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3158              * stdio does not do that for fread()
3159              */
3160             const int ch = PerlSIO_fgetc(s);
3161             if (ch != EOF) {
3162                 *buf = ch;
3163                 got = 1;
3164             }
3165         }
3166         else
3167             got = PerlSIO_fread(vbuf, 1, count, s);
3168         if (got == 0 && PerlSIO_ferror(s))
3169             got = -1;
3170         if (got >= 0 || errno != EINTR)
3171             break;
3172         PERL_ASYNC_CHECK();
3173         SETERRNO(0,0);  /* just in case */
3174     }
3175     return got;
3176 }
3177
3178 SSize_t
3179 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3180 {
3181     SSize_t unread = 0;
3182     FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3183
3184 #ifdef STDIO_BUFFER_WRITABLE
3185     if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3186         STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3187         STDCHAR *base = PerlIO_get_base(f);
3188         SSize_t cnt   = PerlIO_get_cnt(f);
3189         STDCHAR *ptr  = PerlIO_get_ptr(f);
3190         SSize_t avail = ptr - base;
3191         if (avail > 0) {
3192             if (avail > count) {
3193                 avail = count;
3194             }
3195             ptr -= avail;
3196             Move(buf-avail,ptr,avail,STDCHAR);
3197             count -= avail;
3198             unread += avail;
3199             PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3200             if (PerlSIO_feof(s) && unread >= 0)
3201                 PerlSIO_clearerr(s);
3202         }
3203     }
3204     else
3205 #endif
3206     if (PerlIO_has_cntptr(f)) {
3207         /* We can get pointer to buffer but not its base
3208            Do ungetc() but check chars are ending up in the
3209            buffer
3210          */
3211         STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3212         STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3213         while (count > 0) {
3214             const int ch = *--buf & 0xFF;
3215             if (ungetc(ch,s) != ch) {
3216                 /* ungetc did not work */
3217                 break;
3218             }
3219             if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3220                 /* Did not change pointer as expected */
3221                 fgetc(s);  /* get char back again */
3222                 break;
3223             }
3224             /* It worked ! */
3225             count--;
3226             unread++;
3227         }
3228     }
3229
3230     if (count > 0) {
3231         unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3232     }
3233     return unread;
3234 }
3235
3236 SSize_t
3237 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3238 {
3239     dVAR;
3240     SSize_t got;
3241     for (;;) {
3242         got = PerlSIO_fwrite(vbuf, 1, count,
3243                               PerlIOSelf(f, PerlIOStdio)->stdio);
3244         if (got >= 0 || errno != EINTR)
3245             break;
3246         PERL_ASYNC_CHECK();
3247         SETERRNO(0,0);  /* just in case */
3248     }
3249     return got;
3250 }
3251
3252 IV
3253 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3254 {
3255     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3256     PERL_UNUSED_CONTEXT;
3257
3258     return PerlSIO_fseek(stdio, offset, whence);
3259 }
3260
3261 Off_t
3262 PerlIOStdio_tell(pTHX_ PerlIO *f)
3263 {
3264     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3265     PERL_UNUSED_CONTEXT;
3266
3267     return PerlSIO_ftell(stdio);
3268 }
3269
3270 IV
3271 PerlIOStdio_flush(pTHX_ PerlIO *f)
3272 {
3273     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3274     PERL_UNUSED_CONTEXT;
3275
3276     if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3277         return PerlSIO_fflush(stdio);
3278     }
3279     else {
3280         NOOP;
3281 #if 0
3282         /*
3283          * FIXME: This discards ungetc() and pre-read stuff which is not
3284          * right if this is just a "sync" from a layer above Suspect right
3285          * design is to do _this_ but not have layer above flush this
3286          * layer read-to-read
3287          */
3288         /*
3289          * Not writeable - sync by attempting a seek
3290          */
3291         const int err = errno;
3292         if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3293             errno = err;
3294 #endif
3295     }
3296     return 0;
3297 }
3298
3299 IV
3300 PerlIOStdio_eof(pTHX_ PerlIO *f)
3301 {
3302     PERL_UNUSED_CONTEXT;
3303
3304     return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3305 }
3306
3307 IV
3308 PerlIOStdio_error(pTHX_ PerlIO *f)
3309 {
3310     PERL_UNUSED_CONTEXT;
3311
3312     return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3313 }
3314
3315 void
3316 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3317 {
3318     PERL_UNUSED_CONTEXT;
3319
3320     PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3321 }
3322
3323 void
3324 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3325 {
3326     PERL_UNUSED_CONTEXT;
3327
3328 #ifdef HAS_SETLINEBUF
3329     PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3330 #else
3331     PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, NULL, _IOLBF, 0);
3332 #endif
3333 }
3334
3335 #ifdef FILE_base
3336 STDCHAR *
3337 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3338 {
3339     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3340     return (STDCHAR*)PerlSIO_get_base(stdio);
3341 }
3342
3343 Size_t
3344 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3345 {
3346     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3347     return PerlSIO_get_bufsiz(stdio);
3348 }
3349 #endif
3350
3351 #ifdef USE_STDIO_PTR
3352 STDCHAR *
3353 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3354 {
3355     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3356     return (STDCHAR*)PerlSIO_get_ptr(stdio);
3357 }
3358
3359 SSize_t
3360 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3361 {
3362     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3363     return PerlSIO_get_cnt(stdio);
3364 }
3365
3366 void
3367 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3368 {
3369     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3370     if (ptr != NULL) {
3371 #ifdef STDIO_PTR_LVALUE
3372         PerlSIO_set_ptr(stdio, (void*)ptr); /* LHS STDCHAR* cast non-portable */
3373 #ifdef STDIO_PTR_LVAL_SETS_CNT
3374         if (PerlSIO_get_cnt(stdio) != (cnt)) {
3375             assert(PerlSIO_get_cnt(stdio) == (cnt));
3376         }
3377 #endif
3378 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3379         /*
3380          * Setting ptr _does_ change cnt - we are done
3381          */
3382         return;
3383 #endif
3384 #else                           /* STDIO_PTR_LVALUE */
3385         PerlProc_abort();
3386 #endif                          /* STDIO_PTR_LVALUE */
3387     }
3388     /*
3389      * Now (or only) set cnt
3390      */
3391 #ifdef STDIO_CNT_LVALUE
3392     PerlSIO_set_cnt(stdio, cnt);
3393 #else                           /* STDIO_CNT_LVALUE */
3394 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3395     PerlSIO_set_ptr(stdio,
3396                     PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3397                                               cnt));
3398 #else                           /* STDIO_PTR_LVAL_SETS_CNT */
3399     PerlProc_abort();
3400 #endif                          /* STDIO_PTR_LVAL_SETS_CNT */
3401 #endif                          /* STDIO_CNT_LVALUE */
3402 }
3403
3404
3405 #endif
3406
3407 IV
3408 PerlIOStdio_fill(pTHX_ PerlIO *f)
3409 {
3410     FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3411     int c;
3412     PERL_UNUSED_CONTEXT;
3413
3414     /*
3415      * fflush()ing read-only streams can cause trouble on some stdio-s
3416      */
3417     if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3418         if (PerlSIO_fflush(stdio) != 0)
3419             return EOF;
3420     }
3421     c = PerlSIO_fgetc(stdio);
3422     if (c == EOF)
3423         return EOF;
3424
3425 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3426
3427 #ifdef STDIO_BUFFER_WRITABLE
3428     if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3429         /* Fake ungetc() to the real buffer in case system's ungetc
3430            goes elsewhere
3431          */
3432         STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3433         SSize_t cnt   = PerlSIO_get_cnt(stdio);
3434         STDCHAR *ptr  = (STDCHAR*)PerlSIO_get_ptr(stdio);
3435         if (ptr == base+1) {
3436             *--ptr = (STDCHAR) c;
3437             PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3438             if (PerlSIO_feof(stdio))
3439                 PerlSIO_clearerr(stdio);
3440             return 0;
3441         }
3442     }
3443     else
3444 #endif
3445     if (PerlIO_has_cntptr(f)) {
3446         STDCHAR ch = c;
3447         if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3448             return 0;
3449         }
3450     }
3451 #endif
3452
3453 #if defined(VMS)
3454     /* An ungetc()d char is handled separately from the regular
3455      * buffer, so we stuff it in the buffer ourselves.
3456      * Should never get called as should hit code above
3457      */
3458     *(--((*stdio)->_ptr)) = (unsigned char) c;
3459     (*stdio)->_cnt++;
3460 #else
3461     /* If buffer snoop scheme above fails fall back to
3462        using ungetc().
3463      */
3464     if (PerlSIO_ungetc(c, stdio) != c)
3465         return EOF;
3466 #endif
3467     return 0;
3468 }
3469
3470
3471
3472 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3473     sizeof(PerlIO_funcs),
3474     "stdio",
3475     sizeof(PerlIOStdio),
3476     PERLIO_K_BUFFERED|PERLIO_K_RAW,
3477     PerlIOStdio_pushed,
3478     PerlIOBase_popped,
3479     PerlIOStdio_open,
3480     PerlIOBase_binmode,         /* binmode */
3481     NULL,
3482     PerlIOStdio_fileno,
3483     PerlIOStdio_dup,
3484     PerlIOStdio_read,
3485     PerlIOStdio_unread,
3486     PerlIOStdio_write,
3487     PerlIOStdio_seek,
3488     PerlIOStdio_tell,
3489     PerlIOStdio_close,
3490     PerlIOStdio_flush,
3491     PerlIOStdio_fill,
3492     PerlIOStdio_eof,
3493     PerlIOStdio_error,
3494     PerlIOStdio_clearerr,
3495     PerlIOStdio_setlinebuf,
3496 #ifdef FILE_base
3497     PerlIOStdio_get_base,
3498     PerlIOStdio_get_bufsiz,
3499 #else
3500     NULL,
3501     NULL,
3502 #endif
3503 #ifdef USE_STDIO_PTR
3504     PerlIOStdio_get_ptr,
3505     PerlIOStdio_get_cnt,
3506 #   if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3507     PerlIOStdio_set_ptrcnt,
3508 #   else
3509     NULL,
3510 #   endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3511 #else
3512     NULL,
3513     NULL,
3514     NULL,
3515 #endif /* USE_STDIO_PTR */
3516 };
3517
3518 /* Note that calls to PerlIO_exportFILE() are reversed using
3519  * PerlIO_releaseFILE(), not importFILE. */
3520 FILE *
3521 PerlIO_exportFILE(PerlIO * f, const char *mode)
3522 {
3523     dTHX;
3524     FILE *stdio = NULL;
3525     if (PerlIOValid(f)) {
3526         char buf[8];
3527         PerlIO_flush(f);
3528         if (!mode || !*mode) {
3529             mode = PerlIO_modestr(f, buf);
3530         }
3531         stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3532         if (stdio) {
3533             PerlIOl *l = *f;
3534             PerlIO *f2;
3535             /* De-link any lower layers so new :stdio sticks */
3536             *f = NULL;
3537             if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, NULL))) {
3538                 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3539                 s->stdio = stdio;
3540                 /* Link previous lower layers under new one */
3541                 *PerlIONext(f) = l;
3542             }
3543             else {
3544                 /* restore layers list */
3545                 *f = l;
3546             }
3547         }
3548     }
3549     return stdio;
3550 }
3551
3552
3553 FILE *
3554 PerlIO_findFILE(PerlIO *f)
3555 {
3556     PerlIOl *l = *f;
3557     while (l) {
3558         if (l->tab == &PerlIO_stdio) {
3559             PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3560             return s->stdio;
3561         }
3562         l = *PerlIONext(&l);
3563     }
3564     /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3565     return PerlIO_exportFILE(f, NULL);
3566 }
3567
3568 /* Use this to reverse PerlIO_exportFILE calls. */
3569 void
3570 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3571 {
3572     dVAR;
3573     PerlIOl *l;
3574     while ((l = *p)) {
3575         if (l->tab == &PerlIO_stdio) {
3576             PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3577             if (s->stdio == f) {
3578                 dTHX;
3579                 PerlIO_pop(aTHX_ p);
3580                 return;
3581             }
3582         }
3583         p = PerlIONext(p);
3584     }
3585     return;
3586 }
3587
3588 /*--------------------------------------------------------------------------------------*/
3589 /*
3590  * perlio buffer layer
3591  */
3592
3593 IV
3594 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3595 {
3596     PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3597     const int fd = PerlIO_fileno(f);
3598     if (fd >= 0 && PerlLIO_isatty(fd)) {
3599         PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3600     }
3601     if (*PerlIONext(f)) {
3602         const Off_t posn = PerlIO_tell(PerlIONext(f));
3603         if (posn != (Off_t) - 1) {
3604             b->posn = posn;
3605         }
3606     }
3607     return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3608 }
3609
3610 PerlIO *
3611 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3612                IV n, const char *mode, int fd, int imode, int perm,
3613                PerlIO *f, int narg, SV **args)
3614 {
3615     if (PerlIOValid(f)) {
3616         PerlIO *next = PerlIONext(f);
3617         PerlIO_funcs *tab =
3618              PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3619         if (tab && tab->Open)
3620              next =
3621                   (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3622                                next, narg, args);
3623         if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3624             return NULL;
3625         }
3626     }
3627     else {
3628         PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3629         int init = 0;
3630         if (*mode == IoTYPE_IMPLICIT) {
3631             init = 1;
3632             /*
3633              * mode++;
3634              */
3635         }
3636         if (tab && tab->Open)
3637              f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3638                               f, narg, args);
3639         else
3640              SETERRNO(EINVAL, LIB_INVARG);
3641         if (f) {
3642             if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3643                 /*
3644                  * if push fails during open, open fails. close will pop us.
3645                  */
3646                 PerlIO_close (f);
3647                 return NULL;
3648             } else {
3649                 fd = PerlIO_fileno(f);
3650                 if (init && fd == 2) {
3651                     /*
3652                      * Initial stderr is unbuffered
3653                      */
3654                     PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3655                 }
3656 #ifdef PERLIO_USING_CRLF
3657 #  ifdef PERLIO_IS_BINMODE_FD
3658                 if (PERLIO_IS_BINMODE_FD(fd))
3659                     PerlIO_binmode(aTHX_ f,  '<'/*not used*/, O_BINARY, NULL);
3660                 else
3661 #  endif
3662                 /*
3663                  * do something about failing setmode()? --jhi
3664                  */
3665                 PerlLIO_setmode(fd, O_BINARY);
3666 #endif
3667             }
3668         }
3669     }
3670     return f;
3671 }
3672
3673 /*
3674  * This "flush" is akin to sfio's sync in that it handles files in either
3675  * read or write state.  For write state, we put the postponed data through
3676  * the next layers.  For read state, we seek() the next layers to the
3677  * offset given by current position in the buffer, and discard the buffer
3678  * state (XXXX supposed to be for seek()able buffers only, but now it is done
3679  * in any case?).  Then the pass the stick further in chain.
3680  */
3681 IV
3682 PerlIOBuf_flush(pTHX_ PerlIO *f)
3683 {
3684     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3685     int code = 0;
3686     PerlIO *n = PerlIONext(f);
3687     if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3688         /*
3689          * write() the buffer
3690          */
3691         const STDCHAR *buf = b->buf;
3692         const STDCHAR *p = buf;
3693         while (p < b->ptr) {
3694             SSize_t count = PerlIO_write(n, p, b->ptr - p);
3695             if (count > 0) {
3696                 p += count;
3697             }
3698             else if (count < 0 || PerlIO_error(n)) {
3699                 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3700                 code = -1;
3701                 break;
3702             }
3703         }
3704         b->posn += (p - buf);
3705     }
3706     else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3707         STDCHAR *buf = PerlIO_get_base(f);
3708         /*
3709          * Note position change
3710          */
3711         b->posn += (b->ptr - buf);
3712         if (b->ptr < b->end) {
3713             /* We did not consume all of it - try and seek downstream to
3714                our logical position
3715              */
3716             if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3717                 /* Reload n as some layers may pop themselves on seek */
3718                 b->posn = PerlIO_tell(n = PerlIONext(f));
3719             }
3720             else {
3721                 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3722                    data is lost for good - so return saying "ok" having undone
3723                    the position adjust
3724                  */
3725                 b->posn -= (b->ptr - buf);
3726                 return code;
3727             }
3728         }
3729     }
3730     b->ptr = b->end = b->buf;
3731     PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3732     /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3733     if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3734         code = -1;
3735     return code;
3736 }
3737
3738 /* This discards the content of the buffer after b->ptr, and rereads
3739  * the buffer from the position off in the layer downstream; here off
3740  * is at offset corresponding to b->ptr - b->buf.
3741  */
3742 IV
3743 PerlIOBuf_fill(pTHX_ PerlIO *f)
3744 {
3745     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3746     PerlIO *n = PerlIONext(f);
3747     SSize_t avail;
3748     /*
3749      * Down-stream flush is defined not to loose read data so is harmless.
3750      * we would not normally be fill'ing if there was data left in anycase.
3751      */
3752     if (PerlIO_flush(f) != 0)   /* XXXX Check that its seek() succeeded?! */
3753         return -1;
3754     if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3755         PerlIOBase_flush_linebuf(aTHX);
3756
3757     if (!b->buf)
3758         PerlIO_get_base(f);     /* allocate via vtable */
3759
3760     assert(b->buf); /* The b->buf does get allocated via the vtable system. */
3761
3762     b->ptr = b->end = b->buf;
3763
3764     if (!PerlIOValid(n)) {
3765         PerlIOBase(f)->flags |= PERLIO_F_EOF;
3766         return -1;
3767     }
3768
3769     if (PerlIO_fast_gets(n)) {
3770         /*
3771          * Layer below is also buffered. We do _NOT_ want to call its
3772          * ->Read() because that will loop till it gets what we asked for
3773          * which may hang on a pipe etc. Instead take anything it has to
3774          * hand, or ask it to fill _once_.
3775          */
3776         avail = PerlIO_get_cnt(n);
3777         if (avail <= 0) {
3778             avail = PerlIO_fill(n);
3779             if (avail == 0)
3780                 avail = PerlIO_get_cnt(n);
3781             else {
3782                 if (!PerlIO_error(n) && PerlIO_eof(n))
3783                     avail = 0;
3784             }
3785         }
3786         if (avail > 0) {
3787             STDCHAR *ptr = PerlIO_get_ptr(n);
3788             const SSize_t cnt = avail;
3789             if (avail > (SSize_t)b->bufsiz)
3790                 avail = b->bufsiz;
3791             Copy(ptr, b->buf, avail, STDCHAR);
3792             PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3793         }
3794     }
3795     else {
3796         avail = PerlIO_read(n, b->ptr, b->bufsiz);
3797     }
3798     if (avail <= 0) {
3799         if (avail == 0)
3800             PerlIOBase(f)->flags |= PERLIO_F_EOF;
3801         else
3802             PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3803         return -1;
3804     }
3805     b->end = b->buf + avail;
3806     PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3807     return 0;
3808 }
3809
3810 SSize_t
3811 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3812 {
3813     if (PerlIOValid(f)) {
3814         const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3815         if (!b->ptr)
3816             PerlIO_get_base(f);
3817         return PerlIOBase_read(aTHX_ f, vbuf, count);
3818     }
3819     return 0;
3820 }
3821
3822 SSize_t
3823 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3824 {
3825     const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3826     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3827     SSize_t unread = 0;
3828     SSize_t avail;
3829     if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3830         PerlIO_flush(f);
3831     if (!b->buf)
3832         PerlIO_get_base(f);
3833     if (b->buf) {
3834         if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3835             /*
3836              * Buffer is already a read buffer, we can overwrite any chars
3837              * which have been read back to buffer start
3838              */
3839             avail = (b->ptr - b->buf);
3840         }
3841         else {
3842             /*
3843              * Buffer is idle, set it up so whole buffer is available for
3844              * unread
3845              */
3846             avail = b->bufsiz;
3847             b->end = b->buf + avail;
3848             b->ptr = b->end;
3849             PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3850             /*
3851              * Buffer extends _back_ from where we are now
3852              */
3853             b->posn -= b->bufsiz;
3854         }
3855         if (avail > (SSize_t) count) {
3856             /*
3857              * If we have space for more than count, just move count
3858              */
3859             avail = count;
3860         }
3861         if (avail > 0) {
3862             b->ptr -= avail;
3863             buf -= avail;
3864             /*
3865              * In simple stdio-like ungetc() case chars will be already
3866              * there
3867              */
3868             if (buf != b->ptr) {
3869                 Copy(buf, b->ptr, avail, STDCHAR);
3870             }
3871             count -= avail;
3872             unread += avail;
3873             PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3874         }
3875     }
3876     if (count > 0) {
3877         unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3878     }
3879     return unread;
3880 }
3881
3882 SSize_t
3883 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3884 {
3885     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3886     const STDCHAR *buf = (const STDCHAR *) vbuf;
3887     const STDCHAR *flushptr = buf;
3888     Size_t written = 0;
3889     if (!b->buf)
3890         PerlIO_get_base(f);
3891     if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3892         return 0;
3893     if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3894         if (PerlIO_flush(f) != 0) {
3895             return 0;
3896         }
3897     }
3898     if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3899         flushptr = buf + count;
3900         while (flushptr > buf && *(flushptr - 1) != '\n')
3901             --flushptr;
3902     }
3903     while (count > 0) {
3904         SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3905         if ((SSize_t) count < avail)
3906             avail = count;
3907         if (flushptr > buf && flushptr <= buf + avail)
3908             avail = flushptr - buf;
3909         PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3910         if (avail) {
3911             Copy(buf, b->ptr, avail, STDCHAR);
3912             count -= avail;
3913             buf += avail;
3914             written += avail;
3915             b->ptr += avail;
3916             if (buf == flushptr)
3917                 PerlIO_flush(f);
3918         }
3919         if (b->ptr >= (b->buf + b->bufsiz))
3920             PerlIO_flush(f);
3921     }
3922     if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3923         PerlIO_flush(f);
3924     return written;
3925 }
3926
3927 IV
3928 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3929 {
3930     IV code;
3931     if ((code = PerlIO_flush(f)) == 0) {
3932         PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3933         code = PerlIO_seek(PerlIONext(f), offset, whence);
3934         if (code == 0) {
3935             PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3936             b->posn = PerlIO_tell(PerlIONext(f));
3937         }
3938     }
3939     return code;
3940 }
3941
3942 Off_t
3943 PerlIOBuf_tell(pTHX_ PerlIO *f)
3944 {
3945     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3946     /*
3947      * b->posn is file position where b->buf was read, or will be written
3948      */
3949     Off_t posn = b->posn;
3950     if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3951         (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3952 #if 1
3953         /* As O_APPEND files are normally shared in some sense it is better
3954            to flush :
3955          */
3956         PerlIO_flush(f);
3957 #else
3958         /* when file is NOT shared then this is sufficient */
3959         PerlIO_seek(PerlIONext(f),0, SEEK_END);
3960 #endif
3961         posn = b->posn = PerlIO_tell(PerlIONext(f));
3962     }
3963     if (b->buf) {
3964         /*
3965          * If buffer is valid adjust position by amount in buffer
3966          */
3967         posn += (b->ptr - b->buf);
3968     }
3969     return posn;
3970 }
3971
3972 IV
3973 PerlIOBuf_popped(pTHX_ PerlIO *f)
3974 {
3975     const IV code = PerlIOBase_popped(aTHX_ f);
3976     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3977     if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3978         Safefree(b->buf);
3979     }
3980     b->ptr = b->end = b->buf = NULL;
3981     PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3982     return code;
3983 }
3984
3985 IV
3986 PerlIOBuf_close(pTHX_ PerlIO *f)
3987 {
3988     const IV code = PerlIOBase_close(aTHX_ f);
3989     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3990     if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3991         Safefree(b->buf);
3992     }
3993     b->ptr = b->end = b->buf = NULL;
3994     PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3995     return code;
3996 }
3997
3998 STDCHAR *
3999 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
4000 {
4001     const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4002     if (!b->buf)
4003         PerlIO_get_base(f);
4004     return b->ptr;
4005 }
4006
4007 SSize_t
4008 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
4009 {
4010     const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4011     if (!b->buf)
4012         PerlIO_get_base(f);
4013     if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
4014         return (b->end - b->ptr);
4015     return 0;
4016 }
4017
4018 STDCHAR *
4019 PerlIOBuf_get_base(pTHX_ PerlIO *f)
4020 {
4021     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4022     PERL_UNUSED_CONTEXT;
4023
4024     if (!b->buf) {
4025         if (!b->bufsiz)
4026             b->bufsiz = 4096;
4027         b->buf = Newxz(b->buf,b->bufsiz, STDCHAR);
4028         if (!b->buf) {
4029             b->buf = (STDCHAR *) & b->oneword;
4030             b->bufsiz = sizeof(b->oneword);
4031         }
4032         b->end = b->ptr = b->buf;
4033     }
4034     return b->buf;
4035 }
4036
4037 Size_t
4038 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
4039 {
4040     const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4041     if (!b->buf)
4042         PerlIO_get_base(f);
4043     return (b->end - b->buf);
4044 }
4045
4046 void
4047 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4048 {
4049     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4050     if (!b->buf)
4051         PerlIO_get_base(f);
4052     b->ptr = ptr;
4053     if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
4054         assert(PerlIO_get_cnt(f) == cnt);
4055         assert(b->ptr >= b->buf);
4056     }
4057     PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4058 }
4059
4060 PerlIO *
4061 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4062 {
4063  return PerlIOBase_dup(aTHX_ f, o, param, flags);
4064 }
4065
4066
4067
4068 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
4069     sizeof(PerlIO_funcs),
4070     "perlio",
4071     sizeof(PerlIOBuf),
4072     PERLIO_K_BUFFERED|PERLIO_K_RAW,
4073     PerlIOBuf_pushed,
4074     PerlIOBuf_popped,
4075     PerlIOBuf_open,
4076     PerlIOBase_binmode,         /* binmode */
4077     NULL,
4078     PerlIOBase_fileno,
4079     PerlIOBuf_dup,
4080     PerlIOBuf_read,
4081     PerlIOBuf_unread,
4082     PerlIOBuf_write,
4083     PerlIOBuf_seek,
4084     PerlIOBuf_tell,
4085     PerlIOBuf_close,
4086     PerlIOBuf_flush,
4087     PerlIOBuf_fill,
4088     PerlIOBase_eof,
4089     PerlIOBase_error,
4090     PerlIOBase_clearerr,
4091     PerlIOBase_setlinebuf,
4092     PerlIOBuf_get_base,
4093     PerlIOBuf_bufsiz,
4094     PerlIOBuf_get_ptr,
4095     PerlIOBuf_get_cnt,
4096     PerlIOBuf_set_ptrcnt,
4097 };
4098
4099 /*--------------------------------------------------------------------------------------*/
4100 /*
4101  * Temp layer to hold unread chars when cannot do it any other way
4102  */
4103
4104 IV
4105 PerlIOPending_fill(pTHX_ PerlIO *f)
4106 {
4107     /*
4108      * Should never happen
4109      */
4110     PerlIO_flush(f);
4111     return 0;
4112 }
4113
4114 IV
4115 PerlIOPending_close(pTHX_ PerlIO *f)
4116 {
4117     /*
4118      * A tad tricky - flush pops us, then we close new top
4119      */
4120     PerlIO_flush(f);
4121     return PerlIO_close(f);
4122 }
4123
4124 IV
4125 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4126 {
4127     /*
4128      * A tad tricky - flush pops us, then we seek new top
4129      */
4130     PerlIO_flush(f);
4131     return PerlIO_seek(f, offset, whence);
4132 }
4133
4134
4135 IV
4136 PerlIOPending_flush(pTHX_ PerlIO *f)
4137 {
4138     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4139     if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4140         Safefree(b->buf);
4141         b->buf = NULL;
4142     }
4143     PerlIO_pop(aTHX_ f);
4144     return 0;
4145 }
4146
4147 void
4148 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4149 {
4150     if (cnt <= 0) {
4151         PerlIO_flush(f);
4152     }
4153     else {
4154         PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4155     }
4156 }
4157
4158 IV
4159 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4160 {
4161     const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4162     PerlIOl * const l = PerlIOBase(f);
4163     /*
4164      * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4165      * etc. get muddled when it changes mid-string when we auto-pop.
4166      */
4167     l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4168         (PerlIOBase(PerlIONext(f))->
4169          flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4170     return code;
4171 }
4172
4173 SSize_t
4174 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4175 {
4176     SSize_t avail = PerlIO_get_cnt(f);
4177     SSize_t got = 0;
4178     if ((SSize_t)count < avail)
4179         avail = count;
4180     if (avail > 0)
4181         got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4182     if (got >= 0 && got < (SSize_t)count) {
4183         const SSize_t more =
4184             PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4185         if (more >= 0 || got == 0)
4186             got += more;
4187     }
4188     return got;
4189 }
4190
4191 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4192     sizeof(PerlIO_funcs),
4193     "pending",
4194     sizeof(PerlIOBuf),
4195     PERLIO_K_BUFFERED|PERLIO_K_RAW,  /* not sure about RAW here */
4196     PerlIOPending_pushed,
4197     PerlIOBuf_popped,
4198     NULL,
4199     PerlIOBase_binmode,         /* binmode */
4200     NULL,
4201     PerlIOBase_fileno,
4202     PerlIOBuf_dup,
4203     PerlIOPending_read,
4204     PerlIOBuf_unread,
4205     PerlIOBuf_write,
4206     PerlIOPending_seek,
4207     PerlIOBuf_tell,
4208     PerlIOPending_close,
4209     PerlIOPending_flush,
4210     PerlIOPending_fill,
4211     PerlIOBase_eof,
4212     PerlIOBase_error,
4213     PerlIOBase_clearerr,
4214     PerlIOBase_setlinebuf,
4215     PerlIOBuf_get_base,
4216     PerlIOBuf_bufsiz,
4217     PerlIOBuf_get_ptr,
4218     PerlIOBuf_get_cnt,
4219     PerlIOPending_set_ptrcnt,
4220 };
4221
4222
4223
4224 /*--------------------------------------------------------------------------------------*/
4225 /*
4226  * crlf - translation On read translate CR,LF to "\n" we do this by
4227  * overriding ptr/cnt entries to hand back a line at a time and keeping a
4228  * record of which nl we "lied" about. On write translate "\n" to CR,LF
4229  *
4230  * c->nl points on the first byte of CR LF pair when it is temporarily
4231  * replaced by LF, or to the last CR of the buffer.  In the former case
4232  * the caller thinks that the buffer ends at c->nl + 1, in the latter
4233  * that it ends at c->nl; these two cases can be distinguished by
4234  * *c->nl.  c->nl is set during _getcnt() call, and unset during
4235  * _unread() and _flush() calls.
4236  * It only matters for read operations.
4237  */
4238
4239 typedef struct {
4240     PerlIOBuf base;             /* PerlIOBuf stuff */
4241     STDCHAR *nl;                /* Position of crlf we "lied" about in the
4242                                  * buffer */
4243 } PerlIOCrlf;
4244
4245 /* Inherit the PERLIO_F_UTF8 flag from previous layer.
4246  * Otherwise the :crlf layer would always revert back to
4247  * raw mode.
4248  */
4249 static void
4250 S_inherit_utf8_flag(PerlIO *f)
4251 {
4252     PerlIO *g = PerlIONext(f);
4253     if (PerlIOValid(g)) {
4254         if (PerlIOBase(g)->flags & PERLIO_F_UTF8) {
4255             PerlIOBase(f)->flags |= PERLIO_F_UTF8;
4256         }
4257     }
4258 }
4259
4260 IV
4261 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4262 {
4263     IV code;
4264     PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4265     code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4266 #if 0
4267     PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4268                  f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4269                  PerlIOBase(f)->flags);
4270 #endif
4271     {
4272       /* Enable the first CRLF capable layer you can find, but if none
4273        * found, the one we just pushed is fine.  This results in at
4274        * any given moment at most one CRLF-capable layer being enabled
4275        * in the whole layer stack. */
4276          PerlIO *g = PerlIONext(f);
4277          while (PerlIOValid(g)) {
4278               PerlIOl *b = PerlIOBase(g);
4279               if (b && b->tab == &PerlIO_crlf) {
4280                    if (!(b->flags & PERLIO_F_CRLF))
4281                         b->flags |= PERLIO_F_CRLF;
4282                    S_inherit_utf8_flag(g);
4283                    PerlIO_pop(aTHX_ f);
4284                    return code;
4285               }
4286               g = PerlIONext(g);
4287          }
4288     }
4289     S_inherit_utf8_flag(f);
4290     return code;
4291 }
4292
4293
4294 SSize_t
4295 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4296 {
4297     PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4298     if (c->nl) {        /* XXXX Shouldn't it be done only if b->ptr > c->nl? */
4299         *(c->nl) = 0xd;
4300         c->nl = NULL;
4301     }
4302     if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4303         return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4304     else {
4305         const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4306         PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4307         SSize_t unread = 0;
4308         if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4309             PerlIO_flush(f);
4310         if (!b->buf)
4311             PerlIO_get_base(f);
4312         if (b->buf) {
4313             if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4314                 b->end = b->ptr = b->buf + b->bufsiz;
4315                 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4316                 b->posn -= b->bufsiz;
4317             }
4318             while (count > 0 && b->ptr > b->buf) {
4319                 const int ch = *--buf;
4320                 if (ch == '\n') {
4321                     if (b->ptr - 2 >= b->buf) {
4322                         *--(b->ptr) = 0xa;
4323                         *--(b->ptr) = 0xd;
4324                         unread++;
4325                         count--;
4326                     }
4327                     else {
4328                     /* If b->ptr - 1 == b->buf, we are undoing reading 0xa */
4329                         *--(b->ptr) = 0xa;      /* Works even if 0xa == '\r' */
4330                         unread++;
4331                         count--;
4332                     }
4333                 }
4334                 else {
4335                     *--(b->ptr) = ch;
4336                     unread++;
4337                     count--;
4338                 }
4339             }
4340         }
4341         return unread;
4342     }
4343 }
4344
4345 /* XXXX This code assumes that buffer size >=2, but does not check it... */
4346 SSize_t
4347 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4348 {
4349     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4350     if (!b->buf)
4351         PerlIO_get_base(f);
4352     if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4353         PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4354         if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4355             STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4356           scan:
4357             while (nl < b->end && *nl != 0xd)
4358                 nl++;
4359             if (nl < b->end && *nl == 0xd) {
4360               test:
4361                 if (nl + 1 < b->end) {
4362                     if (nl[1] == 0xa) {
4363                         *nl = '\n';
4364                         c->nl = nl;
4365                     }
4366                     else {
4367                         /*
4368                          * Not CR,LF but just CR
4369                          */
4370                         nl++;
4371                         goto scan;
4372                     }
4373                 }
4374                 else {
4375                     /*
4376                      * Blast - found CR as last char in buffer
4377                      */
4378
4379                     if (b->ptr < nl) {
4380                         /*
4381                          * They may not care, defer work as long as
4382                          * possible
4383                          */
4384                         c->nl = nl;
4385                         return (nl - b->ptr);
4386                     }
4387                     else {
4388                         int code;
4389                         b->ptr++;       /* say we have read it as far as
4390                                          * flush() is concerned */
4391                         b->buf++;       /* Leave space in front of buffer */
4392                         /* Note as we have moved buf up flush's
4393                            posn += ptr-buf
4394                            will naturally make posn point at CR
4395                          */
4396                         b->bufsiz--;    /* Buffer is thus smaller */
4397                         code = PerlIO_fill(f);  /* Fetch some more */
4398                         b->bufsiz++;    /* Restore size for next time */
4399                         b->buf--;       /* Point at space */
4400                         b->ptr = nl = b->buf;   /* Which is what we hand
4401                                                  * off */
4402                         *nl = 0xd;      /* Fill in the CR */
4403                         if (code == 0)
4404                             goto test;  /* fill() call worked */
4405                         /*
4406                          * CR at EOF - just fall through
4407                          */
4408                         /* Should we clear EOF though ??? */
4409                     }
4410                 }
4411             }
4412         }
4413         return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4414     }
4415     return 0;
4416 }
4417
4418 void
4419 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4420 {
4421     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4422     PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4423     if (!b->buf)
4424         PerlIO_get_base(f);
4425     if (!ptr) {
4426         if (c->nl) {
4427             ptr = c->nl + 1;
4428             if (ptr == b->end && *c->nl == 0xd) {
4429                 /* Defered CR at end of buffer case - we lied about count */
4430                 ptr--;
4431             }
4432         }
4433         else {
4434             ptr = b->end;
4435         }
4436         ptr -= cnt;
4437     }
4438     else {
4439         NOOP;
4440 #if 0
4441         /*
4442          * Test code - delete when it works ...
4443          */
4444         IV flags = PerlIOBase(f)->flags;
4445         STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4446         if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4447           /* Defered CR at end of buffer case - we lied about count */
4448           chk--;
4449         }
4450         chk -= cnt;
4451
4452         if (ptr != chk ) {
4453             Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4454                        " nl=%p e=%p for %d", ptr, chk, flags, c->nl,
4455                        b->end, cnt);
4456         }
4457 #endif
4458     }
4459     if (c->nl) {
4460         if (ptr > c->nl) {
4461             /*
4462              * They have taken what we lied about
4463              */
4464             *(c->nl) = 0xd;
4465             c->nl = NULL;
4466             ptr++;
4467         }
4468     }
4469     b->ptr = ptr;
4470     PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4471 }
4472
4473 SSize_t
4474 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4475 {
4476     if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4477         return PerlIOBuf_write(aTHX_ f, vbuf, count);
4478     else {
4479         PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4480         const STDCHAR *buf = (const STDCHAR *) vbuf;
4481         const STDCHAR * const ebuf = buf + count;
4482         if (!b->buf)
4483             PerlIO_get_base(f);
4484         if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4485             return 0;
4486         while (buf < ebuf) {
4487             const STDCHAR * const eptr = b->buf + b->bufsiz;
4488             PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4489             while (buf < ebuf && b->ptr < eptr) {
4490                 if (*buf == '\n') {
4491                     if ((b->ptr + 2) > eptr) {
4492                         /*
4493                          * Not room for both
4494                          */
4495                         PerlIO_flush(f);
4496                         break;
4497                     }
4498                     else {
4499                         *(b->ptr)++ = 0xd;      /* CR */
4500                         *(b->ptr)++ = 0xa;      /* LF */
4501                         buf++;
4502                         if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4503                             PerlIO_flush(f);
4504                             break;
4505                         }
4506                     }
4507                 }
4508                 else {
4509                     *(b->ptr)++ = *buf++;
4510                 }
4511                 if (b->ptr >= eptr) {
4512                     PerlIO_flush(f);
4513                     break;
4514                 }
4515             }
4516         }
4517         if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4518             PerlIO_flush(f);
4519         return (buf - (STDCHAR *) vbuf);
4520     }
4521 }
4522
4523 IV
4524 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4525 {
4526     PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4527     if (c->nl) {
4528         *(c->nl) = 0xd;
4529         c->nl = NULL;
4530     }
4531     return PerlIOBuf_flush(aTHX_ f);
4532 }
4533
4534 IV
4535 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4536 {
4537     if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4538         /* In text mode - flush any pending stuff and flip it */
4539         PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4540 #ifndef PERLIO_USING_CRLF
4541         /* CRLF is unusual case - if this is just the :crlf layer pop it */
4542         if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4543                 PerlIO_pop(aTHX_ f);
4544         }
4545 #endif
4546     }
4547     return 0;
4548 }
4549
4550 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4551     sizeof(PerlIO_funcs),
4552     "crlf",
4553     sizeof(PerlIOCrlf),
4554     PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4555     PerlIOCrlf_pushed,
4556     PerlIOBuf_popped,         /* popped */
4557     PerlIOBuf_open,
4558     PerlIOCrlf_binmode,       /* binmode */
4559     NULL,
4560     PerlIOBase_fileno,
4561     PerlIOBuf_dup,
4562     PerlIOBuf_read,             /* generic read works with ptr/cnt lies */
4563     PerlIOCrlf_unread,          /* Put CR,LF in buffer for each '\n' */
4564     PerlIOCrlf_write,           /* Put CR,LF in buffer for each '\n' */
4565     PerlIOBuf_seek,
4566     PerlIOBuf_tell,
4567     PerlIOBuf_close,
4568     PerlIOCrlf_flush,
4569     PerlIOBuf_fill,
4570     PerlIOBase_eof,
4571     PerlIOBase_error,
4572     PerlIOBase_clearerr,
4573     PerlIOBase_setlinebuf,
4574     PerlIOBuf_get_base,
4575     PerlIOBuf_bufsiz,
4576     PerlIOBuf_get_ptr,
4577     PerlIOCrlf_get_cnt,
4578     PerlIOCrlf_set_ptrcnt,
4579 };
4580
4581 #ifdef HAS_MMAP
4582 /*--------------------------------------------------------------------------------------*/
4583 /*
4584  * mmap as "buffer" layer
4585  */
4586
4587 typedef struct {
4588     PerlIOBuf base;             /* PerlIOBuf stuff */
4589     Mmap_t mptr;                /* Mapped address */
4590     Size_t len;                 /* mapped length */
4591     STDCHAR *bbuf;              /* malloced buffer if map fails */
4592 } PerlIOMmap;
4593
4594 IV
4595 PerlIOMmap_map(pTHX_ PerlIO *f)
4596 {
4597     dVAR;
4598     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4599     const IV flags = PerlIOBase(f)->flags;
4600     IV code = 0;
4601     if (m->len)
4602         abort();
4603     if (flags & PERLIO_F_CANREAD) {
4604         PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4605         const int fd = PerlIO_fileno(f);
4606         Stat_t st;
4607         code = Fstat(fd, &st);
4608         if (code == 0 && S_ISREG(st.st_mode)) {
4609             SSize_t len = st.st_size - b->posn;
4610             if (len > 0) {
4611                 Off_t posn;
4612                 if (PL_mmap_page_size <= 0)
4613                   Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4614                              PL_mmap_page_size);
4615                 if (b->posn < 0) {
4616                     /*
4617                      * This is a hack - should never happen - open should
4618                      * have set it !
4619                      */
4620                     b->posn = PerlIO_tell(PerlIONext(f));
4621                 }
4622                 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4623                 len = st.st_size - posn;
4624                 m->mptr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4625                 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4626 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4627                     madvise(m->mptr, len, MADV_SEQUENTIAL);
4628 #endif
4629 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4630                     madvise(m->mptr, len, MADV_WILLNEED);
4631 #endif
4632                     PerlIOBase(f)->flags =
4633                         (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4634                     b->end = ((STDCHAR *) m->mptr) + len;
4635                     b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4636                     b->ptr = b->buf;
4637                     m->len = len;
4638                 }
4639                 else {
4640                     b->buf = NULL;
4641                 }
4642             }
4643             else {
4644                 PerlIOBase(f)->flags =
4645                     flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4646                 b->buf = NULL;
4647                 b->ptr = b->end = b->ptr;
4648                 code = -1;
4649             }
4650         }
4651     }
4652     return code;
4653 }
4654
4655 IV
4656 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4657 {
4658     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4659     IV code = 0;
4660     if (m->len) {
4661         PerlIOBuf * const b = &m->base;
4662         if (b->buf) {
4663             /* The munmap address argument is tricky: depending on the
4664              * standard it is either "void *" or "caddr_t" (which is
4665              * usually "char *" (signed or unsigned).  If we cast it
4666              * to "void *", those that have it caddr_t and an uptight
4667              * C++ compiler, will freak out.  But casting it as char*
4668              * should work.  Maybe.  (Using Mmap_t figured out by
4669              * Configure doesn't always work, apparently.) */
4670             code = munmap((char*)m->mptr, m->len);
4671             b->buf = NULL;
4672             m->len = 0;
4673             m->mptr = NULL;
4674             if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4675                 code = -1;
4676         }
4677         b->ptr = b->end = b->buf;
4678         PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4679     }
4680     return code;
4681 }
4682
4683 STDCHAR *
4684 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4685 {
4686     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4687     PerlIOBuf * const b = &m->base;
4688     if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4689         /*
4690          * Already have a readbuffer in progress
4691          */
4692         return b->buf;
4693     }
4694     if (b->buf) {
4695         /*
4696          * We have a write buffer or flushed PerlIOBuf read buffer
4697          */
4698         m->bbuf = b->buf;       /* save it in case we need it again */
4699         b->buf = NULL;          /* Clear to trigger below */
4700     }
4701     if (!b->buf) {
4702         PerlIOMmap_map(aTHX_ f);        /* Try and map it */
4703         if (!b->buf) {
4704             /*
4705              * Map did not work - recover PerlIOBuf buffer if we have one
4706              */
4707             b->buf = m->bbuf;
4708         }
4709     }
4710     b->ptr = b->end = b->buf;
4711     if (b->buf)
4712         return b->buf;
4713     return PerlIOBuf_get_base(aTHX_ f);
4714 }
4715
4716 SSize_t
4717 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4718 {
4719     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4720     PerlIOBuf * const b = &m->base;
4721     if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4722         PerlIO_flush(f);
4723     if (b->ptr && (b->ptr - count) >= b->buf
4724         && memEQ(b->ptr - count, vbuf, count)) {
4725         b->ptr -= count;
4726         PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4727         return count;
4728     }
4729     if (m->len) {
4730         /*
4731          * Loose the unwritable mapped buffer
4732          */
4733         PerlIO_flush(f);
4734         /*
4735          * If flush took the "buffer" see if we have one from before
4736          */
4737         if (!b->buf && m->bbuf)
4738             b->buf = m->bbuf;
4739         if (!b->buf) {
4740             PerlIOBuf_get_base(aTHX_ f);
4741             m->bbuf = b->buf;
4742         }
4743     }
4744     return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4745 }
4746
4747 SSize_t
4748 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4749 {
4750     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4751     PerlIOBuf * const b = &m->base;
4752
4753     if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4754         /*
4755          * No, or wrong sort of, buffer
4756          */
4757         if (m->len) {
4758             if (PerlIOMmap_unmap(aTHX_ f) != 0)
4759                 return 0;
4760         }
4761         /*
4762          * If unmap took the "buffer" see if we have one from before
4763          */
4764         if (!b->buf && m->bbuf)
4765             b->buf = m->bbuf;
4766         if (!b->buf) {
4767             PerlIOBuf_get_base(aTHX_ f);
4768             m->bbuf = b->buf;
4769         }
4770     }
4771     return PerlIOBuf_write(aTHX_ f, vbuf, count);
4772 }
4773
4774 IV
4775 PerlIOMmap_flush(pTHX_ PerlIO *f)
4776 {
4777     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4778     PerlIOBuf * const b = &m->base;
4779     IV code = PerlIOBuf_flush(aTHX_ f);
4780     /*
4781      * Now we are "synced" at PerlIOBuf level
4782      */
4783     if (b->buf) {
4784         if (m->len) {
4785             /*
4786              * Unmap the buffer
4787              */
4788             if (PerlIOMmap_unmap(aTHX_ f) != 0)
4789                 code = -1;
4790         }
4791         else {
4792             /*
4793              * We seem to have a PerlIOBuf buffer which was not mapped
4794              * remember it in case we need one later
4795              */
4796             m->bbuf = b->buf;
4797         }
4798     }
4799     return code;
4800 }
4801
4802 IV
4803 PerlIOMmap_fill(pTHX_ PerlIO *f)
4804 {
4805     PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4806     IV code = PerlIO_flush(f);
4807     if (code == 0 && !b->buf) {
4808         code = PerlIOMmap_map(aTHX_ f);
4809     }
4810     if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4811         code = PerlIOBuf_fill(aTHX_ f);
4812     }
4813     return code;
4814 }
4815
4816 IV
4817 PerlIOMmap_close(pTHX_ PerlIO *f)
4818 {
4819     PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4820     PerlIOBuf * const b = &m->base;
4821     IV code = PerlIO_flush(f);
4822     if (m->bbuf) {
4823         b->buf = m->bbuf;
4824         m->bbuf = NULL;
4825         b->ptr = b->end = b->buf;
4826     }
4827     if (PerlIOBuf_close(aTHX_ f) != 0)
4828         code = -1;
4829     return code;
4830 }
4831
4832 PerlIO *
4833 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4834 {
4835  return PerlIOBase_dup(aTHX_ f, o, param, flags);
4836 }
4837
4838
4839 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4840     sizeof(PerlIO_funcs),
4841     "mmap",
4842     sizeof(PerlIOMmap),
4843     PERLIO_K_BUFFERED|PERLIO_K_RAW,
4844     PerlIOBuf_pushed,
4845     PerlIOBuf_popped,
4846     PerlIOBuf_open,
4847     PerlIOBase_binmode,         /* binmode */
4848     NULL,
4849     PerlIOBase_fileno,
4850     PerlIOMmap_dup,
4851     PerlIOBuf_read,
4852     PerlIOMmap_unread,
4853     PerlIOMmap_write,
4854     PerlIOBuf_seek,
4855     PerlIOBuf_tell,
4856     PerlIOBuf_close,
4857     PerlIOMmap_flush,
4858     PerlIOMmap_fill,
4859     PerlIOBase_eof,
4860     PerlIOBase_error,
4861     PerlIOBase_clearerr,
4862     PerlIOBase_setlinebuf,
4863     PerlIOMmap_get_base,
4864     PerlIOBuf_bufsiz,
4865     PerlIOBuf_get_ptr,
4866     PerlIOBuf_get_cnt,
4867     PerlIOBuf_set_ptrcnt,
4868 };
4869
4870 #endif                          /* HAS_MMAP */
4871
4872 PerlIO *
4873 Perl_PerlIO_stdin(pTHX)
4874 {
4875     dVAR;
4876     if (!PL_perlio) {
4877         PerlIO_stdstreams(aTHX);
4878     }
4879     return &PL_perlio[1];
4880 }
4881
4882 PerlIO *
4883 Perl_PerlIO_stdout(pTHX)
4884 {
4885     dVAR;
4886     if (!PL_perlio) {
4887         PerlIO_stdstreams(aTHX);
4888     }
4889     return &PL_perlio[2];
4890 }
4891
4892 PerlIO *
4893 Perl_PerlIO_stderr(pTHX)
4894 {
4895     dVAR;
4896     if (!PL_perlio) {
4897         PerlIO_stdstreams(aTHX);
4898     }
4899     return &PL_perlio[3];
4900 }
4901
4902 /*--------------------------------------------------------------------------------------*/
4903
4904 char *
4905 PerlIO_getname(PerlIO *f, char *buf)
4906 {
4907     dTHX;
4908 #ifdef VMS
4909     char *name = NULL;
4910     bool exported = FALSE;
4911     FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4912     if (!stdio) {
4913         stdio = PerlIO_exportFILE(f,0);
4914         exported = TRUE;
4915     }
4916     if (stdio) {
4917         name = fgetname(stdio, buf);
4918         if (exported) PerlIO_releaseFILE(f,stdio);
4919     }
4920     return name;
4921 #else
4922     PERL_UNUSED_ARG(f);
4923     PERL_UNUSED_ARG(buf);
4924     Perl_croak(aTHX_ "Don't know how to get file name");
4925     return NULL;
4926 #endif
4927 }
4928
4929
4930 /*--------------------------------------------------------------------------------------*/
4931 /*
4932  * Functions which can be called on any kind of PerlIO implemented in
4933  * terms of above
4934  */
4935
4936 #undef PerlIO_fdopen
4937 PerlIO *
4938 PerlIO_fdopen(int fd, const char *mode)
4939 {
4940     dTHX;
4941     return PerlIO_openn(aTHX_ NULL, mode, fd, 0, 0, NULL, 0, NULL);
4942 }
4943
4944 #undef PerlIO_open
4945 PerlIO *
4946 PerlIO_open(const char *path, const char *mode)
4947 {
4948     dTHX;
4949     SV *name = sv_2mortal(newSVpv(path, 0));
4950     return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, NULL, 1, &name);
4951 }
4952
4953 #undef Perlio_reopen
4954 PerlIO *
4955 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4956 {
4957     dTHX;
4958     SV *name = sv_2mortal(newSVpv(path,0));
4959     return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, f, 1, &name);
4960 }
4961
4962 #undef PerlIO_getc
4963 int
4964 PerlIO_getc(PerlIO *f)
4965 {
4966     dTHX;
4967     STDCHAR buf[1];
4968     if ( 1 == PerlIO_read(f, buf, 1) ) {
4969         return (unsigned char) buf[0];
4970     }
4971     return EOF;
4972 }
4973
4974 #undef PerlIO_ungetc
4975 int
4976 PerlIO_ungetc(PerlIO *f, int ch)
4977 {
4978     dTHX;
4979     if (ch != EOF) {
4980         STDCHAR buf = ch;
4981         if (PerlIO_unread(f, &buf, 1) == 1)
4982             return ch;
4983     }
4984     return EOF;
4985 }
4986
4987 #undef PerlIO_putc
4988 int
4989 PerlIO_putc(PerlIO *f, int ch)
4990 {
4991     dTHX;
4992     STDCHAR buf = ch;
4993     return PerlIO_write(f, &buf, 1);
4994 }
4995
4996 #undef PerlIO_puts
4997 int
4998 PerlIO_puts(PerlIO *f, const char *s)
4999 {
5000     dTHX;
5001     return PerlIO_write(f, s, strlen(s));
5002 }
5003
5004 #undef PerlIO_rewind
5005 void
5006 PerlIO_rewind(PerlIO *f)
5007 {
5008     dTHX;
5009     PerlIO_seek(f, (Off_t) 0, SEEK_SET);
5010     PerlIO_clearerr(f);
5011 }
5012
5013 #undef PerlIO_vprintf
5014 int
5015 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
5016 {
5017     dTHX;
5018     SV * const sv = newSVpvs("");
5019     const char *s;
5020     STRLEN len;
5021     SSize_t wrote;
5022 #ifdef NEED_VA_COPY
5023     va_list apc;
5024     Perl_va_copy(ap, apc);
5025     sv_vcatpvf(sv, fmt, &apc);
5026 #else
5027     sv_vcatpvf(sv, fmt, &ap);
5028 #endif
5029     s = SvPV_const(sv, len);
5030     wrote = PerlIO_write(f, s, len);
5031     SvREFCNT_dec(sv);
5032     return wrote;
5033 }
5034
5035 #undef PerlIO_printf
5036 int
5037 PerlIO_printf(PerlIO *f, const char *fmt, ...)
5038 {
5039     va_list ap;
5040     int result;
5041     va_start(ap, fmt);
5042     result = PerlIO_vprintf(f, fmt, ap);
5043     va_end(ap);
5044     return result;
5045 }
5046
5047 #undef PerlIO_stdoutf
5048 int
5049 PerlIO_stdoutf(const char *fmt, ...)
5050 {
5051     dTHX;
5052     va_list ap;
5053     int result;
5054     va_start(ap, fmt);
5055     result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
5056     va_end(ap);
5057     return result;
5058 }
5059
5060 #undef PerlIO_tmpfile
5061 PerlIO *
5062 PerlIO_tmpfile(void)
5063 {
5064      dTHX;
5065      PerlIO *f = NULL;
5066 #ifdef WIN32
5067      const int fd = win32_tmpfd();
5068      if (fd >= 0)
5069           f = PerlIO_fdopen(fd, "w+b");
5070 #else /* WIN32 */
5071 #    if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
5072      SV * const sv = newSVpvs("/tmp/PerlIO_XXXXXX");
5073      /*
5074       * I have no idea how portable mkstemp() is ... NI-S
5075       */
5076      const int fd = mkstemp(SvPVX(sv));
5077      if (fd >= 0) {
5078           f = PerlIO_fdopen(fd, "w+");
5079           if (f)
5080                PerlIOBase(f)->flags |= PERLIO_F_TEMP;
5081           PerlLIO_unlink(SvPVX_const(sv));
5082           SvREFCNT_dec(sv);
5083      }
5084 #    else       /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
5085      FILE * const stdio = PerlSIO_tmpfile();
5086
5087      if (stdio) {
5088           if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)),
5089                                PERLIO_FUNCS_CAST(&PerlIO_stdio),
5090                                "w+", NULL))) {
5091                PerlIOStdio * const s = PerlIOSelf(f, PerlIOStdio);
5092
5093                if (s)
5094                     s->stdio = stdio;
5095           }
5096      }
5097 #    endif /* else HAS_MKSTEMP */
5098 #endif /* else WIN32 */
5099      return f;
5100 }
5101
5102 #undef HAS_FSETPOS
5103 #undef HAS_FGETPOS
5104
5105 #endif                          /* USE_SFIO */
5106 #endif                          /* PERLIO_IS_STDIO */
5107
5108 /*======================================================================================*/
5109 /*
5110  * Now some functions in terms of above which may be needed even if we are
5111  * not in true PerlIO mode
5112  */
5113 const char *
5114 Perl_PerlIO_context_layers(pTHX_ const char *mode)
5115 {
5116     dVAR;
5117     const char *type = NULL;
5118     /*
5119      * Need to supply default layer info from open.pm
5120      */
5121     if (PL_curcop && PL_curcop->cop_hints & HINT_LEXICAL_IO) {
5122         SV * const layers
5123             = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash, 0,
5124                                        "open", 4, 0, 0);
5125         assert(layers);
5126         if (SvOK(layers)) {
5127             STRLEN len;
5128             type = SvPV_const(layers, len);
5129             if (type && mode && mode[0] != 'r') {
5130                 /*
5131                  * Skip to write part, which is separated by a '\0'
5132                  */
5133                 STRLEN read_len = strlen(type);
5134                 if (read_len < len) {
5135                     type += read_len + 1;
5136                 }
5137             }
5138         }
5139     }
5140     return type;
5141 }
5142
5143
5144 #ifndef HAS_FSETPOS
5145 #undef PerlIO_setpos
5146 int
5147 PerlIO_setpos(PerlIO *f, SV *pos)
5148 {
5149     dTHX;
5150     if (SvOK(pos)) {
5151         STRLEN len;
5152         const Off_t * const posn = (Off_t *) SvPV(pos, len);
5153         if (f && len == sizeof(Off_t))
5154             return PerlIO_seek(f, *posn, SEEK_SET);
5155     }
5156     SETERRNO(EINVAL, SS_IVCHAN);
5157     return -1;
5158 }
5159 #else
5160 #undef PerlIO_setpos
5161 int
5162 PerlIO_setpos(PerlIO *f, SV *pos)
5163 {
5164     dTHX;
5165     if (SvOK(pos)) {
5166         STRLEN len;
5167         Fpos_t * const fpos = (Fpos_t *) SvPV(pos, len);
5168         if (f && len == sizeof(Fpos_t)) {
5169 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5170             return fsetpos64(f, fpos);
5171 #else
5172             return fsetpos(f, fpos);
5173 #endif
5174         }
5175     }
5176     SETERRNO(EINVAL, SS_IVCHAN);
5177     return -1;
5178 }
5179 #endif
5180
5181 #ifndef HAS_FGETPOS
5182 #undef PerlIO_getpos
5183 int
5184 PerlIO_getpos(PerlIO *f, SV *pos)
5185 {
5186     dTHX;
5187     Off_t posn = PerlIO_tell(f);
5188     sv_setpvn(pos, (char *) &posn, sizeof(posn));
5189     return (posn == (Off_t) - 1) ? -1 : 0;
5190 }
5191 #else
5192 #undef PerlIO_getpos
5193 int
5194 PerlIO_getpos(PerlIO *f, SV *pos)
5195 {
5196     dTHX;
5197     Fpos_t fpos;
5198     int code;
5199 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5200     code = fgetpos64(f, &fpos);
5201 #else
5202     code = fgetpos(f, &fpos);
5203 #endif
5204     sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
5205     return code;
5206 }
5207 #endif
5208
5209 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
5210
5211 int
5212 vprintf(char *pat, char *args)
5213 {
5214     _doprnt(pat, args, stdout);
5215     return 0;                   /* wrong, but perl doesn't use the return
5216                                  * value */
5217 }
5218
5219 int
5220 vfprintf(FILE *fd, char *pat, char *args)
5221 {
5222     _doprnt(pat, args, fd);
5223     return 0;                   /* wrong, but perl doesn't use the return
5224                                  * value */
5225 }
5226
5227 #endif
5228
5229 #ifndef PerlIO_vsprintf
5230 int
5231 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5232 {
5233     dTHX;
5234     const int val = my_vsnprintf(s, n > 0 ? n : 0, fmt, ap);
5235     PERL_UNUSED_CONTEXT;
5236
5237 #ifndef PERL_MY_VSNPRINTF_GUARDED
5238     if (val < 0 || (n > 0 ? val >= n : 0)) {
5239         Perl_croak(aTHX_ "panic: my_vsnprintf overflow in PerlIO_vsprintf\n");
5240     }
5241 #endif
5242     return val;
5243 }
5244 #endif
5245
5246 #ifndef PerlIO_sprintf
5247 int
5248 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5249 {
5250     va_list ap;
5251     int result;
5252     va_start(ap, fmt);
5253     result = PerlIO_vsprintf(s, n, fmt, ap);
5254     va_end(ap);
5255     return result;
5256 }
5257 #endif
5258
5259 /*
5260  * Local variables:
5261  * c-indentation-style: bsd
5262  * c-basic-offset: 4
5263  * indent-tabs-mode: t
5264  * End:
5265  *
5266  * ex: set ts=8 sts=4 sw=4 noet:
5267  */