2 * perlio.c Copyright (c) 1996-2005, 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.
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.
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)
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
23 #ifdef PERL_IMPLICIT_SYS
36 #define PERLIO_NOT_STDIO 0
37 #if !defined(PERLIO_IS_STDIO) && !defined(USE_SFIO)
43 * This file provides those parts of PerlIO abstraction
44 * which are not #defined in perlio.h.
45 * Which these are depends on various Configure #ifdef's
49 #define PERL_IN_PERLIO_C
52 #ifdef PERL_IMPLICIT_CONTEXT
59 #define PERLIO_MAX_REFCOUNTABLE_FD 2048
62 /* Missing proto on LynxOS */
66 /* Call the callback or PerlIOBase, and return failure. */
67 #define Perl_PerlIO_or_Base(f, callback, base, failure, args) \
68 if (PerlIOValid(f)) { \
69 const PerlIO_funcs *tab = PerlIOBase(f)->tab; \
70 if (tab && tab->callback) \
71 return (*tab->callback) args; \
73 return PerlIOBase_ ## base args; \
76 SETERRNO(EBADF, SS_IVCHAN); \
79 /* Call the callback or fail, and return failure. */
80 #define Perl_PerlIO_or_fail(f, callback, failure, args) \
81 if (PerlIOValid(f)) { \
82 const PerlIO_funcs *tab = PerlIOBase(f)->tab; \
83 if (tab && tab->callback) \
84 return (*tab->callback) args; \
85 SETERRNO(EINVAL, LIB_INVARG); \
88 SETERRNO(EBADF, SS_IVCHAN); \
91 /* Call the callback or PerlIOBase, and be void. */
92 #define Perl_PerlIO_or_Base_void(f, callback, base, args) \
93 if (PerlIOValid(f)) { \
94 const PerlIO_funcs *tab = PerlIOBase(f)->tab; \
95 if (tab && tab->callback) \
96 (*tab->callback) args; \
98 PerlIOBase_ ## base args; \
101 SETERRNO(EBADF, SS_IVCHAN)
103 /* Call the callback or fail, and be void. */
104 #define Perl_PerlIO_or_fail_void(f, callback, args) \
105 if (PerlIOValid(f)) { \
106 const PerlIO_funcs *tab = PerlIOBase(f)->tab; \
107 if (tab && tab->callback) \
108 (*tab->callback) args; \
110 SETERRNO(EINVAL, LIB_INVARG); \
113 SETERRNO(EBADF, SS_IVCHAN)
117 perlsio_binmode(FILE *fp, int iotype, int mode)
120 * This used to be contents of do_binmode in doio.c
123 # if defined(atarist) || defined(__MINT__)
126 ((FILE *) fp)->_flag |= _IOBIN;
128 ((FILE *) fp)->_flag &= ~_IOBIN;
135 if (PerlLIO_setmode(fp, mode) != -1) {
137 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
139 # if defined(WIN32) && defined(__BORLANDC__)
141 * The translation mode of the stream is maintained independent of
142 * the translation mode of the fd in the Borland RTL (heavy
143 * digging through their runtime sources reveal). User has to set
144 * the mode explicitly for the stream (though they don't document
145 * this anywhere). GSAR 97-5-24
151 fp->flags &= ~_F_BIN;
159 # if defined(USEMYBINMODE)
161 if (my_binmode(fp, iotype, mode) != FALSE)
176 #define O_ACCMODE 3 /* Assume traditional implementation */
180 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
182 const int result = rawmode & O_ACCMODE;
187 ptype = IoTYPE_RDONLY;
190 ptype = IoTYPE_WRONLY;
198 *writing = (result != O_RDONLY);
200 if (result == O_RDONLY) {
204 else if (rawmode & O_APPEND) {
206 if (result != O_WRONLY)
211 if (result == O_WRONLY)
218 if (rawmode & O_BINARY)
224 #ifndef PERLIO_LAYERS
226 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
228 if (!names || !*names
229 || strEQ(names, ":crlf")
230 || strEQ(names, ":raw")
231 || strEQ(names, ":bytes")
235 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
243 PerlIO_destruct(pTHX)
248 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
256 return perlsio_binmode(fp, iotype, mode);
261 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
263 #if defined(PERL_MICRO) || defined(SYMBIAN)
266 #ifdef PERL_IMPLICIT_SYS
267 return PerlSIO_fdupopen(f);
270 return win32_fdupopen(f);
273 int fd = PerlLIO_dup(PerlIO_fileno(f));
276 int omode = fcntl(fd, F_GETFL);
278 omode = djgpp_get_stream_mode(f);
280 PerlIO_intmode2str(omode,mode,NULL);
281 /* the r+ is a hack */
282 return PerlIO_fdopen(fd, mode);
287 SETERRNO(EBADF, SS_IVCHAN);
297 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
301 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
302 int imode, int perm, PerlIO *old, int narg, SV **args)
306 Perl_croak(aTHX_ "More than one argument to open");
308 if (*args == &PL_sv_undef)
309 return PerlIO_tmpfile();
311 const char *name = SvPV_nolen(*args);
312 if (*mode == IoTYPE_NUMERIC) {
313 fd = PerlLIO_open3(name, imode, perm);
315 return PerlIO_fdopen(fd, mode + 1);
318 return PerlIO_reopen(name, mode, old);
321 return PerlIO_open(name, mode);
326 return PerlIO_fdopen(fd, (char *) mode);
331 XS(XS_PerlIO__Layer__find)
335 Perl_croak(aTHX_ "Usage class->find(name[,load])");
337 const char *name = SvPV_nolen(ST(1));
338 ST(0) = (strEQ(name, "crlf")
339 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
346 Perl_boot_core_PerlIO(pTHX)
348 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
354 #ifdef PERLIO_IS_STDIO
360 * Does nothing (yet) except force this file to be included in perl
361 * binary. That allows this file to force inclusion of other functions
362 * that may be required by loadable extensions e.g. for
363 * FileHandle::tmpfile
367 #undef PerlIO_tmpfile
374 #else /* PERLIO_IS_STDIO */
382 * This section is just to make sure these functions get pulled in from
386 #undef PerlIO_tmpfile
397 * Force this file to be included in perl binary. Which allows this
398 * file to force inclusion of other functions that may be required by
399 * loadable extensions e.g. for FileHandle::tmpfile
403 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
404 * results in a lot of lseek()s to regular files and lot of small
407 sfset(sfstdout, SF_SHARE, 0);
410 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
412 PerlIO_importFILE(FILE *stdio, const char *mode)
414 const int fd = fileno(stdio);
415 if (!mode || !*mode) {
418 return PerlIO_fdopen(fd, mode);
422 PerlIO_findFILE(PerlIO *pio)
424 const int fd = PerlIO_fileno(pio);
425 FILE * const f = fdopen(fd, "r+");
427 if (!f && errno == EINVAL)
429 if (!f && errno == EINVAL)
436 /*======================================================================================*/
438 * Implement all the PerlIO interface ourselves.
444 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
451 #include <sys/mman.h>
455 PerlIO_debug(const char *fmt, ...)
460 if (!PL_perlio_debug_fd && !PL_tainting && PL_uid == PL_euid && PL_gid == PL_egid) {
461 const char *s = PerlEnv_getenv("PERLIO_DEBUG");
463 PL_perlio_debug_fd = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
465 PL_perlio_debug_fd = -1;
467 if (PL_perlio_debug_fd > 0) {
469 const char *s = CopFILE(PL_curcop);
472 /* Use fixed buffer as sv_catpvf etc. needs SVs */
476 len = sprintf(buffer, "%.40s:%" IVdf " ", s, (IV) CopLINE(PL_curcop));
477 vsprintf(buffer+len, fmt, ap);
478 PerlLIO_write(PL_perlio_debug_fd, buffer, strlen(buffer));
480 SV *sv = newSVpvn("", 0);
483 Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s,
484 (IV) CopLINE(PL_curcop));
485 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
488 PerlLIO_write(PL_perlio_debug_fd, s, len);
495 /*--------------------------------------------------------------------------------------*/
498 * Inner level routines
502 * Table of pointers to the PerlIO structs (malloc'ed)
504 #define PERLIO_TABLE_SIZE 64
507 PerlIO_allocate(pTHX)
510 * Find a free slot in the table, allocating new table as necessary
515 while ((f = *last)) {
517 last = (PerlIO **) (f);
518 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
524 Newz('I',f,PERLIO_TABLE_SIZE,PerlIO);
532 #undef PerlIO_fdupopen
534 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
536 if (PerlIOValid(f)) {
537 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
538 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
540 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
542 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
546 SETERRNO(EBADF, SS_IVCHAN);
552 PerlIO_cleantable(pTHX_ PerlIO **tablep)
554 PerlIO *table = *tablep;
557 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
558 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
559 PerlIO *f = table + i;
571 PerlIO_list_alloc(pTHX)
574 Newz('L', list, 1, PerlIO_list_t);
580 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
583 if (--list->refcnt == 0) {
586 for (i = 0; i < list->cur; i++) {
587 if (list->array[i].arg)
588 SvREFCNT_dec(list->array[i].arg);
590 Safefree(list->array);
598 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
601 if (list->cur >= list->len) {
604 Renew(list->array, list->len, PerlIO_pair_t);
606 New('l', list->array, list->len, PerlIO_pair_t);
608 p = &(list->array[list->cur++]);
610 if ((p->arg = arg)) {
611 (void)SvREFCNT_inc(arg);
616 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
618 PerlIO_list_t *list = (PerlIO_list_t *) NULL;
621 list = PerlIO_list_alloc(aTHX);
622 for (i=0; i < proto->cur; i++) {
624 if (proto->array[i].arg)
625 arg = PerlIO_sv_dup(aTHX_ proto->array[i].arg,param);
626 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
633 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
636 PerlIO **table = &proto->Iperlio;
639 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
640 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
641 PerlIO_allocate(aTHX); /* root slot is never used */
642 PerlIO_debug("Clone %p from %p\n",aTHX,proto);
643 while ((f = *table)) {
645 table = (PerlIO **) (f++);
646 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
648 (void) fp_dup(f, 0, param);
657 PerlIO_destruct(pTHX)
659 PerlIO **table = &PL_perlio;
662 PerlIO_debug("Destruct %p\n",aTHX);
664 while ((f = *table)) {
666 table = (PerlIO **) (f++);
667 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
671 if (l->tab->kind & PERLIO_K_DESTRUCT) {
672 PerlIO_debug("Destruct popping %s\n", l->tab->name);
686 PerlIO_pop(pTHX_ PerlIO *f)
690 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
691 if (l->tab->Popped) {
693 * If popped returns non-zero do not free its layer structure
694 * it has either done so itself, or it is shared and still in
697 if ((*l->tab->Popped) (aTHX_ f) != 0)
705 /* Return as an array the stack of layers on a filehandle. Note that
706 * the stack is returned top-first in the array, and there are three
707 * times as many array elements as there are layers in the stack: the
708 * first element of a layer triplet is the name, the second one is the
709 * arguments, and the third one is the flags. */
712 PerlIO_get_layers(pTHX_ PerlIO *f)
716 if (PerlIOValid(f)) {
717 PerlIOl *l = PerlIOBase(f);
720 SV *name = l->tab && l->tab->name ?
721 newSVpv(l->tab->name, 0) : &PL_sv_undef;
722 SV *arg = l->tab && l->tab->Getarg ?
723 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
726 av_push(av, newSViv((IV)l->flags));
734 /*--------------------------------------------------------------------------------------*/
736 * XS Interface for perl code
740 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
744 if ((SSize_t) len <= 0)
746 for (i = 0; i < PL_known_layers->cur; i++) {
747 PerlIO_funcs *f = PL_known_layers->array[i].funcs;
748 if (memEQ(f->name, name, len) && f->name[len] == 0) {
749 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
753 if (load && PL_subname && PL_def_layerlist
754 && PL_def_layerlist->cur >= 2) {
755 if (PL_in_load_module) {
756 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
759 SV *pkgsv = newSVpvn("PerlIO", 6);
760 SV *layer = newSVpvn(name, len);
761 CV *cv = get_cv("PerlIO::Layer::NoWarnings", FALSE);
763 SAVEINT(PL_in_load_module);
765 SAVESPTR(PL_warnhook);
766 PL_warnhook = (SV *) cv;
770 * The two SVs are magically freed by load_module
772 Perl_load_module(aTHX_ 0, pkgsv, Nullsv, layer, Nullsv);
775 return PerlIO_find_layer(aTHX_ name, len, 0);
778 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
782 #ifdef USE_ATTRIBUTES_FOR_PERLIO
785 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
788 IO *io = GvIOn((GV *) SvRV(sv));
789 PerlIO *ifp = IoIFP(io);
790 PerlIO *ofp = IoOFP(io);
791 Perl_warn(aTHX_ "set %" SVf " %p %p %p", sv, io, ifp, ofp);
797 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
800 IO *io = GvIOn((GV *) SvRV(sv));
801 PerlIO *ifp = IoIFP(io);
802 PerlIO *ofp = IoOFP(io);
803 Perl_warn(aTHX_ "get %" SVf " %p %p %p", sv, io, ifp, ofp);
809 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
811 Perl_warn(aTHX_ "clear %" SVf, sv);
816 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
818 Perl_warn(aTHX_ "free %" SVf, sv);
822 MGVTBL perlio_vtab = {
830 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
833 SV *sv = SvRV(ST(1));
838 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
840 mg = mg_find(sv, PERL_MAGIC_ext);
841 mg->mg_virtual = &perlio_vtab;
843 Perl_warn(aTHX_ "attrib %" SVf, sv);
844 for (i = 2; i < items; i++) {
846 const char *name = SvPV(ST(i), len);
847 SV *layer = PerlIO_find_layer(aTHX_ name, len, 1);
849 av_push(av, SvREFCNT_inc(layer));
860 #endif /* USE_ATTIBUTES_FOR_PERLIO */
863 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
865 HV *stash = gv_stashpv("PerlIO::Layer", TRUE);
866 SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
870 XS(XS_PerlIO__Layer__NoWarnings)
872 /* This is used as a %SIG{__WARN__} handler to supress warnings
873 during loading of layers.
877 PerlIO_debug("warning:%s\n",SvPV_nolen(ST(0)));
881 XS(XS_PerlIO__Layer__find)
885 Perl_croak(aTHX_ "Usage class->find(name[,load])");
888 const char *name = SvPV(ST(1), len);
889 const bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
890 PerlIO_funcs *layer = PerlIO_find_layer(aTHX_ name, len, load);
892 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
899 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
901 if (!PL_known_layers)
902 PL_known_layers = PerlIO_list_alloc(aTHX);
903 PerlIO_list_push(aTHX_ PL_known_layers, tab, Nullsv);
904 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
908 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
911 const char *s = names;
913 while (isSPACE(*s) || *s == ':')
918 const char *as = Nullch;
920 if (!isIDFIRST(*s)) {
922 * Message is consistent with how attribute lists are
923 * passed. Even though this means "foo : : bar" is
924 * seen as an invalid separator character.
926 const char q = ((*s == '\'') ? '"' : '\'');
927 if (ckWARN(WARN_LAYER))
928 Perl_warner(aTHX_ packWARN(WARN_LAYER),
929 "Invalid separator character %c%c%c in PerlIO layer specification %s",
931 SETERRNO(EINVAL, LIB_INVARG);
936 } while (isALNUM(*e));
952 * It's a nul terminated string, not allowed
953 * to \ the terminating null. Anything other
954 * character is passed over.
964 if (ckWARN(WARN_LAYER))
965 Perl_warner(aTHX_ packWARN(WARN_LAYER),
966 "Argument list not closed for PerlIO layer \"%.*s\"",
978 const bool warn_layer = ckWARN(WARN_LAYER);
979 PerlIO_funcs *layer =
980 PerlIO_find_layer(aTHX_ s, llen, 1);
982 PerlIO_list_push(aTHX_ av, layer,
989 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
1002 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
1004 PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
1005 #ifdef PERLIO_USING_CRLF
1008 if (PerlIO_stdio.Set_ptrcnt)
1009 tab = &PerlIO_stdio;
1011 PerlIO_debug("Pushing %s\n", tab->name);
1012 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1017 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1019 return av->array[n].arg;
1023 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1025 if (n >= 0 && n < av->cur) {
1026 PerlIO_debug("Layer %" IVdf " is %s\n", n,
1027 av->array[n].funcs->name);
1028 return av->array[n].funcs;
1031 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1036 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1041 if (PerlIOValid(f)) {
1043 PerlIO_pop(aTHX_ f);
1049 PERLIO_FUNCS_DECL(PerlIO_remove) = {
1050 sizeof(PerlIO_funcs),
1053 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1073 NULL, /* get_base */
1074 NULL, /* get_bufsiz */
1077 NULL, /* set_ptrcnt */
1081 PerlIO_default_layers(pTHX)
1083 if (!PL_def_layerlist) {
1084 const char *s = (PL_tainting) ? Nullch : PerlEnv_getenv("PERLIO");
1085 PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1086 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1087 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1089 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1091 osLayer = &PerlIO_win32;
1094 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1095 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1096 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1097 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1099 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_mmap));
1101 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1102 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1103 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1104 PerlIO_list_push(aTHX_ PL_def_layerlist,
1105 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1108 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1111 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1114 if (PL_def_layerlist->cur < 2) {
1115 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1117 return PL_def_layerlist;
1121 Perl_boot_core_PerlIO(pTHX)
1123 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1124 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1127 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1128 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1132 PerlIO_default_layer(pTHX_ I32 n)
1134 PerlIO_list_t *av = PerlIO_default_layers(aTHX);
1137 return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1140 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1141 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1144 PerlIO_stdstreams(pTHX)
1147 PerlIO_allocate(aTHX);
1148 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1149 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1150 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1155 PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1157 if (tab->fsize != sizeof(PerlIO_funcs)) {
1159 Perl_croak(aTHX_ "Layer does not match this perl");
1163 if (tab->size < sizeof(PerlIOl)) {
1166 /* Real layer with a data area */
1167 Newc('L',l,tab->size,char,PerlIOl);
1169 Zero(l, tab->size, char);
1171 l->tab = (PerlIO_funcs*) tab;
1173 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1174 (mode) ? mode : "(Null)", (void*)arg);
1175 if (*l->tab->Pushed &&
1176 (*l->tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1177 PerlIO_pop(aTHX_ f);
1183 /* Pseudo-layer where push does its own stack adjust */
1184 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1185 (mode) ? mode : "(Null)", (void*)arg);
1187 (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1195 PerlIOBase_binmode(pTHX_ PerlIO *f)
1197 if (PerlIOValid(f)) {
1198 /* Is layer suitable for raw stream ? */
1199 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1200 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1201 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1204 /* Not suitable - pop it */
1205 PerlIO_pop(aTHX_ f);
1213 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1219 if (PerlIOValid(f)) {
1224 * Strip all layers that are not suitable for a raw stream
1227 while (t && (l = *t)) {
1228 if (l->tab->Binmode) {
1229 /* Has a handler - normal case */
1230 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1232 /* Layer still there - move down a layer */
1241 /* No handler - pop it */
1242 PerlIO_pop(aTHX_ t);
1245 if (PerlIOValid(f)) {
1246 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1254 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1255 PerlIO_list_t *layers, IV n, IV max)
1259 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1261 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1272 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1276 PerlIO_list_t *layers = PerlIO_list_alloc(aTHX);
1277 code = PerlIO_parse_layers(aTHX_ layers, names);
1279 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1281 PerlIO_list_free(aTHX_ layers);
1287 /*--------------------------------------------------------------------------------------*/
1289 * Given the abstraction above the public API functions
1293 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1295 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n",
1296 (void*)f, PerlIOBase(f)->tab->name, iotype, mode,
1297 (names) ? names : "(Null)");
1299 /* Do not flush etc. if (e.g.) switching encodings.
1300 if a pushed layer knows it needs to flush lower layers
1301 (for example :unix which is never going to call them)
1302 it can do the flush when it is pushed.
1304 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1307 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1308 #ifdef PERLIO_USING_CRLF
1309 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1310 O_BINARY so we can look for it in mode.
1312 if (!(mode & O_BINARY)) {
1314 /* FIXME?: Looking down the layer stack seems wrong,
1315 but is a way of reaching past (say) an encoding layer
1316 to flip CRLF-ness of the layer(s) below
1319 /* Perhaps we should turn on bottom-most aware layer
1320 e.g. Ilya's idea that UNIX TTY could serve
1322 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1323 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1324 /* Not in text mode - flush any pending stuff and flip it */
1326 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1328 /* Only need to turn it on in one layer so we are done */
1333 /* Not finding a CRLF aware layer presumably means we are binary
1334 which is not what was requested - so we failed
1335 We _could_ push :crlf layer but so could caller
1340 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1341 So code that used to be here is now in PerlIORaw_pushed().
1343 return PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), Nullch, Nullsv) ? TRUE : FALSE;
1348 PerlIO__close(pTHX_ PerlIO *f)
1350 if (PerlIOValid(f)) {
1351 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1352 if (tab && tab->Close)
1353 return (*tab->Close)(aTHX_ f);
1355 return PerlIOBase_close(aTHX_ f);
1358 SETERRNO(EBADF, SS_IVCHAN);
1364 Perl_PerlIO_close(pTHX_ PerlIO *f)
1366 const int code = PerlIO__close(aTHX_ f);
1367 while (PerlIOValid(f)) {
1368 PerlIO_pop(aTHX_ f);
1374 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1376 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1380 PerlIO_context_layers(pTHX_ const char *mode)
1382 const char *type = NULL;
1384 * Need to supply default layer info from open.pm
1387 SV *layers = PL_curcop->cop_io;
1390 type = SvPV(layers, len);
1391 if (type && mode[0] != 'r') {
1393 * Skip to write part
1395 const char *s = strchr(type, 0);
1396 if (s && (STRLEN)(s - type) < len) {
1405 static PerlIO_funcs *
1406 PerlIO_layer_from_ref(pTHX_ SV *sv)
1409 * For any scalar type load the handler which is bundled with perl
1411 if (SvTYPE(sv) < SVt_PVAV)
1412 return PerlIO_find_layer(aTHX_ "scalar", 6, 1);
1415 * For other types allow if layer is known but don't try and load it
1417 switch (SvTYPE(sv)) {
1419 return PerlIO_find_layer(aTHX_ "Array", 5, 0);
1421 return PerlIO_find_layer(aTHX_ "Hash", 4, 0);
1423 return PerlIO_find_layer(aTHX_ "Code", 4, 0);
1425 return PerlIO_find_layer(aTHX_ "Glob", 4, 0);
1431 PerlIO_resolve_layers(pTHX_ const char *layers,
1432 const char *mode, int narg, SV **args)
1434 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1437 PerlIO_stdstreams(aTHX);
1441 * If it is a reference but not an object see if we have a handler
1444 if (SvROK(arg) && !sv_isobject(arg)) {
1445 PerlIO_funcs *handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1447 def = PerlIO_list_alloc(aTHX);
1448 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1452 * Don't fail if handler cannot be found :via(...) etc. may do
1453 * something sensible else we will just stringfy and open
1459 layers = PerlIO_context_layers(aTHX_ mode);
1460 if (layers && *layers) {
1464 av = PerlIO_list_alloc(aTHX);
1465 for (i = 0; i < def->cur; i++) {
1466 PerlIO_list_push(aTHX_ av, def->array[i].funcs,
1473 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1477 PerlIO_list_free(aTHX_ av);
1478 return (PerlIO_list_t *) NULL;
1489 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1490 int imode, int perm, PerlIO *f, int narg, SV **args)
1492 if (!f && narg == 1 && *args == &PL_sv_undef) {
1493 if ((f = PerlIO_tmpfile())) {
1495 layers = PerlIO_context_layers(aTHX_ mode);
1496 if (layers && *layers)
1497 PerlIO_apply_layers(aTHX_ f, mode, layers);
1501 PerlIO_list_t *layera;
1503 PerlIO_funcs *tab = NULL;
1504 if (PerlIOValid(f)) {
1506 * This is "reopen" - it is not tested as perl does not use it
1510 layera = PerlIO_list_alloc(aTHX);
1512 SV *arg = (l->tab->Getarg)
1513 ? (*l->tab->Getarg) (aTHX_ &l, NULL, 0)
1515 PerlIO_list_push(aTHX_ layera, l->tab, arg);
1516 l = *PerlIONext(&l);
1520 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1526 * Start at "top" of layer stack
1528 n = layera->cur - 1;
1530 PerlIO_funcs *t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1539 * Found that layer 'n' can do opens - call it
1541 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1542 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1544 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1545 tab->name, layers, mode, fd, imode, perm,
1546 (void*)f, narg, (void*)args);
1548 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1551 SETERRNO(EINVAL, LIB_INVARG);
1555 if (n + 1 < layera->cur) {
1557 * More layers above the one that we used to open -
1560 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1561 /* If pushing layers fails close the file */
1568 PerlIO_list_free(aTHX_ layera);
1575 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1577 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1581 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1583 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1587 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1589 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1593 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1595 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1599 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1601 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1605 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1609 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1611 if (tab && tab->Flush)
1612 return (*tab->Flush) (aTHX_ f);
1614 return 0; /* If no Flush defined, silently succeed. */
1617 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1618 SETERRNO(EBADF, SS_IVCHAN);
1624 * Is it good API design to do flush-all on NULL, a potentially
1625 * errorneous input? Maybe some magical value (PerlIO*
1626 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1627 * things on fflush(NULL), but should we be bound by their design
1630 PerlIO **table = &PL_perlio;
1632 while ((f = *table)) {
1634 table = (PerlIO **) (f++);
1635 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1636 if (*f && PerlIO_flush(f) != 0)
1646 PerlIOBase_flush_linebuf(pTHX)
1648 PerlIO **table = &PL_perlio;
1650 while ((f = *table)) {
1652 table = (PerlIO **) (f++);
1653 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1656 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1657 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1665 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1667 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1671 PerlIO_isutf8(PerlIO *f)
1674 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1676 SETERRNO(EBADF, SS_IVCHAN);
1682 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1684 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1688 Perl_PerlIO_error(pTHX_ PerlIO *f)
1690 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1694 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1696 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1700 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1702 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1706 PerlIO_has_base(PerlIO *f)
1708 if (PerlIOValid(f)) {
1709 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1712 return (tab->Get_base != NULL);
1713 SETERRNO(EINVAL, LIB_INVARG);
1716 SETERRNO(EBADF, SS_IVCHAN);
1722 PerlIO_fast_gets(PerlIO *f)
1724 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1725 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1728 return (tab->Set_ptrcnt != NULL);
1729 SETERRNO(EINVAL, LIB_INVARG);
1732 SETERRNO(EBADF, SS_IVCHAN);
1738 PerlIO_has_cntptr(PerlIO *f)
1740 if (PerlIOValid(f)) {
1741 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1744 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1745 SETERRNO(EINVAL, LIB_INVARG);
1748 SETERRNO(EBADF, SS_IVCHAN);
1754 PerlIO_canset_cnt(PerlIO *f)
1756 if (PerlIOValid(f)) {
1757 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1760 return (tab->Set_ptrcnt != NULL);
1761 SETERRNO(EINVAL, LIB_INVARG);
1764 SETERRNO(EBADF, SS_IVCHAN);
1770 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1772 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1776 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1778 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1782 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1784 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1788 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1790 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1794 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1796 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1800 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1802 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1806 /*--------------------------------------------------------------------------------------*/
1808 * utf8 and raw dummy layers
1812 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1816 if (PerlIOValid(f)) {
1817 if (tab->kind & PERLIO_K_UTF8)
1818 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1820 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1826 PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1827 sizeof(PerlIO_funcs),
1830 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1850 NULL, /* get_base */
1851 NULL, /* get_bufsiz */
1854 NULL, /* set_ptrcnt */
1857 PERLIO_FUNCS_DECL(PerlIO_byte) = {
1858 sizeof(PerlIO_funcs),
1881 NULL, /* get_base */
1882 NULL, /* get_bufsiz */
1885 NULL, /* set_ptrcnt */
1889 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1890 IV n, const char *mode, int fd, int imode, int perm,
1891 PerlIO *old, int narg, SV **args)
1893 PerlIO_funcs *tab = PerlIO_default_btm();
1895 if (tab && tab->Open)
1896 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1898 SETERRNO(EINVAL, LIB_INVARG);
1902 PERLIO_FUNCS_DECL(PerlIO_raw) = {
1903 sizeof(PerlIO_funcs),
1926 NULL, /* get_base */
1927 NULL, /* get_bufsiz */
1930 NULL, /* set_ptrcnt */
1932 /*--------------------------------------------------------------------------------------*/
1933 /*--------------------------------------------------------------------------------------*/
1935 * "Methods" of the "base class"
1939 PerlIOBase_fileno(pTHX_ PerlIO *f)
1941 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1945 PerlIO_modestr(PerlIO * f, char *buf)
1948 if (PerlIOValid(f)) {
1949 const IV flags = PerlIOBase(f)->flags;
1950 if (flags & PERLIO_F_APPEND) {
1952 if (flags & PERLIO_F_CANREAD) {
1956 else if (flags & PERLIO_F_CANREAD) {
1958 if (flags & PERLIO_F_CANWRITE)
1961 else if (flags & PERLIO_F_CANWRITE) {
1963 if (flags & PERLIO_F_CANREAD) {
1967 #ifdef PERLIO_USING_CRLF
1968 if (!(flags & PERLIO_F_CRLF))
1978 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1980 PerlIOl * const l = PerlIOBase(f);
1983 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
1984 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
1985 if (tab->Set_ptrcnt != NULL)
1986 l->flags |= PERLIO_F_FASTGETS;
1988 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
1992 l->flags |= PERLIO_F_CANREAD;
1995 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
1998 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
2001 SETERRNO(EINVAL, LIB_INVARG);
2007 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2010 l->flags &= ~PERLIO_F_CRLF;
2013 l->flags |= PERLIO_F_CRLF;
2016 SETERRNO(EINVAL, LIB_INVARG);
2023 l->flags |= l->next->flags &
2024 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2029 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2030 f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2031 l->flags, PerlIO_modestr(f, temp));
2037 PerlIOBase_popped(pTHX_ PerlIO *f)
2044 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2047 * Save the position as current head considers it
2049 const Off_t old = PerlIO_tell(f);
2050 PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", Nullsv);
2051 PerlIOSelf(f, PerlIOBuf)->posn = old;
2052 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
2056 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2058 STDCHAR *buf = (STDCHAR *) vbuf;
2060 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2061 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2062 SETERRNO(EBADF, SS_IVCHAN);
2066 SSize_t avail = PerlIO_get_cnt(f);
2069 take = ((SSize_t)count < avail) ? count : avail;
2071 STDCHAR *ptr = PerlIO_get_ptr(f);
2072 Copy(ptr, buf, take, STDCHAR);
2073 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2077 if (count > 0 && avail <= 0) {
2078 if (PerlIO_fill(f) != 0)
2082 return (buf - (STDCHAR *) vbuf);
2088 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2095 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2102 PerlIOBase_close(pTHX_ PerlIO *f)
2105 if (PerlIOValid(f)) {
2106 PerlIO *n = PerlIONext(f);
2107 code = PerlIO_flush(f);
2108 PerlIOBase(f)->flags &=
2109 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2110 while (PerlIOValid(n)) {
2111 const PerlIO_funcs * const tab = PerlIOBase(n)->tab;
2112 if (tab && tab->Close) {
2113 if ((*tab->Close)(aTHX_ n) != 0)
2118 PerlIOBase(n)->flags &=
2119 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2125 SETERRNO(EBADF, SS_IVCHAN);
2131 PerlIOBase_eof(pTHX_ PerlIO *f)
2133 if (PerlIOValid(f)) {
2134 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2140 PerlIOBase_error(pTHX_ PerlIO *f)
2142 if (PerlIOValid(f)) {
2143 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2149 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2151 if (PerlIOValid(f)) {
2152 PerlIO *n = PerlIONext(f);
2153 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2160 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2162 if (PerlIOValid(f)) {
2163 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2168 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2174 return sv_dup(arg, param);
2177 return newSVsv(arg);
2180 return newSVsv(arg);
2185 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2187 PerlIO *nexto = PerlIONext(o);
2188 if (PerlIOValid(nexto)) {
2189 const PerlIO_funcs * const tab = PerlIOBase(nexto)->tab;
2190 if (tab && tab->Dup)
2191 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2193 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2196 PerlIO_funcs *self = PerlIOBase(o)->tab;
2199 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2200 self->name, (void*)f, (void*)o, (void*)param);
2202 arg = (*self->Getarg)(aTHX_ o, param, flags);
2206 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2215 perl_mutex PerlIO_mutex;
2218 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2223 /* Place holder for stdstreams call ??? */
2225 MUTEX_INIT(&PerlIO_mutex);
2230 PerlIOUnix_refcnt_inc(int fd)
2233 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2235 MUTEX_LOCK(&PerlIO_mutex);
2237 PL_perlio_fd_refcnt[fd]++;
2238 PerlIO_debug("fd %d refcnt=%d\n",fd,PL_perlio_fd_refcnt[fd]);
2240 MUTEX_UNLOCK(&PerlIO_mutex);
2246 PerlIOUnix_refcnt_dec(int fd)
2250 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2252 MUTEX_LOCK(&PerlIO_mutex);
2254 cnt = --PL_perlio_fd_refcnt[fd];
2255 PerlIO_debug("fd %d refcnt=%d\n",fd,cnt);
2257 MUTEX_UNLOCK(&PerlIO_mutex);
2264 PerlIO_cleanup(pTHX)
2268 PerlIO_debug("Cleanup layers for %p\n",aTHX);
2270 PerlIO_debug("Cleanup layers\n");
2272 /* Raise STDIN..STDERR refcount so we don't close them */
2273 for (i=0; i < 3; i++)
2274 PerlIOUnix_refcnt_inc(i);
2275 PerlIO_cleantable(aTHX_ &PL_perlio);
2276 /* Restore STDIN..STDERR refcount */
2277 for (i=0; i < 3; i++)
2278 PerlIOUnix_refcnt_dec(i);
2280 if (PL_known_layers) {
2281 PerlIO_list_free(aTHX_ PL_known_layers);
2282 PL_known_layers = NULL;
2284 if (PL_def_layerlist) {
2285 PerlIO_list_free(aTHX_ PL_def_layerlist);
2286 PL_def_layerlist = NULL;
2292 /*--------------------------------------------------------------------------------------*/
2294 * Bottom-most level for UNIX-like case
2298 struct _PerlIO base; /* The generic part */
2299 int fd; /* UNIX like file descriptor */
2300 int oflags; /* open/fcntl flags */
2304 PerlIOUnix_oflags(const char *mode)
2307 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2312 if (*++mode == '+') {
2319 oflags = O_CREAT | O_TRUNC;
2320 if (*++mode == '+') {
2329 oflags = O_CREAT | O_APPEND;
2330 if (*++mode == '+') {
2343 else if (*mode == 't') {
2345 oflags &= ~O_BINARY;
2349 * Always open in binary mode
2352 if (*mode || oflags == -1) {
2353 SETERRNO(EINVAL, LIB_INVARG);
2360 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2362 return PerlIOSelf(f, PerlIOUnix)->fd;
2366 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2368 PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2371 if (PerlLIO_fstat(fd, &st) == 0) {
2372 if (!S_ISREG(st.st_mode)) {
2373 PerlIO_debug("%d is not regular file\n",fd);
2374 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2377 PerlIO_debug("%d _is_ a regular file\n",fd);
2383 PerlIOUnix_refcnt_inc(fd);
2387 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2389 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2390 if (*PerlIONext(f)) {
2391 /* We never call down so do any pending stuff now */
2392 PerlIO_flush(PerlIONext(f));
2394 * XXX could (or should) we retrieve the oflags from the open file
2395 * handle rather than believing the "mode" we are passed in? XXX
2396 * Should the value on NULL mode be 0 or -1?
2398 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2399 mode ? PerlIOUnix_oflags(mode) : -1);
2401 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2407 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2409 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2411 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2413 SETERRNO(ESPIPE, LIB_INVARG);
2415 SETERRNO(EINVAL, LIB_INVARG);
2419 new_loc = PerlLIO_lseek(fd, offset, whence);
2420 if (new_loc == (Off_t) - 1)
2424 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2429 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2430 IV n, const char *mode, int fd, int imode,
2431 int perm, PerlIO *f, int narg, SV **args)
2433 if (PerlIOValid(f)) {
2434 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2435 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2438 if (*mode == IoTYPE_NUMERIC)
2441 imode = PerlIOUnix_oflags(mode);
2445 const char *path = SvPV_nolen(*args);
2446 fd = PerlLIO_open3(path, imode, perm);
2450 if (*mode == IoTYPE_IMPLICIT)
2453 f = PerlIO_allocate(aTHX);
2455 if (!PerlIOValid(f)) {
2456 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2460 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2461 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2462 if (*mode == IoTYPE_APPEND)
2463 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2469 * FIXME: pop layers ???
2477 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2479 PerlIOUnix *os = PerlIOSelf(o, PerlIOUnix);
2481 if (flags & PERLIO_DUP_FD) {
2482 fd = PerlLIO_dup(fd);
2484 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2485 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2487 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2488 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2497 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2499 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2500 #ifdef PERLIO_STD_SPECIAL
2502 return PERLIO_STD_IN(fd, vbuf, count);
2504 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2505 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2509 SSize_t len = PerlLIO_read(fd, vbuf, count);
2510 if (len >= 0 || errno != EINTR) {
2512 if (errno != EAGAIN) {
2513 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2516 else if (len == 0 && count != 0) {
2517 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2527 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2529 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2530 #ifdef PERLIO_STD_SPECIAL
2531 if (fd == 1 || fd == 2)
2532 return PERLIO_STD_OUT(fd, vbuf, count);
2535 const SSize_t len = PerlLIO_write(fd, vbuf, count);
2536 if (len >= 0 || errno != EINTR) {
2538 if (errno != EAGAIN) {
2539 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2549 PerlIOUnix_tell(pTHX_ PerlIO *f)
2551 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2556 PerlIOUnix_close(pTHX_ PerlIO *f)
2558 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2560 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2561 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2562 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2567 SETERRNO(EBADF,SS_IVCHAN);
2570 while (PerlLIO_close(fd) != 0) {
2571 if (errno != EINTR) {
2578 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2583 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2584 sizeof(PerlIO_funcs),
2591 PerlIOBase_binmode, /* binmode */
2601 PerlIOBase_noop_ok, /* flush */
2602 PerlIOBase_noop_fail, /* fill */
2605 PerlIOBase_clearerr,
2606 PerlIOBase_setlinebuf,
2607 NULL, /* get_base */
2608 NULL, /* get_bufsiz */
2611 NULL, /* set_ptrcnt */
2614 /*--------------------------------------------------------------------------------------*/
2619 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2620 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2621 broken by the last second glibc 2.3 fix
2623 #define STDIO_BUFFER_WRITABLE
2628 struct _PerlIO base;
2629 FILE *stdio; /* The stream */
2633 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2636 if (PerlIOValid(f) && (s = PerlIOSelf(f, PerlIOStdio)->stdio)) {
2637 return PerlSIO_fileno(s);
2644 PerlIOStdio_mode(const char *mode, char *tmode)
2646 char * const ret = tmode;
2652 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2660 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2663 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2664 PerlIO_funcs *toptab = PerlIOBase(n)->tab;
2665 if (toptab == tab) {
2666 /* Top is already stdio - pop self (duplicate) and use original */
2667 PerlIO_pop(aTHX_ f);
2670 const int fd = PerlIO_fileno(n);
2673 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2674 mode = PerlIOStdio_mode(mode, tmode)))) {
2675 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2676 /* We never call down so do any pending stuff now */
2677 PerlIO_flush(PerlIONext(f));
2684 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2689 PerlIO_importFILE(FILE *stdio, const char *mode)
2695 if (!mode || !*mode) {
2696 /* We need to probe to see how we can open the stream
2697 so start with read/write and then try write and read
2698 we dup() so that we can fclose without loosing the fd.
2700 Note that the errno value set by a failing fdopen
2701 varies between stdio implementations.
2703 const int fd = PerlLIO_dup(fileno(stdio));
2704 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2706 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2709 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2712 /* Don't seem to be able to open */
2718 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, Nullsv))) {
2719 s = PerlIOSelf(f, PerlIOStdio);
2727 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2728 IV n, const char *mode, int fd, int imode,
2729 int perm, PerlIO *f, int narg, SV **args)
2732 if (PerlIOValid(f)) {
2733 const char *path = SvPV_nolen(*args);
2734 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2736 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2737 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2742 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2747 const char *path = SvPV_nolen(*args);
2748 if (*mode == IoTYPE_NUMERIC) {
2750 fd = PerlLIO_open3(path, imode, perm);
2754 bool appended = FALSE;
2756 /* Cygwin wants its 'b' early. */
2758 mode = PerlIOStdio_mode(mode, tmode);
2760 stdio = PerlSIO_fopen(path, mode);
2764 f = PerlIO_allocate(aTHX);
2767 mode = PerlIOStdio_mode(mode, tmode);
2768 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2770 s = PerlIOSelf(f, PerlIOStdio);
2772 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2784 if (*mode == IoTYPE_IMPLICIT) {
2791 stdio = PerlSIO_stdin;
2794 stdio = PerlSIO_stdout;
2797 stdio = PerlSIO_stderr;
2802 stdio = PerlSIO_fdopen(fd, mode =
2803 PerlIOStdio_mode(mode, tmode));
2807 f = PerlIO_allocate(aTHX);
2809 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2810 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2812 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2822 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2824 /* This assumes no layers underneath - which is what
2825 happens, but is not how I remember it. NI-S 2001/10/16
2827 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2828 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2829 const int fd = fileno(stdio);
2831 if (flags & PERLIO_DUP_FD) {
2832 const int dfd = PerlLIO_dup(fileno(stdio));
2834 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2838 /* FIXME: To avoid messy error recovery if dup fails
2839 re-use the existing stdio as though flag was not set
2843 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2845 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2846 PerlIOUnix_refcnt_inc(fileno(stdio));
2852 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
2854 /* XXX this could use PerlIO_canset_fileno() and
2855 * PerlIO_set_fileno() support from Configure
2857 # if defined(__UCLIBC__)
2858 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
2861 # elif defined(__GLIBC__)
2862 /* There may be a better way for GLIBC:
2863 - libio.h defines a flag to not close() on cleanup
2867 # elif defined(__sun__)
2869 /* On solaris, if _LP64 is defined, the FILE structure is this:
2875 * It turns out that the fd is stored in the top 32 bits of
2876 * file->__pad[4]. The lower 32 bits contain flags. file->pad[5] appears
2877 * to contain a pointer or offset into another structure. All the
2878 * remaining fields are zero.
2880 * We set the top bits to -1 (0xFFFFFFFF).
2882 f->__pad[4] |= 0xffffffff00000000L;
2883 assert(fileno(f) == 0xffffffff);
2884 # else /* !defined(_LP64) */
2885 /* _file is just a unsigned char :-(
2886 Not clear why we dup() rather than using -1
2887 even if that would be treated as 0xFF - so will
2890 f->_file = PerlLIO_dup(fileno(f));
2891 # endif /* defined(_LP64) */
2893 # elif defined(__hpux)
2897 /* Next one ->_file seems to be a reasonable fallback, i.e. if
2898 your platform does not have special entry try this one.
2899 [For OSF only have confirmation for Tru64 (alpha)
2900 but assume other OSFs will be similar.]
2902 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
2905 # elif defined(__FreeBSD__)
2906 /* There may be a better way on FreeBSD:
2907 - we could insert a dummy func in the _close function entry
2908 f->_close = (int (*)(void *)) dummy_close;
2912 # elif defined(__OpenBSD__)
2913 /* There may be a better way on OpenBSD:
2914 - we could insert a dummy func in the _close function entry
2915 f->_close = (int (*)(void *)) dummy_close;
2919 # elif defined(__EMX__)
2920 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
2923 # elif defined(__CYGWIN__)
2924 /* There may be a better way on CYGWIN:
2925 - we could insert a dummy func in the _close function entry
2926 f->_close = (int (*)(void *)) dummy_close;
2930 # elif defined(WIN32)
2931 # if defined(__BORLANDC__)
2932 f->fd = PerlLIO_dup(fileno(f));
2933 # elif defined(UNDER_CE)
2934 /* WIN_CE does not have access to FILE internals, it hardly has FILE
2943 /* Sarathy's code did this - we fall back to a dup/dup2 hack
2944 (which isn't thread safe) instead
2946 # error "Don't know how to set FILE.fileno on your platform"
2953 PerlIOStdio_close(pTHX_ PerlIO *f)
2955 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
2961 const int fd = fileno(stdio);
2967 #ifdef SOCKS5_VERSION_NAME
2968 /* Socks lib overrides close() but stdio isn't linked to
2969 that library (though we are) - so we must call close()
2970 on sockets on stdio's behalf.
2973 Sock_size_t optlen = sizeof(int);
2974 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0) {
2979 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2980 /* File descriptor still in use */
2985 /* For STD* handles don't close the stdio at all
2986 this is because we have shared the FILE * too
2988 if (stdio == stdin) {
2989 /* Some stdios are buggy fflush-ing inputs */
2992 else if (stdio == stdout || stdio == stderr) {
2993 return PerlIO_flush(f);
2995 /* Tricky - must fclose(stdio) to free memory but not close(fd)
2996 Use Sarathy's trick from maint-5.6 to invalidate the
2997 fileno slot of the FILE *
2999 result = PerlIO_flush(f);
3001 if (!(invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio))) {
3002 dupfd = PerlLIO_dup(fd);
3005 result = PerlSIO_fclose(stdio);
3006 /* We treat error from stdio as success if we invalidated
3007 errno may NOT be expected EBADF
3009 if (invalidate && result != 0) {
3014 /* in SOCKS case let close() determine return value */
3018 PerlLIO_dup2(dupfd,fd);
3019 PerlLIO_close(dupfd);
3026 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3028 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3032 STDCHAR *buf = (STDCHAR *) vbuf;
3034 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3035 * stdio does not do that for fread()
3037 const int ch = PerlSIO_fgetc(s);
3044 got = PerlSIO_fread(vbuf, 1, count, s);
3045 if (got == 0 && PerlSIO_ferror(s))
3047 if (got >= 0 || errno != EINTR)
3050 SETERRNO(0,0); /* just in case */
3056 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3059 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3061 #ifdef STDIO_BUFFER_WRITABLE
3062 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3063 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3064 STDCHAR *base = PerlIO_get_base(f);
3065 SSize_t cnt = PerlIO_get_cnt(f);
3066 STDCHAR *ptr = PerlIO_get_ptr(f);
3067 SSize_t avail = ptr - base;
3069 if (avail > count) {
3073 Move(buf-avail,ptr,avail,STDCHAR);
3076 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3077 if (PerlSIO_feof(s) && unread >= 0)
3078 PerlSIO_clearerr(s);
3083 if (PerlIO_has_cntptr(f)) {
3084 /* We can get pointer to buffer but not its base
3085 Do ungetc() but check chars are ending up in the
3088 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3089 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3091 const int ch = *--buf & 0xFF;
3092 if (ungetc(ch,s) != ch) {
3093 /* ungetc did not work */
3096 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3097 /* Did not change pointer as expected */
3098 fgetc(s); /* get char back again */
3108 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3114 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3118 got = PerlSIO_fwrite(vbuf, 1, count,
3119 PerlIOSelf(f, PerlIOStdio)->stdio);
3120 if (got >= 0 || errno != EINTR)
3123 SETERRNO(0,0); /* just in case */
3129 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3131 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3132 return PerlSIO_fseek(stdio, offset, whence);
3136 PerlIOStdio_tell(pTHX_ PerlIO *f)
3138 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3139 return PerlSIO_ftell(stdio);
3143 PerlIOStdio_flush(pTHX_ PerlIO *f)
3145 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3146 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3147 return PerlSIO_fflush(stdio);
3152 * FIXME: This discards ungetc() and pre-read stuff which is not
3153 * right if this is just a "sync" from a layer above Suspect right
3154 * design is to do _this_ but not have layer above flush this
3155 * layer read-to-read
3158 * Not writeable - sync by attempting a seek
3161 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3169 PerlIOStdio_eof(pTHX_ PerlIO *f)
3171 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3175 PerlIOStdio_error(pTHX_ PerlIO *f)
3177 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3181 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3183 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3187 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3189 #ifdef HAS_SETLINEBUF
3190 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3192 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, Nullch, _IOLBF, 0);
3198 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3200 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3201 return (STDCHAR*)PerlSIO_get_base(stdio);
3205 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3207 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3208 return PerlSIO_get_bufsiz(stdio);
3212 #ifdef USE_STDIO_PTR
3214 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3216 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3217 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3221 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3223 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3224 return PerlSIO_get_cnt(stdio);
3228 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3230 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3232 #ifdef STDIO_PTR_LVALUE
3233 PerlSIO_set_ptr(stdio, (void*)ptr); /* LHS STDCHAR* cast non-portable */
3234 #ifdef STDIO_PTR_LVAL_SETS_CNT
3235 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3236 assert(PerlSIO_get_cnt(stdio) == (cnt));
3239 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3241 * Setting ptr _does_ change cnt - we are done
3245 #else /* STDIO_PTR_LVALUE */
3247 #endif /* STDIO_PTR_LVALUE */
3250 * Now (or only) set cnt
3252 #ifdef STDIO_CNT_LVALUE
3253 PerlSIO_set_cnt(stdio, cnt);
3254 #else /* STDIO_CNT_LVALUE */
3255 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3256 PerlSIO_set_ptr(stdio,
3257 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3259 #else /* STDIO_PTR_LVAL_SETS_CNT */
3261 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3262 #endif /* STDIO_CNT_LVALUE */
3269 PerlIOStdio_fill(pTHX_ PerlIO *f)
3271 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3274 * fflush()ing read-only streams can cause trouble on some stdio-s
3276 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3277 if (PerlSIO_fflush(stdio) != 0)
3280 c = PerlSIO_fgetc(stdio);
3284 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3286 #ifdef STDIO_BUFFER_WRITABLE
3287 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3288 /* Fake ungetc() to the real buffer in case system's ungetc
3291 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3292 SSize_t cnt = PerlSIO_get_cnt(stdio);
3293 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3294 if (ptr == base+1) {
3295 *--ptr = (STDCHAR) c;
3296 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3297 if (PerlSIO_feof(stdio))
3298 PerlSIO_clearerr(stdio);
3304 if (PerlIO_has_cntptr(f)) {
3306 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3313 /* An ungetc()d char is handled separately from the regular
3314 * buffer, so we stuff it in the buffer ourselves.
3315 * Should never get called as should hit code above
3317 *(--((*stdio)->_ptr)) = (unsigned char) c;
3320 /* If buffer snoop scheme above fails fall back to
3323 if (PerlSIO_ungetc(c, stdio) != c)
3331 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3332 sizeof(PerlIO_funcs),
3334 sizeof(PerlIOStdio),
3335 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3339 PerlIOBase_binmode, /* binmode */
3353 PerlIOStdio_clearerr,
3354 PerlIOStdio_setlinebuf,
3356 PerlIOStdio_get_base,
3357 PerlIOStdio_get_bufsiz,
3362 #ifdef USE_STDIO_PTR
3363 PerlIOStdio_get_ptr,
3364 PerlIOStdio_get_cnt,
3365 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3366 PerlIOStdio_set_ptrcnt,
3369 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3374 #endif /* USE_STDIO_PTR */
3377 /* Note that calls to PerlIO_exportFILE() are reversed using
3378 * PerlIO_releaseFILE(), not importFILE. */
3380 PerlIO_exportFILE(PerlIO * f, const char *mode)
3384 if (PerlIOValid(f)) {
3387 if (!mode || !*mode) {
3388 mode = PerlIO_modestr(f, buf);
3390 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3394 /* De-link any lower layers so new :stdio sticks */
3396 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, Nullsv))) {
3397 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3399 /* Link previous lower layers under new one */
3403 /* restore layers list */
3413 PerlIO_findFILE(PerlIO *f)
3417 if (l->tab == &PerlIO_stdio) {
3418 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3421 l = *PerlIONext(&l);
3423 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3424 return PerlIO_exportFILE(f, Nullch);
3427 /* Use this to reverse PerlIO_exportFILE calls. */
3429 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3434 if (l->tab == &PerlIO_stdio) {
3435 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3436 if (s->stdio == f) {
3438 PerlIO_pop(aTHX_ p);
3447 /*--------------------------------------------------------------------------------------*/
3449 * perlio buffer layer
3453 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3455 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3456 const int fd = PerlIO_fileno(f);
3457 if (fd >= 0 && PerlLIO_isatty(fd)) {
3458 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3460 if (*PerlIONext(f)) {
3461 const Off_t posn = PerlIO_tell(PerlIONext(f));
3462 if (posn != (Off_t) - 1) {
3466 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3470 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3471 IV n, const char *mode, int fd, int imode, int perm,
3472 PerlIO *f, int narg, SV **args)
3474 if (PerlIOValid(f)) {
3475 PerlIO *next = PerlIONext(f);
3477 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3478 if (tab && tab->Open)
3480 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3482 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3487 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3489 if (*mode == IoTYPE_IMPLICIT) {
3495 if (tab && tab->Open)
3496 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3499 SETERRNO(EINVAL, LIB_INVARG);
3501 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3503 * if push fails during open, open fails. close will pop us.
3508 fd = PerlIO_fileno(f);
3509 if (init && fd == 2) {
3511 * Initial stderr is unbuffered
3513 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3515 #ifdef PERLIO_USING_CRLF
3516 # ifdef PERLIO_IS_BINMODE_FD
3517 if (PERLIO_IS_BINMODE_FD(fd))
3518 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, Nullch);
3522 * do something about failing setmode()? --jhi
3524 PerlLIO_setmode(fd, O_BINARY);
3533 * This "flush" is akin to sfio's sync in that it handles files in either
3534 * read or write state
3537 PerlIOBuf_flush(pTHX_ PerlIO *f)
3539 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3541 PerlIO *n = PerlIONext(f);
3542 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3544 * write() the buffer
3546 const STDCHAR *buf = b->buf;
3547 const STDCHAR *p = buf;
3548 while (p < b->ptr) {
3549 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3553 else if (count < 0 || PerlIO_error(n)) {
3554 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3559 b->posn += (p - buf);
3561 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3562 STDCHAR *buf = PerlIO_get_base(f);
3564 * Note position change
3566 b->posn += (b->ptr - buf);
3567 if (b->ptr < b->end) {
3568 /* We did not consume all of it - try and seek downstream to
3569 our logical position
3571 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3572 /* Reload n as some layers may pop themselves on seek */
3573 b->posn = PerlIO_tell(n = PerlIONext(f));
3576 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3577 data is lost for good - so return saying "ok" having undone
3580 b->posn -= (b->ptr - buf);
3585 b->ptr = b->end = b->buf;
3586 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3587 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3588 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3594 PerlIOBuf_fill(pTHX_ PerlIO *f)
3596 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3597 PerlIO *n = PerlIONext(f);
3600 * Down-stream flush is defined not to loose read data so is harmless.
3601 * we would not normally be fill'ing if there was data left in anycase.
3603 if (PerlIO_flush(f) != 0)
3605 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3606 PerlIOBase_flush_linebuf(aTHX);
3609 PerlIO_get_base(f); /* allocate via vtable */
3611 b->ptr = b->end = b->buf;
3613 if (!PerlIOValid(n)) {
3614 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3618 if (PerlIO_fast_gets(n)) {
3620 * Layer below is also buffered. We do _NOT_ want to call its
3621 * ->Read() because that will loop till it gets what we asked for
3622 * which may hang on a pipe etc. Instead take anything it has to
3623 * hand, or ask it to fill _once_.
3625 avail = PerlIO_get_cnt(n);
3627 avail = PerlIO_fill(n);
3629 avail = PerlIO_get_cnt(n);
3631 if (!PerlIO_error(n) && PerlIO_eof(n))
3636 STDCHAR *ptr = PerlIO_get_ptr(n);
3637 SSize_t cnt = avail;
3638 if (avail > (SSize_t)b->bufsiz)
3640 Copy(ptr, b->buf, avail, STDCHAR);
3641 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3645 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3649 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3651 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3654 b->end = b->buf + avail;
3655 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3660 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3662 if (PerlIOValid(f)) {
3663 const PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3666 return PerlIOBase_read(aTHX_ f, vbuf, count);
3672 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3674 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3675 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3678 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3683 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3685 * Buffer is already a read buffer, we can overwrite any chars
3686 * which have been read back to buffer start
3688 avail = (b->ptr - b->buf);
3692 * Buffer is idle, set it up so whole buffer is available for
3696 b->end = b->buf + avail;
3698 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3700 * Buffer extends _back_ from where we are now
3702 b->posn -= b->bufsiz;
3704 if (avail > (SSize_t) count) {
3706 * If we have space for more than count, just move count
3714 * In simple stdio-like ungetc() case chars will be already
3717 if (buf != b->ptr) {
3718 Copy(buf, b->ptr, avail, STDCHAR);
3722 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3726 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3732 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3734 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3735 const STDCHAR *buf = (const STDCHAR *) vbuf;
3736 const STDCHAR *flushptr = buf;
3740 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3742 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3743 if (PerlIO_flush(f) != 0) {
3747 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3748 flushptr = buf + count;
3749 while (flushptr > buf && *(flushptr - 1) != '\n')
3753 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3754 if ((SSize_t) count < avail)
3756 if (flushptr > buf && flushptr <= buf + avail)
3757 avail = flushptr - buf;
3758 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3760 Copy(buf, b->ptr, avail, STDCHAR);
3765 if (buf == flushptr)
3768 if (b->ptr >= (b->buf + b->bufsiz))
3771 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3777 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3780 if ((code = PerlIO_flush(f)) == 0) {
3781 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3782 code = PerlIO_seek(PerlIONext(f), offset, whence);
3784 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3785 b->posn = PerlIO_tell(PerlIONext(f));
3792 PerlIOBuf_tell(pTHX_ PerlIO *f)
3794 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3796 * b->posn is file position where b->buf was read, or will be written
3798 Off_t posn = b->posn;
3799 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3800 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3802 /* As O_APPEND files are normally shared in some sense it is better
3807 /* when file is NOT shared then this is sufficient */
3808 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3810 posn = b->posn = PerlIO_tell(PerlIONext(f));
3814 * If buffer is valid adjust position by amount in buffer
3816 posn += (b->ptr - b->buf);
3822 PerlIOBuf_popped(pTHX_ PerlIO *f)
3824 const IV code = PerlIOBase_popped(aTHX_ f);
3825 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3826 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3830 b->ptr = b->end = b->buf;
3831 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3836 PerlIOBuf_close(pTHX_ PerlIO *f)
3838 const IV code = PerlIOBase_close(aTHX_ f);
3839 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3840 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3844 b->ptr = b->end = b->buf;
3845 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3850 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
3852 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3859 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
3861 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3864 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
3865 return (b->end - b->ptr);
3870 PerlIOBuf_get_base(pTHX_ PerlIO *f)
3872 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3876 b->buf = Newz('B',b->buf,b->bufsiz, STDCHAR);
3878 b->buf = (STDCHAR *) & b->oneword;
3879 b->bufsiz = sizeof(b->oneword);
3888 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
3890 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3893 return (b->end - b->buf);
3897 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3899 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3903 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
3904 assert(PerlIO_get_cnt(f) == cnt);
3905 assert(b->ptr >= b->buf);
3907 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3911 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3913 return PerlIOBase_dup(aTHX_ f, o, param, flags);
3918 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
3919 sizeof(PerlIO_funcs),
3922 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3926 PerlIOBase_binmode, /* binmode */
3940 PerlIOBase_clearerr,
3941 PerlIOBase_setlinebuf,
3946 PerlIOBuf_set_ptrcnt,
3949 /*--------------------------------------------------------------------------------------*/
3951 * Temp layer to hold unread chars when cannot do it any other way
3955 PerlIOPending_fill(pTHX_ PerlIO *f)
3958 * Should never happen
3965 PerlIOPending_close(pTHX_ PerlIO *f)
3968 * A tad tricky - flush pops us, then we close new top
3971 return PerlIO_close(f);
3975 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3978 * A tad tricky - flush pops us, then we seek new top
3981 return PerlIO_seek(f, offset, whence);
3986 PerlIOPending_flush(pTHX_ PerlIO *f)
3988 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3989 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3993 PerlIO_pop(aTHX_ f);
3998 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4004 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4009 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4011 const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4012 PerlIOl *l = PerlIOBase(f);
4014 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4015 * etc. get muddled when it changes mid-string when we auto-pop.
4017 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4018 (PerlIOBase(PerlIONext(f))->
4019 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4024 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4026 SSize_t avail = PerlIO_get_cnt(f);
4028 if ((SSize_t)count < avail)
4031 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4032 if (got >= 0 && got < (SSize_t)count) {
4033 const SSize_t more =
4034 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4035 if (more >= 0 || got == 0)
4041 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4042 sizeof(PerlIO_funcs),
4045 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4046 PerlIOPending_pushed,
4049 PerlIOBase_binmode, /* binmode */
4058 PerlIOPending_close,
4059 PerlIOPending_flush,
4063 PerlIOBase_clearerr,
4064 PerlIOBase_setlinebuf,
4069 PerlIOPending_set_ptrcnt,
4074 /*--------------------------------------------------------------------------------------*/
4076 * crlf - translation On read translate CR,LF to "\n" we do this by
4077 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4078 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4082 PerlIOBuf base; /* PerlIOBuf stuff */
4083 STDCHAR *nl; /* Position of crlf we "lied" about in the
4088 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4091 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4092 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4094 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4095 f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4096 PerlIOBase(f)->flags);
4099 /* Enable the first CRLF capable layer you can find, but if none
4100 * found, the one we just pushed is fine. This results in at
4101 * any given moment at most one CRLF-capable layer being enabled
4102 * in the whole layer stack. */
4103 PerlIO *g = PerlIONext(f);
4105 PerlIOl *b = PerlIOBase(g);
4106 if (b && b->tab == &PerlIO_crlf) {
4107 if (!(b->flags & PERLIO_F_CRLF))
4108 b->flags |= PERLIO_F_CRLF;
4109 PerlIO_pop(aTHX_ f);
4120 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4122 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4127 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4128 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4130 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4131 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4133 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4138 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4139 b->end = b->ptr = b->buf + b->bufsiz;
4140 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4141 b->posn -= b->bufsiz;
4143 while (count > 0 && b->ptr > b->buf) {
4146 if (b->ptr - 2 >= b->buf) {
4169 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4171 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4174 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4175 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4176 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4177 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4179 while (nl < b->end && *nl != 0xd)
4181 if (nl < b->end && *nl == 0xd) {
4183 if (nl + 1 < b->end) {
4190 * Not CR,LF but just CR
4198 * Blast - found CR as last char in buffer
4203 * They may not care, defer work as long as
4207 return (nl - b->ptr);
4211 b->ptr++; /* say we have read it as far as
4212 * flush() is concerned */
4213 b->buf++; /* Leave space in front of buffer */
4214 /* Note as we have moved buf up flush's
4216 will naturally make posn point at CR
4218 b->bufsiz--; /* Buffer is thus smaller */
4219 code = PerlIO_fill(f); /* Fetch some more */
4220 b->bufsiz++; /* Restore size for next time */
4221 b->buf--; /* Point at space */
4222 b->ptr = nl = b->buf; /* Which is what we hand
4224 *nl = 0xd; /* Fill in the CR */
4226 goto test; /* fill() call worked */
4228 * CR at EOF - just fall through
4230 /* Should we clear EOF though ??? */
4235 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4241 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4243 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4244 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4250 if (ptr == b->end && *c->nl == 0xd) {
4251 /* Defered CR at end of buffer case - we lied about count */
4263 * Test code - delete when it works ...
4265 IV flags = PerlIOBase(f)->flags;
4266 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4267 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4268 /* Defered CR at end of buffer case - we lied about count */
4274 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4275 " nl=%p e=%p for %d", ptr, chk, flags, c->nl,
4283 * They have taken what we lied about
4291 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4295 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4297 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4298 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4300 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4301 const STDCHAR *buf = (const STDCHAR *) vbuf;
4302 const STDCHAR *ebuf = buf + count;
4305 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4307 while (buf < ebuf) {
4308 STDCHAR *eptr = b->buf + b->bufsiz;
4309 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4310 while (buf < ebuf && b->ptr < eptr) {
4312 if ((b->ptr + 2) > eptr) {
4320 *(b->ptr)++ = 0xd; /* CR */
4321 *(b->ptr)++ = 0xa; /* LF */
4323 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4333 if (b->ptr >= eptr) {
4339 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4341 return (buf - (STDCHAR *) vbuf);
4346 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4348 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4353 return PerlIOBuf_flush(aTHX_ f);
4357 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4359 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4360 /* In text mode - flush any pending stuff and flip it */
4361 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4362 #ifndef PERLIO_USING_CRLF
4363 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4364 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4365 PerlIO_pop(aTHX_ f);
4372 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4373 sizeof(PerlIO_funcs),
4376 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4378 PerlIOBuf_popped, /* popped */
4380 PerlIOCrlf_binmode, /* binmode */
4384 PerlIOBuf_read, /* generic read works with ptr/cnt lies */
4385 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4386 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4394 PerlIOBase_clearerr,
4395 PerlIOBase_setlinebuf,
4400 PerlIOCrlf_set_ptrcnt,
4404 /*--------------------------------------------------------------------------------------*/
4406 * mmap as "buffer" layer
4410 PerlIOBuf base; /* PerlIOBuf stuff */
4411 Mmap_t mptr; /* Mapped address */
4412 Size_t len; /* mapped length */
4413 STDCHAR *bbuf; /* malloced buffer if map fails */
4417 PerlIOMmap_map(pTHX_ PerlIO *f)
4420 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4421 const IV flags = PerlIOBase(f)->flags;
4425 if (flags & PERLIO_F_CANREAD) {
4426 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4427 const int fd = PerlIO_fileno(f);
4429 code = Fstat(fd, &st);
4430 if (code == 0 && S_ISREG(st.st_mode)) {
4431 SSize_t len = st.st_size - b->posn;
4434 if (PL_mmap_page_size <= 0)
4435 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4439 * This is a hack - should never happen - open should
4442 b->posn = PerlIO_tell(PerlIONext(f));
4444 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4445 len = st.st_size - posn;
4446 m->mptr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4447 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4448 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4449 madvise(m->mptr, len, MADV_SEQUENTIAL);
4451 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4452 madvise(m->mptr, len, MADV_WILLNEED);
4454 PerlIOBase(f)->flags =
4455 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4456 b->end = ((STDCHAR *) m->mptr) + len;
4457 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4466 PerlIOBase(f)->flags =
4467 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4469 b->ptr = b->end = b->ptr;
4478 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4480 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4481 PerlIOBuf *b = &m->base;
4485 code = munmap(m->mptr, m->len);
4489 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4492 b->ptr = b->end = b->buf;
4493 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4499 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4501 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4502 PerlIOBuf *b = &m->base;
4503 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4505 * Already have a readbuffer in progress
4511 * We have a write buffer or flushed PerlIOBuf read buffer
4513 m->bbuf = b->buf; /* save it in case we need it again */
4514 b->buf = NULL; /* Clear to trigger below */
4517 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4520 * Map did not work - recover PerlIOBuf buffer if we have one
4525 b->ptr = b->end = b->buf;
4528 return PerlIOBuf_get_base(aTHX_ f);
4532 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4534 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4535 PerlIOBuf *b = &m->base;
4536 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4538 if (b->ptr && (b->ptr - count) >= b->buf
4539 && memEQ(b->ptr - count, vbuf, count)) {
4541 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4546 * Loose the unwritable mapped buffer
4550 * If flush took the "buffer" see if we have one from before
4552 if (!b->buf && m->bbuf)
4555 PerlIOBuf_get_base(aTHX_ f);
4559 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4563 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4565 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4566 PerlIOBuf * const b = &m->base;
4568 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4570 * No, or wrong sort of, buffer
4573 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4577 * If unmap took the "buffer" see if we have one from before
4579 if (!b->buf && m->bbuf)
4582 PerlIOBuf_get_base(aTHX_ f);
4586 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4590 PerlIOMmap_flush(pTHX_ PerlIO *f)
4592 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4593 PerlIOBuf *b = &m->base;
4594 IV code = PerlIOBuf_flush(aTHX_ f);
4596 * Now we are "synced" at PerlIOBuf level
4603 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4608 * We seem to have a PerlIOBuf buffer which was not mapped
4609 * remember it in case we need one later
4618 PerlIOMmap_fill(pTHX_ PerlIO *f)
4620 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4621 IV code = PerlIO_flush(f);
4622 if (code == 0 && !b->buf) {
4623 code = PerlIOMmap_map(aTHX_ f);
4625 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4626 code = PerlIOBuf_fill(aTHX_ f);
4632 PerlIOMmap_close(pTHX_ PerlIO *f)
4634 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4635 PerlIOBuf *b = &m->base;
4636 IV code = PerlIO_flush(f);
4640 b->ptr = b->end = b->buf;
4642 if (PerlIOBuf_close(aTHX_ f) != 0)
4648 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4650 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4654 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4655 sizeof(PerlIO_funcs),
4658 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4662 PerlIOBase_binmode, /* binmode */
4676 PerlIOBase_clearerr,
4677 PerlIOBase_setlinebuf,
4678 PerlIOMmap_get_base,
4682 PerlIOBuf_set_ptrcnt,
4685 #endif /* HAS_MMAP */
4688 Perl_PerlIO_stdin(pTHX)
4691 PerlIO_stdstreams(aTHX);
4693 return &PL_perlio[1];
4697 Perl_PerlIO_stdout(pTHX)
4700 PerlIO_stdstreams(aTHX);
4702 return &PL_perlio[2];
4706 Perl_PerlIO_stderr(pTHX)
4709 PerlIO_stdstreams(aTHX);
4711 return &PL_perlio[3];
4714 /*--------------------------------------------------------------------------------------*/
4717 PerlIO_getname(PerlIO *f, char *buf)
4722 bool exported = FALSE;
4723 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4725 stdio = PerlIO_exportFILE(f,0);
4729 name = fgetname(stdio, buf);
4730 if (exported) PerlIO_releaseFILE(f,stdio);
4736 Perl_croak(aTHX_ "Don't know how to get file name");
4742 /*--------------------------------------------------------------------------------------*/
4744 * Functions which can be called on any kind of PerlIO implemented in
4748 #undef PerlIO_fdopen
4750 PerlIO_fdopen(int fd, const char *mode)
4753 return PerlIO_openn(aTHX_ Nullch, mode, fd, 0, 0, NULL, 0, NULL);
4758 PerlIO_open(const char *path, const char *mode)
4761 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4762 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, NULL, 1, &name);
4765 #undef Perlio_reopen
4767 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4770 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4771 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, f, 1, &name);
4776 PerlIO_getc(PerlIO *f)
4780 if ( 1 == PerlIO_read(f, buf, 1) ) {
4781 return (unsigned char) buf[0];
4786 #undef PerlIO_ungetc
4788 PerlIO_ungetc(PerlIO *f, int ch)
4793 if (PerlIO_unread(f, &buf, 1) == 1)
4801 PerlIO_putc(PerlIO *f, int ch)
4805 return PerlIO_write(f, &buf, 1);
4810 PerlIO_puts(PerlIO *f, const char *s)
4813 STRLEN len = strlen(s);
4814 return PerlIO_write(f, s, len);
4817 #undef PerlIO_rewind
4819 PerlIO_rewind(PerlIO *f)
4822 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4826 #undef PerlIO_vprintf
4828 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4831 SV *sv = newSVpvn("", 0);
4837 Perl_va_copy(ap, apc);
4838 sv_vcatpvf(sv, fmt, &apc);
4840 sv_vcatpvf(sv, fmt, &ap);
4843 wrote = PerlIO_write(f, s, len);
4848 #undef PerlIO_printf
4850 PerlIO_printf(PerlIO *f, const char *fmt, ...)
4855 result = PerlIO_vprintf(f, fmt, ap);
4860 #undef PerlIO_stdoutf
4862 PerlIO_stdoutf(const char *fmt, ...)
4868 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
4873 #undef PerlIO_tmpfile
4875 PerlIO_tmpfile(void)
4880 const int fd = win32_tmpfd();
4882 f = PerlIO_fdopen(fd, "w+b");
4884 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
4885 SV *sv = newSVpv("/tmp/PerlIO_XXXXXX", 0);
4887 * I have no idea how portable mkstemp() is ... NI-S
4889 const int fd = mkstemp(SvPVX(sv));
4891 f = PerlIO_fdopen(fd, "w+");
4893 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
4894 PerlLIO_unlink(SvPVX(sv));
4897 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
4898 FILE *stdio = PerlSIO_tmpfile();
4901 if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)),
4902 PERLIO_FUNCS_CAST(&PerlIO_stdio),
4904 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
4910 # endif /* else HAS_MKSTEMP */
4911 #endif /* else WIN32 */
4918 #endif /* USE_SFIO */
4919 #endif /* PERLIO_IS_STDIO */
4921 /*======================================================================================*/
4923 * Now some functions in terms of above which may be needed even if we are
4924 * not in true PerlIO mode
4928 #undef PerlIO_setpos
4930 PerlIO_setpos(PerlIO *f, SV *pos)
4935 Off_t *posn = (Off_t *) SvPV(pos, len);
4936 if (f && len == sizeof(Off_t))
4937 return PerlIO_seek(f, *posn, SEEK_SET);
4939 SETERRNO(EINVAL, SS_IVCHAN);
4943 #undef PerlIO_setpos
4945 PerlIO_setpos(PerlIO *f, SV *pos)
4950 Fpos_t *fpos = (Fpos_t *) SvPV(pos, len);
4951 if (f && len == sizeof(Fpos_t)) {
4952 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4953 return fsetpos64(f, fpos);
4955 return fsetpos(f, fpos);
4959 SETERRNO(EINVAL, SS_IVCHAN);
4965 #undef PerlIO_getpos
4967 PerlIO_getpos(PerlIO *f, SV *pos)
4970 Off_t posn = PerlIO_tell(f);
4971 sv_setpvn(pos, (char *) &posn, sizeof(posn));
4972 return (posn == (Off_t) - 1) ? -1 : 0;
4975 #undef PerlIO_getpos
4977 PerlIO_getpos(PerlIO *f, SV *pos)
4982 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4983 code = fgetpos64(f, &fpos);
4985 code = fgetpos(f, &fpos);
4987 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
4992 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
4995 vprintf(char *pat, char *args)
4997 _doprnt(pat, args, stdout);
4998 return 0; /* wrong, but perl doesn't use the return
5003 vfprintf(FILE *fd, char *pat, char *args)
5005 _doprnt(pat, args, fd);
5006 return 0; /* wrong, but perl doesn't use the return
5012 #ifndef PerlIO_vsprintf
5014 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5017 const int val = vsprintf(s, fmt, ap);
5019 if (strlen(s) >= (STRLEN) n) {
5021 (void) PerlIO_puts(Perl_error_log,
5022 "panic: sprintf overflow - memory corrupted!\n");
5030 #ifndef PerlIO_sprintf
5032 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5037 result = PerlIO_vsprintf(s, n, fmt, ap);