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