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