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
60 /* Missing proto on LynxOS */
64 /* Call the callback or PerlIOBase, and return failure. */
65 #define Perl_PerlIO_or_Base(f, callback, base, failure, args) \
66 if (PerlIOValid(f)) { \
67 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
68 if (tab && tab->callback) \
69 return (*tab->callback) args; \
71 return PerlIOBase_ ## base args; \
74 SETERRNO(EBADF, SS_IVCHAN); \
77 /* Call the callback or fail, and return failure. */
78 #define Perl_PerlIO_or_fail(f, callback, failure, args) \
79 if (PerlIOValid(f)) { \
80 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
81 if (tab && tab->callback) \
82 return (*tab->callback) args; \
83 SETERRNO(EINVAL, LIB_INVARG); \
86 SETERRNO(EBADF, SS_IVCHAN); \
89 /* Call the callback or PerlIOBase, and be void. */
90 #define Perl_PerlIO_or_Base_void(f, callback, base, args) \
91 if (PerlIOValid(f)) { \
92 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
93 if (tab && tab->callback) \
94 (*tab->callback) args; \
96 PerlIOBase_ ## base args; \
99 SETERRNO(EBADF, SS_IVCHAN)
101 /* Call the callback or fail, and be void. */
102 #define Perl_PerlIO_or_fail_void(f, callback, args) \
103 if (PerlIOValid(f)) { \
104 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
105 if (tab && tab->callback) \
106 (*tab->callback) args; \
108 SETERRNO(EINVAL, LIB_INVARG); \
111 SETERRNO(EBADF, SS_IVCHAN)
114 perlsio_binmode(FILE *fp, int iotype, int mode)
117 * This used to be contents of do_binmode in doio.c
120 # if defined(atarist) || defined(__MINT__)
123 ((FILE *) fp)->_flag |= _IOBIN;
125 ((FILE *) fp)->_flag &= ~_IOBIN;
132 if (PerlLIO_setmode(fp, mode) != -1) {
134 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
136 # if defined(WIN32) && defined(__BORLANDC__)
138 * The translation mode of the stream is maintained independent of
139 * the translation mode of the fd in the Borland RTL (heavy
140 * digging through their runtime sources reveal). User has to set
141 * the mode explicitly for the stream (though they don't document
142 * this anywhere). GSAR 97-5-24
148 fp->flags &= ~_F_BIN;
156 # if defined(USEMYBINMODE)
158 if (my_binmode(fp, iotype, mode) != FALSE)
169 #define O_ACCMODE 3 /* Assume traditional implementation */
173 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
175 int result = rawmode & O_ACCMODE;
180 ptype = IoTYPE_RDONLY;
183 ptype = IoTYPE_WRONLY;
191 *writing = (result != O_RDONLY);
193 if (result == O_RDONLY) {
197 else if (rawmode & O_APPEND) {
199 if (result != O_WRONLY)
204 if (result == O_WRONLY)
211 if (rawmode & O_BINARY)
217 #ifndef PERLIO_LAYERS
219 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
221 if (!names || !*names
222 || strEQ(names, ":crlf")
223 || strEQ(names, ":raw")
224 || strEQ(names, ":bytes")
228 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
236 PerlIO_destruct(pTHX)
241 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
246 return perlsio_binmode(fp, iotype, mode);
251 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
256 #ifdef PERL_IMPLICIT_SYS
257 return PerlSIO_fdupopen(f);
260 return win32_fdupopen(f);
263 int fd = PerlLIO_dup(PerlIO_fileno(f));
266 int omode = fcntl(fd, F_GETFL);
268 omode = djgpp_get_stream_mode(f);
270 PerlIO_intmode2str(omode,mode,NULL);
271 /* the r+ is a hack */
272 return PerlIO_fdopen(fd, mode);
277 SETERRNO(EBADF, SS_IVCHAN);
287 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
291 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
292 int imode, int perm, PerlIO *old, int narg, SV **args)
296 Perl_croak(aTHX_ "More than one argument to open");
298 if (*args == &PL_sv_undef)
299 return PerlIO_tmpfile();
301 char *name = SvPV_nolen(*args);
302 if (*mode == IoTYPE_NUMERIC) {
303 fd = PerlLIO_open3(name, imode, perm);
305 return PerlIO_fdopen(fd, (char *) mode + 1);
308 return PerlIO_reopen(name, mode, old);
311 return PerlIO_open(name, mode);
316 return PerlIO_fdopen(fd, (char *) mode);
321 XS(XS_PerlIO__Layer__find)
325 Perl_croak(aTHX_ "Usage class->find(name[,load])");
327 char *name = SvPV_nolen(ST(1));
328 ST(0) = (strEQ(name, "crlf")
329 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
336 Perl_boot_core_PerlIO(pTHX)
338 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
344 #ifdef PERLIO_IS_STDIO
350 * Does nothing (yet) except force this file to be included in perl
351 * binary. That allows this file to force inclusion of other functions
352 * that may be required by loadable extensions e.g. for
353 * FileHandle::tmpfile
357 #undef PerlIO_tmpfile
364 #else /* PERLIO_IS_STDIO */
372 * This section is just to make sure these functions get pulled in from
376 #undef PerlIO_tmpfile
387 * Force this file to be included in perl binary. Which allows this
388 * file to force inclusion of other functions that may be required by
389 * loadable extensions e.g. for FileHandle::tmpfile
393 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
394 * results in a lot of lseek()s to regular files and lot of small
397 sfset(sfstdout, SF_SHARE, 0);
400 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
402 PerlIO_importFILE(FILE *stdio, const char *mode)
404 int fd = fileno(stdio);
405 if (!mode || !*mode) {
408 return PerlIO_fdopen(fd, mode);
412 PerlIO_findFILE(PerlIO *pio)
414 int fd = PerlIO_fileno(pio);
415 FILE *f = fdopen(fd, "r+");
417 if (!f && errno == EINVAL)
419 if (!f && errno == EINVAL)
426 /*======================================================================================*/
428 * Implement all the PerlIO interface ourselves.
434 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
441 #include <sys/mman.h>
445 * Why is this here - not in perlio.h? RMB
447 void PerlIO_debug(const char *fmt, ...)
448 __attribute__format__(__printf__, 1, 2);
451 PerlIO_debug(const char *fmt, ...)
459 char *s = PerlEnv_getenv("PERLIO_DEBUG");
461 dbg = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
468 /* Use fixed buffer as sv_catpvf etc. needs SVs */
472 s = CopFILE(PL_curcop);
475 sprintf(buffer, "%.40s:%" IVdf " ", s, (IV) CopLINE(PL_curcop));
476 len = strlen(buffer);
477 vsprintf(buffer+len, fmt, ap);
478 PerlLIO_write(dbg, buffer, strlen(buffer));
480 SV *sv = newSVpvn("", 0);
483 s = CopFILE(PL_curcop);
486 Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s,
487 (IV) CopLINE(PL_curcop));
488 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
491 PerlLIO_write(dbg, s, len);
499 /*--------------------------------------------------------------------------------------*/
502 * Inner level routines
506 * Table of pointers to the PerlIO structs (malloc'ed)
508 #define PERLIO_TABLE_SIZE 64
511 PerlIO_allocate(pTHX)
514 * Find a free slot in the table, allocating new table as necessary
519 while ((f = *last)) {
521 last = (PerlIO **) (f);
522 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
528 Newz('I',f,PERLIO_TABLE_SIZE,PerlIO);
536 #undef PerlIO_fdupopen
538 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
540 if (PerlIOValid(f)) {
541 PerlIO_funcs *tab = PerlIOBase(f)->tab;
542 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
544 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
546 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
550 SETERRNO(EBADF, SS_IVCHAN);
556 PerlIO_cleantable(pTHX_ PerlIO **tablep)
558 PerlIO *table = *tablep;
561 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
562 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
563 PerlIO *f = table + i;
575 PerlIO_list_alloc(pTHX)
578 Newz('L', list, 1, PerlIO_list_t);
584 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
587 if (--list->refcnt == 0) {
590 for (i = 0; i < list->cur; i++) {
591 if (list->array[i].arg)
592 SvREFCNT_dec(list->array[i].arg);
594 Safefree(list->array);
602 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
605 if (list->cur >= list->len) {
608 Renew(list->array, list->len, PerlIO_pair_t);
610 New('l', list->array, list->len, PerlIO_pair_t);
612 p = &(list->array[list->cur++]);
614 if ((p->arg = arg)) {
620 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
622 PerlIO_list_t *list = (PerlIO_list_t *) NULL;
625 list = PerlIO_list_alloc(aTHX);
626 for (i=0; i < proto->cur; i++) {
628 if (proto->array[i].arg)
629 arg = PerlIO_sv_dup(aTHX_ proto->array[i].arg,param);
630 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
637 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
640 PerlIO **table = &proto->Iperlio;
643 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
644 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
645 PerlIO_allocate(aTHX); /* root slot is never used */
646 PerlIO_debug("Clone %p from %p\n",aTHX,proto);
647 while ((f = *table)) {
649 table = (PerlIO **) (f++);
650 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
652 (void) fp_dup(f, 0, param);
661 PerlIO_destruct(pTHX)
663 PerlIO **table = &PL_perlio;
666 PerlIO_debug("Destruct %p\n",aTHX);
668 while ((f = *table)) {
670 table = (PerlIO **) (f++);
671 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
675 if (l->tab->kind & PERLIO_K_DESTRUCT) {
676 PerlIO_debug("Destruct popping %s\n", l->tab->name);
690 PerlIO_pop(pTHX_ PerlIO *f)
694 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
695 if (l->tab->Popped) {
697 * If popped returns non-zero do not free its layer structure
698 * it has either done so itself, or it is shared and still in
701 if ((*l->tab->Popped) (aTHX_ f) != 0)
709 /* Return as an array the stack of layers on a filehandle. Note that
710 * the stack is returned top-first in the array, and there are three
711 * times as many array elements as there are layers in the stack: the
712 * first element of a layer triplet is the name, the second one is the
713 * arguments, and the third one is the flags. */
716 PerlIO_get_layers(pTHX_ PerlIO *f)
720 if (PerlIOValid(f)) {
721 PerlIOl *l = PerlIOBase(f);
724 SV *name = l->tab && l->tab->name ?
725 newSVpv(l->tab->name, 0) : &PL_sv_undef;
726 SV *arg = l->tab && l->tab->Getarg ?
727 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
730 av_push(av, newSViv((IV)l->flags));
738 /*--------------------------------------------------------------------------------------*/
740 * XS Interface for perl code
744 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
747 if ((SSize_t) len <= 0)
749 for (i = 0; i < PL_known_layers->cur; i++) {
750 PerlIO_funcs *f = PL_known_layers->array[i].funcs;
751 if (memEQ(f->name, name, len) && f->name[len] == 0) {
752 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
756 if (load && PL_subname && PL_def_layerlist
757 && PL_def_layerlist->cur >= 2) {
758 if (PL_in_load_module) {
759 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
762 SV *pkgsv = newSVpvn("PerlIO", 6);
763 SV *layer = newSVpvn(name, len);
764 CV *cv = get_cv("PerlIO::Layer::NoWarnings", FALSE);
766 SAVEINT(PL_in_load_module);
768 SAVESPTR(PL_warnhook);
769 PL_warnhook = (SV *) cv;
773 * The two SVs are magically freed by load_module
775 Perl_load_module(aTHX_ 0, pkgsv, Nullsv, layer, Nullsv);
778 return PerlIO_find_layer(aTHX_ name, len, 0);
781 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
785 #ifdef USE_ATTRIBUTES_FOR_PERLIO
788 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
791 IO *io = GvIOn((GV *) SvRV(sv));
792 PerlIO *ifp = IoIFP(io);
793 PerlIO *ofp = IoOFP(io);
794 Perl_warn(aTHX_ "set %" SVf " %p %p %p", sv, io, ifp, ofp);
800 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
803 IO *io = GvIOn((GV *) SvRV(sv));
804 PerlIO *ifp = IoIFP(io);
805 PerlIO *ofp = IoOFP(io);
806 Perl_warn(aTHX_ "get %" SVf " %p %p %p", sv, io, ifp, ofp);
812 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
814 Perl_warn(aTHX_ "clear %" SVf, sv);
819 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
821 Perl_warn(aTHX_ "free %" SVf, sv);
825 MGVTBL perlio_vtab = {
833 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
836 SV *sv = SvRV(ST(1));
841 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
843 mg = mg_find(sv, PERL_MAGIC_ext);
844 mg->mg_virtual = &perlio_vtab;
846 Perl_warn(aTHX_ "attrib %" SVf, sv);
847 for (i = 2; i < items; i++) {
849 const char *name = SvPV(ST(i), len);
850 SV *layer = PerlIO_find_layer(aTHX_ name, len, 1);
852 av_push(av, SvREFCNT_inc(layer));
863 #endif /* USE_ATTIBUTES_FOR_PERLIO */
866 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
868 HV *stash = gv_stashpv("PerlIO::Layer", TRUE);
869 SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
873 XS(XS_PerlIO__Layer__NoWarnings)
875 /* This is used as a %SIG{__WARN__} handler to supress warnings
876 during loading of layers.
880 PerlIO_debug("warning:%s\n",SvPV_nolen(ST(0)));
884 XS(XS_PerlIO__Layer__find)
888 Perl_croak(aTHX_ "Usage class->find(name[,load])");
891 char *name = SvPV(ST(1), len);
892 bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
893 PerlIO_funcs *layer = PerlIO_find_layer(aTHX_ name, len, load);
895 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
902 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
904 if (!PL_known_layers)
905 PL_known_layers = PerlIO_list_alloc(aTHX);
906 PerlIO_list_push(aTHX_ PL_known_layers, tab, Nullsv);
907 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
911 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
914 const char *s = names;
916 while (isSPACE(*s) || *s == ':')
921 const char *as = Nullch;
923 if (!isIDFIRST(*s)) {
925 * Message is consistent with how attribute lists are
926 * passed. Even though this means "foo : : bar" is
927 * seen as an invalid separator character.
929 char q = ((*s == '\'') ? '"' : '\'');
930 if (ckWARN(WARN_LAYER))
931 Perl_warner(aTHX_ packWARN(WARN_LAYER),
932 "Invalid separator character %c%c%c in PerlIO layer specification %s",
934 SETERRNO(EINVAL, LIB_INVARG);
939 } while (isALNUM(*e));
955 * It's a nul terminated string, not allowed
956 * to \ the terminating null. Anything other
957 * character is passed over.
967 if (ckWARN(WARN_LAYER))
968 Perl_warner(aTHX_ packWARN(WARN_LAYER),
969 "Argument list not closed for PerlIO layer \"%.*s\"",
981 bool warn_layer = ckWARN(WARN_LAYER);
982 PerlIO_funcs *layer =
983 PerlIO_find_layer(aTHX_ s, llen, 1);
985 PerlIO_list_push(aTHX_ av, layer,
992 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
1005 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
1007 PerlIO_funcs *tab = &PerlIO_perlio;
1008 #ifdef PERLIO_USING_CRLF
1011 if (PerlIO_stdio.Set_ptrcnt)
1012 tab = &PerlIO_stdio;
1014 PerlIO_debug("Pushing %s\n", tab->name);
1015 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1020 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1022 return av->array[n].arg;
1026 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1028 if (n >= 0 && n < av->cur) {
1029 PerlIO_debug("Layer %" IVdf " is %s\n", n,
1030 av->array[n].funcs->name);
1031 return av->array[n].funcs;
1034 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1039 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 PerlIO_remove = {
1050 sizeof(PerlIO_funcs),
1053 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1071 NULL, /* get_base */
1072 NULL, /* get_bufsiz */
1075 NULL, /* set_ptrcnt */
1079 PerlIO_default_layers(pTHX)
1081 if (!PL_def_layerlist) {
1082 const char *s = (PL_tainting) ? Nullch : PerlEnv_getenv("PERLIO");
1083 PerlIO_funcs *osLayer = &PerlIO_unix;
1084 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1085 PerlIO_define_layer(aTHX_ & PerlIO_unix);
1087 PerlIO_define_layer(aTHX_ & PerlIO_win32);
1089 osLayer = &PerlIO_win32;
1092 PerlIO_define_layer(aTHX_ & PerlIO_raw);
1093 PerlIO_define_layer(aTHX_ & PerlIO_perlio);
1094 PerlIO_define_layer(aTHX_ & PerlIO_stdio);
1095 PerlIO_define_layer(aTHX_ & PerlIO_crlf);
1097 PerlIO_define_layer(aTHX_ & PerlIO_mmap);
1099 PerlIO_define_layer(aTHX_ & PerlIO_utf8);
1100 PerlIO_define_layer(aTHX_ & PerlIO_remove);
1101 PerlIO_define_layer(aTHX_ & PerlIO_byte);
1102 PerlIO_list_push(aTHX_ PL_def_layerlist,
1103 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1106 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1109 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1112 if (PL_def_layerlist->cur < 2) {
1113 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1115 return PL_def_layerlist;
1119 Perl_boot_core_PerlIO(pTHX)
1121 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1122 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1125 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1126 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1130 PerlIO_default_layer(pTHX_ I32 n)
1132 PerlIO_list_t *av = PerlIO_default_layers(aTHX);
1135 return PerlIO_layer_fetch(aTHX_ av, n, &PerlIO_stdio);
1138 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1139 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1142 PerlIO_stdstreams(pTHX)
1145 PerlIO_allocate(aTHX);
1146 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1147 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1148 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1153 PerlIO_push(pTHX_ PerlIO *f, PerlIO_funcs *tab, const char *mode, SV *arg)
1155 if (tab->fsize != sizeof(PerlIO_funcs)) {
1157 Perl_croak(aTHX_ "Layer does not match this perl");
1161 if (tab->size < sizeof(PerlIOl)) {
1164 /* Real layer with a data area */
1165 Newc('L',l,tab->size,char,PerlIOl);
1167 Zero(l, tab->size, char);
1171 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1172 (mode) ? mode : "(Null)", (void*)arg);
1173 if (*l->tab->Pushed &&
1174 (*l->tab->Pushed) (aTHX_ f, mode, arg, tab) != 0) {
1175 PerlIO_pop(aTHX_ f);
1181 /* Pseudo-layer where push does its own stack adjust */
1182 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1183 (mode) ? mode : "(Null)", (void*)arg);
1185 (*tab->Pushed) (aTHX_ f, mode, arg, tab) != 0) {
1193 PerlIOBase_binmode(pTHX_ PerlIO *f)
1195 if (PerlIOValid(f)) {
1196 /* Is layer suitable for raw stream ? */
1197 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1198 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1199 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1202 /* Not suitable - pop it */
1203 PerlIO_pop(aTHX_ f);
1211 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1214 if (PerlIOValid(f)) {
1219 * Strip all layers that are not suitable for a raw stream
1222 while (t && (l = *t)) {
1223 if (l->tab->Binmode) {
1224 /* Has a handler - normal case */
1225 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1227 /* Layer still there - move down a layer */
1236 /* No handler - pop it */
1237 PerlIO_pop(aTHX_ t);
1240 if (PerlIOValid(f)) {
1241 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1249 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1250 PerlIO_list_t *layers, IV n, IV max)
1254 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1256 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1267 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1271 PerlIO_list_t *layers = PerlIO_list_alloc(aTHX);
1272 code = PerlIO_parse_layers(aTHX_ layers, names);
1274 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1276 PerlIO_list_free(aTHX_ layers);
1282 /*--------------------------------------------------------------------------------------*/
1284 * Given the abstraction above the public API functions
1288 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1290 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n",
1291 (void*)f, PerlIOBase(f)->tab->name, iotype, mode,
1292 (names) ? names : "(Null)");
1294 /* Do not flush etc. if (e.g.) switching encodings.
1295 if a pushed layer knows it needs to flush lower layers
1296 (for example :unix which is never going to call them)
1297 it can do the flush when it is pushed.
1299 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1302 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1303 #ifdef PERLIO_USING_CRLF
1304 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1305 O_BINARY so we can look for it in mode.
1307 if (!(mode & O_BINARY)) {
1309 /* FIXME?: Looking down the layer stack seems wrong,
1310 but is a way of reaching past (say) an encoding layer
1311 to flip CRLF-ness of the layer(s) below
1314 /* Perhaps we should turn on bottom-most aware layer
1315 e.g. Ilya's idea that UNIX TTY could serve
1317 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1318 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1319 /* Not in text mode - flush any pending stuff and flip it */
1321 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1323 /* Only need to turn it on in one layer so we are done */
1328 /* Not finding a CRLF aware layer presumably means we are binary
1329 which is not what was requested - so we failed
1330 We _could_ push :crlf layer but so could caller
1335 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1336 So code that used to be here is now in PerlIORaw_pushed().
1338 return PerlIO_push(aTHX_ f, &PerlIO_raw, Nullch, Nullsv) ? TRUE : FALSE;
1343 PerlIO__close(pTHX_ PerlIO *f)
1345 if (PerlIOValid(f)) {
1346 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1347 if (tab && tab->Close)
1348 return (*tab->Close)(aTHX_ f);
1350 return PerlIOBase_close(aTHX_ f);
1353 SETERRNO(EBADF, SS_IVCHAN);
1359 Perl_PerlIO_close(pTHX_ PerlIO *f)
1361 int code = PerlIO__close(aTHX_ f);
1362 while (PerlIOValid(f)) {
1363 PerlIO_pop(aTHX_ f);
1369 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1371 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1375 PerlIO_context_layers(pTHX_ const char *mode)
1377 const char *type = NULL;
1379 * Need to supply default layer info from open.pm
1382 SV *layers = PL_curcop->cop_io;
1385 type = SvPV(layers, len);
1386 if (type && mode[0] != 'r') {
1388 * Skip to write part
1390 const char *s = strchr(type, 0);
1391 if (s && (STRLEN)(s - type) < len) {
1400 static PerlIO_funcs *
1401 PerlIO_layer_from_ref(pTHX_ SV *sv)
1404 * For any scalar type load the handler which is bundled with perl
1406 if (SvTYPE(sv) < SVt_PVAV)
1407 return PerlIO_find_layer(aTHX_ "scalar", 6, 1);
1410 * For other types allow if layer is known but don't try and load it
1412 switch (SvTYPE(sv)) {
1414 return PerlIO_find_layer(aTHX_ "Array", 5, 0);
1416 return PerlIO_find_layer(aTHX_ "Hash", 4, 0);
1418 return PerlIO_find_layer(aTHX_ "Code", 4, 0);
1420 return PerlIO_find_layer(aTHX_ "Glob", 4, 0);
1426 PerlIO_resolve_layers(pTHX_ const char *layers,
1427 const char *mode, int narg, SV **args)
1429 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1432 PerlIO_stdstreams(aTHX);
1436 * If it is a reference but not an object see if we have a handler
1439 if (SvROK(arg) && !sv_isobject(arg)) {
1440 PerlIO_funcs *handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1442 def = PerlIO_list_alloc(aTHX);
1443 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1447 * Don't fail if handler cannot be found :via(...) etc. may do
1448 * something sensible else we will just stringfy and open
1454 layers = PerlIO_context_layers(aTHX_ mode);
1455 if (layers && *layers) {
1459 av = PerlIO_list_alloc(aTHX);
1460 for (i = 0; i < def->cur; i++) {
1461 PerlIO_list_push(aTHX_ av, def->array[i].funcs,
1468 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1472 PerlIO_list_free(aTHX_ av);
1473 return (PerlIO_list_t *) NULL;
1484 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1485 int imode, int perm, PerlIO *f, int narg, SV **args)
1487 if (!f && narg == 1 && *args == &PL_sv_undef) {
1488 if ((f = PerlIO_tmpfile())) {
1490 layers = PerlIO_context_layers(aTHX_ mode);
1491 if (layers && *layers)
1492 PerlIO_apply_layers(aTHX_ f, mode, layers);
1496 PerlIO_list_t *layera = NULL;
1498 PerlIO_funcs *tab = NULL;
1499 if (PerlIOValid(f)) {
1501 * This is "reopen" - it is not tested as perl does not use it
1505 layera = PerlIO_list_alloc(aTHX);
1507 SV *arg = (l->tab->Getarg)
1508 ? (*l->tab->Getarg) (aTHX_ &l, NULL, 0)
1510 PerlIO_list_push(aTHX_ layera, l->tab, arg);
1511 l = *PerlIONext(&l);
1515 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1521 * Start at "top" of layer stack
1523 n = layera->cur - 1;
1525 PerlIO_funcs *t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1534 * Found that layer 'n' can do opens - call it
1536 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1537 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1539 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1540 tab->name, layers, mode, fd, imode, perm,
1541 (void*)f, narg, (void*)args);
1543 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1546 SETERRNO(EINVAL, LIB_INVARG);
1550 if (n + 1 < layera->cur) {
1552 * More layers above the one that we used to open -
1555 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1556 /* If pushing layers fails close the file */
1563 PerlIO_list_free(aTHX_ layera);
1570 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1572 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1576 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1578 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1582 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1584 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1588 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1590 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1594 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1596 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1600 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1604 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1606 if (tab && tab->Flush)
1607 return (*tab->Flush) (aTHX_ f);
1609 return 0; /* If no Flush defined, silently succeed. */
1612 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1613 SETERRNO(EBADF, SS_IVCHAN);
1619 * Is it good API design to do flush-all on NULL, a potentially
1620 * errorneous input? Maybe some magical value (PerlIO*
1621 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1622 * things on fflush(NULL), but should we be bound by their design
1625 PerlIO **table = &PL_perlio;
1627 while ((f = *table)) {
1629 table = (PerlIO **) (f++);
1630 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1631 if (*f && PerlIO_flush(f) != 0)
1641 PerlIOBase_flush_linebuf(pTHX)
1643 PerlIO **table = &PL_perlio;
1645 while ((f = *table)) {
1647 table = (PerlIO **) (f++);
1648 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1651 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1652 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1660 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1662 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1666 PerlIO_isutf8(PerlIO *f)
1669 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1671 SETERRNO(EBADF, SS_IVCHAN);
1677 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1679 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1683 Perl_PerlIO_error(pTHX_ PerlIO *f)
1685 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1689 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1691 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1695 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1697 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1701 PerlIO_has_base(PerlIO *f)
1703 if (PerlIOValid(f)) {
1704 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1707 return (tab->Get_base != NULL);
1708 SETERRNO(EINVAL, LIB_INVARG);
1711 SETERRNO(EBADF, SS_IVCHAN);
1717 PerlIO_fast_gets(PerlIO *f)
1719 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1720 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1723 return (tab->Set_ptrcnt != NULL);
1724 SETERRNO(EINVAL, LIB_INVARG);
1727 SETERRNO(EBADF, SS_IVCHAN);
1733 PerlIO_has_cntptr(PerlIO *f)
1735 if (PerlIOValid(f)) {
1736 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1739 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1740 SETERRNO(EINVAL, LIB_INVARG);
1743 SETERRNO(EBADF, SS_IVCHAN);
1749 PerlIO_canset_cnt(PerlIO *f)
1751 if (PerlIOValid(f)) {
1752 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1755 return (tab->Set_ptrcnt != NULL);
1756 SETERRNO(EINVAL, LIB_INVARG);
1759 SETERRNO(EBADF, SS_IVCHAN);
1765 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1767 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1771 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1773 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1777 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1779 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1783 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1785 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1789 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1791 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1795 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1797 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1801 /*--------------------------------------------------------------------------------------*/
1803 * utf8 and raw dummy layers
1807 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1809 if (PerlIOValid(f)) {
1810 if (tab->kind & PERLIO_K_UTF8)
1811 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1813 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1819 PerlIO_funcs PerlIO_utf8 = {
1820 sizeof(PerlIO_funcs),
1823 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1841 NULL, /* get_base */
1842 NULL, /* get_bufsiz */
1845 NULL, /* set_ptrcnt */
1848 PerlIO_funcs PerlIO_byte = {
1849 sizeof(PerlIO_funcs),
1870 NULL, /* get_base */
1871 NULL, /* get_bufsiz */
1874 NULL, /* set_ptrcnt */
1878 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1879 IV n, const char *mode, int fd, int imode, int perm,
1880 PerlIO *old, int narg, SV **args)
1882 PerlIO_funcs *tab = PerlIO_default_btm();
1883 if (tab && tab->Open)
1884 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1886 SETERRNO(EINVAL, LIB_INVARG);
1890 PerlIO_funcs PerlIO_raw = {
1891 sizeof(PerlIO_funcs),
1912 NULL, /* get_base */
1913 NULL, /* get_bufsiz */
1916 NULL, /* set_ptrcnt */
1918 /*--------------------------------------------------------------------------------------*/
1919 /*--------------------------------------------------------------------------------------*/
1921 * "Methods" of the "base class"
1925 PerlIOBase_fileno(pTHX_ PerlIO *f)
1927 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1931 PerlIO_modestr(PerlIO * f, char *buf)
1934 if (PerlIOValid(f)) {
1935 IV flags = PerlIOBase(f)->flags;
1936 if (flags & PERLIO_F_APPEND) {
1938 if (flags & PERLIO_F_CANREAD) {
1942 else if (flags & PERLIO_F_CANREAD) {
1944 if (flags & PERLIO_F_CANWRITE)
1947 else if (flags & PERLIO_F_CANWRITE) {
1949 if (flags & PERLIO_F_CANREAD) {
1953 #ifdef PERLIO_USING_CRLF
1954 if (!(flags & PERLIO_F_CRLF))
1964 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1966 PerlIOl *l = PerlIOBase(f);
1968 const char *omode = mode;
1971 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
1972 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
1973 if (tab->Set_ptrcnt != NULL)
1974 l->flags |= PERLIO_F_FASTGETS;
1976 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
1980 l->flags |= PERLIO_F_CANREAD;
1983 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
1986 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
1989 SETERRNO(EINVAL, LIB_INVARG);
1995 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
1998 l->flags &= ~PERLIO_F_CRLF;
2001 l->flags |= PERLIO_F_CRLF;
2004 SETERRNO(EINVAL, LIB_INVARG);
2011 l->flags |= l->next->flags &
2012 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2017 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2018 f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2019 l->flags, PerlIO_modestr(f, temp));
2025 PerlIOBase_popped(pTHX_ PerlIO *f)
2031 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2034 * Save the position as current head considers it
2036 Off_t old = PerlIO_tell(f);
2038 PerlIO_push(aTHX_ f, &PerlIO_pending, "r", Nullsv);
2039 PerlIOSelf(f, PerlIOBuf)->posn = old;
2040 done = PerlIOBuf_unread(aTHX_ f, vbuf, count);
2045 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2047 STDCHAR *buf = (STDCHAR *) vbuf;
2049 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2050 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2051 SETERRNO(EBADF, SS_IVCHAN);
2055 SSize_t avail = PerlIO_get_cnt(f);
2058 take = ((SSize_t)count < avail) ? count : avail;
2060 STDCHAR *ptr = PerlIO_get_ptr(f);
2061 Copy(ptr, buf, take, STDCHAR);
2062 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2066 if (count > 0 && avail <= 0) {
2067 if (PerlIO_fill(f) != 0)
2071 return (buf - (STDCHAR *) vbuf);
2077 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2083 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2089 PerlIOBase_close(pTHX_ PerlIO *f)
2092 if (PerlIOValid(f)) {
2093 PerlIO *n = PerlIONext(f);
2094 code = PerlIO_flush(f);
2095 PerlIOBase(f)->flags &=
2096 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2097 while (PerlIOValid(n)) {
2098 PerlIO_funcs *tab = PerlIOBase(n)->tab;
2099 if (tab && tab->Close) {
2100 if ((*tab->Close)(aTHX_ n) != 0)
2105 PerlIOBase(n)->flags &=
2106 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2112 SETERRNO(EBADF, SS_IVCHAN);
2118 PerlIOBase_eof(pTHX_ PerlIO *f)
2120 if (PerlIOValid(f)) {
2121 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2127 PerlIOBase_error(pTHX_ PerlIO *f)
2129 if (PerlIOValid(f)) {
2130 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2136 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2138 if (PerlIOValid(f)) {
2139 PerlIO *n = PerlIONext(f);
2140 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2147 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2149 if (PerlIOValid(f)) {
2150 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2155 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2161 return sv_dup(arg, param);
2164 return newSVsv(arg);
2167 return newSVsv(arg);
2172 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2174 PerlIO *nexto = PerlIONext(o);
2175 if (PerlIOValid(nexto)) {
2176 PerlIO_funcs *tab = PerlIOBase(nexto)->tab;
2177 if (tab && tab->Dup)
2178 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2180 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2183 PerlIO_funcs *self = PerlIOBase(o)->tab;
2186 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2187 self->name, (void*)f, (void*)o, (void*)param);
2189 arg = (*self->Getarg)(aTHX_ o, param, flags);
2193 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2201 #define PERLIO_MAX_REFCOUNTABLE_FD 2048
2203 perl_mutex PerlIO_mutex;
2205 int PerlIO_fd_refcnt[PERLIO_MAX_REFCOUNTABLE_FD];
2210 /* Place holder for stdstreams call ??? */
2212 MUTEX_INIT(&PerlIO_mutex);
2217 PerlIOUnix_refcnt_inc(int fd)
2219 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2221 MUTEX_LOCK(&PerlIO_mutex);
2223 PerlIO_fd_refcnt[fd]++;
2224 PerlIO_debug("fd %d refcnt=%d\n",fd,PerlIO_fd_refcnt[fd]);
2226 MUTEX_UNLOCK(&PerlIO_mutex);
2232 PerlIOUnix_refcnt_dec(int fd)
2235 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2237 MUTEX_LOCK(&PerlIO_mutex);
2239 cnt = --PerlIO_fd_refcnt[fd];
2240 PerlIO_debug("fd %d refcnt=%d\n",fd,cnt);
2242 MUTEX_UNLOCK(&PerlIO_mutex);
2249 PerlIO_cleanup(pTHX)
2253 PerlIO_debug("Cleanup layers for %p\n",aTHX);
2255 PerlIO_debug("Cleanup layers\n");
2257 /* Raise STDIN..STDERR refcount so we don't close them */
2258 for (i=0; i < 3; i++)
2259 PerlIOUnix_refcnt_inc(i);
2260 PerlIO_cleantable(aTHX_ &PL_perlio);
2261 /* Restore STDIN..STDERR refcount */
2262 for (i=0; i < 3; i++)
2263 PerlIOUnix_refcnt_dec(i);
2265 if (PL_known_layers) {
2266 PerlIO_list_free(aTHX_ PL_known_layers);
2267 PL_known_layers = NULL;
2269 if(PL_def_layerlist) {
2270 PerlIO_list_free(aTHX_ PL_def_layerlist);
2271 PL_def_layerlist = NULL;
2277 /*--------------------------------------------------------------------------------------*/
2279 * Bottom-most level for UNIX-like case
2283 struct _PerlIO base; /* The generic part */
2284 int fd; /* UNIX like file descriptor */
2285 int oflags; /* open/fcntl flags */
2289 PerlIOUnix_oflags(const char *mode)
2292 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2297 if (*++mode == '+') {
2304 oflags = O_CREAT | O_TRUNC;
2305 if (*++mode == '+') {
2314 oflags = O_CREAT | O_APPEND;
2315 if (*++mode == '+') {
2328 else if (*mode == 't') {
2330 oflags &= ~O_BINARY;
2334 * Always open in binary mode
2337 if (*mode || oflags == -1) {
2338 SETERRNO(EINVAL, LIB_INVARG);
2345 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2347 return PerlIOSelf(f, PerlIOUnix)->fd;
2351 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2353 PerlIOUnix *s = PerlIOSelf(f, PerlIOUnix);
2356 if (PerlLIO_fstat(fd, &st) == 0) {
2357 if (!S_ISREG(st.st_mode)) {
2358 PerlIO_debug("%d is not regular file\n",fd);
2359 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2362 PerlIO_debug("%d _is_ a regular file\n",fd);
2368 PerlIOUnix_refcnt_inc(fd);
2372 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2374 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2375 if (*PerlIONext(f)) {
2376 /* We never call down so do any pending stuff now */
2377 PerlIO_flush(PerlIONext(f));
2379 * XXX could (or should) we retrieve the oflags from the open file
2380 * handle rather than believing the "mode" we are passed in? XXX
2381 * Should the value on NULL mode be 0 or -1?
2383 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2384 mode ? PerlIOUnix_oflags(mode) : -1);
2386 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2392 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2394 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2396 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2398 SETERRNO(ESPIPE, LIB_INVARG);
2400 SETERRNO(EINVAL, LIB_INVARG);
2404 new = PerlLIO_lseek(fd, offset, whence);
2405 if (new == (Off_t) - 1)
2409 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2414 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2415 IV n, const char *mode, int fd, int imode,
2416 int perm, PerlIO *f, int narg, SV **args)
2418 if (PerlIOValid(f)) {
2419 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2420 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2423 char *path = SvPV_nolen(*args);
2424 if (*mode == IoTYPE_NUMERIC)
2427 imode = PerlIOUnix_oflags(mode);
2431 fd = PerlLIO_open3(path, imode, perm);
2435 if (*mode == IoTYPE_IMPLICIT)
2438 f = PerlIO_allocate(aTHX);
2440 if (!PerlIOValid(f)) {
2441 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2445 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2446 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2447 if (*mode == IoTYPE_APPEND)
2448 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2454 * FIXME: pop layers ???
2462 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2464 PerlIOUnix *os = PerlIOSelf(o, PerlIOUnix);
2466 if (flags & PERLIO_DUP_FD) {
2467 fd = PerlLIO_dup(fd);
2469 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2470 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2472 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2473 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2482 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2484 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2485 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2486 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2490 SSize_t len = PerlLIO_read(fd, vbuf, count);
2491 if (len >= 0 || errno != EINTR) {
2493 if (errno != EAGAIN) {
2494 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2497 else if (len == 0 && count != 0) {
2498 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2508 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2510 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2512 SSize_t len = PerlLIO_write(fd, vbuf, count);
2513 if (len >= 0 || errno != EINTR) {
2515 if (errno != EAGAIN) {
2516 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2526 PerlIOUnix_tell(pTHX_ PerlIO *f)
2528 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2533 PerlIOUnix_close(pTHX_ PerlIO *f)
2535 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2537 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2538 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2539 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2544 SETERRNO(EBADF,SS_IVCHAN);
2547 while (PerlLIO_close(fd) != 0) {
2548 if (errno != EINTR) {
2555 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2560 PerlIO_funcs PerlIO_unix = {
2561 sizeof(PerlIO_funcs),
2568 PerlIOBase_binmode, /* binmode */
2578 PerlIOBase_noop_ok, /* flush */
2579 PerlIOBase_noop_fail, /* fill */
2582 PerlIOBase_clearerr,
2583 PerlIOBase_setlinebuf,
2584 NULL, /* get_base */
2585 NULL, /* get_bufsiz */
2588 NULL, /* set_ptrcnt */
2591 /*--------------------------------------------------------------------------------------*/
2596 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2597 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2598 broken by the last second glibc 2.3 fix
2600 #define STDIO_BUFFER_WRITABLE
2605 struct _PerlIO base;
2606 FILE *stdio; /* The stream */
2610 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2613 if (PerlIOValid(f) && (s = PerlIOSelf(f, PerlIOStdio)->stdio)) {
2614 return PerlSIO_fileno(s);
2621 PerlIOStdio_mode(const char *mode, char *tmode)
2629 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2637 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2640 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2641 PerlIO_funcs *toptab = PerlIOBase(n)->tab;
2642 if (toptab == tab) {
2643 /* Top is already stdio - pop self (duplicate) and use original */
2644 PerlIO_pop(aTHX_ f);
2647 int fd = PerlIO_fileno(n);
2650 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2651 mode = PerlIOStdio_mode(mode, tmode)))) {
2652 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2653 /* We never call down so do any pending stuff now */
2654 PerlIO_flush(PerlIONext(f));
2661 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2666 PerlIO_importFILE(FILE *stdio, const char *mode)
2672 if (!mode || !*mode) {
2673 /* We need to probe to see how we can open the stream
2674 so start with read/write and then try write and read
2675 we dup() so that we can fclose without loosing the fd.
2677 Note that the errno value set by a failing fdopen
2678 varies between stdio implementations.
2680 int fd = PerlLIO_dup(fileno(stdio));
2681 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2683 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2686 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2689 /* Don't seem to be able to open */
2695 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), &PerlIO_stdio, mode, Nullsv))) {
2696 s = PerlIOSelf(f, PerlIOStdio);
2704 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2705 IV n, const char *mode, int fd, int imode,
2706 int perm, PerlIO *f, int narg, SV **args)
2709 if (PerlIOValid(f)) {
2710 char *path = SvPV_nolen(*args);
2711 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2713 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2714 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2719 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2724 char *path = SvPV_nolen(*args);
2725 if (*mode == IoTYPE_NUMERIC) {
2727 fd = PerlLIO_open3(path, imode, perm);
2731 bool appended = FALSE;
2733 /* Cygwin wants its 'b' early. */
2735 mode = PerlIOStdio_mode(mode, tmode);
2737 stdio = PerlSIO_fopen(path, mode);
2741 f = PerlIO_allocate(aTHX);
2744 mode = PerlIOStdio_mode(mode, tmode);
2745 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2747 s = PerlIOSelf(f, PerlIOStdio);
2749 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2761 if (*mode == IoTYPE_IMPLICIT) {
2768 stdio = PerlSIO_stdin;
2771 stdio = PerlSIO_stdout;
2774 stdio = PerlSIO_stderr;
2779 stdio = PerlSIO_fdopen(fd, mode =
2780 PerlIOStdio_mode(mode, tmode));
2785 f = PerlIO_allocate(aTHX);
2787 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2788 s = PerlIOSelf(f, PerlIOStdio);
2790 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2800 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2802 /* This assumes no layers underneath - which is what
2803 happens, but is not how I remember it. NI-S 2001/10/16
2805 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2806 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2807 int fd = fileno(stdio);
2809 if (flags & PERLIO_DUP_FD) {
2810 int dfd = PerlLIO_dup(fileno(stdio));
2812 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2816 /* FIXME: To avoid messy error recovery if dup fails
2817 re-use the existing stdio as though flag was not set
2821 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2823 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2824 PerlIOUnix_refcnt_inc(fileno(stdio));
2830 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
2832 /* XXX this could use PerlIO_canset_fileno() and
2833 * PerlIO_set_fileno() support from Configure
2835 # if defined(__UCLIBC__)
2836 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
2839 # elif defined(__GLIBC__)
2840 /* There may be a better way for GLIBC:
2841 - libio.h defines a flag to not close() on cleanup
2845 # elif defined(__sun__)
2847 /* On solaris, if _LP64 is defined, the FILE structure is this:
2853 * It turns out that the fd is stored in the top 32 bits of
2854 * file->__pad[4]. The lower 32 bits contain flags. file->pad[5] appears
2855 * to contain a pointer or offset into another structure. All the
2856 * remaining fields are zero.
2858 * We set the top bits to -1 (0xFFFFFFFF).
2860 f->__pad[4] |= 0xffffffff00000000L;
2861 assert(fileno(f) == 0xffffffff);
2862 # else /* !defined(_LP64) */
2863 /* _file is just a unsigned char :-(
2864 Not clear why we dup() rather than using -1
2865 even if that would be treated as 0xFF - so will
2868 f->_file = PerlLIO_dup(fileno(f));
2869 # endif /* defined(_LP64) */
2871 # elif defined(__hpux)
2875 /* Next one ->_file seems to be a reasonable fallback, i.e. if
2876 your platform does not have special entry try this one.
2877 [For OSF only have confirmation for Tru64 (alpha)
2878 but assume other OSFs will be similar.]
2880 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
2883 # elif defined(__FreeBSD__)
2884 /* There may be a better way on FreeBSD:
2885 - we could insert a dummy func in the _close function entry
2886 f->_close = (int (*)(void *)) dummy_close;
2890 # elif defined(__OpenBSD__)
2891 /* There may be a better way on OpenBSD:
2892 - we could insert a dummy func in the _close function entry
2893 f->_close = (int (*)(void *)) dummy_close;
2897 # elif defined(__EMX__)
2898 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
2901 # elif defined(__CYGWIN__)
2902 /* There may be a better way on CYGWIN:
2903 - we could insert a dummy func in the _close function entry
2904 f->_close = (int (*)(void *)) dummy_close;
2908 # elif defined(WIN32)
2909 # if defined(__BORLANDC__)
2910 f->fd = PerlLIO_dup(fileno(f));
2911 # elif defined(UNDER_CE)
2912 /* WIN_CE does not have access to FILE internals, it hardly has FILE
2921 /* Sarathy's code did this - we fall back to a dup/dup2 hack
2922 (which isn't thread safe) instead
2924 # error "Don't know how to set FILE.fileno on your platform"
2931 PerlIOStdio_close(pTHX_ PerlIO *f)
2933 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
2939 int fd = fileno(stdio);
2945 #ifdef SOCKS5_VERSION_NAME
2946 /* Socks lib overrides close() but stdio isn't linked to
2947 that library (though we are) - so we must call close()
2948 on sockets on stdio's behalf.
2951 Sock_size_t optlen = sizeof(int);
2952 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0) {
2957 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2958 /* File descriptor still in use */
2963 /* For STD* handles don't close the stdio at all
2964 this is because we have shared the FILE * too
2966 if (stdio == stdin) {
2967 /* Some stdios are buggy fflush-ing inputs */
2970 else if (stdio == stdout || stdio == stderr) {
2971 return PerlIO_flush(f);
2973 /* Tricky - must fclose(stdio) to free memory but not close(fd)
2974 Use Sarathy's trick from maint-5.6 to invalidate the
2975 fileno slot of the FILE *
2977 result = PerlIO_flush(f);
2979 if (!(invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio))) {
2980 dupfd = PerlLIO_dup(fd);
2983 result = PerlSIO_fclose(stdio);
2984 /* We treat error from stdio as success if we invalidated
2985 errno may NOT be expected EBADF
2987 if (invalidate && result != 0) {
2992 /* in SOCKS case let close() determine return value */
2996 PerlLIO_dup2(dupfd,fd);
2997 PerlLIO_close(dupfd);
3004 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3006 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3010 STDCHAR *buf = (STDCHAR *) vbuf;
3012 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3013 * stdio does not do that for fread()
3015 int ch = PerlSIO_fgetc(s);
3022 got = PerlSIO_fread(vbuf, 1, count, s);
3023 if (got == 0 && PerlSIO_ferror(s))
3025 if (got >= 0 || errno != EINTR)
3028 SETERRNO(0,0); /* just in case */
3034 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3037 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3039 #ifdef STDIO_BUFFER_WRITABLE
3040 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3041 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3042 STDCHAR *base = PerlIO_get_base(f);
3043 SSize_t cnt = PerlIO_get_cnt(f);
3044 STDCHAR *ptr = PerlIO_get_ptr(f);
3045 SSize_t avail = ptr - base;
3047 if (avail > count) {
3051 Move(buf-avail,ptr,avail,STDCHAR);
3054 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3055 if (PerlSIO_feof(s) && unread >= 0)
3056 PerlSIO_clearerr(s);
3061 if (PerlIO_has_cntptr(f)) {
3062 /* We can get pointer to buffer but not its base
3063 Do ungetc() but check chars are ending up in the
3066 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3067 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3069 int ch = *--buf & 0xFF;
3070 if (ungetc(ch,s) != ch) {
3071 /* ungetc did not work */
3074 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3075 /* Did not change pointer as expected */
3076 fgetc(s); /* get char back again */
3086 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3092 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3096 got = PerlSIO_fwrite(vbuf, 1, count,
3097 PerlIOSelf(f, PerlIOStdio)->stdio);
3098 if (got >= 0 || errno != EINTR)
3101 SETERRNO(0,0); /* just in case */
3107 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3109 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3110 return PerlSIO_fseek(stdio, offset, whence);
3114 PerlIOStdio_tell(pTHX_ PerlIO *f)
3116 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3117 return PerlSIO_ftell(stdio);
3121 PerlIOStdio_flush(pTHX_ PerlIO *f)
3123 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3124 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3125 return PerlSIO_fflush(stdio);
3130 * FIXME: This discards ungetc() and pre-read stuff which is not
3131 * right if this is just a "sync" from a layer above Suspect right
3132 * design is to do _this_ but not have layer above flush this
3133 * layer read-to-read
3136 * Not writeable - sync by attempting a seek
3139 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3147 PerlIOStdio_eof(pTHX_ PerlIO *f)
3149 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3153 PerlIOStdio_error(pTHX_ PerlIO *f)
3155 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3159 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3161 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3165 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3167 #ifdef HAS_SETLINEBUF
3168 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3170 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, Nullch, _IOLBF, 0);
3176 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3178 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3179 return (STDCHAR*)PerlSIO_get_base(stdio);
3183 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3185 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3186 return PerlSIO_get_bufsiz(stdio);
3190 #ifdef USE_STDIO_PTR
3192 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3194 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3195 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3199 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3201 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3202 return PerlSIO_get_cnt(stdio);
3206 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3208 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3210 #ifdef STDIO_PTR_LVALUE
3211 PerlSIO_set_ptr(stdio, (void*)ptr); /* LHS STDCHAR* cast non-portable */
3212 #ifdef STDIO_PTR_LVAL_SETS_CNT
3213 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3214 assert(PerlSIO_get_cnt(stdio) == (cnt));
3217 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3219 * Setting ptr _does_ change cnt - we are done
3223 #else /* STDIO_PTR_LVALUE */
3225 #endif /* STDIO_PTR_LVALUE */
3228 * Now (or only) set cnt
3230 #ifdef STDIO_CNT_LVALUE
3231 PerlSIO_set_cnt(stdio, cnt);
3232 #else /* STDIO_CNT_LVALUE */
3233 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3234 PerlSIO_set_ptr(stdio,
3235 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3237 #else /* STDIO_PTR_LVAL_SETS_CNT */
3239 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3240 #endif /* STDIO_CNT_LVALUE */
3247 PerlIOStdio_fill(pTHX_ PerlIO *f)
3249 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3252 * fflush()ing read-only streams can cause trouble on some stdio-s
3254 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3255 if (PerlSIO_fflush(stdio) != 0)
3258 c = PerlSIO_fgetc(stdio);
3262 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3264 #ifdef STDIO_BUFFER_WRITABLE
3265 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3266 /* Fake ungetc() to the real buffer in case system's ungetc
3269 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3270 SSize_t cnt = PerlSIO_get_cnt(stdio);
3271 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3272 if (ptr == base+1) {
3273 *--ptr = (STDCHAR) c;
3274 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3275 if (PerlSIO_feof(stdio))
3276 PerlSIO_clearerr(stdio);
3282 if (PerlIO_has_cntptr(f)) {
3284 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3291 /* An ungetc()d char is handled separately from the regular
3292 * buffer, so we stuff it in the buffer ourselves.
3293 * Should never get called as should hit code above
3295 *(--((*stdio)->_ptr)) = (unsigned char) c;
3298 /* If buffer snoop scheme above fails fall back to
3301 if (PerlSIO_ungetc(c, stdio) != c)
3309 PerlIO_funcs PerlIO_stdio = {
3310 sizeof(PerlIO_funcs),
3312 sizeof(PerlIOStdio),
3313 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3317 PerlIOBase_binmode, /* binmode */
3331 PerlIOStdio_clearerr,
3332 PerlIOStdio_setlinebuf,
3334 PerlIOStdio_get_base,
3335 PerlIOStdio_get_bufsiz,
3340 #ifdef USE_STDIO_PTR
3341 PerlIOStdio_get_ptr,
3342 PerlIOStdio_get_cnt,
3343 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3344 PerlIOStdio_set_ptrcnt,
3347 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3352 #endif /* USE_STDIO_PTR */
3355 /* Note that calls to PerlIO_exportFILE() are reversed using
3356 * PerlIO_releaseFILE(), not importFILE. */
3358 PerlIO_exportFILE(PerlIO * f, const char *mode)
3362 if (PerlIOValid(f)) {
3365 if (!mode || !*mode) {
3366 mode = PerlIO_modestr(f, buf);
3368 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3372 /* De-link any lower layers so new :stdio sticks */
3374 if ((f2 = PerlIO_push(aTHX_ f, &PerlIO_stdio, buf, Nullsv))) {
3375 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3377 /* Link previous lower layers under new one */
3381 /* restore layers list */
3391 PerlIO_findFILE(PerlIO *f)
3395 if (l->tab == &PerlIO_stdio) {
3396 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3399 l = *PerlIONext(&l);
3401 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3402 return PerlIO_exportFILE(f, Nullch);
3405 /* Use this to reverse PerlIO_exportFILE calls. */
3407 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3411 if (l->tab == &PerlIO_stdio) {
3412 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3413 if (s->stdio == f) {
3415 PerlIO_pop(aTHX_ p);
3424 /*--------------------------------------------------------------------------------------*/
3426 * perlio buffer layer
3430 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3432 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3433 int fd = PerlIO_fileno(f);
3434 if (fd >= 0 && PerlLIO_isatty(fd)) {
3435 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3437 if (*PerlIONext(f)) {
3438 Off_t posn = PerlIO_tell(PerlIONext(f));
3439 if (posn != (Off_t) - 1) {
3443 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3447 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3448 IV n, const char *mode, int fd, int imode, int perm,
3449 PerlIO *f, int narg, SV **args)
3451 if (PerlIOValid(f)) {
3452 PerlIO *next = PerlIONext(f);
3454 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3455 if (tab && tab->Open)
3457 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3459 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3464 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3466 if (*mode == IoTYPE_IMPLICIT) {
3472 if (tab && tab->Open)
3473 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3476 SETERRNO(EINVAL, LIB_INVARG);
3478 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3480 * if push fails during open, open fails. close will pop us.
3485 fd = PerlIO_fileno(f);
3486 if (init && fd == 2) {
3488 * Initial stderr is unbuffered
3490 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3492 #ifdef PERLIO_USING_CRLF
3493 # ifdef PERLIO_IS_BINMODE_FD
3494 if (PERLIO_IS_BINMODE_FD(fd))
3495 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, Nullch);
3499 * do something about failing setmode()? --jhi
3501 PerlLIO_setmode(fd, O_BINARY);
3510 * This "flush" is akin to sfio's sync in that it handles files in either
3511 * read or write state
3514 PerlIOBuf_flush(pTHX_ PerlIO *f)
3516 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3518 PerlIO *n = PerlIONext(f);
3519 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3521 * write() the buffer
3523 STDCHAR *buf = b->buf;
3525 while (p < b->ptr) {
3526 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3530 else if (count < 0 || PerlIO_error(n)) {
3531 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3536 b->posn += (p - buf);
3538 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3539 STDCHAR *buf = PerlIO_get_base(f);
3541 * Note position change
3543 b->posn += (b->ptr - buf);
3544 if (b->ptr < b->end) {
3545 /* We did not consume all of it - try and seek downstream to
3546 our logical position
3548 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3549 /* Reload n as some layers may pop themselves on seek */
3550 b->posn = PerlIO_tell(n = PerlIONext(f));
3553 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3554 data is lost for good - so return saying "ok" having undone
3557 b->posn -= (b->ptr - buf);
3562 b->ptr = b->end = b->buf;
3563 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3564 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3565 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3571 PerlIOBuf_fill(pTHX_ PerlIO *f)
3573 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3574 PerlIO *n = PerlIONext(f);
3577 * Down-stream flush is defined not to loose read data so is harmless.
3578 * we would not normally be fill'ing if there was data left in anycase.
3580 if (PerlIO_flush(f) != 0)
3582 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3583 PerlIOBase_flush_linebuf(aTHX);
3586 PerlIO_get_base(f); /* allocate via vtable */
3588 b->ptr = b->end = b->buf;
3590 if (!PerlIOValid(n)) {
3591 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3595 if (PerlIO_fast_gets(n)) {
3597 * Layer below is also buffered. We do _NOT_ want to call its
3598 * ->Read() because that will loop till it gets what we asked for
3599 * which may hang on a pipe etc. Instead take anything it has to
3600 * hand, or ask it to fill _once_.
3602 avail = PerlIO_get_cnt(n);
3604 avail = PerlIO_fill(n);
3606 avail = PerlIO_get_cnt(n);
3608 if (!PerlIO_error(n) && PerlIO_eof(n))
3613 STDCHAR *ptr = PerlIO_get_ptr(n);
3614 SSize_t cnt = avail;
3615 if (avail > (SSize_t)b->bufsiz)
3617 Copy(ptr, b->buf, avail, STDCHAR);
3618 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3622 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3626 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3628 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3631 b->end = b->buf + avail;
3632 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3637 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3639 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3640 if (PerlIOValid(f)) {
3643 return PerlIOBase_read(aTHX_ f, vbuf, count);
3649 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3651 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3652 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3655 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3660 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3662 * Buffer is already a read buffer, we can overwrite any chars
3663 * which have been read back to buffer start
3665 avail = (b->ptr - b->buf);
3669 * Buffer is idle, set it up so whole buffer is available for
3673 b->end = b->buf + avail;
3675 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3677 * Buffer extends _back_ from where we are now
3679 b->posn -= b->bufsiz;
3681 if (avail > (SSize_t) count) {
3683 * If we have space for more than count, just move count
3691 * In simple stdio-like ungetc() case chars will be already
3694 if (buf != b->ptr) {
3695 Copy(buf, b->ptr, avail, STDCHAR);
3699 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3703 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3709 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3711 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3712 const STDCHAR *buf = (const STDCHAR *) vbuf;
3713 const STDCHAR *flushptr = buf;
3717 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3719 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3720 if (PerlIO_flush(f) != 0) {
3724 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3725 flushptr = buf + count;
3726 while (flushptr > buf && *(flushptr - 1) != '\n')
3730 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3731 if ((SSize_t) count < avail)
3733 if (flushptr > buf && flushptr <= buf + avail)
3734 avail = flushptr - buf;
3735 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3737 Copy(buf, b->ptr, avail, STDCHAR);
3742 if (buf == flushptr)
3745 if (b->ptr >= (b->buf + b->bufsiz))
3748 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3754 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3757 if ((code = PerlIO_flush(f)) == 0) {
3758 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3759 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3760 code = PerlIO_seek(PerlIONext(f), offset, whence);
3762 b->posn = PerlIO_tell(PerlIONext(f));
3769 PerlIOBuf_tell(pTHX_ PerlIO *f)
3771 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3773 * b->posn is file position where b->buf was read, or will be written
3775 Off_t posn = b->posn;
3776 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3777 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3779 /* As O_APPEND files are normally shared in some sense it is better
3784 /* when file is NOT shared then this is sufficient */
3785 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3787 posn = b->posn = PerlIO_tell(PerlIONext(f));
3791 * If buffer is valid adjust position by amount in buffer
3793 posn += (b->ptr - b->buf);
3799 PerlIOBuf_popped(pTHX_ PerlIO *f)
3801 IV code = PerlIOBase_popped(aTHX_ f);
3802 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3803 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3807 b->ptr = b->end = b->buf;
3808 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3813 PerlIOBuf_close(pTHX_ PerlIO *f)
3815 IV code = PerlIOBase_close(aTHX_ f);
3816 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3817 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3821 b->ptr = b->end = b->buf;
3822 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3827 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
3829 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3836 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
3838 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3841 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
3842 return (b->end - b->ptr);
3847 PerlIOBuf_get_base(pTHX_ PerlIO *f)
3849 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3854 Newz('B',b->buf,b->bufsiz, STDCHAR);
3856 b->buf = (STDCHAR *) & b->oneword;
3857 b->bufsiz = sizeof(b->oneword);
3866 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
3868 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3871 return (b->end - b->buf);
3875 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3877 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3881 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
3882 assert(PerlIO_get_cnt(f) == cnt);
3883 assert(b->ptr >= b->buf);
3885 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3889 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3891 return PerlIOBase_dup(aTHX_ f, o, param, flags);
3896 PerlIO_funcs PerlIO_perlio = {
3897 sizeof(PerlIO_funcs),
3900 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3904 PerlIOBase_binmode, /* binmode */
3918 PerlIOBase_clearerr,
3919 PerlIOBase_setlinebuf,
3924 PerlIOBuf_set_ptrcnt,
3927 /*--------------------------------------------------------------------------------------*/
3929 * Temp layer to hold unread chars when cannot do it any other way
3933 PerlIOPending_fill(pTHX_ PerlIO *f)
3936 * Should never happen
3943 PerlIOPending_close(pTHX_ PerlIO *f)
3946 * A tad tricky - flush pops us, then we close new top
3949 return PerlIO_close(f);
3953 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3956 * A tad tricky - flush pops us, then we seek new top
3959 return PerlIO_seek(f, offset, whence);
3964 PerlIOPending_flush(pTHX_ PerlIO *f)
3966 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3967 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3971 PerlIO_pop(aTHX_ f);
3976 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3982 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
3987 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3989 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3990 PerlIOl *l = PerlIOBase(f);
3992 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
3993 * etc. get muddled when it changes mid-string when we auto-pop.
3995 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
3996 (PerlIOBase(PerlIONext(f))->
3997 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4002 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4004 SSize_t avail = PerlIO_get_cnt(f);
4006 if ((SSize_t)count < avail)
4009 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4010 if (got >= 0 && got < (SSize_t)count) {
4012 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4013 if (more >= 0 || got == 0)
4019 PerlIO_funcs PerlIO_pending = {
4020 sizeof(PerlIO_funcs),
4023 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4024 PerlIOPending_pushed,
4027 PerlIOBase_binmode, /* binmode */
4036 PerlIOPending_close,
4037 PerlIOPending_flush,
4041 PerlIOBase_clearerr,
4042 PerlIOBase_setlinebuf,
4047 PerlIOPending_set_ptrcnt,
4052 /*--------------------------------------------------------------------------------------*/
4054 * crlf - translation On read translate CR,LF to "\n" we do this by
4055 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4056 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4060 PerlIOBuf base; /* PerlIOBuf stuff */
4061 STDCHAR *nl; /* Position of crlf we "lied" about in the
4066 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4069 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4070 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4072 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4073 f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4074 PerlIOBase(f)->flags);
4077 /* Enable the first CRLF capable layer you can find, but if none
4078 * found, the one we just pushed is fine. This results in at
4079 * any given moment at most one CRLF-capable layer being enabled
4080 * in the whole layer stack. */
4081 PerlIO *g = PerlIONext(f);
4083 PerlIOl *b = PerlIOBase(g);
4084 if (b && b->tab == &PerlIO_crlf) {
4085 if (!(b->flags & PERLIO_F_CRLF))
4086 b->flags |= PERLIO_F_CRLF;
4087 PerlIO_pop(aTHX_ f);
4098 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4100 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4105 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4106 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4108 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4109 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4111 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4116 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4117 b->end = b->ptr = b->buf + b->bufsiz;
4118 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4119 b->posn -= b->bufsiz;
4121 while (count > 0 && b->ptr > b->buf) {
4124 if (b->ptr - 2 >= b->buf) {
4147 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4149 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4152 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4153 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4154 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4155 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4157 while (nl < b->end && *nl != 0xd)
4159 if (nl < b->end && *nl == 0xd) {
4161 if (nl + 1 < b->end) {
4168 * Not CR,LF but just CR
4176 * Blast - found CR as last char in buffer
4181 * They may not care, defer work as long as
4185 return (nl - b->ptr);
4189 b->ptr++; /* say we have read it as far as
4190 * flush() is concerned */
4191 b->buf++; /* Leave space in front of buffer */
4192 /* Note as we have moved buf up flush's
4194 will naturally make posn point at CR
4196 b->bufsiz--; /* Buffer is thus smaller */
4197 code = PerlIO_fill(f); /* Fetch some more */
4198 b->bufsiz++; /* Restore size for next time */
4199 b->buf--; /* Point at space */
4200 b->ptr = nl = b->buf; /* Which is what we hand
4202 *nl = 0xd; /* Fill in the CR */
4204 goto test; /* fill() call worked */
4206 * CR at EOF - just fall through
4208 /* Should we clear EOF though ??? */
4213 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4219 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4221 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4222 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4228 if (ptr == b->end && *c->nl == 0xd) {
4229 /* Defered CR at end of buffer case - we lied about count */
4241 * Test code - delete when it works ...
4243 IV flags = PerlIOBase(f)->flags;
4244 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4245 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4246 /* Defered CR at end of buffer case - we lied about count */
4252 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4253 " nl=%p e=%p for %d", ptr, chk, flags, c->nl,
4261 * They have taken what we lied about
4269 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4273 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4275 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4276 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4278 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4279 const STDCHAR *buf = (const STDCHAR *) vbuf;
4280 const STDCHAR *ebuf = buf + count;
4283 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4285 while (buf < ebuf) {
4286 STDCHAR *eptr = b->buf + b->bufsiz;
4287 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4288 while (buf < ebuf && b->ptr < eptr) {
4290 if ((b->ptr + 2) > eptr) {
4298 *(b->ptr)++ = 0xd; /* CR */
4299 *(b->ptr)++ = 0xa; /* LF */
4301 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4311 if (b->ptr >= eptr) {
4317 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4319 return (buf - (STDCHAR *) vbuf);
4324 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4326 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4331 return PerlIOBuf_flush(aTHX_ f);
4335 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4337 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4338 /* In text mode - flush any pending stuff and flip it */
4339 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4340 #ifndef PERLIO_USING_CRLF
4341 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4342 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4343 PerlIO_pop(aTHX_ f);
4350 PerlIO_funcs PerlIO_crlf = {
4351 sizeof(PerlIO_funcs),
4354 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4356 PerlIOBuf_popped, /* popped */
4358 PerlIOCrlf_binmode, /* binmode */
4362 PerlIOBuf_read, /* generic read works with ptr/cnt lies
4364 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4365 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4373 PerlIOBase_clearerr,
4374 PerlIOBase_setlinebuf,
4379 PerlIOCrlf_set_ptrcnt,
4383 /*--------------------------------------------------------------------------------------*/
4385 * mmap as "buffer" layer
4389 PerlIOBuf base; /* PerlIOBuf stuff */
4390 Mmap_t mptr; /* Mapped address */
4391 Size_t len; /* mapped length */
4392 STDCHAR *bbuf; /* malloced buffer if map fails */
4395 static size_t page_size = 0;
4398 PerlIOMmap_map(pTHX_ PerlIO *f)
4400 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4401 IV flags = PerlIOBase(f)->flags;
4405 if (flags & PERLIO_F_CANREAD) {
4406 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4407 int fd = PerlIO_fileno(f);
4409 code = Fstat(fd, &st);
4410 if (code == 0 && S_ISREG(st.st_mode)) {
4411 SSize_t len = st.st_size - b->posn;
4415 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_PAGE_SIZE))
4417 SETERRNO(0, SS_NORMAL);
4418 # ifdef _SC_PAGESIZE
4419 page_size = sysconf(_SC_PAGESIZE);
4421 page_size = sysconf(_SC_PAGE_SIZE);
4423 if ((long) page_size < 0) {
4428 (void) SvUPGRADE(error, SVt_PV);
4429 msg = SvPVx(error, n_a);
4430 Perl_croak(aTHX_ "panic: sysconf: %s",
4435 "panic: sysconf: pagesize unknown");
4439 # ifdef HAS_GETPAGESIZE
4440 page_size = getpagesize();
4442 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
4443 page_size = PAGESIZE; /* compiletime, bad */
4447 if ((IV) page_size <= 0)
4448 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4453 * This is a hack - should never happen - open should
4456 b->posn = PerlIO_tell(PerlIONext(f));
4458 posn = (b->posn / page_size) * page_size;
4459 len = st.st_size - posn;
4460 m->mptr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4461 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4462 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4463 madvise(m->mptr, len, MADV_SEQUENTIAL);
4465 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4466 madvise(m->mptr, len, MADV_WILLNEED);
4468 PerlIOBase(f)->flags =
4469 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4470 b->end = ((STDCHAR *) m->mptr) + len;
4471 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4480 PerlIOBase(f)->flags =
4481 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4483 b->ptr = b->end = b->ptr;
4492 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4494 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4495 PerlIOBuf *b = &m->base;
4499 code = munmap(m->mptr, m->len);
4503 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4506 b->ptr = b->end = b->buf;
4507 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4513 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4515 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4516 PerlIOBuf *b = &m->base;
4517 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4519 * Already have a readbuffer in progress
4525 * We have a write buffer or flushed PerlIOBuf read buffer
4527 m->bbuf = b->buf; /* save it in case we need it again */
4528 b->buf = NULL; /* Clear to trigger below */
4531 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4534 * Map did not work - recover PerlIOBuf buffer if we have one
4539 b->ptr = b->end = b->buf;
4542 return PerlIOBuf_get_base(aTHX_ f);
4546 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4548 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4549 PerlIOBuf *b = &m->base;
4550 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4552 if (b->ptr && (b->ptr - count) >= b->buf
4553 && memEQ(b->ptr - count, vbuf, count)) {
4555 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4560 * Loose the unwritable mapped buffer
4564 * If flush took the "buffer" see if we have one from before
4566 if (!b->buf && m->bbuf)
4569 PerlIOBuf_get_base(aTHX_ f);
4573 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4577 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4579 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4580 PerlIOBuf *b = &m->base;
4581 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4583 * No, or wrong sort of, buffer
4586 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4590 * If unmap took the "buffer" see if we have one from before
4592 if (!b->buf && m->bbuf)
4595 PerlIOBuf_get_base(aTHX_ f);
4599 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4603 PerlIOMmap_flush(pTHX_ PerlIO *f)
4605 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4606 PerlIOBuf *b = &m->base;
4607 IV code = PerlIOBuf_flush(aTHX_ f);
4609 * Now we are "synced" at PerlIOBuf level
4616 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4621 * We seem to have a PerlIOBuf buffer which was not mapped
4622 * remember it in case we need one later
4631 PerlIOMmap_fill(pTHX_ PerlIO *f)
4633 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4634 IV code = PerlIO_flush(f);
4635 if (code == 0 && !b->buf) {
4636 code = PerlIOMmap_map(aTHX_ f);
4638 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4639 code = PerlIOBuf_fill(aTHX_ f);
4645 PerlIOMmap_close(pTHX_ PerlIO *f)
4647 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4648 PerlIOBuf *b = &m->base;
4649 IV code = PerlIO_flush(f);
4653 b->ptr = b->end = b->buf;
4655 if (PerlIOBuf_close(aTHX_ f) != 0)
4661 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4663 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4667 PerlIO_funcs PerlIO_mmap = {
4668 sizeof(PerlIO_funcs),
4671 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4675 PerlIOBase_binmode, /* binmode */
4689 PerlIOBase_clearerr,
4690 PerlIOBase_setlinebuf,
4691 PerlIOMmap_get_base,
4695 PerlIOBuf_set_ptrcnt,
4698 #endif /* HAS_MMAP */
4701 Perl_PerlIO_stdin(pTHX)
4704 PerlIO_stdstreams(aTHX);
4706 return &PL_perlio[1];
4710 Perl_PerlIO_stdout(pTHX)
4713 PerlIO_stdstreams(aTHX);
4715 return &PL_perlio[2];
4719 Perl_PerlIO_stderr(pTHX)
4722 PerlIO_stdstreams(aTHX);
4724 return &PL_perlio[3];
4727 /*--------------------------------------------------------------------------------------*/
4730 PerlIO_getname(PerlIO *f, char *buf)
4735 bool exported = FALSE;
4736 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4738 stdio = PerlIO_exportFILE(f,0);
4742 name = fgetname(stdio, buf);
4743 if (exported) PerlIO_releaseFILE(f,stdio);
4746 Perl_croak(aTHX_ "Don't know how to get file name");
4752 /*--------------------------------------------------------------------------------------*/
4754 * Functions which can be called on any kind of PerlIO implemented in
4758 #undef PerlIO_fdopen
4760 PerlIO_fdopen(int fd, const char *mode)
4763 return PerlIO_openn(aTHX_ Nullch, mode, fd, 0, 0, NULL, 0, NULL);
4768 PerlIO_open(const char *path, const char *mode)
4771 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4772 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, NULL, 1, &name);
4775 #undef Perlio_reopen
4777 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4780 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4781 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, f, 1, &name);
4786 PerlIO_getc(PerlIO *f)
4790 SSize_t count = PerlIO_read(f, buf, 1);
4792 return (unsigned char) buf[0];
4797 #undef PerlIO_ungetc
4799 PerlIO_ungetc(PerlIO *f, int ch)
4804 if (PerlIO_unread(f, &buf, 1) == 1)
4812 PerlIO_putc(PerlIO *f, int ch)
4816 return PerlIO_write(f, &buf, 1);
4821 PerlIO_puts(PerlIO *f, const char *s)
4824 STRLEN len = strlen(s);
4825 return PerlIO_write(f, s, len);
4828 #undef PerlIO_rewind
4830 PerlIO_rewind(PerlIO *f)
4833 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4837 #undef PerlIO_vprintf
4839 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4842 SV *sv = newSVpvn("", 0);
4848 Perl_va_copy(ap, apc);
4849 sv_vcatpvf(sv, fmt, &apc);
4851 sv_vcatpvf(sv, fmt, &ap);
4854 wrote = PerlIO_write(f, s, len);
4859 #undef PerlIO_printf
4861 PerlIO_printf(PerlIO *f, const char *fmt, ...)
4866 result = PerlIO_vprintf(f, fmt, ap);
4871 #undef PerlIO_stdoutf
4873 PerlIO_stdoutf(const char *fmt, ...)
4879 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
4884 #undef PerlIO_tmpfile
4886 PerlIO_tmpfile(void)
4894 f = PerlIO_fdopen(fd, "w+b");
4896 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
4897 SV *sv = newSVpv("/tmp/PerlIO_XXXXXX", 0);
4900 * I have no idea how portable mkstemp() is ... NI-S
4902 fd = mkstemp(SvPVX(sv));
4904 f = PerlIO_fdopen(fd, "w+");
4906 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
4907 PerlLIO_unlink(SvPVX(sv));
4910 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
4911 FILE *stdio = PerlSIO_tmpfile();
4914 if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)),
4915 &PerlIO_stdio, "w+", Nullsv))) {
4916 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
4922 # endif /* else HAS_MKSTEMP */
4923 #endif /* else WIN32 */
4930 #endif /* USE_SFIO */
4931 #endif /* PERLIO_IS_STDIO */
4933 /*======================================================================================*/
4935 * Now some functions in terms of above which may be needed even if we are
4936 * not in true PerlIO mode
4940 #undef PerlIO_setpos
4942 PerlIO_setpos(PerlIO *f, SV *pos)
4947 Off_t *posn = (Off_t *) SvPV(pos, len);
4948 if (f && len == sizeof(Off_t))
4949 return PerlIO_seek(f, *posn, SEEK_SET);
4951 SETERRNO(EINVAL, SS_IVCHAN);
4955 #undef PerlIO_setpos
4957 PerlIO_setpos(PerlIO *f, SV *pos)
4962 Fpos_t *fpos = (Fpos_t *) SvPV(pos, len);
4963 if (f && len == sizeof(Fpos_t)) {
4964 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4965 return fsetpos64(f, fpos);
4967 return fsetpos(f, fpos);
4971 SETERRNO(EINVAL, SS_IVCHAN);
4977 #undef PerlIO_getpos
4979 PerlIO_getpos(PerlIO *f, SV *pos)
4982 Off_t posn = PerlIO_tell(f);
4983 sv_setpvn(pos, (char *) &posn, sizeof(posn));
4984 return (posn == (Off_t) - 1) ? -1 : 0;
4987 #undef PerlIO_getpos
4989 PerlIO_getpos(PerlIO *f, SV *pos)
4994 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4995 code = fgetpos64(f, &fpos);
4997 code = fgetpos(f, &fpos);
4999 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
5004 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
5007 vprintf(char *pat, char *args)
5009 _doprnt(pat, args, stdout);
5010 return 0; /* wrong, but perl doesn't use the return
5015 vfprintf(FILE *fd, char *pat, char *args)
5017 _doprnt(pat, args, fd);
5018 return 0; /* wrong, but perl doesn't use the return
5024 #ifndef PerlIO_vsprintf
5026 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5028 int val = vsprintf(s, fmt, ap);
5030 if (strlen(s) >= (STRLEN) n) {
5032 (void) PerlIO_puts(Perl_error_log,
5033 "panic: sprintf overflow - memory corrupted!\n");
5041 #ifndef PerlIO_sprintf
5043 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5048 result = PerlIO_vsprintf(s, n, fmt, ap);