2 * perlio.c Copyright (c) 1996-2005, Nick Ing-Simmons You may distribute
3 * under the terms of either the GNU General Public License or the
4 * Artistic License, as specified in the README file.
8 * Hour after hour for nearly three weary days he had jogged up and down,
9 * over passes, and through long dales, and across many streams.
12 /* This file contains the functions needed to implement PerlIO, which
13 * is Perl's private replacement for the C stdio library. This is used
14 * by default unless you compile with -Uuseperlio or run with
15 * PERLIO=:stdio (but don't do this unless you know what you're doing)
19 * If we have ActivePerl-like PERL_IMPLICIT_SYS then we need a dTHX to get
20 * at the dispatch tables, even when we do not need it for other reasons.
21 * Invent a dSYS macro to abstract this out
23 #ifdef PERL_IMPLICIT_SYS
36 #define PERLIO_NOT_STDIO 0
37 #if !defined(PERLIO_IS_STDIO) && !defined(USE_SFIO)
43 * This file provides those parts of PerlIO abstraction
44 * which are not #defined in perlio.h.
45 * Which these are depends on various Configure #ifdef's
49 #define PERL_IN_PERLIO_C
52 #ifdef PERL_IMPLICIT_CONTEXT
59 #define PERLIO_MAX_REFCOUNTABLE_FD 2048
62 /* Missing proto on LynxOS */
66 /* Call the callback or PerlIOBase, and return failure. */
67 #define Perl_PerlIO_or_Base(f, callback, base, failure, args) \
68 if (PerlIOValid(f)) { \
69 const PerlIO_funcs *tab = PerlIOBase(f)->tab; \
70 if (tab && tab->callback) \
71 return (*tab->callback) args; \
73 return PerlIOBase_ ## base args; \
76 SETERRNO(EBADF, SS_IVCHAN); \
79 /* Call the callback or fail, and return failure. */
80 #define Perl_PerlIO_or_fail(f, callback, failure, args) \
81 if (PerlIOValid(f)) { \
82 const PerlIO_funcs *tab = PerlIOBase(f)->tab; \
83 if (tab && tab->callback) \
84 return (*tab->callback) args; \
85 SETERRNO(EINVAL, LIB_INVARG); \
88 SETERRNO(EBADF, SS_IVCHAN); \
91 /* Call the callback or PerlIOBase, and be void. */
92 #define Perl_PerlIO_or_Base_void(f, callback, base, args) \
93 if (PerlIOValid(f)) { \
94 const PerlIO_funcs *tab = PerlIOBase(f)->tab; \
95 if (tab && tab->callback) \
96 (*tab->callback) args; \
98 PerlIOBase_ ## base args; \
101 SETERRNO(EBADF, SS_IVCHAN)
103 /* Call the callback or fail, and be void. */
104 #define Perl_PerlIO_or_fail_void(f, callback, args) \
105 if (PerlIOValid(f)) { \
106 const PerlIO_funcs *tab = PerlIOBase(f)->tab; \
107 if (tab && tab->callback) \
108 (*tab->callback) args; \
110 SETERRNO(EINVAL, LIB_INVARG); \
113 SETERRNO(EBADF, SS_IVCHAN)
117 perlsio_binmode(FILE *fp, int iotype, int mode)
120 * This used to be contents of do_binmode in doio.c
123 # if defined(atarist) || defined(__MINT__)
126 ((FILE *) fp)->_flag |= _IOBIN;
128 ((FILE *) fp)->_flag &= ~_IOBIN;
135 if (PerlLIO_setmode(fp, mode) != -1) {
137 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
139 # if defined(WIN32) && defined(__BORLANDC__)
141 * The translation mode of the stream is maintained independent of
142 * the translation mode of the fd in the Borland RTL (heavy
143 * digging through their runtime sources reveal). User has to set
144 * the mode explicitly for the stream (though they don't document
145 * this anywhere). GSAR 97-5-24
151 fp->flags &= ~_F_BIN;
159 # if defined(USEMYBINMODE)
161 if (my_binmode(fp, iotype, mode) != FALSE)
167 PERL_UNUSED_ARG(iotype);
168 PERL_UNUSED_ARG(mode);
176 #define O_ACCMODE 3 /* Assume traditional implementation */
180 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
182 const int result = rawmode & O_ACCMODE;
187 ptype = IoTYPE_RDONLY;
190 ptype = IoTYPE_WRONLY;
198 *writing = (result != O_RDONLY);
200 if (result == O_RDONLY) {
204 else if (rawmode & O_APPEND) {
206 if (result != O_WRONLY)
211 if (result == O_WRONLY)
218 if (rawmode & O_BINARY)
224 #ifndef PERLIO_LAYERS
226 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
228 if (!names || !*names
229 || strEQ(names, ":crlf")
230 || strEQ(names, ":raw")
231 || strEQ(names, ":bytes")
235 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
243 PerlIO_destruct(pTHX)
248 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
251 PERL_UNUSED_ARG(iotype);
252 PERL_UNUSED_ARG(mode);
253 PERL_UNUSED_ARG(names);
256 return perlsio_binmode(fp, iotype, mode);
261 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
263 #if defined(PERL_MICRO) || defined(SYMBIAN)
266 #ifdef PERL_IMPLICIT_SYS
267 return PerlSIO_fdupopen(f);
270 return win32_fdupopen(f);
273 const int fd = PerlLIO_dup(PerlIO_fileno(f));
276 int omode = fcntl(fd, F_GETFL);
278 omode = djgpp_get_stream_mode(f);
280 PerlIO_intmode2str(omode,mode,NULL);
281 /* the r+ is a hack */
282 return PerlIO_fdopen(fd, mode);
287 SETERRNO(EBADF, SS_IVCHAN);
297 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
301 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
302 int imode, int perm, PerlIO *old, int narg, SV **args)
306 Perl_croak(aTHX_ "More than one argument to open");
308 if (*args == &PL_sv_undef)
309 return PerlIO_tmpfile();
311 const char *name = SvPV_nolen_const(*args);
312 if (*mode == IoTYPE_NUMERIC) {
313 fd = PerlLIO_open3(name, imode, perm);
315 return PerlIO_fdopen(fd, mode + 1);
318 return PerlIO_reopen(name, mode, old);
321 return PerlIO_open(name, mode);
326 return PerlIO_fdopen(fd, (char *) mode);
331 XS(XS_PerlIO__Layer__find)
335 Perl_croak(aTHX_ "Usage class->find(name[,load])");
337 const char *name = SvPV_nolen_const(ST(1));
338 ST(0) = (strEQ(name, "crlf")
339 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
346 Perl_boot_core_PerlIO(pTHX)
348 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
354 #ifdef PERLIO_IS_STDIO
360 * Does nothing (yet) except force this file to be included in perl
361 * binary. That allows this file to force inclusion of other functions
362 * that may be required by loadable extensions e.g. for
363 * FileHandle::tmpfile
367 #undef PerlIO_tmpfile
374 #else /* PERLIO_IS_STDIO */
382 * This section is just to make sure these functions get pulled in from
386 #undef PerlIO_tmpfile
397 * Force this file to be included in perl binary. Which allows this
398 * file to force inclusion of other functions that may be required by
399 * loadable extensions e.g. for FileHandle::tmpfile
403 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
404 * results in a lot of lseek()s to regular files and lot of small
407 sfset(sfstdout, SF_SHARE, 0);
410 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
412 PerlIO_importFILE(FILE *stdio, const char *mode)
414 const int fd = fileno(stdio);
415 if (!mode || !*mode) {
418 return PerlIO_fdopen(fd, mode);
422 PerlIO_findFILE(PerlIO *pio)
424 const int fd = PerlIO_fileno(pio);
425 FILE * const f = fdopen(fd, "r+");
427 if (!f && errno == EINVAL)
429 if (!f && errno == EINVAL)
436 /*======================================================================================*/
438 * Implement all the PerlIO interface ourselves.
444 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
451 #include <sys/mman.h>
455 PerlIO_debug(const char *fmt, ...)
460 if (!PL_perlio_debug_fd && !PL_tainting && PL_uid == PL_euid && PL_gid == PL_egid) {
461 const char *s = PerlEnv_getenv("PERLIO_DEBUG");
463 PL_perlio_debug_fd = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
465 PL_perlio_debug_fd = -1;
467 if (PL_perlio_debug_fd > 0) {
469 const char *s = CopFILE(PL_curcop);
472 /* Use fixed buffer as sv_catpvf etc. needs SVs */
476 len = sprintf(buffer, "%.40s:%" IVdf " ", s, (IV) CopLINE(PL_curcop));
477 vsprintf(buffer+len, fmt, ap);
478 PerlLIO_write(PL_perlio_debug_fd, buffer, strlen(buffer));
480 SV *sv = newSVpvn("", 0);
483 Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s,
484 (IV) CopLINE(PL_curcop));
485 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
487 s = SvPV_const(sv, len);
488 PerlLIO_write(PL_perlio_debug_fd, s, len);
495 /*--------------------------------------------------------------------------------------*/
498 * Inner level routines
502 * Table of pointers to the PerlIO structs (malloc'ed)
504 #define PERLIO_TABLE_SIZE 64
507 PerlIO_allocate(pTHX)
510 * Find a free slot in the table, allocating new table as necessary
515 while ((f = *last)) {
517 last = (PerlIO **) (f);
518 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
524 Newz('I',f,PERLIO_TABLE_SIZE,PerlIO);
532 #undef PerlIO_fdupopen
534 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
536 if (PerlIOValid(f)) {
537 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
538 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
540 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
542 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
546 SETERRNO(EBADF, SS_IVCHAN);
552 PerlIO_cleantable(pTHX_ PerlIO **tablep)
554 PerlIO *table = *tablep;
557 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
558 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
559 PerlIO *f = table + i;
571 PerlIO_list_alloc(pTHX)
574 Newz('L', list, 1, PerlIO_list_t);
580 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
583 if (--list->refcnt == 0) {
586 for (i = 0; i < list->cur; i++) {
587 if (list->array[i].arg)
588 SvREFCNT_dec(list->array[i].arg);
590 Safefree(list->array);
598 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
601 if (list->cur >= list->len) {
604 Renew(list->array, list->len, PerlIO_pair_t);
606 New('l', list->array, list->len, PerlIO_pair_t);
608 p = &(list->array[list->cur++]);
610 if ((p->arg = arg)) {
611 (void)SvREFCNT_inc(arg);
616 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
618 PerlIO_list_t *list = (PerlIO_list_t *) NULL;
621 list = PerlIO_list_alloc(aTHX);
622 for (i=0; i < proto->cur; i++) {
624 if (proto->array[i].arg)
625 arg = PerlIO_sv_dup(aTHX_ proto->array[i].arg,param);
626 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
633 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
636 PerlIO **table = &proto->Iperlio;
639 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
640 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
641 PerlIO_allocate(aTHX); /* root slot is never used */
642 PerlIO_debug("Clone %p from %p\n",aTHX,proto);
643 while ((f = *table)) {
645 table = (PerlIO **) (f++);
646 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
648 (void) fp_dup(f, 0, param);
654 PERL_UNUSED_ARG(proto);
655 PERL_UNUSED_ARG(param);
660 PerlIO_destruct(pTHX)
662 PerlIO **table = &PL_perlio;
665 PerlIO_debug("Destruct %p\n",aTHX);
667 while ((f = *table)) {
669 table = (PerlIO **) (f++);
670 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
674 if (l->tab->kind & PERLIO_K_DESTRUCT) {
675 PerlIO_debug("Destruct popping %s\n", l->tab->name);
689 PerlIO_pop(pTHX_ PerlIO *f)
693 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
694 if (l->tab->Popped) {
696 * If popped returns non-zero do not free its layer structure
697 * it has either done so itself, or it is shared and still in
700 if ((*l->tab->Popped) (aTHX_ f) != 0)
708 /* Return as an array the stack of layers on a filehandle. Note that
709 * the stack is returned top-first in the array, and there are three
710 * times as many array elements as there are layers in the stack: the
711 * first element of a layer triplet is the name, the second one is the
712 * arguments, and the third one is the flags. */
715 PerlIO_get_layers(pTHX_ PerlIO *f)
719 if (PerlIOValid(f)) {
720 PerlIOl *l = PerlIOBase(f);
723 SV *name = l->tab && l->tab->name ?
724 newSVpv(l->tab->name, 0) : &PL_sv_undef;
725 SV *arg = l->tab && l->tab->Getarg ?
726 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
729 av_push(av, newSViv((IV)l->flags));
737 /*--------------------------------------------------------------------------------------*/
739 * XS Interface for perl code
743 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 SAVEGENERICSV(PL_warnhook);
769 (void)SvREFCNT_inc(cv);
770 PL_warnhook = (SV *) cv;
774 * The two SVs are magically freed by load_module
776 Perl_load_module(aTHX_ 0, pkgsv, Nullsv, layer, Nullsv);
779 return PerlIO_find_layer(aTHX_ name, len, 0);
782 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
786 #ifdef USE_ATTRIBUTES_FOR_PERLIO
789 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
792 IO *io = GvIOn((GV *) SvRV(sv));
793 PerlIO *ifp = IoIFP(io);
794 PerlIO *ofp = IoOFP(io);
795 Perl_warn(aTHX_ "set %" SVf " %p %p %p", sv, io, ifp, ofp);
801 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
804 IO *io = GvIOn((GV *) SvRV(sv));
805 PerlIO *ifp = IoIFP(io);
806 PerlIO *ofp = IoOFP(io);
807 Perl_warn(aTHX_ "get %" SVf " %p %p %p", sv, io, ifp, ofp);
813 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
815 Perl_warn(aTHX_ "clear %" SVf, sv);
820 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
822 Perl_warn(aTHX_ "free %" SVf, sv);
826 MGVTBL perlio_vtab = {
834 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
837 SV *sv = SvRV(ST(1));
842 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
844 mg = mg_find(sv, PERL_MAGIC_ext);
845 mg->mg_virtual = &perlio_vtab;
847 Perl_warn(aTHX_ "attrib %" SVf, sv);
848 for (i = 2; i < items; i++) {
850 const char *name = SvPV_const(ST(i), len);
851 SV *layer = PerlIO_find_layer(aTHX_ name, len, 1);
853 av_push(av, SvREFCNT_inc(layer));
864 #endif /* USE_ATTIBUTES_FOR_PERLIO */
867 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
869 HV *stash = gv_stashpv("PerlIO::Layer", TRUE);
870 SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
874 XS(XS_PerlIO__Layer__NoWarnings)
876 /* This is used as a %SIG{__WARN__} handler to supress warnings
877 during loading of layers.
881 PerlIO_debug("warning:%s\n",SvPV_nolen_const(ST(0)));
885 XS(XS_PerlIO__Layer__find)
889 Perl_croak(aTHX_ "Usage class->find(name[,load])");
892 const char *name = SvPV_const(ST(1), len);
893 const bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
894 PerlIO_funcs *layer = PerlIO_find_layer(aTHX_ name, len, load);
896 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
903 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
905 if (!PL_known_layers)
906 PL_known_layers = PerlIO_list_alloc(aTHX);
907 PerlIO_list_push(aTHX_ PL_known_layers, tab, Nullsv);
908 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
912 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
915 const char *s = names;
917 while (isSPACE(*s) || *s == ':')
922 const char *as = Nullch;
924 if (!isIDFIRST(*s)) {
926 * Message is consistent with how attribute lists are
927 * passed. Even though this means "foo : : bar" is
928 * seen as an invalid separator character.
930 const char q = ((*s == '\'') ? '"' : '\'');
931 if (ckWARN(WARN_LAYER))
932 Perl_warner(aTHX_ packWARN(WARN_LAYER),
933 "Invalid separator character %c%c%c in PerlIO layer specification %s",
935 SETERRNO(EINVAL, LIB_INVARG);
940 } while (isALNUM(*e));
956 * It's a nul terminated string, not allowed
957 * to \ the terminating null. Anything other
958 * character is passed over.
968 if (ckWARN(WARN_LAYER))
969 Perl_warner(aTHX_ packWARN(WARN_LAYER),
970 "Argument list not closed for PerlIO layer \"%.*s\"",
982 const bool warn_layer = ckWARN(WARN_LAYER);
983 PerlIO_funcs *layer =
984 PerlIO_find_layer(aTHX_ s, llen, 1);
986 PerlIO_list_push(aTHX_ av, layer,
993 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
1006 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
1008 PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
1009 #ifdef PERLIO_USING_CRLF
1012 if (PerlIO_stdio.Set_ptrcnt)
1013 tab = &PerlIO_stdio;
1015 PerlIO_debug("Pushing %s\n", tab->name);
1016 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1021 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1023 return av->array[n].arg;
1027 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1029 if (n >= 0 && n < av->cur) {
1030 PerlIO_debug("Layer %" IVdf " is %s\n", n,
1031 av->array[n].funcs->name);
1032 return av->array[n].funcs;
1035 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1040 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1042 PERL_UNUSED_ARG(mode);
1043 PERL_UNUSED_ARG(arg);
1044 PERL_UNUSED_ARG(tab);
1045 if (PerlIOValid(f)) {
1047 PerlIO_pop(aTHX_ f);
1053 PERLIO_FUNCS_DECL(PerlIO_remove) = {
1054 sizeof(PerlIO_funcs),
1057 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1077 NULL, /* get_base */
1078 NULL, /* get_bufsiz */
1081 NULL, /* set_ptrcnt */
1085 PerlIO_default_layers(pTHX)
1087 if (!PL_def_layerlist) {
1088 const char *s = (PL_tainting) ? Nullch : PerlEnv_getenv("PERLIO");
1089 PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1090 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1091 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1093 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1095 osLayer = &PerlIO_win32;
1098 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1099 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1100 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1101 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1103 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_mmap));
1105 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1106 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1107 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1108 PerlIO_list_push(aTHX_ PL_def_layerlist,
1109 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1112 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1115 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1118 if (PL_def_layerlist->cur < 2) {
1119 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1121 return PL_def_layerlist;
1125 Perl_boot_core_PerlIO(pTHX)
1127 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1128 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1131 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1132 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1136 PerlIO_default_layer(pTHX_ I32 n)
1138 PerlIO_list_t *av = PerlIO_default_layers(aTHX);
1141 return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1144 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1145 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1148 PerlIO_stdstreams(pTHX)
1151 PerlIO_allocate(aTHX);
1152 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1153 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1154 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1159 PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1161 if (tab->fsize != sizeof(PerlIO_funcs)) {
1163 Perl_croak(aTHX_ "Layer does not match this perl");
1167 if (tab->size < sizeof(PerlIOl)) {
1170 /* Real layer with a data area */
1171 Newc('L',l,tab->size,char,PerlIOl);
1173 Zero(l, tab->size, char);
1175 l->tab = (PerlIO_funcs*) tab;
1177 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1178 (mode) ? mode : "(Null)", (void*)arg);
1179 if (*l->tab->Pushed &&
1180 (*l->tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1181 PerlIO_pop(aTHX_ f);
1187 /* Pseudo-layer where push does its own stack adjust */
1188 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1189 (mode) ? mode : "(Null)", (void*)arg);
1191 (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1199 PerlIOBase_binmode(pTHX_ PerlIO *f)
1201 if (PerlIOValid(f)) {
1202 /* Is layer suitable for raw stream ? */
1203 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1204 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1205 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1208 /* Not suitable - pop it */
1209 PerlIO_pop(aTHX_ f);
1217 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1219 PERL_UNUSED_ARG(mode);
1220 PERL_UNUSED_ARG(arg);
1221 PERL_UNUSED_ARG(tab);
1223 if (PerlIOValid(f)) {
1228 * Strip all layers that are not suitable for a raw stream
1231 while (t && (l = *t)) {
1232 if (l->tab->Binmode) {
1233 /* Has a handler - normal case */
1234 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1236 /* Layer still there - move down a layer */
1245 /* No handler - pop it */
1246 PerlIO_pop(aTHX_ t);
1249 if (PerlIOValid(f)) {
1250 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1258 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1259 PerlIO_list_t *layers, IV n, IV max)
1263 PerlIO_funcs * const tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1265 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1276 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1280 PerlIO_list_t * const layers = PerlIO_list_alloc(aTHX);
1281 code = PerlIO_parse_layers(aTHX_ layers, names);
1283 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1285 PerlIO_list_free(aTHX_ layers);
1291 /*--------------------------------------------------------------------------------------*/
1293 * Given the abstraction above the public API functions
1297 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1299 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n",
1300 (void*)f, PerlIOBase(f)->tab->name, iotype, mode,
1301 (names) ? names : "(Null)");
1303 /* Do not flush etc. if (e.g.) switching encodings.
1304 if a pushed layer knows it needs to flush lower layers
1305 (for example :unix which is never going to call them)
1306 it can do the flush when it is pushed.
1308 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1311 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1312 #ifdef PERLIO_USING_CRLF
1313 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1314 O_BINARY so we can look for it in mode.
1316 if (!(mode & O_BINARY)) {
1318 /* FIXME?: Looking down the layer stack seems wrong,
1319 but is a way of reaching past (say) an encoding layer
1320 to flip CRLF-ness of the layer(s) below
1323 /* Perhaps we should turn on bottom-most aware layer
1324 e.g. Ilya's idea that UNIX TTY could serve
1326 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1327 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1328 /* Not in text mode - flush any pending stuff and flip it */
1330 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1332 /* Only need to turn it on in one layer so we are done */
1337 /* Not finding a CRLF aware layer presumably means we are binary
1338 which is not what was requested - so we failed
1339 We _could_ push :crlf layer but so could caller
1344 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1345 So code that used to be here is now in PerlIORaw_pushed().
1347 return PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), Nullch, Nullsv) ? TRUE : FALSE;
1352 PerlIO__close(pTHX_ PerlIO *f)
1354 if (PerlIOValid(f)) {
1355 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1356 if (tab && tab->Close)
1357 return (*tab->Close)(aTHX_ f);
1359 return PerlIOBase_close(aTHX_ f);
1362 SETERRNO(EBADF, SS_IVCHAN);
1368 Perl_PerlIO_close(pTHX_ PerlIO *f)
1370 const int code = PerlIO__close(aTHX_ f);
1371 while (PerlIOValid(f)) {
1372 PerlIO_pop(aTHX_ f);
1378 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1380 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1384 PerlIO_context_layers(pTHX_ const char *mode)
1386 const char *type = NULL;
1388 * Need to supply default layer info from open.pm
1391 SV *layers = PL_curcop->cop_io;
1394 type = SvPV_const(layers, len);
1395 if (type && mode[0] != 'r') {
1397 * Skip to write part
1399 const char *s = strchr(type, 0);
1400 if (s && (STRLEN)(s - type) < len) {
1409 static PerlIO_funcs *
1410 PerlIO_layer_from_ref(pTHX_ SV *sv)
1413 * For any scalar type load the handler which is bundled with perl
1415 if (SvTYPE(sv) < SVt_PVAV)
1416 return PerlIO_find_layer(aTHX_ "scalar", 6, 1);
1419 * For other types allow if layer is known but don't try and load it
1421 switch (SvTYPE(sv)) {
1423 return PerlIO_find_layer(aTHX_ "Array", 5, 0);
1425 return PerlIO_find_layer(aTHX_ "Hash", 4, 0);
1427 return PerlIO_find_layer(aTHX_ "Code", 4, 0);
1429 return PerlIO_find_layer(aTHX_ "Glob", 4, 0);
1435 PerlIO_resolve_layers(pTHX_ const char *layers,
1436 const char *mode, int narg, SV **args)
1438 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1441 PerlIO_stdstreams(aTHX);
1445 * If it is a reference but not an object see if we have a handler
1448 if (SvROK(arg) && !sv_isobject(arg)) {
1449 PerlIO_funcs *handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1451 def = PerlIO_list_alloc(aTHX);
1452 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1456 * Don't fail if handler cannot be found :via(...) etc. may do
1457 * something sensible else we will just stringfy and open
1463 layers = PerlIO_context_layers(aTHX_ mode);
1464 if (layers && *layers) {
1468 av = PerlIO_list_alloc(aTHX);
1469 for (i = 0; i < def->cur; i++) {
1470 PerlIO_list_push(aTHX_ av, def->array[i].funcs,
1477 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1481 PerlIO_list_free(aTHX_ av);
1482 return (PerlIO_list_t *) NULL;
1493 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1494 int imode, int perm, PerlIO *f, int narg, SV **args)
1496 if (!f && narg == 1 && *args == &PL_sv_undef) {
1497 if ((f = PerlIO_tmpfile())) {
1499 layers = PerlIO_context_layers(aTHX_ mode);
1500 if (layers && *layers)
1501 PerlIO_apply_layers(aTHX_ f, mode, layers);
1505 PerlIO_list_t *layera;
1507 PerlIO_funcs *tab = NULL;
1508 if (PerlIOValid(f)) {
1510 * This is "reopen" - it is not tested as perl does not use it
1514 layera = PerlIO_list_alloc(aTHX);
1516 SV *arg = (l->tab->Getarg)
1517 ? (*l->tab->Getarg) (aTHX_ &l, NULL, 0)
1519 PerlIO_list_push(aTHX_ layera, l->tab, arg);
1520 l = *PerlIONext(&l);
1524 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1530 * Start at "top" of layer stack
1532 n = layera->cur - 1;
1534 PerlIO_funcs *t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1543 * Found that layer 'n' can do opens - call it
1545 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1546 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1548 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1549 tab->name, layers, mode, fd, imode, perm,
1550 (void*)f, narg, (void*)args);
1552 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1555 SETERRNO(EINVAL, LIB_INVARG);
1559 if (n + 1 < layera->cur) {
1561 * More layers above the one that we used to open -
1564 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1565 /* If pushing layers fails close the file */
1572 PerlIO_list_free(aTHX_ layera);
1579 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1581 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1585 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1587 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1591 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1593 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1597 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1599 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1603 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1605 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1609 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1613 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1615 if (tab && tab->Flush)
1616 return (*tab->Flush) (aTHX_ f);
1618 return 0; /* If no Flush defined, silently succeed. */
1621 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1622 SETERRNO(EBADF, SS_IVCHAN);
1628 * Is it good API design to do flush-all on NULL, a potentially
1629 * errorneous input? Maybe some magical value (PerlIO*
1630 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1631 * things on fflush(NULL), but should we be bound by their design
1634 PerlIO **table = &PL_perlio;
1636 while ((f = *table)) {
1638 table = (PerlIO **) (f++);
1639 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1640 if (*f && PerlIO_flush(f) != 0)
1650 PerlIOBase_flush_linebuf(pTHX)
1652 PerlIO **table = &PL_perlio;
1654 while ((f = *table)) {
1656 table = (PerlIO **) (f++);
1657 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1660 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1661 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1669 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1671 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1675 PerlIO_isutf8(PerlIO *f)
1678 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1680 SETERRNO(EBADF, SS_IVCHAN);
1686 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1688 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1692 Perl_PerlIO_error(pTHX_ PerlIO *f)
1694 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1698 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1700 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1704 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1706 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1710 PerlIO_has_base(PerlIO *f)
1712 if (PerlIOValid(f)) {
1713 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1716 return (tab->Get_base != NULL);
1717 SETERRNO(EINVAL, LIB_INVARG);
1720 SETERRNO(EBADF, SS_IVCHAN);
1726 PerlIO_fast_gets(PerlIO *f)
1728 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1729 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1732 return (tab->Set_ptrcnt != NULL);
1733 SETERRNO(EINVAL, LIB_INVARG);
1736 SETERRNO(EBADF, SS_IVCHAN);
1742 PerlIO_has_cntptr(PerlIO *f)
1744 if (PerlIOValid(f)) {
1745 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1748 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1749 SETERRNO(EINVAL, LIB_INVARG);
1752 SETERRNO(EBADF, SS_IVCHAN);
1758 PerlIO_canset_cnt(PerlIO *f)
1760 if (PerlIOValid(f)) {
1761 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1764 return (tab->Set_ptrcnt != NULL);
1765 SETERRNO(EINVAL, LIB_INVARG);
1768 SETERRNO(EBADF, SS_IVCHAN);
1774 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1776 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1780 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1782 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1786 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1788 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1792 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1794 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1798 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1800 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1804 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1806 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1810 /*--------------------------------------------------------------------------------------*/
1812 * utf8 and raw dummy layers
1816 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1818 PERL_UNUSED_ARG(mode);
1819 PERL_UNUSED_ARG(arg);
1820 if (PerlIOValid(f)) {
1821 if (tab->kind & PERLIO_K_UTF8)
1822 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1824 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1830 PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1831 sizeof(PerlIO_funcs),
1834 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1854 NULL, /* get_base */
1855 NULL, /* get_bufsiz */
1858 NULL, /* set_ptrcnt */
1861 PERLIO_FUNCS_DECL(PerlIO_byte) = {
1862 sizeof(PerlIO_funcs),
1885 NULL, /* get_base */
1886 NULL, /* get_bufsiz */
1889 NULL, /* set_ptrcnt */
1893 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1894 IV n, const char *mode, int fd, int imode, int perm,
1895 PerlIO *old, int narg, SV **args)
1897 PerlIO_funcs * const tab = PerlIO_default_btm();
1898 PERL_UNUSED_ARG(self);
1899 if (tab && tab->Open)
1900 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1902 SETERRNO(EINVAL, LIB_INVARG);
1906 PERLIO_FUNCS_DECL(PerlIO_raw) = {
1907 sizeof(PerlIO_funcs),
1930 NULL, /* get_base */
1931 NULL, /* get_bufsiz */
1934 NULL, /* set_ptrcnt */
1936 /*--------------------------------------------------------------------------------------*/
1937 /*--------------------------------------------------------------------------------------*/
1939 * "Methods" of the "base class"
1943 PerlIOBase_fileno(pTHX_ PerlIO *f)
1945 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1949 PerlIO_modestr(PerlIO * f, char *buf)
1952 if (PerlIOValid(f)) {
1953 const IV flags = PerlIOBase(f)->flags;
1954 if (flags & PERLIO_F_APPEND) {
1956 if (flags & PERLIO_F_CANREAD) {
1960 else if (flags & PERLIO_F_CANREAD) {
1962 if (flags & PERLIO_F_CANWRITE)
1965 else if (flags & PERLIO_F_CANWRITE) {
1967 if (flags & PERLIO_F_CANREAD) {
1971 #ifdef PERLIO_USING_CRLF
1972 if (!(flags & PERLIO_F_CRLF))
1982 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1984 PerlIOl * const l = PerlIOBase(f);
1985 PERL_UNUSED_ARG(arg);
1987 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
1988 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
1989 if (tab->Set_ptrcnt != NULL)
1990 l->flags |= PERLIO_F_FASTGETS;
1992 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
1996 l->flags |= PERLIO_F_CANREAD;
1999 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
2002 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
2005 SETERRNO(EINVAL, LIB_INVARG);
2011 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2014 l->flags &= ~PERLIO_F_CRLF;
2017 l->flags |= PERLIO_F_CRLF;
2020 SETERRNO(EINVAL, LIB_INVARG);
2027 l->flags |= l->next->flags &
2028 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2033 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2034 f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2035 l->flags, PerlIO_modestr(f, temp));
2041 PerlIOBase_popped(pTHX_ PerlIO *f)
2048 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2051 * Save the position as current head considers it
2053 const Off_t old = PerlIO_tell(f);
2054 PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", Nullsv);
2055 PerlIOSelf(f, PerlIOBuf)->posn = old;
2056 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
2060 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2062 STDCHAR *buf = (STDCHAR *) vbuf;
2064 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2065 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2066 SETERRNO(EBADF, SS_IVCHAN);
2070 SSize_t avail = PerlIO_get_cnt(f);
2073 take = ((SSize_t)count < avail) ? count : avail;
2075 STDCHAR *ptr = PerlIO_get_ptr(f);
2076 Copy(ptr, buf, take, STDCHAR);
2077 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2081 if (count > 0 && avail <= 0) {
2082 if (PerlIO_fill(f) != 0)
2086 return (buf - (STDCHAR *) vbuf);
2092 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2099 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2106 PerlIOBase_close(pTHX_ PerlIO *f)
2109 if (PerlIOValid(f)) {
2110 PerlIO *n = PerlIONext(f);
2111 code = PerlIO_flush(f);
2112 PerlIOBase(f)->flags &=
2113 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2114 while (PerlIOValid(n)) {
2115 const PerlIO_funcs * const tab = PerlIOBase(n)->tab;
2116 if (tab && tab->Close) {
2117 if ((*tab->Close)(aTHX_ n) != 0)
2122 PerlIOBase(n)->flags &=
2123 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2129 SETERRNO(EBADF, SS_IVCHAN);
2135 PerlIOBase_eof(pTHX_ PerlIO *f)
2137 if (PerlIOValid(f)) {
2138 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2144 PerlIOBase_error(pTHX_ PerlIO *f)
2146 if (PerlIOValid(f)) {
2147 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2153 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2155 if (PerlIOValid(f)) {
2156 PerlIO *n = PerlIONext(f);
2157 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2164 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2166 if (PerlIOValid(f)) {
2167 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2172 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2178 return sv_dup(arg, param);
2181 return newSVsv(arg);
2184 PERL_UNUSED_ARG(param);
2185 return newSVsv(arg);
2190 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2192 PerlIO * const nexto = PerlIONext(o);
2193 if (PerlIOValid(nexto)) {
2194 const PerlIO_funcs * const tab = PerlIOBase(nexto)->tab;
2195 if (tab && tab->Dup)
2196 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2198 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2201 PerlIO_funcs *self = PerlIOBase(o)->tab;
2204 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2205 self->name, (void*)f, (void*)o, (void*)param);
2207 arg = (*self->Getarg)(aTHX_ o, param, flags);
2211 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2220 perl_mutex PerlIO_mutex;
2223 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2228 /* Place holder for stdstreams call ??? */
2230 MUTEX_INIT(&PerlIO_mutex);
2235 PerlIOUnix_refcnt_inc(int fd)
2238 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2240 MUTEX_LOCK(&PerlIO_mutex);
2242 PL_perlio_fd_refcnt[fd]++;
2243 PerlIO_debug("fd %d refcnt=%d\n",fd,PL_perlio_fd_refcnt[fd]);
2245 MUTEX_UNLOCK(&PerlIO_mutex);
2251 PerlIOUnix_refcnt_dec(int fd)
2255 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2257 MUTEX_LOCK(&PerlIO_mutex);
2259 cnt = --PL_perlio_fd_refcnt[fd];
2260 PerlIO_debug("fd %d refcnt=%d\n",fd,cnt);
2262 MUTEX_UNLOCK(&PerlIO_mutex);
2269 PerlIO_cleanup(pTHX)
2273 PerlIO_debug("Cleanup layers for %p\n",aTHX);
2275 PerlIO_debug("Cleanup layers\n");
2277 /* Raise STDIN..STDERR refcount so we don't close them */
2278 for (i=0; i < 3; i++)
2279 PerlIOUnix_refcnt_inc(i);
2280 PerlIO_cleantable(aTHX_ &PL_perlio);
2281 /* Restore STDIN..STDERR refcount */
2282 for (i=0; i < 3; i++)
2283 PerlIOUnix_refcnt_dec(i);
2285 if (PL_known_layers) {
2286 PerlIO_list_free(aTHX_ PL_known_layers);
2287 PL_known_layers = NULL;
2289 if (PL_def_layerlist) {
2290 PerlIO_list_free(aTHX_ PL_def_layerlist);
2291 PL_def_layerlist = NULL;
2297 /*--------------------------------------------------------------------------------------*/
2299 * Bottom-most level for UNIX-like case
2303 struct _PerlIO base; /* The generic part */
2304 int fd; /* UNIX like file descriptor */
2305 int oflags; /* open/fcntl flags */
2309 PerlIOUnix_oflags(const char *mode)
2312 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2317 if (*++mode == '+') {
2324 oflags = O_CREAT | O_TRUNC;
2325 if (*++mode == '+') {
2334 oflags = O_CREAT | O_APPEND;
2335 if (*++mode == '+') {
2348 else if (*mode == 't') {
2350 oflags &= ~O_BINARY;
2354 * Always open in binary mode
2357 if (*mode || oflags == -1) {
2358 SETERRNO(EINVAL, LIB_INVARG);
2365 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2367 return PerlIOSelf(f, PerlIOUnix)->fd;
2371 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2373 PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2376 if (PerlLIO_fstat(fd, &st) == 0) {
2377 if (!S_ISREG(st.st_mode)) {
2378 PerlIO_debug("%d is not regular file\n",fd);
2379 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2382 PerlIO_debug("%d _is_ a regular file\n",fd);
2388 PerlIOUnix_refcnt_inc(fd);
2392 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2394 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2395 if (*PerlIONext(f)) {
2396 /* We never call down so do any pending stuff now */
2397 PerlIO_flush(PerlIONext(f));
2399 * XXX could (or should) we retrieve the oflags from the open file
2400 * handle rather than believing the "mode" we are passed in? XXX
2401 * Should the value on NULL mode be 0 or -1?
2403 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2404 mode ? PerlIOUnix_oflags(mode) : -1);
2406 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2412 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2414 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2416 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2418 SETERRNO(ESPIPE, LIB_INVARG);
2420 SETERRNO(EINVAL, LIB_INVARG);
2424 new_loc = PerlLIO_lseek(fd, offset, whence);
2425 if (new_loc == (Off_t) - 1)
2429 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2434 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2435 IV n, const char *mode, int fd, int imode,
2436 int perm, PerlIO *f, int narg, SV **args)
2438 if (PerlIOValid(f)) {
2439 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2440 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2443 if (*mode == IoTYPE_NUMERIC)
2446 imode = PerlIOUnix_oflags(mode);
2450 const char *path = SvPV_nolen_const(*args);
2451 fd = PerlLIO_open3(path, imode, perm);
2455 if (*mode == IoTYPE_IMPLICIT)
2458 f = PerlIO_allocate(aTHX);
2460 if (!PerlIOValid(f)) {
2461 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2465 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2466 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2467 if (*mode == IoTYPE_APPEND)
2468 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2474 * FIXME: pop layers ???
2482 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2484 PerlIOUnix *os = PerlIOSelf(o, PerlIOUnix);
2486 if (flags & PERLIO_DUP_FD) {
2487 fd = PerlLIO_dup(fd);
2489 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2490 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2492 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2493 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2502 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2504 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2505 #ifdef PERLIO_STD_SPECIAL
2507 return PERLIO_STD_IN(fd, vbuf, count);
2509 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2510 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2514 const SSize_t len = PerlLIO_read(fd, vbuf, count);
2515 if (len >= 0 || errno != EINTR) {
2517 if (errno != EAGAIN) {
2518 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2521 else if (len == 0 && count != 0) {
2522 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2533 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2535 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2536 #ifdef PERLIO_STD_SPECIAL
2537 if (fd == 1 || fd == 2)
2538 return PERLIO_STD_OUT(fd, vbuf, count);
2541 const SSize_t len = PerlLIO_write(fd, vbuf, count);
2542 if (len >= 0 || errno != EINTR) {
2544 if (errno != EAGAIN) {
2545 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2556 PerlIOUnix_tell(pTHX_ PerlIO *f)
2558 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2563 PerlIOUnix_close(pTHX_ PerlIO *f)
2565 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2567 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2568 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2569 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2574 SETERRNO(EBADF,SS_IVCHAN);
2577 while (PerlLIO_close(fd) != 0) {
2578 if (errno != EINTR) {
2585 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2590 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2591 sizeof(PerlIO_funcs),
2598 PerlIOBase_binmode, /* binmode */
2608 PerlIOBase_noop_ok, /* flush */
2609 PerlIOBase_noop_fail, /* fill */
2612 PerlIOBase_clearerr,
2613 PerlIOBase_setlinebuf,
2614 NULL, /* get_base */
2615 NULL, /* get_bufsiz */
2618 NULL, /* set_ptrcnt */
2621 /*--------------------------------------------------------------------------------------*/
2626 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2627 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2628 broken by the last second glibc 2.3 fix
2630 #define STDIO_BUFFER_WRITABLE
2635 struct _PerlIO base;
2636 FILE *stdio; /* The stream */
2640 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2643 if (PerlIOValid(f) && (s = PerlIOSelf(f, PerlIOStdio)->stdio)) {
2644 return PerlSIO_fileno(s);
2651 PerlIOStdio_mode(const char *mode, char *tmode)
2653 char * const ret = tmode;
2659 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2667 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2670 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2671 PerlIO_funcs *toptab = PerlIOBase(n)->tab;
2672 if (toptab == tab) {
2673 /* Top is already stdio - pop self (duplicate) and use original */
2674 PerlIO_pop(aTHX_ f);
2677 const int fd = PerlIO_fileno(n);
2680 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2681 mode = PerlIOStdio_mode(mode, tmode)))) {
2682 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2683 /* We never call down so do any pending stuff now */
2684 PerlIO_flush(PerlIONext(f));
2691 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2696 PerlIO_importFILE(FILE *stdio, const char *mode)
2702 if (!mode || !*mode) {
2703 /* We need to probe to see how we can open the stream
2704 so start with read/write and then try write and read
2705 we dup() so that we can fclose without loosing the fd.
2707 Note that the errno value set by a failing fdopen
2708 varies between stdio implementations.
2710 const int fd = PerlLIO_dup(fileno(stdio));
2711 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2713 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2716 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2719 /* Don't seem to be able to open */
2725 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, Nullsv))) {
2726 s = PerlIOSelf(f, PerlIOStdio);
2734 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2735 IV n, const char *mode, int fd, int imode,
2736 int perm, PerlIO *f, int narg, SV **args)
2739 if (PerlIOValid(f)) {
2740 const char *path = SvPV_nolen_const(*args);
2741 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2743 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2744 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2749 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2754 const char *path = SvPV_nolen_const(*args);
2755 if (*mode == IoTYPE_NUMERIC) {
2757 fd = PerlLIO_open3(path, imode, perm);
2761 bool appended = FALSE;
2763 /* Cygwin wants its 'b' early. */
2765 mode = PerlIOStdio_mode(mode, tmode);
2767 stdio = PerlSIO_fopen(path, mode);
2771 f = PerlIO_allocate(aTHX);
2774 mode = PerlIOStdio_mode(mode, tmode);
2775 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2777 s = PerlIOSelf(f, PerlIOStdio);
2779 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2791 if (*mode == IoTYPE_IMPLICIT) {
2798 stdio = PerlSIO_stdin;
2801 stdio = PerlSIO_stdout;
2804 stdio = PerlSIO_stderr;
2809 stdio = PerlSIO_fdopen(fd, mode =
2810 PerlIOStdio_mode(mode, tmode));
2814 f = PerlIO_allocate(aTHX);
2816 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2817 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2819 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2829 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2831 /* This assumes no layers underneath - which is what
2832 happens, but is not how I remember it. NI-S 2001/10/16
2834 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2835 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2836 const int fd = fileno(stdio);
2838 if (flags & PERLIO_DUP_FD) {
2839 const int dfd = PerlLIO_dup(fileno(stdio));
2841 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2845 /* FIXME: To avoid messy error recovery if dup fails
2846 re-use the existing stdio as though flag was not set
2850 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2852 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2853 PerlIOUnix_refcnt_inc(fileno(stdio));
2859 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
2861 /* XXX this could use PerlIO_canset_fileno() and
2862 * PerlIO_set_fileno() support from Configure
2864 # if defined(__UCLIBC__)
2865 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
2868 # elif defined(__GLIBC__)
2869 /* There may be a better way for GLIBC:
2870 - libio.h defines a flag to not close() on cleanup
2874 # elif defined(__sun__)
2876 /* On solaris, if _LP64 is defined, the FILE structure is this:
2882 * It turns out that the fd is stored in the top 32 bits of
2883 * file->__pad[4]. The lower 32 bits contain flags. file->pad[5] appears
2884 * to contain a pointer or offset into another structure. All the
2885 * remaining fields are zero.
2887 * We set the top bits to -1 (0xFFFFFFFF).
2889 f->__pad[4] |= 0xffffffff00000000L;
2890 assert(fileno(f) == 0xffffffff);
2891 # else /* !defined(_LP64) */
2892 /* _file is just a unsigned char :-(
2893 Not clear why we dup() rather than using -1
2894 even if that would be treated as 0xFF - so will
2897 f->_file = PerlLIO_dup(fileno(f));
2898 # endif /* defined(_LP64) */
2900 # elif defined(__hpux)
2904 /* Next one ->_file seems to be a reasonable fallback, i.e. if
2905 your platform does not have special entry try this one.
2906 [For OSF only have confirmation for Tru64 (alpha)
2907 but assume other OSFs will be similar.]
2909 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
2912 # elif defined(__FreeBSD__)
2913 /* There may be a better way on FreeBSD:
2914 - we could insert a dummy func in the _close function entry
2915 f->_close = (int (*)(void *)) dummy_close;
2919 # elif defined(__OpenBSD__)
2920 /* There may be a better way on OpenBSD:
2921 - we could insert a dummy func in the _close function entry
2922 f->_close = (int (*)(void *)) dummy_close;
2926 # elif defined(__EMX__)
2927 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
2930 # elif defined(__CYGWIN__)
2931 /* There may be a better way on CYGWIN:
2932 - we could insert a dummy func in the _close function entry
2933 f->_close = (int (*)(void *)) dummy_close;
2937 # elif defined(WIN32)
2938 # if defined(__BORLANDC__)
2939 f->fd = PerlLIO_dup(fileno(f));
2940 # elif defined(UNDER_CE)
2941 /* WIN_CE does not have access to FILE internals, it hardly has FILE
2950 /* Sarathy's code did this - we fall back to a dup/dup2 hack
2951 (which isn't thread safe) instead
2953 # error "Don't know how to set FILE.fileno on your platform"
2961 PerlIOStdio_close(pTHX_ PerlIO *f)
2963 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
2969 const int fd = fileno(stdio);
2975 #ifdef SOCKS5_VERSION_NAME
2976 /* Socks lib overrides close() but stdio isn't linked to
2977 that library (though we are) - so we must call close()
2978 on sockets on stdio's behalf.
2981 Sock_size_t optlen = sizeof(int);
2982 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0) {
2987 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2988 /* File descriptor still in use */
2993 /* For STD* handles don't close the stdio at all
2994 this is because we have shared the FILE * too
2996 if (stdio == stdin) {
2997 /* Some stdios are buggy fflush-ing inputs */
3000 else if (stdio == stdout || stdio == stderr) {
3001 return PerlIO_flush(f);
3003 /* Tricky - must fclose(stdio) to free memory but not close(fd)
3004 Use Sarathy's trick from maint-5.6 to invalidate the
3005 fileno slot of the FILE *
3007 result = PerlIO_flush(f);
3009 if (!(invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio))) {
3010 dupfd = PerlLIO_dup(fd);
3013 result = PerlSIO_fclose(stdio);
3014 /* We treat error from stdio as success if we invalidated
3015 errno may NOT be expected EBADF
3017 if (invalidate && result != 0) {
3022 /* in SOCKS case let close() determine return value */
3026 PerlLIO_dup2(dupfd,fd);
3027 PerlLIO_close(dupfd);
3034 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3036 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3040 STDCHAR *buf = (STDCHAR *) vbuf;
3042 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3043 * stdio does not do that for fread()
3045 const int ch = PerlSIO_fgetc(s);
3052 got = PerlSIO_fread(vbuf, 1, count, s);
3053 if (got == 0 && PerlSIO_ferror(s))
3055 if (got >= 0 || errno != EINTR)
3058 SETERRNO(0,0); /* just in case */
3064 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3067 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3069 #ifdef STDIO_BUFFER_WRITABLE
3070 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3071 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3072 STDCHAR *base = PerlIO_get_base(f);
3073 SSize_t cnt = PerlIO_get_cnt(f);
3074 STDCHAR *ptr = PerlIO_get_ptr(f);
3075 SSize_t avail = ptr - base;
3077 if (avail > count) {
3081 Move(buf-avail,ptr,avail,STDCHAR);
3084 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3085 if (PerlSIO_feof(s) && unread >= 0)
3086 PerlSIO_clearerr(s);
3091 if (PerlIO_has_cntptr(f)) {
3092 /* We can get pointer to buffer but not its base
3093 Do ungetc() but check chars are ending up in the
3096 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3097 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3099 const int ch = *--buf & 0xFF;
3100 if (ungetc(ch,s) != ch) {
3101 /* ungetc did not work */
3104 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3105 /* Did not change pointer as expected */
3106 fgetc(s); /* get char back again */
3116 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3122 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3126 got = PerlSIO_fwrite(vbuf, 1, count,
3127 PerlIOSelf(f, PerlIOStdio)->stdio);
3128 if (got >= 0 || errno != EINTR)
3131 SETERRNO(0,0); /* just in case */
3137 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3139 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3140 return PerlSIO_fseek(stdio, offset, whence);
3144 PerlIOStdio_tell(pTHX_ PerlIO *f)
3146 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3147 return PerlSIO_ftell(stdio);
3151 PerlIOStdio_flush(pTHX_ PerlIO *f)
3153 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3154 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3155 return PerlSIO_fflush(stdio);
3160 * FIXME: This discards ungetc() and pre-read stuff which is not
3161 * right if this is just a "sync" from a layer above Suspect right
3162 * design is to do _this_ but not have layer above flush this
3163 * layer read-to-read
3166 * Not writeable - sync by attempting a seek
3169 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3177 PerlIOStdio_eof(pTHX_ PerlIO *f)
3179 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3183 PerlIOStdio_error(pTHX_ PerlIO *f)
3185 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3189 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3191 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3195 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3197 #ifdef HAS_SETLINEBUF
3198 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3200 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, Nullch, _IOLBF, 0);
3206 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3208 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3209 return (STDCHAR*)PerlSIO_get_base(stdio);
3213 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3215 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3216 return PerlSIO_get_bufsiz(stdio);
3220 #ifdef USE_STDIO_PTR
3222 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3224 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3225 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3229 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3231 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3232 return PerlSIO_get_cnt(stdio);
3236 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3238 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3240 #ifdef STDIO_PTR_LVALUE
3241 PerlSIO_set_ptr(stdio, (void*)ptr); /* LHS STDCHAR* cast non-portable */
3242 #ifdef STDIO_PTR_LVAL_SETS_CNT
3243 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3244 assert(PerlSIO_get_cnt(stdio) == (cnt));
3247 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3249 * Setting ptr _does_ change cnt - we are done
3253 #else /* STDIO_PTR_LVALUE */
3255 #endif /* STDIO_PTR_LVALUE */
3258 * Now (or only) set cnt
3260 #ifdef STDIO_CNT_LVALUE
3261 PerlSIO_set_cnt(stdio, cnt);
3262 #else /* STDIO_CNT_LVALUE */
3263 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3264 PerlSIO_set_ptr(stdio,
3265 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3267 #else /* STDIO_PTR_LVAL_SETS_CNT */
3269 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3270 #endif /* STDIO_CNT_LVALUE */
3277 PerlIOStdio_fill(pTHX_ PerlIO *f)
3279 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3282 * fflush()ing read-only streams can cause trouble on some stdio-s
3284 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3285 if (PerlSIO_fflush(stdio) != 0)
3288 c = PerlSIO_fgetc(stdio);
3292 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3294 #ifdef STDIO_BUFFER_WRITABLE
3295 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3296 /* Fake ungetc() to the real buffer in case system's ungetc
3299 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3300 SSize_t cnt = PerlSIO_get_cnt(stdio);
3301 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3302 if (ptr == base+1) {
3303 *--ptr = (STDCHAR) c;
3304 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3305 if (PerlSIO_feof(stdio))
3306 PerlSIO_clearerr(stdio);
3312 if (PerlIO_has_cntptr(f)) {
3314 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3321 /* An ungetc()d char is handled separately from the regular
3322 * buffer, so we stuff it in the buffer ourselves.
3323 * Should never get called as should hit code above
3325 *(--((*stdio)->_ptr)) = (unsigned char) c;
3328 /* If buffer snoop scheme above fails fall back to
3331 if (PerlSIO_ungetc(c, stdio) != c)
3339 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3340 sizeof(PerlIO_funcs),
3342 sizeof(PerlIOStdio),
3343 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3347 PerlIOBase_binmode, /* binmode */
3361 PerlIOStdio_clearerr,
3362 PerlIOStdio_setlinebuf,
3364 PerlIOStdio_get_base,
3365 PerlIOStdio_get_bufsiz,
3370 #ifdef USE_STDIO_PTR
3371 PerlIOStdio_get_ptr,
3372 PerlIOStdio_get_cnt,
3373 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3374 PerlIOStdio_set_ptrcnt,
3377 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3382 #endif /* USE_STDIO_PTR */
3385 /* Note that calls to PerlIO_exportFILE() are reversed using
3386 * PerlIO_releaseFILE(), not importFILE. */
3388 PerlIO_exportFILE(PerlIO * f, const char *mode)
3392 if (PerlIOValid(f)) {
3395 if (!mode || !*mode) {
3396 mode = PerlIO_modestr(f, buf);
3398 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3402 /* De-link any lower layers so new :stdio sticks */
3404 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, Nullsv))) {
3405 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3407 /* Link previous lower layers under new one */
3411 /* restore layers list */
3421 PerlIO_findFILE(PerlIO *f)
3425 if (l->tab == &PerlIO_stdio) {
3426 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3429 l = *PerlIONext(&l);
3431 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3432 return PerlIO_exportFILE(f, Nullch);
3435 /* Use this to reverse PerlIO_exportFILE calls. */
3437 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3442 if (l->tab == &PerlIO_stdio) {
3443 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3444 if (s->stdio == f) {
3446 PerlIO_pop(aTHX_ p);
3455 /*--------------------------------------------------------------------------------------*/
3457 * perlio buffer layer
3461 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3463 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3464 const int fd = PerlIO_fileno(f);
3465 if (fd >= 0 && PerlLIO_isatty(fd)) {
3466 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3468 if (*PerlIONext(f)) {
3469 const Off_t posn = PerlIO_tell(PerlIONext(f));
3470 if (posn != (Off_t) - 1) {
3474 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3478 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3479 IV n, const char *mode, int fd, int imode, int perm,
3480 PerlIO *f, int narg, SV **args)
3482 if (PerlIOValid(f)) {
3483 PerlIO *next = PerlIONext(f);
3485 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3486 if (tab && tab->Open)
3488 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3490 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3495 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3497 if (*mode == IoTYPE_IMPLICIT) {
3503 if (tab && tab->Open)
3504 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3507 SETERRNO(EINVAL, LIB_INVARG);
3509 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3511 * if push fails during open, open fails. close will pop us.
3516 fd = PerlIO_fileno(f);
3517 if (init && fd == 2) {
3519 * Initial stderr is unbuffered
3521 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3523 #ifdef PERLIO_USING_CRLF
3524 # ifdef PERLIO_IS_BINMODE_FD
3525 if (PERLIO_IS_BINMODE_FD(fd))
3526 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, Nullch);
3530 * do something about failing setmode()? --jhi
3532 PerlLIO_setmode(fd, O_BINARY);
3541 * This "flush" is akin to sfio's sync in that it handles files in either
3542 * read or write state
3545 PerlIOBuf_flush(pTHX_ PerlIO *f)
3547 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3549 PerlIO *n = PerlIONext(f);
3550 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3552 * write() the buffer
3554 const STDCHAR *buf = b->buf;
3555 const STDCHAR *p = buf;
3556 while (p < b->ptr) {
3557 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3561 else if (count < 0 || PerlIO_error(n)) {
3562 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3567 b->posn += (p - buf);
3569 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3570 STDCHAR *buf = PerlIO_get_base(f);
3572 * Note position change
3574 b->posn += (b->ptr - buf);
3575 if (b->ptr < b->end) {
3576 /* We did not consume all of it - try and seek downstream to
3577 our logical position
3579 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3580 /* Reload n as some layers may pop themselves on seek */
3581 b->posn = PerlIO_tell(n = PerlIONext(f));
3584 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3585 data is lost for good - so return saying "ok" having undone
3588 b->posn -= (b->ptr - buf);
3593 b->ptr = b->end = b->buf;
3594 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3595 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3596 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3602 PerlIOBuf_fill(pTHX_ PerlIO *f)
3604 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3605 PerlIO *n = PerlIONext(f);
3608 * Down-stream flush is defined not to loose read data so is harmless.
3609 * we would not normally be fill'ing if there was data left in anycase.
3611 if (PerlIO_flush(f) != 0)
3613 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3614 PerlIOBase_flush_linebuf(aTHX);
3617 PerlIO_get_base(f); /* allocate via vtable */
3619 b->ptr = b->end = b->buf;
3621 if (!PerlIOValid(n)) {
3622 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3626 if (PerlIO_fast_gets(n)) {
3628 * Layer below is also buffered. We do _NOT_ want to call its
3629 * ->Read() because that will loop till it gets what we asked for
3630 * which may hang on a pipe etc. Instead take anything it has to
3631 * hand, or ask it to fill _once_.
3633 avail = PerlIO_get_cnt(n);
3635 avail = PerlIO_fill(n);
3637 avail = PerlIO_get_cnt(n);
3639 if (!PerlIO_error(n) && PerlIO_eof(n))
3644 STDCHAR *ptr = PerlIO_get_ptr(n);
3645 SSize_t cnt = avail;
3646 if (avail > (SSize_t)b->bufsiz)
3648 Copy(ptr, b->buf, avail, STDCHAR);
3649 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3653 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3657 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3659 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3662 b->end = b->buf + avail;
3663 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3668 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3670 if (PerlIOValid(f)) {
3671 const PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3674 return PerlIOBase_read(aTHX_ f, vbuf, count);
3680 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3682 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3683 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3686 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3691 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3693 * Buffer is already a read buffer, we can overwrite any chars
3694 * which have been read back to buffer start
3696 avail = (b->ptr - b->buf);
3700 * Buffer is idle, set it up so whole buffer is available for
3704 b->end = b->buf + avail;
3706 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3708 * Buffer extends _back_ from where we are now
3710 b->posn -= b->bufsiz;
3712 if (avail > (SSize_t) count) {
3714 * If we have space for more than count, just move count
3722 * In simple stdio-like ungetc() case chars will be already
3725 if (buf != b->ptr) {
3726 Copy(buf, b->ptr, avail, STDCHAR);
3730 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3734 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3740 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3742 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3743 const STDCHAR *buf = (const STDCHAR *) vbuf;
3744 const STDCHAR *flushptr = buf;
3748 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3750 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3751 if (PerlIO_flush(f) != 0) {
3755 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3756 flushptr = buf + count;
3757 while (flushptr > buf && *(flushptr - 1) != '\n')
3761 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3762 if ((SSize_t) count < avail)
3764 if (flushptr > buf && flushptr <= buf + avail)
3765 avail = flushptr - buf;
3766 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3768 Copy(buf, b->ptr, avail, STDCHAR);
3773 if (buf == flushptr)
3776 if (b->ptr >= (b->buf + b->bufsiz))
3779 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3785 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3788 if ((code = PerlIO_flush(f)) == 0) {
3789 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3790 code = PerlIO_seek(PerlIONext(f), offset, whence);
3792 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3793 b->posn = PerlIO_tell(PerlIONext(f));
3800 PerlIOBuf_tell(pTHX_ PerlIO *f)
3802 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3804 * b->posn is file position where b->buf was read, or will be written
3806 Off_t posn = b->posn;
3807 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3808 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3810 /* As O_APPEND files are normally shared in some sense it is better
3815 /* when file is NOT shared then this is sufficient */
3816 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3818 posn = b->posn = PerlIO_tell(PerlIONext(f));
3822 * If buffer is valid adjust position by amount in buffer
3824 posn += (b->ptr - b->buf);
3830 PerlIOBuf_popped(pTHX_ PerlIO *f)
3832 const IV code = PerlIOBase_popped(aTHX_ f);
3833 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3834 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3838 b->ptr = b->end = b->buf;
3839 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3844 PerlIOBuf_close(pTHX_ PerlIO *f)
3846 const IV code = PerlIOBase_close(aTHX_ f);
3847 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3848 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3852 b->ptr = b->end = b->buf;
3853 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3858 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
3860 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3867 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
3869 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3872 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
3873 return (b->end - b->ptr);
3878 PerlIOBuf_get_base(pTHX_ PerlIO *f)
3880 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3884 b->buf = Newz('B',b->buf,b->bufsiz, STDCHAR);
3886 b->buf = (STDCHAR *) & b->oneword;
3887 b->bufsiz = sizeof(b->oneword);
3896 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
3898 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3901 return (b->end - b->buf);
3905 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3907 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3911 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
3912 assert(PerlIO_get_cnt(f) == cnt);
3913 assert(b->ptr >= b->buf);
3915 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3919 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3921 return PerlIOBase_dup(aTHX_ f, o, param, flags);
3926 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
3927 sizeof(PerlIO_funcs),
3930 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3934 PerlIOBase_binmode, /* binmode */
3948 PerlIOBase_clearerr,
3949 PerlIOBase_setlinebuf,
3954 PerlIOBuf_set_ptrcnt,
3957 /*--------------------------------------------------------------------------------------*/
3959 * Temp layer to hold unread chars when cannot do it any other way
3963 PerlIOPending_fill(pTHX_ PerlIO *f)
3966 * Should never happen
3973 PerlIOPending_close(pTHX_ PerlIO *f)
3976 * A tad tricky - flush pops us, then we close new top
3979 return PerlIO_close(f);
3983 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3986 * A tad tricky - flush pops us, then we seek new top
3989 return PerlIO_seek(f, offset, whence);
3994 PerlIOPending_flush(pTHX_ PerlIO *f)
3996 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3997 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4001 PerlIO_pop(aTHX_ f);
4006 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4012 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4017 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4019 const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4020 PerlIOl *l = PerlIOBase(f);
4022 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4023 * etc. get muddled when it changes mid-string when we auto-pop.
4025 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4026 (PerlIOBase(PerlIONext(f))->
4027 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4032 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4034 SSize_t avail = PerlIO_get_cnt(f);
4036 if ((SSize_t)count < avail)
4039 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4040 if (got >= 0 && got < (SSize_t)count) {
4041 const SSize_t more =
4042 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4043 if (more >= 0 || got == 0)
4049 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4050 sizeof(PerlIO_funcs),
4053 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4054 PerlIOPending_pushed,
4057 PerlIOBase_binmode, /* binmode */
4066 PerlIOPending_close,
4067 PerlIOPending_flush,
4071 PerlIOBase_clearerr,
4072 PerlIOBase_setlinebuf,
4077 PerlIOPending_set_ptrcnt,
4082 /*--------------------------------------------------------------------------------------*/
4084 * crlf - translation On read translate CR,LF to "\n" we do this by
4085 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4086 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4090 PerlIOBuf base; /* PerlIOBuf stuff */
4091 STDCHAR *nl; /* Position of crlf we "lied" about in the
4096 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4099 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4100 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4102 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4103 f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4104 PerlIOBase(f)->flags);
4107 /* Enable the first CRLF capable layer you can find, but if none
4108 * found, the one we just pushed is fine. This results in at
4109 * any given moment at most one CRLF-capable layer being enabled
4110 * in the whole layer stack. */
4111 PerlIO *g = PerlIONext(f);
4113 PerlIOl *b = PerlIOBase(g);
4114 if (b && b->tab == &PerlIO_crlf) {
4115 if (!(b->flags & PERLIO_F_CRLF))
4116 b->flags |= PERLIO_F_CRLF;
4117 PerlIO_pop(aTHX_ f);
4128 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4130 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4135 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4136 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4138 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4139 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4141 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4146 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4147 b->end = b->ptr = b->buf + b->bufsiz;
4148 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4149 b->posn -= b->bufsiz;
4151 while (count > 0 && b->ptr > b->buf) {
4154 if (b->ptr - 2 >= b->buf) {
4177 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4179 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4182 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4183 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4184 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4185 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4187 while (nl < b->end && *nl != 0xd)
4189 if (nl < b->end && *nl == 0xd) {
4191 if (nl + 1 < b->end) {
4198 * Not CR,LF but just CR
4206 * Blast - found CR as last char in buffer
4211 * They may not care, defer work as long as
4215 return (nl - b->ptr);
4219 b->ptr++; /* say we have read it as far as
4220 * flush() is concerned */
4221 b->buf++; /* Leave space in front of buffer */
4222 /* Note as we have moved buf up flush's
4224 will naturally make posn point at CR
4226 b->bufsiz--; /* Buffer is thus smaller */
4227 code = PerlIO_fill(f); /* Fetch some more */
4228 b->bufsiz++; /* Restore size for next time */
4229 b->buf--; /* Point at space */
4230 b->ptr = nl = b->buf; /* Which is what we hand
4232 *nl = 0xd; /* Fill in the CR */
4234 goto test; /* fill() call worked */
4236 * CR at EOF - just fall through
4238 /* Should we clear EOF though ??? */
4243 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4249 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4251 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4252 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4258 if (ptr == b->end && *c->nl == 0xd) {
4259 /* Defered CR at end of buffer case - we lied about count */
4271 * Test code - delete when it works ...
4273 IV flags = PerlIOBase(f)->flags;
4274 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4275 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4276 /* Defered CR at end of buffer case - we lied about count */
4282 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4283 " nl=%p e=%p for %d", ptr, chk, flags, c->nl,
4291 * They have taken what we lied about
4299 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4303 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4305 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4306 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4308 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4309 const STDCHAR *buf = (const STDCHAR *) vbuf;
4310 const STDCHAR *ebuf = buf + count;
4313 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4315 while (buf < ebuf) {
4316 STDCHAR *eptr = b->buf + b->bufsiz;
4317 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4318 while (buf < ebuf && b->ptr < eptr) {
4320 if ((b->ptr + 2) > eptr) {
4328 *(b->ptr)++ = 0xd; /* CR */
4329 *(b->ptr)++ = 0xa; /* LF */
4331 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4341 if (b->ptr >= eptr) {
4347 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4349 return (buf - (STDCHAR *) vbuf);
4354 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4356 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4361 return PerlIOBuf_flush(aTHX_ f);
4365 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4367 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4368 /* In text mode - flush any pending stuff and flip it */
4369 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4370 #ifndef PERLIO_USING_CRLF
4371 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4372 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4373 PerlIO_pop(aTHX_ f);
4380 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4381 sizeof(PerlIO_funcs),
4384 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4386 PerlIOBuf_popped, /* popped */
4388 PerlIOCrlf_binmode, /* binmode */
4392 PerlIOBuf_read, /* generic read works with ptr/cnt lies */
4393 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4394 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4402 PerlIOBase_clearerr,
4403 PerlIOBase_setlinebuf,
4408 PerlIOCrlf_set_ptrcnt,
4412 /*--------------------------------------------------------------------------------------*/
4414 * mmap as "buffer" layer
4418 PerlIOBuf base; /* PerlIOBuf stuff */
4419 Mmap_t mptr; /* Mapped address */
4420 Size_t len; /* mapped length */
4421 STDCHAR *bbuf; /* malloced buffer if map fails */
4425 PerlIOMmap_map(pTHX_ PerlIO *f)
4428 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4429 const IV flags = PerlIOBase(f)->flags;
4433 if (flags & PERLIO_F_CANREAD) {
4434 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4435 const int fd = PerlIO_fileno(f);
4437 code = Fstat(fd, &st);
4438 if (code == 0 && S_ISREG(st.st_mode)) {
4439 SSize_t len = st.st_size - b->posn;
4442 if (PL_mmap_page_size <= 0)
4443 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4447 * This is a hack - should never happen - open should
4450 b->posn = PerlIO_tell(PerlIONext(f));
4452 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4453 len = st.st_size - posn;
4454 m->mptr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4455 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4456 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4457 madvise(m->mptr, len, MADV_SEQUENTIAL);
4459 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4460 madvise(m->mptr, len, MADV_WILLNEED);
4462 PerlIOBase(f)->flags =
4463 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4464 b->end = ((STDCHAR *) m->mptr) + len;
4465 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4474 PerlIOBase(f)->flags =
4475 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4477 b->ptr = b->end = b->ptr;
4486 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4488 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4489 PerlIOBuf *b = &m->base;
4493 code = munmap(m->mptr, m->len);
4497 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4500 b->ptr = b->end = b->buf;
4501 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4507 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4509 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4510 PerlIOBuf *b = &m->base;
4511 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4513 * Already have a readbuffer in progress
4519 * We have a write buffer or flushed PerlIOBuf read buffer
4521 m->bbuf = b->buf; /* save it in case we need it again */
4522 b->buf = NULL; /* Clear to trigger below */
4525 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4528 * Map did not work - recover PerlIOBuf buffer if we have one
4533 b->ptr = b->end = b->buf;
4536 return PerlIOBuf_get_base(aTHX_ f);
4540 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4542 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4543 PerlIOBuf *b = &m->base;
4544 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4546 if (b->ptr && (b->ptr - count) >= b->buf
4547 && memEQ(b->ptr - count, vbuf, count)) {
4549 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4554 * Loose the unwritable mapped buffer
4558 * If flush took the "buffer" see if we have one from before
4560 if (!b->buf && m->bbuf)
4563 PerlIOBuf_get_base(aTHX_ f);
4567 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4571 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4573 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4574 PerlIOBuf * const b = &m->base;
4576 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4578 * No, or wrong sort of, buffer
4581 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4585 * If unmap took the "buffer" see if we have one from before
4587 if (!b->buf && m->bbuf)
4590 PerlIOBuf_get_base(aTHX_ f);
4594 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4598 PerlIOMmap_flush(pTHX_ PerlIO *f)
4600 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4601 PerlIOBuf *b = &m->base;
4602 IV code = PerlIOBuf_flush(aTHX_ f);
4604 * Now we are "synced" at PerlIOBuf level
4611 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4616 * We seem to have a PerlIOBuf buffer which was not mapped
4617 * remember it in case we need one later
4626 PerlIOMmap_fill(pTHX_ PerlIO *f)
4628 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4629 IV code = PerlIO_flush(f);
4630 if (code == 0 && !b->buf) {
4631 code = PerlIOMmap_map(aTHX_ f);
4633 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4634 code = PerlIOBuf_fill(aTHX_ f);
4640 PerlIOMmap_close(pTHX_ PerlIO *f)
4642 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4643 PerlIOBuf *b = &m->base;
4644 IV code = PerlIO_flush(f);
4648 b->ptr = b->end = b->buf;
4650 if (PerlIOBuf_close(aTHX_ f) != 0)
4656 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4658 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4662 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4663 sizeof(PerlIO_funcs),
4666 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4670 PerlIOBase_binmode, /* binmode */
4684 PerlIOBase_clearerr,
4685 PerlIOBase_setlinebuf,
4686 PerlIOMmap_get_base,
4690 PerlIOBuf_set_ptrcnt,
4693 #endif /* HAS_MMAP */
4696 Perl_PerlIO_stdin(pTHX)
4699 PerlIO_stdstreams(aTHX);
4701 return &PL_perlio[1];
4705 Perl_PerlIO_stdout(pTHX)
4708 PerlIO_stdstreams(aTHX);
4710 return &PL_perlio[2];
4714 Perl_PerlIO_stderr(pTHX)
4717 PerlIO_stdstreams(aTHX);
4719 return &PL_perlio[3];
4722 /*--------------------------------------------------------------------------------------*/
4725 PerlIO_getname(PerlIO *f, char *buf)
4730 bool exported = FALSE;
4731 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4733 stdio = PerlIO_exportFILE(f,0);
4737 name = fgetname(stdio, buf);
4738 if (exported) PerlIO_releaseFILE(f,stdio);
4743 PERL_UNUSED_ARG(buf);
4744 Perl_croak(aTHX_ "Don't know how to get file name");
4750 /*--------------------------------------------------------------------------------------*/
4752 * Functions which can be called on any kind of PerlIO implemented in
4756 #undef PerlIO_fdopen
4758 PerlIO_fdopen(int fd, const char *mode)
4761 return PerlIO_openn(aTHX_ Nullch, mode, fd, 0, 0, NULL, 0, NULL);
4766 PerlIO_open(const char *path, const char *mode)
4769 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4770 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, NULL, 1, &name);
4773 #undef Perlio_reopen
4775 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4778 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4779 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, f, 1, &name);
4784 PerlIO_getc(PerlIO *f)
4788 if ( 1 == PerlIO_read(f, buf, 1) ) {
4789 return (unsigned char) buf[0];
4794 #undef PerlIO_ungetc
4796 PerlIO_ungetc(PerlIO *f, int ch)
4801 if (PerlIO_unread(f, &buf, 1) == 1)
4809 PerlIO_putc(PerlIO *f, int ch)
4813 return PerlIO_write(f, &buf, 1);
4818 PerlIO_puts(PerlIO *f, const char *s)
4821 STRLEN len = strlen(s);
4822 return PerlIO_write(f, s, len);
4825 #undef PerlIO_rewind
4827 PerlIO_rewind(PerlIO *f)
4830 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4834 #undef PerlIO_vprintf
4836 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4839 SV *sv = newSVpvn("", 0);
4845 Perl_va_copy(ap, apc);
4846 sv_vcatpvf(sv, fmt, &apc);
4848 sv_vcatpvf(sv, fmt, &ap);
4850 s = SvPV_const(sv, len);
4851 wrote = PerlIO_write(f, s, len);
4856 #undef PerlIO_printf
4858 PerlIO_printf(PerlIO *f, const char *fmt, ...)
4863 result = PerlIO_vprintf(f, fmt, ap);
4868 #undef PerlIO_stdoutf
4870 PerlIO_stdoutf(const char *fmt, ...)
4876 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
4881 #undef PerlIO_tmpfile
4883 PerlIO_tmpfile(void)
4888 const int fd = win32_tmpfd();
4890 f = PerlIO_fdopen(fd, "w+b");
4892 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
4893 SV *sv = newSVpv("/tmp/PerlIO_XXXXXX", 0);
4895 * I have no idea how portable mkstemp() is ... NI-S
4897 const int fd = mkstemp(SvPVX(sv));
4899 f = PerlIO_fdopen(fd, "w+");
4901 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
4902 PerlLIO_unlink(SvPVX_const(sv));
4905 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
4906 FILE *stdio = PerlSIO_tmpfile();
4909 if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)),
4910 PERLIO_FUNCS_CAST(&PerlIO_stdio),
4912 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
4918 # endif /* else HAS_MKSTEMP */
4919 #endif /* else WIN32 */
4926 #endif /* USE_SFIO */
4927 #endif /* PERLIO_IS_STDIO */
4929 /*======================================================================================*/
4931 * Now some functions in terms of above which may be needed even if we are
4932 * not in true PerlIO mode
4936 #undef PerlIO_setpos
4938 PerlIO_setpos(PerlIO *f, SV *pos)
4943 Off_t *posn = (Off_t *) SvPV(pos, len);
4944 if (f && len == sizeof(Off_t))
4945 return PerlIO_seek(f, *posn, SEEK_SET);
4947 SETERRNO(EINVAL, SS_IVCHAN);
4951 #undef PerlIO_setpos
4953 PerlIO_setpos(PerlIO *f, SV *pos)
4958 Fpos_t *fpos = (Fpos_t *) SvPV(pos, len);
4959 if (f && len == sizeof(Fpos_t)) {
4960 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4961 return fsetpos64(f, fpos);
4963 return fsetpos(f, fpos);
4967 SETERRNO(EINVAL, SS_IVCHAN);
4973 #undef PerlIO_getpos
4975 PerlIO_getpos(PerlIO *f, SV *pos)
4978 Off_t posn = PerlIO_tell(f);
4979 sv_setpvn(pos, (char *) &posn, sizeof(posn));
4980 return (posn == (Off_t) - 1) ? -1 : 0;
4983 #undef PerlIO_getpos
4985 PerlIO_getpos(PerlIO *f, SV *pos)
4990 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4991 code = fgetpos64(f, &fpos);
4993 code = fgetpos(f, &fpos);
4995 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
5000 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
5003 vprintf(char *pat, char *args)
5005 _doprnt(pat, args, stdout);
5006 return 0; /* wrong, but perl doesn't use the return
5011 vfprintf(FILE *fd, char *pat, char *args)
5013 _doprnt(pat, args, fd);
5014 return 0; /* wrong, but perl doesn't use the return
5020 #ifndef PerlIO_vsprintf
5022 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5025 const int val = vsprintf(s, fmt, ap);
5027 if (strlen(s) >= (STRLEN) n) {
5029 (void) PerlIO_puts(Perl_error_log,
5030 "panic: sprintf overflow - memory corrupted!\n");
5038 #ifndef PerlIO_sprintf
5040 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5045 result = PerlIO_vsprintf(s, n, fmt, ap);
5053 * c-indentation-style: bsd
5055 * indent-tabs-mode: t
5058 * ex: set ts=8 sts=4 sw=4 noet: