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