2 * perlio.c Copyright (c) 1996-2002, 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.
13 * If we have ActivePerl-like PERL_IMPLICIT_SYS then we need a dTHX to get
14 * at the dispatch tables, even when we do not need it for other reasons.
15 * Invent a dSYS macro to abstract this out
17 #ifdef PERL_IMPLICIT_SYS
30 #define PERLIO_NOT_STDIO 0
31 #if !defined(PERLIO_IS_STDIO) && !defined(USE_SFIO)
37 * This file provides those parts of PerlIO abstraction
38 * which are not #defined in perlio.h.
39 * Which these are depends on various Configure #ifdef's
43 #define PERL_IN_PERLIO_C
46 #ifdef PERL_IMPLICIT_CONTEXT
53 /* Call the callback or PerlIOBase, and return failure. */
54 #define Perl_PerlIO_or_Base(f, callback, base, failure, args) \
55 if (PerlIOValid(f)) { \
56 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
57 if (tab && tab->callback) \
58 return (*tab->callback) args; \
60 return PerlIOBase_ ## base args; \
63 SETERRNO(EBADF, SS_IVCHAN); \
66 /* Call the callback or fail, and return failure. */
67 #define Perl_PerlIO_or_fail(f, callback, failure, args) \
68 if (PerlIOValid(f)) { \
69 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
70 if (tab && tab->callback) \
71 return (*tab->callback) args; \
72 SETERRNO(EINVAL, LIB_INVARG); \
75 SETERRNO(EBADF, SS_IVCHAN); \
78 /* Call the callback or PerlIOBase, and be void. */
79 #define Perl_PerlIO_or_Base_void(f, callback, base, args) \
80 if (PerlIOValid(f)) { \
81 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
82 if (tab && tab->callback) \
83 (*tab->callback) args; \
85 PerlIOBase_ ## base args; \
88 SETERRNO(EBADF, SS_IVCHAN)
90 /* Call the callback or fail, and be void. */
91 #define Perl_PerlIO_or_fail_void(f, callback, args) \
92 if (PerlIOValid(f)) { \
93 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
94 if (tab && tab->callback) \
95 (*tab->callback) args; \
97 SETERRNO(EINVAL, LIB_INVARG); \
100 SETERRNO(EBADF, SS_IVCHAN)
103 perlsio_binmode(FILE *fp, int iotype, int mode)
106 * This used to be contents of do_binmode in doio.c
109 # if defined(atarist) || defined(__MINT__)
112 ((FILE *) fp)->_flag |= _IOBIN;
114 ((FILE *) fp)->_flag &= ~_IOBIN;
121 if (PerlLIO_setmode(fp, mode) != -1) {
123 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
125 # if defined(WIN32) && defined(__BORLANDC__)
127 * The translation mode of the stream is maintained independent of
128 * the translation mode of the fd in the Borland RTL (heavy
129 * digging through their runtime sources reveal). User has to set
130 * the mode explicitly for the stream (though they don't document
131 * this anywhere). GSAR 97-5-24
137 fp->flags &= ~_F_BIN;
145 # if defined(USEMYBINMODE)
147 if (my_binmode(fp, iotype, mode) != FALSE)
158 #define O_ACCMODE 3 /* Assume traditional implementation */
162 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
164 int result = rawmode & O_ACCMODE;
169 ptype = IoTYPE_RDONLY;
172 ptype = IoTYPE_WRONLY;
180 *writing = (result != O_RDONLY);
182 if (result == O_RDONLY) {
186 else if (rawmode & O_APPEND) {
188 if (result != O_WRONLY)
193 if (result == O_WRONLY)
200 if (rawmode & O_BINARY)
206 #ifndef PERLIO_LAYERS
208 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
210 if (!names || !*names || strEQ(names, ":crlf")
211 || strEQ(names, ":raw")
212 || strEQ(names, ":bytes")
216 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
224 PerlIO_destruct(pTHX)
229 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
234 return perlsio_binmode(fp, iotype, mode);
239 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
244 #ifdef PERL_IMPLICIT_SYS
245 return PerlSIO_fdupopen(f);
248 return win32_fdupopen(f);
251 int fd = PerlLIO_dup(PerlIO_fileno(f));
254 int omode = fcntl(fd, F_GETFL);
256 omode = djgpp_get_stream_mode(f);
258 PerlIO_intmode2str(omode, mode, NULL);
259 /* the r+ is a hack */
260 return PerlIO_fdopen(fd, mode);
265 SETERRNO(EBADF, SS_IVCHAN);
275 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
279 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
280 int imode, int perm, PerlIO *old, int narg, SV **args)
284 Perl_croak(aTHX_ "More than one argument to open");
286 if (*args == &PL_sv_undef)
287 return PerlIO_tmpfile();
289 char *name = SvPV_nolen(*args);
291 fd = PerlLIO_open3(name, imode, perm);
293 return PerlIO_fdopen(fd, (char *) mode + 1);
296 return PerlIO_reopen(name, mode, old);
299 return PerlIO_open(name, mode);
304 return PerlIO_fdopen(fd, (char *) mode);
309 XS(XS_PerlIO__Layer__find)
313 Perl_croak(aTHX_ "Usage class->find(name[,load])");
315 char *name = SvPV_nolen(ST(1));
316 ST(0) = (strEQ(name, "crlf")
317 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
324 Perl_boot_core_PerlIO(pTHX)
326 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
332 #ifdef PERLIO_IS_STDIO
338 * Does nothing (yet) except force this file to be included in perl
339 * binary. That allows this file to force inclusion of other functions
340 * that may be required by loadable extensions e.g. for
341 * FileHandle::tmpfile
345 #undef PerlIO_tmpfile
352 #else /* PERLIO_IS_STDIO */
360 * This section is just to make sure these functions get pulled in from
364 #undef PerlIO_tmpfile
375 * Force this file to be included in perl binary. Which allows this
376 * file to force inclusion of other functions that may be required by
377 * loadable extensions e.g. for FileHandle::tmpfile
381 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
382 * results in a lot of lseek()s to regular files and lot of small
385 sfset(sfstdout, SF_SHARE, 0);
388 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
390 PerlIO_importFILE(FILE *stdio, const char *mode)
392 int fd = fileno(stdio);
393 if (!mode || !*mode) {
396 return PerlIO_fdopen(fd, mode);
400 PerlIO_findFILE(PerlIO *pio)
402 int fd = PerlIO_fileno(pio);
403 FILE *f = fdopen(fd, "r+");
405 if (!f && errno == EINVAL)
407 if (!f && errno == EINVAL)
414 /*======================================================================================*/
416 * Implement all the PerlIO interface ourselves.
422 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
429 #include <sys/mman.h>
434 PerlIO_debug(const char *fmt, ...)
441 char *s = PerlEnv_getenv("PERLIO_DEBUG");
443 dbg = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
450 /* Use fixed buffer as sv_catpvf etc. needs SVs */
454 s = CopFILE(PL_curcop);
457 sprintf(buffer, "%s:%" IVdf " ", s, (IV) CopLINE(PL_curcop));
458 len = strlen(buffer);
459 vsprintf(buffer + len, fmt, ap);
460 PerlLIO_write(dbg, buffer, strlen(buffer));
462 SV *sv = newSVpvn("", 0);
465 s = CopFILE(PL_curcop);
468 Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s,
469 (IV) CopLINE(PL_curcop));
470 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
473 PerlLIO_write(dbg, s, len);
480 /*--------------------------------------------------------------------------------------*/
483 * Inner level routines
487 * Table of pointers to the PerlIO structs (malloc'ed)
489 #define PERLIO_TABLE_SIZE 64
492 PerlIO_allocate(pTHX)
495 * Find a free slot in the table, allocating new table as necessary
500 while ((f = *last)) {
502 last = (PerlIO **) (f);
503 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
509 Newz('I', f, PERLIO_TABLE_SIZE, PerlIO);
517 #undef PerlIO_fdupopen
519 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
521 if (PerlIOValid(f)) {
522 PerlIO_funcs *tab = PerlIOBase(f)->tab;
523 PerlIO_debug("fdupopen f=%p param=%p\n", (void *) f,
526 return (*tab->Dup) (aTHX_ PerlIO_allocate(aTHX), f, param,
529 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param,
534 SETERRNO(EBADF, SS_IVCHAN);
540 PerlIO_cleantable(pTHX_ PerlIO **tablep)
542 PerlIO *table = *tablep;
545 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
546 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
547 PerlIO *f = table + i;
559 PerlIO_list_alloc(pTHX)
562 Newz('L', list, 1, PerlIO_list_t);
568 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
571 if (--list->refcnt == 0) {
574 for (i = 0; i < list->cur; i++) {
575 if (list->array[i].arg)
576 SvREFCNT_dec(list->array[i].arg);
578 Safefree(list->array);
586 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
589 if (list->cur >= list->len) {
592 Renew(list->array, list->len, PerlIO_pair_t);
594 New('l', list->array, list->len, PerlIO_pair_t);
596 p = &(list->array[list->cur++]);
598 if ((p->arg = arg)) {
604 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
606 PerlIO_list_t *list = (PerlIO_list_t *) NULL;
609 list = PerlIO_list_alloc(aTHX);
610 for (i = 0; i < proto->cur; i++) {
612 if (proto->array[i].arg)
613 arg = PerlIO_sv_dup(aTHX_ proto->array[i].arg, param);
614 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
621 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
624 PerlIO **table = &proto->Iperlio;
627 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
629 PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
630 PerlIO_allocate(aTHX); /* root slot is never used */
631 PerlIO_debug("Clone %p from %p\n", aTHX, proto);
632 while ((f = *table)) {
634 table = (PerlIO **) (f++);
635 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
637 (void) fp_dup(f, 0, param);
646 PerlIO_destruct(pTHX)
648 PerlIO **table = &PL_perlio;
651 PerlIO_debug("Destruct %p\n", aTHX);
653 while ((f = *table)) {
655 table = (PerlIO **) (f++);
656 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
660 if (l->tab->kind & PERLIO_K_DESTRUCT) {
661 PerlIO_debug("Destruct popping %s\n", l->tab->name);
675 PerlIO_pop(pTHX_ PerlIO *f)
679 PerlIO_debug("PerlIO_pop f=%p %s\n", (void *) f, l->tab->name);
680 if (l->tab->Popped) {
682 * If popped returns non-zero do not free its layer structure
683 * it has either done so itself, or it is shared and still in
686 if ((*l->tab->Popped) (aTHX_ f) != 0)
694 /* Return as an array the stack of layers on a filehandle. Note that
695 * the stack is returned top-first in the array, and there are three
696 * times as many array elements as there are layers in the stack: the
697 * first element of a layer triplet is the name, the second one is the
698 * arguments, and the third one is the flags. */
701 PerlIO_get_layers(pTHX_ PerlIO *f)
705 if (PerlIOValid(f)) {
706 PerlIOl *l = PerlIOBase(f);
709 SV *name = l->tab && l->tab->name ?
710 newSVpv(l->tab->name, 0) : &PL_sv_undef;
711 SV *arg = l->tab && l->tab->Getarg ?
712 (*l->tab->Getarg) (aTHX_ & l, 0, 0) : &PL_sv_undef;
715 av_push(av, newSViv((IV) l->flags));
723 /*--------------------------------------------------------------------------------------*/
725 * XS Interface for perl code
729 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
732 if ((SSize_t) len <= 0)
734 for (i = 0; i < PL_known_layers->cur; i++) {
735 PerlIO_funcs *f = PL_known_layers->array[i].funcs;
736 if (memEQ(f->name, name, len)) {
737 PerlIO_debug("%.*s => %p\n", (int) len, name, (void *) f);
741 if (load && PL_subname && PL_def_layerlist
742 && PL_def_layerlist->cur >= 2) {
743 if (PL_in_load_module) {
745 "Recursive call to Perl_load_module in PerlIO_find_layer");
749 SV *pkgsv = newSVpvn("PerlIO", 6);
750 SV *layer = newSVpvn(name, len);
751 CV *cv = get_cv("PerlIO::Layer::NoWarnings", FALSE);
753 SAVEINT(PL_in_load_module);
755 SAVESPTR(PL_warnhook);
756 PL_warnhook = (SV *) cv;
760 * The two SVs are magically freed by load_module
762 Perl_load_module(aTHX_ 0, pkgsv, Nullsv, layer, Nullsv);
765 return PerlIO_find_layer(aTHX_ name, len, 0);
768 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
772 #ifdef USE_ATTRIBUTES_FOR_PERLIO
775 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
778 IO *io = GvIOn((GV *) SvRV(sv));
779 PerlIO *ifp = IoIFP(io);
780 PerlIO *ofp = IoOFP(io);
781 Perl_warn(aTHX_ "set %" SVf " %p %p %p", sv, io, ifp, ofp);
787 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
790 IO *io = GvIOn((GV *) SvRV(sv));
791 PerlIO *ifp = IoIFP(io);
792 PerlIO *ofp = IoOFP(io);
793 Perl_warn(aTHX_ "get %" SVf " %p %p %p", sv, io, ifp, ofp);
799 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
801 Perl_warn(aTHX_ "clear %" SVf, sv);
806 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
808 Perl_warn(aTHX_ "free %" SVf, sv);
812 MGVTBL perlio_vtab = {
820 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
823 SV *sv = SvRV(ST(1));
828 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
830 mg = mg_find(sv, PERL_MAGIC_ext);
831 mg->mg_virtual = &perlio_vtab;
833 Perl_warn(aTHX_ "attrib %" SVf, sv);
834 for (i = 2; i < items; i++) {
836 const char *name = SvPV(ST(i), len);
837 SV *layer = PerlIO_find_layer(aTHX_ name, len, 1);
839 av_push(av, SvREFCNT_inc(layer));
850 #endif /* USE_ATTIBUTES_FOR_PERLIO */
853 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
855 HV *stash = gv_stashpv("PerlIO::Layer", TRUE);
856 SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
860 XS(XS_PerlIO__Layer__NoWarnings)
862 /* This is used as a %SIG{__WARN__} handler to supress warnings
863 during loading of layers.
867 PerlIO_debug("warning:%s\n", SvPV_nolen(ST(0)));
871 XS(XS_PerlIO__Layer__find)
875 Perl_croak(aTHX_ "Usage class->find(name[,load])");
878 char *name = SvPV(ST(1), len);
879 bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
880 PerlIO_funcs *layer = PerlIO_find_layer(aTHX_ name, len, load);
882 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
889 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
891 if (!PL_known_layers)
892 PL_known_layers = PerlIO_list_alloc(aTHX);
893 PerlIO_list_push(aTHX_ PL_known_layers, tab, Nullsv);
894 PerlIO_debug("define %s %p\n", tab->name, (void *) tab);
898 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
901 const char *s = names;
903 while (isSPACE(*s) || *s == ':')
908 const char *as = Nullch;
910 if (!isIDFIRST(*s)) {
912 * Message is consistent with how attribute lists are
913 * passed. Even though this means "foo : : bar" is
914 * seen as an invalid separator character.
916 char q = ((*s == '\'') ? '"' : '\'');
917 if (ckWARN(WARN_LAYER))
918 Perl_warner(aTHX_ packWARN(WARN_LAYER),
919 "perlio: invalid separator character %c%c%c in layer specification list %s",
921 SETERRNO(EINVAL, LIB_INVARG);
926 } while (isALNUM(*e));
942 * It's a nul terminated string, not allowed
943 * to \ the terminating null. Anything other
944 * character is passed over.
954 if (ckWARN(WARN_LAYER))
955 Perl_warner(aTHX_ packWARN(WARN_LAYER),
956 "perlio: argument list not closed for layer \"%.*s\"",
968 bool warn_layer = ckWARN(WARN_LAYER);
969 PerlIO_funcs *layer =
970 PerlIO_find_layer(aTHX_ s, llen, 1);
972 PerlIO_list_push(aTHX_ av, layer,
979 Perl_warner(aTHX_ packWARN(WARN_LAYER),
980 "perlio: unknown layer \"%.*s\"",
993 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
995 PerlIO_funcs *tab = &PerlIO_perlio;
996 #ifdef PERLIO_USING_CRLF
999 if (PerlIO_stdio.Set_ptrcnt)
1000 tab = &PerlIO_stdio;
1002 PerlIO_debug("Pushing %s\n", tab->name);
1003 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1008 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1010 return av->array[n].arg;
1014 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1016 if (n >= 0 && n < av->cur) {
1017 PerlIO_debug("Layer %" IVdf " is %s\n", n,
1018 av->array[n].funcs->name);
1019 return av->array[n].funcs;
1022 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1027 PerlIO_syslayer(pTHX_ PerlIO *f)
1029 if (PerlIOValid(f)) {
1031 while (*PerlIONext(f)) {
1036 Perl_warn(aTHX_ "syslayer %s", l->tab->name);
1041 SETERRNO(EBADF, SS_IVCHAN);
1048 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg,
1051 if (PerlIOValid(f)) {
1053 PerlIO_pop(aTHX_ f);
1059 PerlIO_funcs PerlIO_remove = {
1060 sizeof(PerlIO_funcs),
1063 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1081 NULL, /* get_base */
1082 NULL, /* get_bufsiz */
1085 NULL, /* set_ptrcnt */
1089 PerlIO_default_layers(pTHX)
1091 if (!PL_def_layerlist) {
1092 const char *s = (PL_tainting) ? Nullch : PerlEnv_getenv("PERLIO");
1093 PerlIO_funcs *osLayer = &PerlIO_unix;
1094 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1095 PerlIO_define_layer(aTHX_ & PerlIO_unix);
1096 #if defined(WIN32) && !defined(UNDER_CE)
1097 PerlIO_define_layer(aTHX_ & PerlIO_win32);
1099 osLayer = &PerlIO_win32;
1102 PerlIO_define_layer(aTHX_ & PerlIO_raw);
1103 PerlIO_define_layer(aTHX_ & PerlIO_perlio);
1104 PerlIO_define_layer(aTHX_ & PerlIO_stdio);
1105 PerlIO_define_layer(aTHX_ & PerlIO_crlf);
1107 PerlIO_define_layer(aTHX_ & PerlIO_mmap);
1109 PerlIO_define_layer(aTHX_ & PerlIO_utf8);
1110 PerlIO_define_layer(aTHX_ & PerlIO_remove);
1111 PerlIO_define_layer(aTHX_ & PerlIO_byte);
1112 PerlIO_list_push(aTHX_ PL_def_layerlist,
1113 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1116 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1119 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1122 if (PL_def_layerlist->cur < 2) {
1123 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1125 return PL_def_layerlist;
1129 Perl_boot_core_PerlIO(pTHX)
1131 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1132 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1135 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1136 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings,
1141 PerlIO_default_layer(pTHX_ I32 n)
1143 PerlIO_list_t *av = PerlIO_default_layers(aTHX);
1146 return PerlIO_layer_fetch(aTHX_ av, n, &PerlIO_stdio);
1149 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1150 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1153 PerlIO_stdstreams(pTHX)
1156 PerlIO_allocate(aTHX);
1157 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1158 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1159 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1164 PerlIO_push(pTHX_ PerlIO *f, PerlIO_funcs *tab, const char *mode, SV *arg)
1166 if (tab->fsize != sizeof(PerlIO_funcs)) {
1168 Perl_croak(aTHX_ "Layer does not match this perl");
1172 if (tab->size < sizeof(PerlIOl)) {
1175 /* Real layer with a data area */
1176 Newc('L', l, tab->size, char, PerlIOl);
1178 Zero(l, tab->size, char);
1182 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void *) f,
1183 tab->name, (mode) ? mode : "(Null)",
1186 && (*l->tab->Pushed) (aTHX_ f, mode, arg, tab) != 0) {
1187 PerlIO_pop(aTHX_ f);
1193 /* Pseudo-layer where push does its own stack adjust */
1194 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void *) f, tab->name,
1195 (mode) ? mode : "(Null)", (void *) arg);
1196 if (tab->Pushed && (*tab->Pushed) (aTHX_ f, mode, arg, tab) != 0) {
1204 PerlIOBase_binmode(pTHX_ PerlIO *f)
1206 if (PerlIOValid(f)) {
1207 /* Is layer suitable for raw stream ? */
1208 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1209 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1210 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1213 /* Not suitable - pop it */
1214 PerlIO_pop(aTHX_ f);
1222 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg,
1226 if (PerlIOValid(f)) {
1231 * Strip all layers that are not suitable for a raw stream
1234 while (t && (l = *t)) {
1235 if (l->tab->Binmode) {
1236 /* Has a handler - normal case */
1237 if ((*l->tab->Binmode) (aTHX_ f) == 0) {
1239 /* Layer still there - move down a layer */
1248 /* No handler - pop it */
1249 PerlIO_pop(aTHX_ t);
1252 if (PerlIOValid(f)) {
1253 PerlIO_debug(":raw f=%p :%s\n", (void *) f,
1254 PerlIOBase(f)->tab->name);
1262 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1263 PerlIO_list_t *layers, IV n, IV max)
1267 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1269 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1280 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1284 PerlIO_list_t *layers = PerlIO_list_alloc(aTHX);
1285 code = PerlIO_parse_layers(aTHX_ layers, names);
1288 PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1290 PerlIO_list_free(aTHX_ layers);
1296 /*--------------------------------------------------------------------------------------*/
1298 * Given the abstraction above the public API functions
1302 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1304 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n",
1305 (void *) f, PerlIOBase(f)->tab->name, iotype, mode,
1306 (names) ? names : "(Null)");
1308 /* Do not flush etc. if (e.g.) switching encodings.
1309 if a pushed layer knows it needs to flush lower layers
1310 (for example :unix which is never going to call them)
1311 it can do the flush when it is pushed.
1313 return PerlIO_apply_layers(aTHX_ f, NULL,
1314 names) == 0 ? TRUE : FALSE;
1317 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1318 #ifdef PERLIO_USING_CRLF
1319 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1320 O_BINARY so we can look for it in mode.
1322 if (!(mode & O_BINARY)) {
1324 /* FIXME?: Looking down the layer stack seems wrong,
1325 but is a way of reaching past (say) an encoding layer
1326 to flip CRLF-ness of the layer(s) below
1329 /* Perhaps we should turn on bottom-most aware layer
1330 e.g. Ilya's idea that UNIX TTY could serve
1332 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1333 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1334 /* Not in text mode - flush any pending stuff and flip it */
1336 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1338 /* Only need to turn it on in one layer so we are done */
1343 /* Not finding a CRLF aware layer presumably means we are binary
1344 which is not what was requested - so we failed
1345 We _could_ push :crlf layer but so could caller
1350 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1351 So code that used to be here is now in PerlIORaw_pushed().
1353 return PerlIO_push(aTHX_ f, &PerlIO_raw, Nullch,
1354 Nullsv) ? TRUE : FALSE;
1359 PerlIO__close(pTHX_ PerlIO *f)
1361 if (PerlIOValid(f)) {
1362 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1363 if (tab && tab->Close)
1364 return (*tab->Close) (aTHX_ f);
1366 return PerlIOBase_close(aTHX_ f);
1369 SETERRNO(EBADF, SS_IVCHAN);
1375 Perl_PerlIO_close(pTHX_ PerlIO *f)
1377 int code = PerlIO__close(aTHX_ f);
1378 while (PerlIOValid(f)) {
1379 PerlIO_pop(aTHX_ f);
1385 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1387 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1391 PerlIO_context_layers(pTHX_ const char *mode)
1393 const char *type = NULL;
1395 * Need to supply default layer info from open.pm
1398 SV *layers = PL_curcop->cop_io;
1401 type = SvPV(layers, len);
1402 if (type && mode[0] != 'r') {
1404 * Skip to write part
1406 const char *s = strchr(type, 0);
1407 if (s && (STRLEN) (s - type) < len) {
1416 static PerlIO_funcs *
1417 PerlIO_layer_from_ref(pTHX_ SV *sv)
1420 * For any scalar type load the handler which is bundled with perl
1422 if (SvTYPE(sv) < SVt_PVAV)
1423 return PerlIO_find_layer(aTHX_ "scalar", 6, 1);
1426 * For other types allow if layer is known but don't try and load it
1428 switch (SvTYPE(sv)) {
1430 return PerlIO_find_layer(aTHX_ "Array", 5, 0);
1432 return PerlIO_find_layer(aTHX_ "Hash", 4, 0);
1434 return PerlIO_find_layer(aTHX_ "Code", 4, 0);
1436 return PerlIO_find_layer(aTHX_ "Glob", 4, 0);
1442 PerlIO_resolve_layers(pTHX_ const char *layers,
1443 const char *mode, int narg, SV **args)
1445 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1448 PerlIO_stdstreams(aTHX);
1452 * If it is a reference but not an object see if we have a handler
1455 if (SvROK(arg) && !sv_isobject(arg)) {
1456 PerlIO_funcs *handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1458 def = PerlIO_list_alloc(aTHX);
1459 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1463 * Don't fail if handler cannot be found :via(...) etc. may do
1464 * something sensible else we will just stringfy and open
1470 layers = PerlIO_context_layers(aTHX_ mode);
1471 if (layers && *layers) {
1475 av = PerlIO_list_alloc(aTHX);
1476 for (i = 0; i < def->cur; i++) {
1477 PerlIO_list_push(aTHX_ av, def->array[i].funcs,
1484 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1488 PerlIO_list_free(aTHX_ av);
1489 return (PerlIO_list_t *) NULL;
1500 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1501 int imode, int perm, PerlIO *f, int narg, SV **args)
1503 if (!f && narg == 1 && *args == &PL_sv_undef) {
1504 if ((f = PerlIO_tmpfile())) {
1506 layers = PerlIO_context_layers(aTHX_ mode);
1507 if (layers && *layers)
1508 PerlIO_apply_layers(aTHX_ f, mode, layers);
1512 PerlIO_list_t *layera = NULL;
1514 PerlIO_funcs *tab = NULL;
1515 if (PerlIOValid(f)) {
1517 * This is "reopen" - it is not tested as perl does not use it
1521 layera = PerlIO_list_alloc(aTHX);
1523 SV *arg = (l->tab->Getarg)
1524 ? (*l->tab->Getarg) (aTHX_ & l, NULL, 0)
1526 PerlIO_list_push(aTHX_ layera, l->tab, arg);
1527 l = *PerlIONext(&l);
1531 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1537 * Start at "top" of layer stack
1539 n = layera->cur - 1;
1541 PerlIO_funcs *t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1550 * Found that layer 'n' can do opens - call it
1552 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1553 Perl_croak(aTHX_ "More than one argument to open(,':%s')",
1556 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1557 tab->name, layers, mode, fd, imode, perm,
1558 (void *) f, narg, (void *) args);
1560 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode,
1561 perm, f, narg, args);
1563 SETERRNO(EINVAL, LIB_INVARG);
1567 if (n + 1 < layera->cur) {
1569 * More layers above the one that we used to open -
1572 if (PerlIO_apply_layera
1573 (aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1574 /* If pushing layers fails close the file */
1581 PerlIO_list_free(aTHX_ layera);
1588 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1590 if (PerlIOValid(f)) {
1591 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
1592 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
1595 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1596 if (PerlIO_eof(f) || PerlIO_error(f)) {
1601 if (tab && tab->Read)
1602 len = (*tab->Read) (aTHX_ f, vbuf, count);
1604 len = PerlIOBase_read(aTHX_ f, vbuf, count);
1605 if (len >= 0 || errno != EINTR) {
1607 if (errno != EAGAIN) {
1608 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
1611 else if (len == 0 && count != 0) {
1612 PerlIOBase(f)->flags |= PERLIO_F_EOF;
1621 SETERRNO(EBADF, SS_IVCHAN);
1626 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1628 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1632 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1634 if (PerlIOValid(f)) {
1635 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1636 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE) || !tab
1638 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
1642 SSize_t len = (*tab->Write) (aTHX_ f, vbuf, count);
1643 if (len >= 0 || errno != EINTR) {
1645 if (errno != EAGAIN) {
1646 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
1649 else if (len == 0 && count != 0) {
1650 PerlIOBase(f)->flags |= PERLIO_F_EOF;
1659 SETERRNO(EBADF, SS_IVCHAN);
1664 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1666 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1670 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1672 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1676 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1680 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1682 if (tab && tab->Flush)
1683 return (*tab->Flush) (aTHX_ f);
1685 return 0; /* If no Flush defined, silently succeed. */
1688 PerlIO_debug("Cannot flush f=%p\n", (void *) f);
1689 SETERRNO(EBADF, SS_IVCHAN);
1695 * Is it good API design to do flush-all on NULL, a potentially
1696 * errorneous input? Maybe some magical value (PerlIO*
1697 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1698 * things on fflush(NULL), but should we be bound by their design
1701 PerlIO **table = &PL_perlio;
1703 while ((f = *table)) {
1705 table = (PerlIO **) (f++);
1706 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1707 if (*f && PerlIO_flush(f) != 0)
1717 PerlIOBase_flush_linebuf(pTHX)
1719 PerlIO **table = &PL_perlio;
1721 while ((f = *table)) {
1723 table = (PerlIO **) (f++);
1724 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1727 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1728 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1736 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1738 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1742 PerlIO_isutf8(PerlIO *f)
1745 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1751 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1753 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1757 Perl_PerlIO_error(pTHX_ PerlIO *f)
1759 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1763 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1765 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1769 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1771 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1775 PerlIO_has_base(PerlIO *f)
1777 if (PerlIOValid(f)) {
1778 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1781 return (tab->Get_base != NULL);
1782 SETERRNO(EINVAL, LIB_INVARG);
1785 SETERRNO(EBADF, SS_IVCHAN);
1791 PerlIO_fast_gets(PerlIO *f)
1793 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1794 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1797 return (tab->Set_ptrcnt != NULL);
1798 SETERRNO(EINVAL, LIB_INVARG);
1801 SETERRNO(EBADF, SS_IVCHAN);
1807 PerlIO_has_cntptr(PerlIO *f)
1809 if (PerlIOValid(f)) {
1810 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1813 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1814 SETERRNO(EINVAL, LIB_INVARG);
1817 SETERRNO(EBADF, SS_IVCHAN);
1823 PerlIO_canset_cnt(PerlIO *f)
1825 if (PerlIOValid(f)) {
1826 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1829 return (tab->Set_ptrcnt != NULL);
1830 SETERRNO(EINVAL, LIB_INVARG);
1833 SETERRNO(EBADF, SS_IVCHAN);
1839 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1841 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1845 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1847 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1851 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1853 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1857 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1859 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1863 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1865 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1869 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1871 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1875 /*--------------------------------------------------------------------------------------*/
1877 * utf8 and raw dummy layers
1881 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg,
1884 if (PerlIOValid(f)) {
1885 if (tab->kind & PERLIO_K_UTF8)
1886 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1888 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1894 PerlIO_funcs PerlIO_utf8 = {
1895 sizeof(PerlIO_funcs),
1898 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1916 NULL, /* get_base */
1917 NULL, /* get_bufsiz */
1920 NULL, /* set_ptrcnt */
1923 PerlIO_funcs PerlIO_byte = {
1924 sizeof(PerlIO_funcs),
1945 NULL, /* get_base */
1946 NULL, /* get_bufsiz */
1949 NULL, /* set_ptrcnt */
1953 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1954 IV n, const char *mode, int fd, int imode, int perm,
1955 PerlIO *old, int narg, SV **args)
1957 PerlIO_funcs *tab = PerlIO_default_btm();
1958 if (tab && tab->Open)
1959 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode,
1960 perm, old, narg, args);
1961 SETERRNO(EINVAL, LIB_INVARG);
1965 PerlIO_funcs PerlIO_raw = {
1966 sizeof(PerlIO_funcs),
1987 NULL, /* get_base */
1988 NULL, /* get_bufsiz */
1991 NULL, /* set_ptrcnt */
1993 /*--------------------------------------------------------------------------------------*/
1994 /*--------------------------------------------------------------------------------------*/
1996 * "Methods" of the "base class"
2000 PerlIOBase_fileno(pTHX_ PerlIO *f)
2002 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
2006 PerlIO_modestr(PerlIO *f, char *buf)
2009 if (PerlIOValid(f)) {
2010 IV flags = PerlIOBase(f)->flags;
2011 if (flags & PERLIO_F_APPEND) {
2013 if (flags & PERLIO_F_CANREAD) {
2017 else if (flags & PERLIO_F_CANREAD) {
2019 if (flags & PERLIO_F_CANWRITE)
2022 else if (flags & PERLIO_F_CANWRITE) {
2024 if (flags & PERLIO_F_CANREAD) {
2028 #ifdef PERLIO_USING_CRLF
2029 if (!(flags & PERLIO_F_CRLF))
2039 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg,
2042 PerlIOl *l = PerlIOBase(f);
2044 const char *omode = mode;
2047 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
2048 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
2049 if (tab->Set_ptrcnt != NULL)
2050 l->flags |= PERLIO_F_FASTGETS;
2052 if (*mode == '#' || *mode == 'I')
2056 l->flags |= PERLIO_F_CANREAD;
2059 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
2062 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
2065 SETERRNO(EINVAL, LIB_INVARG);
2071 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2074 l->flags &= ~PERLIO_F_CRLF;
2077 l->flags |= PERLIO_F_CRLF;
2080 SETERRNO(EINVAL, LIB_INVARG);
2087 l->flags |= l->next->flags &
2088 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2093 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2094 f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2095 l->flags, PerlIO_modestr(f, temp));
2098 l->flags |= l->next->flags &
2099 (PERLIO_F_TTY | PERLIO_F_NOTREG | PERLIO_F_SOCKET);
2105 PerlIOBase_popped(pTHX_ PerlIO *f)
2111 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2114 * Save the position as current head considers it
2116 Off_t old = PerlIO_tell(f);
2118 PerlIO_push(aTHX_ f, &PerlIO_pending, "r", Nullsv);
2119 PerlIOSelf(f, PerlIOBuf)->posn = old;
2120 done = PerlIOBuf_unread(aTHX_ f, vbuf, count);
2125 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2127 STDCHAR *buf = (STDCHAR *) vbuf;
2128 if (PerlIOValid(f)) {
2129 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2130 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2134 SSize_t avail = PerlIO_get_cnt(f);
2137 take = ((SSize_t) count < avail) ? count : avail;
2139 STDCHAR *ptr = PerlIO_get_ptr(f);
2140 Copy(ptr, buf, take, STDCHAR);
2141 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2145 if (count > 0 && avail <= 0) {
2146 if (PerlIO_fill(f) != 0)
2150 return (buf - (STDCHAR *) vbuf);
2153 SETERRNO(EBADF, SS_IVCHAN);
2158 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2164 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2170 PerlIOBase_close(pTHX_ PerlIO *f)
2173 if (PerlIOValid(f)) {
2174 PerlIO *n = PerlIONext(f);
2175 code = PerlIO_flush(f);
2176 PerlIOBase(f)->flags &=
2177 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2178 while (PerlIOValid(n)) {
2179 PerlIO_funcs *tab = PerlIOBase(n)->tab;
2180 if (tab && tab->Close) {
2181 if ((*tab->Close) (aTHX_ n) != 0)
2186 PerlIOBase(n)->flags &=
2187 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
2194 SETERRNO(EBADF, SS_IVCHAN);
2200 PerlIOBase_eof(pTHX_ PerlIO *f)
2202 if (PerlIOValid(f)) {
2203 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2209 PerlIOBase_error(pTHX_ PerlIO *f)
2211 if (PerlIOValid(f)) {
2212 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2218 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2220 if (PerlIOValid(f)) {
2221 PerlIO *n = PerlIONext(f);
2222 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2229 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2231 if (PerlIOValid(f)) {
2232 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2237 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2243 return sv_dup(arg, param);
2246 return newSVsv(arg);
2249 return newSVsv(arg);
2254 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2256 PerlIO *nexto = PerlIONext(o);
2257 if (PerlIOValid(nexto)) {
2258 PerlIO_funcs *tab = PerlIOBase(nexto)->tab;
2259 if (tab && tab->Dup)
2260 f = (*tab->Dup) (aTHX_ f, nexto, param, flags);
2262 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2265 PerlIO_funcs *self = PerlIOBase(o)->tab;
2268 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2269 self->name, (void *) f, (void *) o, (void *) param);
2271 arg = (*self->Getarg) (aTHX_ o, param, flags);
2275 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o, buf), arg);
2283 #define PERLIO_MAX_REFCOUNTABLE_FD 2048
2285 perl_mutex PerlIO_mutex;
2287 int PerlIO_fd_refcnt[PERLIO_MAX_REFCOUNTABLE_FD];
2292 /* Place holder for stdstreams call ??? */
2294 MUTEX_INIT(&PerlIO_mutex);
2299 PerlIOUnix_refcnt_inc(int fd)
2301 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2303 MUTEX_LOCK(&PerlIO_mutex);
2305 PerlIO_fd_refcnt[fd]++;
2306 PerlIO_debug("fd %d refcnt=%d\n", fd, PerlIO_fd_refcnt[fd]);
2308 MUTEX_UNLOCK(&PerlIO_mutex);
2314 PerlIOUnix_refcnt_dec(int fd)
2317 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2319 MUTEX_LOCK(&PerlIO_mutex);
2321 cnt = --PerlIO_fd_refcnt[fd];
2322 PerlIO_debug("fd %d refcnt=%d\n", fd, cnt);
2324 MUTEX_UNLOCK(&PerlIO_mutex);
2331 PerlIO_cleanup(pTHX)
2335 PerlIO_debug("Cleanup layers for %p\n", aTHX);
2337 PerlIO_debug("Cleanup layers\n");
2339 /* Raise STDIN..STDERR refcount so we don't close them */
2340 for (i = 0; i < 3; i++)
2341 PerlIOUnix_refcnt_inc(i);
2342 PerlIO_cleantable(aTHX_ & PL_perlio);
2343 /* Restore STDIN..STDERR refcount */
2344 for (i = 0; i < 3; i++)
2345 PerlIOUnix_refcnt_dec(i);
2347 if (PL_known_layers) {
2348 PerlIO_list_free(aTHX_ PL_known_layers);
2349 PL_known_layers = NULL;
2351 if (PL_def_layerlist) {
2352 PerlIO_list_free(aTHX_ PL_def_layerlist);
2353 PL_def_layerlist = NULL;
2359 /*--------------------------------------------------------------------------------------*/
2361 * Bottom-most level for UNIX-like case
2365 struct _PerlIO base; /* The generic part */
2366 int fd; /* UNIX like file descriptor */
2367 int oflags; /* open/fcntl flags */
2371 PerlIOUnix_oflags(const char *mode)
2374 if (*mode == 'I' || *mode == '#')
2379 if (*++mode == '+') {
2386 oflags = O_CREAT | O_TRUNC;
2387 if (*++mode == '+') {
2396 oflags = O_CREAT | O_APPEND;
2397 if (*++mode == '+') {
2410 else if (*mode == 't') {
2412 oflags &= ~O_BINARY;
2416 * Always open in binary mode
2419 if (*mode || oflags == -1) {
2420 SETERRNO(EINVAL, LIB_INVARG);
2427 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2429 return PerlIOSelf(f, PerlIOUnix)->fd;
2433 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2435 PerlIOUnix *s = PerlIOSelf(f, PerlIOUnix);
2437 #if 1 || defined(WIN32) || defined(HAS_SOCKET) && \
2438 (defined(PERL_SOCK_SYSREAD_IS_RECV) || \
2439 defined(PERL_SOCK_SYSWRITE_IS_SEND))
2441 if (PerlLIO_fstat(fd, &st) == 0) {
2443 /* WIN32 needs to know about non-regular files
2444 as only regular files can be lseek()ed
2446 if (!S_ISREG(st.st_mode)) {
2447 PerlIO_debug("%d is not regular file\n", fd);
2448 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2451 PerlIO_debug("%d _is_ a regular file\n", fd);
2454 /* If read/write are to be mapped to recv/send we need
2455 to know this is a socket.
2456 Lifted from code in doio.c that handles socket detection on dup
2459 if (S_ISSOCK(st.st_mode))
2460 PerlIOBase(f)->flags |= PERLIO_F_SOCKET;
2463 !(st.st_mode & S_IFMT)
2469 Sock_size_t buflen = sizeof tmpbuf;
2470 if (PerlSock_getsockname
2471 (fd, (struct sockaddr *) tmpbuf, &buflen) >= 0
2472 || errno != ENOTSOCK)
2473 PerlIOBase(f)->flags |= PERLIO_F_SOCKET; /* some OS's return 0 on fstat()ed socket */
2474 /* but some return 0 for streams too, sigh */
2476 #endif /* !PERL_MICRO */
2478 #endif /* HAS_SOCKET ... */
2482 PerlIOUnix_refcnt_inc(fd);
2486 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg,
2489 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2490 if (*PerlIONext(f)) {
2491 /* We never call down so do any pending stuff now */
2492 PerlIO_flush(PerlIONext(f));
2494 * XXX could (or should) we retrieve the oflags from the open file
2495 * handle rather than believing the "mode" we are passed in? XXX
2496 * Should the value on NULL mode be 0 or -1?
2498 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2499 mode ? PerlIOUnix_oflags(mode) : -1);
2501 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2507 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2508 IV n, const char *mode, int fd, int imode,
2509 int perm, PerlIO *f, int narg, SV **args)
2511 if (PerlIOValid(f)) {
2512 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2513 (*PerlIOBase(f)->tab->Close) (aTHX_ f);
2516 char *path = SvPV_nolen(*args);
2520 imode = PerlIOUnix_oflags(mode);
2524 fd = PerlLIO_open3(path, imode, perm);
2531 f = PerlIO_allocate(aTHX);
2533 if (!PerlIOValid(f)) {
2534 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2538 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2539 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2545 * FIXME: pop layers ???
2553 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2555 PerlIOUnix *os = PerlIOSelf(o, PerlIOUnix);
2557 if (flags & PERLIO_DUP_FD) {
2558 fd = PerlLIO_dup(fd);
2560 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2561 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2563 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2564 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2573 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2575 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2576 if (PerlIOBase(f)->flags & (PERLIO_F_EOF | PERLIO_F_ERROR)) {
2579 #ifdef PERL_SOCK_SYSREAD_IS_RECV
2580 if (PerlIOBase(f)->flags & PERLIO_F_SOCKET) {
2581 return PerlSock_recv(fd, vbuf, count, 0);
2586 return PerlLIO_read(fd, vbuf, count);
2591 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2593 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2594 return PerlLIO_write(fd, vbuf, count);
2598 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2600 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2602 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2604 SETERRNO(ESPIPE, LIB_INVARG);
2606 SETERRNO(EINVAL, LIB_INVARG);
2610 new = PerlLIO_lseek(fd, offset, whence);
2611 if (new == (Off_t) - 1) {
2614 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2619 PerlIOUnix_tell(pTHX_ PerlIO *f)
2621 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2626 PerlIOUnix_close(pTHX_ PerlIO *f)
2628 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2630 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2631 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2632 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2637 SETERRNO(EBADF, SS_IVCHAN);
2640 while (PerlLIO_close(fd) != 0) {
2641 if (errno != EINTR) {
2648 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2653 PerlIO_funcs PerlIO_unix = {
2654 sizeof(PerlIO_funcs),
2661 PerlIOBase_binmode, /* binmode */
2671 PerlIOBase_noop_ok, /* flush */
2672 PerlIOBase_noop_fail, /* fill */
2675 PerlIOBase_clearerr,
2676 PerlIOBase_setlinebuf,
2677 NULL, /* get_base */
2678 NULL, /* get_bufsiz */
2681 NULL, /* set_ptrcnt */
2684 /*--------------------------------------------------------------------------------------*/
2689 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2690 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2691 broken by the last second glibc 2.3 fix
2693 #define STDIO_BUFFER_WRITABLE
2698 struct _PerlIO base;
2699 FILE *stdio; /* The stream */
2703 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2706 if (PerlIOValid(f) && (s = PerlIOSelf(f, PerlIOStdio)->stdio)) {
2707 return PerlSIO_fileno(s);
2714 PerlIOStdio_mode(const char *mode, char *tmode)
2720 #ifdef PERLIO_USING_CRLF
2728 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg,
2732 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2733 PerlIO_funcs *toptab = PerlIOBase(n)->tab;
2734 if (toptab == tab) {
2735 /* Top is already stdio - pop self (duplicate) and use original */
2736 PerlIO_pop(aTHX_ f);
2740 int fd = PerlIO_fileno(n);
2743 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2745 PerlIOStdio_mode(mode,
2748 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2749 /* We never call down so do any pending stuff now */
2750 PerlIO_flush(PerlIONext(f));
2757 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2762 PerlIO_importFILE(FILE *stdio, const char *mode)
2768 if (!mode || !*mode) {
2769 /* We need to probe to see how we can open the stream
2770 so start with read/write and then try write and read
2771 we dup() so that we can fclose without loosing the fd.
2773 Note that the errno value set by a failing fdopen
2774 varies between stdio implementations.
2776 int fd = PerlLIO_dup(fileno(stdio));
2777 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2779 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2782 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2785 /* Don't seem to be able to open */
2792 PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), &PerlIO_stdio,
2794 s = PerlIOSelf(f, PerlIOStdio);
2802 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2803 IV n, const char *mode, int fd, int imode,
2804 int perm, PerlIO *f, int narg, SV **args)
2807 if (PerlIOValid(f)) {
2808 char *path = SvPV_nolen(*args);
2809 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2811 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2813 PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2818 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2823 char *path = SvPV_nolen(*args);
2826 fd = PerlLIO_open3(path, imode, perm);
2829 FILE *stdio = PerlSIO_fopen(path, mode);
2833 f = PerlIO_allocate(aTHX);
2835 if ((f = PerlIO_push(aTHX_ f, self,
2837 PerlIOStdio_mode(mode, tmode)),
2839 s = PerlIOSelf(f, PerlIOStdio);
2841 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2860 stdio = PerlSIO_stdin;
2863 stdio = PerlSIO_stdout;
2866 stdio = PerlSIO_stderr;
2871 stdio = PerlSIO_fdopen(fd, mode =
2872 PerlIOStdio_mode(mode, tmode));
2877 f = PerlIO_allocate(aTHX);
2879 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2880 s = PerlIOSelf(f, PerlIOStdio);
2882 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2892 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2894 /* This assumes no layers underneath - which is what
2895 happens, but is not how I remember it. NI-S 2001/10/16
2897 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2898 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2899 int fd = fileno(stdio);
2901 if (flags & PERLIO_DUP_FD) {
2902 int dfd = PerlLIO_dup(fileno(stdio));
2904 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o, mode));
2908 /* FIXME: To avoid messy error recovery if dup fails
2909 re-use the existing stdio as though flag was not set
2913 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o, mode));
2915 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2916 PerlIOUnix_refcnt_inc(fileno(stdio));
2922 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
2924 /* XXX this could use PerlIO_canset_fileno() and
2925 * PerlIO_set_fileno() support from Configure
2927 # if defined(__GLIBC__)
2928 /* There may be a better way for GLIBC:
2929 - libio.h defines a flag to not close() on cleanup
2933 # elif defined(__sun__)
2935 /* On solaris, if _LP64 is defined, the FILE structure is this:
2941 * It turns out that the fd is stored in the top 32 bits of
2942 * file->__pad[4]. The lower 32 bits contain flags. file->pad[5] appears
2943 * to contain a pointer or offset into another structure. All the
2944 * remaining fields are zero.
2946 * We set the top bits to -1 (0xFFFFFFFF).
2948 f->__pad[4] |= 0xffffffff00000000L;
2949 assert(fileno(f) == 0xffffffff);
2950 # else /* !defined(_LP64) */
2951 /* _file is just a unsigned char :-(
2952 Not clear why we dup() rather than using -1
2953 even if that would be treated as 0xFF - so will
2956 f->_file = PerlLIO_dup(fileno(f));
2957 # endif /* defined(_LP64) */
2959 # elif defined(__hpux)
2963 /* Next one ->_file seems to be a reasonable fallback, i.e. if
2964 your platform does not have special entry try this one.
2965 [For OSF only have confirmation for Tru64 (alpha)
2966 but assume other OSFs will be similar.]
2968 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
2971 # elif defined(__FreeBSD__)
2972 /* There may be a better way on FreeBSD:
2973 - we could insert a dummy func in the _close function entry
2974 f->_close = (int (*)(void *)) dummy_close;
2978 # elif defined(__CYGWIN__)
2979 /* There may be a better way on CYGWIN:
2980 - we could insert a dummy func in the _close function entry
2981 f->_close = (int (*)(void *)) dummy_close;
2985 # elif defined(WIN32)
2986 # if defined(__BORLANDC__)
2987 f->fd = PerlLIO_dup(fileno(f));
2988 # elif defined(UNDER_CE)
2989 /* WIN_CE does not have access to FILE internals, it hardly has FILE
2998 /* Sarathy's code did this - we fall back to a dup/dup2 hack
2999 (which isn't thread safe) instead
3001 # error "Don't know how to set FILE.fileno on your platform"
3008 PerlIOStdio_close(pTHX_ PerlIO *f)
3010 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3016 int fd = fileno(stdio);
3022 #ifdef SOCKS5_VERSION_NAME
3023 /* Socks lib overrides close() but stdio isn't linked to
3024 that library (though we are) - so we must call close()
3025 on sockets on stdio's behalf.
3028 Sock_size_t optlen = sizeof(int);
3029 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen)
3035 if (PerlIOUnix_refcnt_dec(fd) > 0) {
3036 /* File descriptor still in use */
3041 /* For STD* handles don't close the stdio at all
3042 this is because we have shared the FILE * too
3044 if (stdio == stdin) {
3045 /* Some stdios are buggy fflush-ing inputs */
3048 else if (stdio == stdout || stdio == stderr) {
3049 return PerlIO_flush(f);
3051 /* Tricky - must fclose(stdio) to free memory but not close(fd)
3052 Use Sarathy's trick from maint-5.6 to invalidate the
3053 fileno slot of the FILE *
3055 result = PerlIO_flush(f);
3057 if (!(invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio))) {
3058 dupfd = PerlLIO_dup(fd);
3061 result = PerlSIO_fclose(stdio);
3062 /* We treat error from stdio as success if we invalidated
3063 errno may NOT be expected EBADF
3065 if (invalidate && result != 0) {
3070 /* in SOCKS case let close() determine return value */
3074 PerlLIO_dup2(dupfd, fd);
3075 PerlLIO_close(dupfd);
3082 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3084 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3087 STDCHAR *buf = (STDCHAR *) vbuf;
3089 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3090 * stdio does not do that for fread()
3092 int ch = PerlSIO_fgetc(s);
3099 got = PerlSIO_fread(vbuf, 1, count, s);
3100 if (got == 0 && PerlSIO_ferror(s))
3106 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3109 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3111 #ifdef STDIO_BUFFER_WRITABLE
3112 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3113 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3114 STDCHAR *base = PerlIO_get_base(f);
3115 SSize_t cnt = PerlIO_get_cnt(f);
3116 STDCHAR *ptr = PerlIO_get_ptr(f);
3117 SSize_t avail = ptr - base;
3119 if (avail > count) {
3123 Move(buf - avail, ptr, avail, STDCHAR);
3126 PerlIO_set_ptrcnt(f, ptr, cnt + avail);
3127 if (PerlSIO_feof(s) && unread >= 0)
3128 PerlSIO_clearerr(s);
3133 if (PerlIO_has_cntptr(f)) {
3134 /* We can get pointer to buffer but not its base
3135 Do ungetc() but check chars are ending up in the
3138 STDCHAR *eptr = (STDCHAR *) PerlSIO_get_ptr(s);
3139 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3141 int ch = *--buf & 0xFF;
3142 if (ungetc(ch, s) != ch) {
3143 /* ungetc did not work */
3146 if ((STDCHAR *) PerlSIO_get_ptr(s) != --eptr
3147 || ((*eptr & 0xFF) != ch)) {
3148 /* Did not change pointer as expected */
3149 fgetc(s); /* get char back again */
3159 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3165 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3167 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3168 SSize_t got = PerlSIO_fwrite(vbuf, 1, count, stdio);
3169 if (got == 0 && PerlSIO_ferror(stdio))
3175 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3177 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3178 return PerlSIO_fseek(stdio, offset, whence);
3182 PerlIOStdio_tell(pTHX_ PerlIO *f)
3184 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3185 return PerlSIO_ftell(stdio);
3189 PerlIOStdio_flush(pTHX_ PerlIO *f)
3191 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3192 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3193 return PerlSIO_fflush(stdio);
3198 * FIXME: This discards ungetc() and pre-read stuff which is not
3199 * right if this is just a "sync" from a layer above Suspect right
3200 * design is to do _this_ but not have layer above flush this
3201 * layer read-to-read
3204 * Not writeable - sync by attempting a seek
3207 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3215 PerlIOStdio_eof(pTHX_ PerlIO *f)
3217 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3221 PerlIOStdio_error(pTHX_ PerlIO *f)
3223 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3227 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3229 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3233 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3235 #ifdef HAS_SETLINEBUF
3236 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3238 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, Nullch, _IOLBF, 0);
3244 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3246 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3247 return (STDCHAR *) PerlSIO_get_base(stdio);
3251 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3253 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3254 return PerlSIO_get_bufsiz(stdio);
3258 #ifdef USE_STDIO_PTR
3260 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3262 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3263 return (STDCHAR *) PerlSIO_get_ptr(stdio);
3267 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3269 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3270 return PerlSIO_get_cnt(stdio);
3274 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3276 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3278 #ifdef STDIO_PTR_LVALUE
3279 PerlSIO_set_ptr(stdio, (void *) ptr); /* LHS STDCHAR* cast non-portable */
3280 #ifdef STDIO_PTR_LVAL_SETS_CNT
3281 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3282 assert(PerlSIO_get_cnt(stdio) == (cnt));
3285 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3287 * Setting ptr _does_ change cnt - we are done
3291 #else /* STDIO_PTR_LVALUE */
3293 #endif /* STDIO_PTR_LVALUE */
3296 * Now (or only) set cnt
3298 #ifdef STDIO_CNT_LVALUE
3299 PerlSIO_set_cnt(stdio, cnt);
3300 #else /* STDIO_CNT_LVALUE */
3301 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3302 PerlSIO_set_ptr(stdio,
3303 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3305 #else /* STDIO_PTR_LVAL_SETS_CNT */
3307 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3308 #endif /* STDIO_CNT_LVALUE */
3315 PerlIOStdio_fill(pTHX_ PerlIO *f)
3317 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3320 * fflush()ing read-only streams can cause trouble on some stdio-s
3322 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3323 if (PerlSIO_fflush(stdio) != 0)
3326 c = PerlSIO_fgetc(stdio);
3330 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3332 #ifdef STDIO_BUFFER_WRITABLE
3333 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3334 /* Fake ungetc() to the real buffer in case system's ungetc
3337 STDCHAR *base = (STDCHAR *) PerlSIO_get_base(stdio);
3338 SSize_t cnt = PerlSIO_get_cnt(stdio);
3339 STDCHAR *ptr = (STDCHAR *) PerlSIO_get_ptr(stdio);
3340 if (ptr == base + 1) {
3341 *--ptr = (STDCHAR) c;
3342 PerlIOStdio_set_ptrcnt(aTHX_ f, ptr, cnt + 1);
3343 if (PerlSIO_feof(stdio))
3344 PerlSIO_clearerr(stdio);
3350 if (PerlIO_has_cntptr(f)) {
3352 if (PerlIOStdio_unread(aTHX_ f, &ch, 1) == 1) {
3359 /* An ungetc()d char is handled separately from the regular
3360 * buffer, so we stuff it in the buffer ourselves.
3361 * Should never get called as should hit code above
3363 *(--((*stdio)->_ptr)) = (unsigned char) c;
3366 /* If buffer snoop scheme above fails fall back to
3369 if (PerlSIO_ungetc(c, stdio) != c)
3377 PerlIO_funcs PerlIO_stdio = {
3378 sizeof(PerlIO_funcs),
3380 sizeof(PerlIOStdio),
3381 PERLIO_K_BUFFERED | PERLIO_K_RAW,
3385 PerlIOBase_binmode, /* binmode */
3399 PerlIOStdio_clearerr,
3400 PerlIOStdio_setlinebuf,
3402 PerlIOStdio_get_base,
3403 PerlIOStdio_get_bufsiz,
3408 #ifdef USE_STDIO_PTR
3409 PerlIOStdio_get_ptr,
3410 PerlIOStdio_get_cnt,
3411 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3412 PerlIOStdio_set_ptrcnt,
3415 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3420 #endif /* USE_STDIO_PTR */
3423 /* Note that calls to PerlIO_exportFILE() are reversed using
3424 * PerlIO_releaseFILE(), not importFILE. */
3426 PerlIO_exportFILE(PerlIO *f, const char *mode)
3430 if (PerlIOValid(f)) {
3433 if (!mode || !*mode) {
3434 mode = PerlIO_modestr(f, buf);
3436 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3439 /* De-link any lower layers so new :stdio sticks */
3441 if ((f = PerlIO_push(aTHX_ f, &PerlIO_stdio, buf, Nullsv))) {
3442 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
3444 /* Link previous lower layers under new one */
3448 /* restore layers list */
3458 PerlIO_findFILE(PerlIO *f)
3462 if (l->tab == &PerlIO_stdio) {
3463 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3466 l = *PerlIONext(&l);
3468 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3469 return PerlIO_exportFILE(f, Nullch);
3472 /* Use this to reverse PerlIO_exportFILE calls. */
3474 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3478 if (l->tab == &PerlIO_stdio) {
3479 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3480 if (s->stdio == f) {
3482 PerlIO_pop(aTHX_ p);
3491 /*--------------------------------------------------------------------------------------*/
3493 * perlio buffer layer
3497 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg,
3500 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3501 int fd = PerlIO_fileno(f);
3502 if (fd >= 0 && PerlLIO_isatty(fd)) {
3503 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3505 if (*PerlIONext(f)) {
3506 Off_t posn = PerlIO_tell(PerlIONext(f));
3507 if (posn != (Off_t) - 1) {
3511 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3515 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3516 IV n, const char *mode, int fd, int imode, int perm,
3517 PerlIO *f, int narg, SV **args)
3519 if (PerlIOValid(f)) {
3520 PerlIO *next = PerlIONext(f);
3522 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3524 (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3527 || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg,
3534 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3542 f = (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3545 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3547 * if push fails during open, open fails. close will pop us.
3553 fd = PerlIO_fileno(f);
3554 if (init && fd == 2) {
3556 * Initial stderr is unbuffered
3558 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3560 #ifdef PERLIO_USING_CRLF
3561 # ifdef PERLIO_IS_BINMODE_FD
3562 if (PERLIO_IS_BINMODE_FD(fd))
3563 PerlIO_binmode(aTHX_ f, '<' /*not used */ , O_BINARY,
3568 * do something about failing setmode()? --jhi
3570 PerlLIO_setmode(fd, O_BINARY);
3579 * This "flush" is akin to sfio's sync in that it handles files in either
3580 * read or write state
3583 PerlIOBuf_flush(pTHX_ PerlIO *f)
3585 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3587 PerlIO *n = PerlIONext(f);
3588 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3590 * write() the buffer
3592 STDCHAR *buf = b->buf;
3594 while (p < b->ptr) {
3595 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3599 else if (count < 0 || PerlIO_error(n)) {
3600 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3605 b->posn += (p - buf);
3607 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3608 STDCHAR *buf = PerlIO_get_base(f);
3610 * Note position change
3612 b->posn += (b->ptr - buf);
3613 if (b->ptr < b->end) {
3614 /* We did not consume all of it - try and seek downstream to
3615 our logical position
3617 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3618 /* Reload n as some layers may pop themselves on seek */
3619 b->posn = PerlIO_tell(n = PerlIONext(f));
3622 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3623 data is lost for good - so return saying "ok" having undone
3626 b->posn -= (b->ptr - buf);
3631 b->ptr = b->end = b->buf;
3632 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3633 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3634 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3640 PerlIOBuf_fill(pTHX_ PerlIO *f)
3642 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3643 PerlIO *n = PerlIONext(f);
3646 * Down-stream flush is defined not to loose read data so is harmless.
3647 * we would not normally be fill'ing if there was data left in anycase.
3649 if (PerlIO_flush(f) != 0)
3651 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3652 PerlIOBase_flush_linebuf(aTHX);
3655 PerlIO_get_base(f); /* allocate via vtable */
3657 b->ptr = b->end = b->buf;
3659 if (!PerlIOValid(n)) {
3660 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3664 if (PerlIO_fast_gets(n)) {
3666 * Layer below is also buffered. We do _NOT_ want to call its
3667 * ->Read() because that will loop till it gets what we asked for
3668 * which may hang on a pipe etc. Instead take anything it has to
3669 * hand, or ask it to fill _once_.
3671 avail = PerlIO_get_cnt(n);
3673 avail = PerlIO_fill(n);
3675 avail = PerlIO_get_cnt(n);
3677 if (!PerlIO_error(n) && PerlIO_eof(n))
3682 STDCHAR *ptr = PerlIO_get_ptr(n);
3683 SSize_t cnt = avail;
3684 if (avail > (SSize_t) b->bufsiz)
3686 Copy(ptr, b->buf, avail, STDCHAR);
3687 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3691 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3695 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3697 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3700 b->end = b->buf + avail;
3701 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3706 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3708 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3709 if (PerlIOValid(f)) {
3712 return PerlIOBase_read(aTHX_ f, vbuf, count);
3718 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3720 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3721 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3724 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3729 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3731 * Buffer is already a read buffer, we can overwrite any chars
3732 * which have been read back to buffer start
3734 avail = (b->ptr - b->buf);
3738 * Buffer is idle, set it up so whole buffer is available for
3742 b->end = b->buf + avail;
3744 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3746 * Buffer extends _back_ from where we are now
3748 b->posn -= b->bufsiz;
3750 if (avail > (SSize_t) count) {
3752 * If we have space for more than count, just move count
3760 * In simple stdio-like ungetc() case chars will be already
3763 if (buf != b->ptr) {
3764 Copy(buf, b->ptr, avail, STDCHAR);
3768 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3772 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3778 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3780 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3781 const STDCHAR *buf = (const STDCHAR *) vbuf;
3785 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3787 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3788 if (PerlIO_flush(f) != 0) {
3793 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3794 if ((SSize_t) count < avail)
3796 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3797 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3812 Copy(buf, b->ptr, avail, STDCHAR);
3819 if (b->ptr >= (b->buf + b->bufsiz))
3822 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3828 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3831 if ((code = PerlIO_flush(f)) == 0) {
3832 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3833 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3834 code = PerlIO_seek(PerlIONext(f), offset, whence);
3836 b->posn = PerlIO_tell(PerlIONext(f));
3843 PerlIOBuf_tell(pTHX_ PerlIO *f)
3845 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3847 * b->posn is file position where b->buf was read, or will be written
3849 Off_t posn = b->posn;
3850 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3851 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3853 /* As O_APPEND files are normally shared in some sense it is better
3858 /* when file is NOT shared then this is sufficient */
3859 PerlIO_seek(PerlIONext(f), 0, SEEK_END);
3861 posn = b->posn = PerlIO_tell(PerlIONext(f));
3865 * If buffer is valid adjust position by amount in buffer
3867 posn += (b->ptr - b->buf);
3873 PerlIOBuf_popped(pTHX_ PerlIO *f)
3875 IV code = PerlIOBase_popped(aTHX_ f);
3876 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3877 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3881 b->ptr = b->end = b->buf;
3882 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3887 PerlIOBuf_close(pTHX_ PerlIO *f)
3889 IV code = PerlIOBase_close(aTHX_ f);
3890 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3891 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3895 b->ptr = b->end = b->buf;
3896 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3901 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
3903 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3910 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
3912 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3915 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
3916 return (b->end - b->ptr);
3921 PerlIOBuf_get_base(pTHX_ PerlIO *f)
3923 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3927 b->buf = Newz('B', b->buf, b->bufsiz, STDCHAR);
3929 b->buf = (STDCHAR *) & b->oneword;
3930 b->bufsiz = sizeof(b->oneword);
3939 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
3941 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3944 return (b->end - b->buf);
3948 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3950 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3954 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
3955 assert(PerlIO_get_cnt(f) == cnt);
3956 assert(b->ptr >= b->buf);
3958 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3962 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3964 return PerlIOBase_dup(aTHX_ f, o, param, flags);
3969 PerlIO_funcs PerlIO_perlio = {
3970 sizeof(PerlIO_funcs),
3973 PERLIO_K_BUFFERED | PERLIO_K_RAW,
3977 PerlIOBase_binmode, /* binmode */
3991 PerlIOBase_clearerr,
3992 PerlIOBase_setlinebuf,
3997 PerlIOBuf_set_ptrcnt,
4000 /*--------------------------------------------------------------------------------------*/
4002 * Temp layer to hold unread chars when cannot do it any other way
4006 PerlIOPending_fill(pTHX_ PerlIO *f)
4009 * Should never happen
4016 PerlIOPending_close(pTHX_ PerlIO *f)
4019 * A tad tricky - flush pops us, then we close new top
4022 return PerlIO_close(f);
4026 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4029 * A tad tricky - flush pops us, then we seek new top
4032 return PerlIO_seek(f, offset, whence);
4037 PerlIOPending_flush(pTHX_ PerlIO *f)
4039 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4040 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4044 PerlIO_pop(aTHX_ f);
4049 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4055 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4060 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg,
4063 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4064 PerlIOl *l = PerlIOBase(f);
4066 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4067 * etc. get muddled when it changes mid-string when we auto-pop.
4069 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4070 (PerlIOBase(PerlIONext(f))->
4071 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4076 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4078 SSize_t avail = PerlIO_get_cnt(f);
4080 if ((SSize_t) count < avail)
4083 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4084 if (got >= 0 && got < (SSize_t) count) {
4086 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4087 if (more >= 0 || got == 0)
4093 PerlIO_funcs PerlIO_pending = {
4094 sizeof(PerlIO_funcs),
4097 PERLIO_K_BUFFERED | PERLIO_K_RAW, /* not sure about RAW here */
4098 PerlIOPending_pushed,
4101 PerlIOBase_binmode, /* binmode */
4110 PerlIOPending_close,
4111 PerlIOPending_flush,
4115 PerlIOBase_clearerr,
4116 PerlIOBase_setlinebuf,
4121 PerlIOPending_set_ptrcnt,
4126 /*--------------------------------------------------------------------------------------*/
4128 * crlf - translation On read translate CR,LF to "\n" we do this by
4129 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4130 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4134 PerlIOBuf base; /* PerlIOBuf stuff */
4135 STDCHAR *nl; /* Position of crlf we "lied" about in the
4140 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg,
4144 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4145 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4147 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4148 f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4149 PerlIOBase(f)->flags);
4156 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4158 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4163 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4164 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4166 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4167 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4169 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4174 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4175 b->end = b->ptr = b->buf + b->bufsiz;
4176 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4177 b->posn -= b->bufsiz;
4179 while (count > 0 && b->ptr > b->buf) {
4182 if (b->ptr - 2 >= b->buf) {
4205 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4207 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4210 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4211 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4212 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)
4213 && (!c->nl || *c->nl == 0xd)) {
4214 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4216 while (nl < b->end && *nl != 0xd)
4218 if (nl < b->end && *nl == 0xd) {
4220 if (nl + 1 < b->end) {
4227 * Not CR,LF but just CR
4235 * Blast - found CR as last char in buffer
4240 * They may not care, defer work as long as
4244 return (nl - b->ptr);
4248 b->ptr++; /* say we have read it as far as
4249 * flush() is concerned */
4250 b->buf++; /* Leave space in front of buffer */
4251 /* Note as we have moved buf up flush's
4253 will naturally make posn point at CR
4255 b->bufsiz--; /* Buffer is thus smaller */
4256 code = PerlIO_fill(f); /* Fetch some more */
4257 b->bufsiz++; /* Restore size for next time */
4258 b->buf--; /* Point at space */
4259 b->ptr = nl = b->buf; /* Which is what we hand
4261 *nl = 0xd; /* Fill in the CR */
4263 goto test; /* fill() call worked */
4265 * CR at EOF - just fall through
4267 /* Should we clear EOF though ??? */
4272 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4278 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4280 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4281 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4287 if (ptr == b->end && *c->nl == 0xd) {
4288 /* Defered CR at end of buffer case - we lied about count */
4300 * Test code - delete when it works ...
4302 IV flags = PerlIOBase(f)->flags;
4303 STDCHAR *chk = (c->nl) ? (c->nl + 1) : b->end;
4304 if (ptr + cnt == c->nl && c->nl + 1 == b->end && *c->nl == 0xd) {
4305 /* Defered CR at end of buffer case - we lied about count */
4311 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4312 " nl=%p e=%p for %d", ptr, chk, flags, c->nl,
4320 * They have taken what we lied about
4328 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4332 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4334 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4335 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4337 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4338 const STDCHAR *buf = (const STDCHAR *) vbuf;
4339 const STDCHAR *ebuf = buf + count;
4342 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4344 while (buf < ebuf) {
4345 STDCHAR *eptr = b->buf + b->bufsiz;
4346 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4347 while (buf < ebuf && b->ptr < eptr) {
4349 if ((b->ptr + 2) > eptr) {
4357 *(b->ptr)++ = 0xd; /* CR */
4358 *(b->ptr)++ = 0xa; /* LF */
4360 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4370 if (b->ptr >= eptr) {
4376 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4378 return (buf - (STDCHAR *) vbuf);
4383 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4385 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4390 return PerlIOBuf_flush(aTHX_ f);
4394 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4396 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4397 /* In text mode - flush any pending stuff and flip it */
4398 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4399 #ifndef PERLIO_USING_CRLF
4400 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4401 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4402 PerlIO_pop(aTHX_ f);
4409 PerlIO_funcs PerlIO_crlf = {
4410 sizeof(PerlIO_funcs),
4413 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4415 PerlIOBuf_popped, /* popped */
4417 PerlIOCrlf_binmode, /* binmode */
4421 PerlIOBuf_read, /* generic read works with ptr/cnt lies
4423 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4424 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4432 PerlIOBase_clearerr,
4433 PerlIOBase_setlinebuf,
4438 PerlIOCrlf_set_ptrcnt,
4442 /*--------------------------------------------------------------------------------------*/
4444 * mmap as "buffer" layer
4448 PerlIOBuf base; /* PerlIOBuf stuff */
4449 Mmap_t mptr; /* Mapped address */
4450 Size_t len; /* mapped length */
4451 STDCHAR *bbuf; /* malloced buffer if map fails */
4454 static size_t page_size = 0;
4457 PerlIOMmap_map(pTHX_ PerlIO *f)
4459 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4460 IV flags = PerlIOBase(f)->flags;
4464 if (flags & PERLIO_F_CANREAD) {
4465 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4466 int fd = PerlIO_fileno(f);
4468 code = Fstat(fd, &st);
4469 if (code == 0 && S_ISREG(st.st_mode)) {
4470 SSize_t len = st.st_size - b->posn;
4474 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_PAGE_SIZE))
4476 SETERRNO(0, SS_NORMAL);
4477 # ifdef _SC_PAGESIZE
4478 page_size = sysconf(_SC_PAGESIZE);
4480 page_size = sysconf(_SC_PAGE_SIZE);
4482 if ((long) page_size < 0) {
4487 (void) SvUPGRADE(error, SVt_PV);
4488 msg = SvPVx(error, n_a);
4489 Perl_croak(aTHX_ "panic: sysconf: %s",
4494 "panic: sysconf: pagesize unknown");
4498 # ifdef HAS_GETPAGESIZE
4499 page_size = getpagesize();
4501 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
4502 page_size = PAGESIZE; /* compiletime, bad */
4506 if ((IV) page_size <= 0)
4507 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4512 * This is a hack - should never happen - open should
4515 b->posn = PerlIO_tell(PerlIONext(f));
4517 posn = (b->posn / page_size) * page_size;
4518 len = st.st_size - posn;
4519 m->mptr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4520 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4521 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4522 madvise(m->mptr, len, MADV_SEQUENTIAL);
4524 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4525 madvise(m->mptr, len, MADV_WILLNEED);
4527 PerlIOBase(f)->flags =
4528 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4529 b->end = ((STDCHAR *) m->mptr) + len;
4530 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4539 PerlIOBase(f)->flags =
4540 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4542 b->ptr = b->end = b->ptr;
4551 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4553 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4554 PerlIOBuf *b = &m->base;
4558 code = munmap(m->mptr, m->len);
4562 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4565 b->ptr = b->end = b->buf;
4566 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4572 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4574 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4575 PerlIOBuf *b = &m->base;
4576 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4578 * Already have a readbuffer in progress
4584 * We have a write buffer or flushed PerlIOBuf read buffer
4586 m->bbuf = b->buf; /* save it in case we need it again */
4587 b->buf = NULL; /* Clear to trigger below */
4590 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4593 * Map did not work - recover PerlIOBuf buffer if we have one
4598 b->ptr = b->end = b->buf;
4601 return PerlIOBuf_get_base(aTHX_ f);
4605 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4607 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4608 PerlIOBuf *b = &m->base;
4609 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4611 if (b->ptr && (b->ptr - count) >= b->buf
4612 && memEQ(b->ptr - count, vbuf, count)) {
4614 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4619 * Loose the unwritable mapped buffer
4623 * If flush took the "buffer" see if we have one from before
4625 if (!b->buf && m->bbuf)
4628 PerlIOBuf_get_base(aTHX_ f);
4632 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4636 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4638 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4639 PerlIOBuf *b = &m->base;
4640 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4642 * No, or wrong sort of, buffer
4645 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4649 * If unmap took the "buffer" see if we have one from before
4651 if (!b->buf && m->bbuf)
4654 PerlIOBuf_get_base(aTHX_ f);
4658 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4662 PerlIOMmap_flush(pTHX_ PerlIO *f)
4664 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4665 PerlIOBuf *b = &m->base;
4666 IV code = PerlIOBuf_flush(aTHX_ f);
4668 * Now we are "synced" at PerlIOBuf level
4675 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4680 * We seem to have a PerlIOBuf buffer which was not mapped
4681 * remember it in case we need one later
4690 PerlIOMmap_fill(pTHX_ PerlIO *f)
4692 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4693 IV code = PerlIO_flush(f);
4694 if (code == 0 && !b->buf) {
4695 code = PerlIOMmap_map(aTHX_ f);
4697 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4698 code = PerlIOBuf_fill(aTHX_ f);
4704 PerlIOMmap_close(pTHX_ PerlIO *f)
4706 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4707 PerlIOBuf *b = &m->base;
4708 IV code = PerlIO_flush(f);
4712 b->ptr = b->end = b->buf;
4714 if (PerlIOBuf_close(aTHX_ f) != 0)
4720 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4722 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4726 PerlIO_funcs PerlIO_mmap = {
4727 sizeof(PerlIO_funcs),
4730 PERLIO_K_BUFFERED | PERLIO_K_RAW,
4734 PerlIOBase_binmode, /* binmode */
4748 PerlIOBase_clearerr,
4749 PerlIOBase_setlinebuf,
4750 PerlIOMmap_get_base,
4754 PerlIOBuf_set_ptrcnt,
4757 #endif /* HAS_MMAP */
4760 Perl_PerlIO_stdin(pTHX)
4763 PerlIO_stdstreams(aTHX);
4765 return &PL_perlio[1];
4769 Perl_PerlIO_stdout(pTHX)
4772 PerlIO_stdstreams(aTHX);
4774 return &PL_perlio[2];
4778 Perl_PerlIO_stderr(pTHX)
4781 PerlIO_stdstreams(aTHX);
4783 return &PL_perlio[3];
4786 /*--------------------------------------------------------------------------------------*/
4789 PerlIO_getname(PerlIO *f, char *buf)
4794 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4796 name = fgetname(stdio, buf);
4798 Perl_croak(aTHX_ "Don't know how to get file name");
4804 /*--------------------------------------------------------------------------------------*/
4806 * Functions which can be called on any kind of PerlIO implemented in
4810 #undef PerlIO_fdopen
4812 PerlIO_fdopen(int fd, const char *mode)
4815 return PerlIO_openn(aTHX_ Nullch, mode, fd, 0, 0, NULL, 0, NULL);
4820 PerlIO_open(const char *path, const char *mode)
4823 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4824 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, NULL, 1, &name);
4827 #undef Perlio_reopen
4829 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4832 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4833 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, f, 1, &name);
4838 PerlIO_getc(PerlIO *f)
4842 SSize_t count = PerlIO_read(f, buf, 1);
4844 return (unsigned char) buf[0];
4849 #undef PerlIO_ungetc
4851 PerlIO_ungetc(PerlIO *f, int ch)
4856 if (PerlIO_unread(f, &buf, 1) == 1)
4864 PerlIO_putc(PerlIO *f, int ch)
4868 return PerlIO_write(f, &buf, 1);
4873 PerlIO_puts(PerlIO *f, const char *s)
4876 STRLEN len = strlen(s);
4877 return PerlIO_write(f, s, len);
4880 #undef PerlIO_rewind
4882 PerlIO_rewind(PerlIO *f)
4885 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4889 #undef PerlIO_vprintf
4891 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4894 SV *sv = newSVpvn("", 0);
4900 Perl_va_copy(ap, apc);
4901 sv_vcatpvf(sv, fmt, &apc);
4903 sv_vcatpvf(sv, fmt, &ap);
4906 wrote = PerlIO_write(f, s, len);
4911 #undef PerlIO_printf
4913 PerlIO_printf(PerlIO *f, const char *fmt, ...)
4918 result = PerlIO_vprintf(f, fmt, ap);
4923 #undef PerlIO_stdoutf
4925 PerlIO_stdoutf(const char *fmt, ...)
4931 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
4936 #undef PerlIO_tmpfile
4938 PerlIO_tmpfile(void)
4946 f = PerlIO_fdopen(fd, "w+b");
4949 SV *sv = newSVpv("/tmp/PerlIO_XXXXXX", 0);
4952 * I have no idea how portable mkstemp() is ... NI-S
4954 fd = mkstemp(SvPVX(sv));
4956 f = PerlIO_fdopen(fd, "w+");
4958 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
4959 PerlLIO_unlink(SvPVX(sv));
4962 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
4963 FILE *stdio = PerlSIO_tmpfile();
4966 if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)),
4967 &PerlIO_stdio, "w+", Nullsv))) {
4968 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
4974 # endif /* else HAS_MKSTEMP */
4975 #endif /* else WIN32 */
4982 #endif /* USE_SFIO */
4983 #endif /* PERLIO_IS_STDIO */
4985 /*======================================================================================*/
4987 * Now some functions in terms of above which may be needed even if we are
4988 * not in true PerlIO mode
4992 #undef PerlIO_setpos
4994 PerlIO_setpos(PerlIO *f, SV *pos)
4999 Off_t *posn = (Off_t *) SvPV(pos, len);
5000 if (f && len == sizeof(Off_t))
5001 return PerlIO_seek(f, *posn, SEEK_SET);
5003 SETERRNO(EINVAL, SS_IVCHAN);
5007 #undef PerlIO_setpos
5009 PerlIO_setpos(PerlIO *f, SV *pos)
5014 Fpos_t *fpos = (Fpos_t *) SvPV(pos, len);
5015 if (f && len == sizeof(Fpos_t)) {
5016 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5017 return fsetpos64(f, fpos);
5019 return fsetpos(f, fpos);
5023 SETERRNO(EINVAL, SS_IVCHAN);
5029 #undef PerlIO_getpos
5031 PerlIO_getpos(PerlIO *f, SV *pos)
5034 Off_t posn = PerlIO_tell(f);
5035 sv_setpvn(pos, (char *) &posn, sizeof(posn));
5036 return (posn == (Off_t) - 1) ? -1 : 0;
5039 #undef PerlIO_getpos
5041 PerlIO_getpos(PerlIO *f, SV *pos)
5046 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5047 code = fgetpos64(f, &fpos);
5049 code = fgetpos(f, &fpos);
5051 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
5056 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
5059 vprintf(char *pat, char *args)
5061 _doprnt(pat, args, stdout);
5062 return 0; /* wrong, but perl doesn't use the return
5067 vfprintf(FILE *fd, char *pat, char *args)
5069 _doprnt(pat, args, fd);
5070 return 0; /* wrong, but perl doesn't use the return
5076 #ifndef PerlIO_vsprintf
5078 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5080 int val = vsprintf(s, fmt, ap);
5082 if (strlen(s) >= (STRLEN) n) {
5084 (void) PerlIO_puts(Perl_error_log,
5085 "panic: sprintf overflow - memory corrupted!\n");
5093 #ifndef PerlIO_sprintf
5095 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5100 result = PerlIO_vsprintf(s, n, fmt, ap);