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)
173 #define O_ACCMODE 3 /* Assume traditional implementation */
177 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
179 const int result = rawmode & O_ACCMODE;
184 ptype = IoTYPE_RDONLY;
187 ptype = IoTYPE_WRONLY;
195 *writing = (result != O_RDONLY);
197 if (result == O_RDONLY) {
201 else if (rawmode & O_APPEND) {
203 if (result != O_WRONLY)
208 if (result == O_WRONLY)
215 if (rawmode & O_BINARY)
221 #ifndef PERLIO_LAYERS
223 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
225 if (!names || !*names
226 || strEQ(names, ":crlf")
227 || strEQ(names, ":raw")
228 || strEQ(names, ":bytes")
232 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
240 PerlIO_destruct(pTHX)
245 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
250 return perlsio_binmode(fp, iotype, mode);
255 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
257 #if defined(PERL_MICRO) || defined(SYMBIAN)
260 #ifdef PERL_IMPLICIT_SYS
261 return PerlSIO_fdupopen(f);
264 return win32_fdupopen(f);
267 int fd = PerlLIO_dup(PerlIO_fileno(f));
270 int omode = fcntl(fd, F_GETFL);
272 omode = djgpp_get_stream_mode(f);
274 PerlIO_intmode2str(omode,mode,NULL);
275 /* the r+ is a hack */
276 return PerlIO_fdopen(fd, mode);
281 SETERRNO(EBADF, SS_IVCHAN);
291 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
295 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
296 int imode, int perm, PerlIO *old, int narg, SV **args)
300 Perl_croak(aTHX_ "More than one argument to open");
302 if (*args == &PL_sv_undef)
303 return PerlIO_tmpfile();
305 const char *name = SvPV_nolen(*args);
306 if (*mode == IoTYPE_NUMERIC) {
307 fd = PerlLIO_open3(name, imode, perm);
309 return PerlIO_fdopen(fd, mode + 1);
312 return PerlIO_reopen(name, mode, old);
315 return PerlIO_open(name, mode);
320 return PerlIO_fdopen(fd, (char *) mode);
325 XS(XS_PerlIO__Layer__find)
329 Perl_croak(aTHX_ "Usage class->find(name[,load])");
331 const char *name = SvPV_nolen(ST(1));
332 ST(0) = (strEQ(name, "crlf")
333 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
340 Perl_boot_core_PerlIO(pTHX)
342 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
348 #ifdef PERLIO_IS_STDIO
354 * Does nothing (yet) except force this file to be included in perl
355 * binary. That allows this file to force inclusion of other functions
356 * that may be required by loadable extensions e.g. for
357 * FileHandle::tmpfile
361 #undef PerlIO_tmpfile
368 #else /* PERLIO_IS_STDIO */
376 * This section is just to make sure these functions get pulled in from
380 #undef PerlIO_tmpfile
391 * Force this file to be included in perl binary. Which allows this
392 * file to force inclusion of other functions that may be required by
393 * loadable extensions e.g. for FileHandle::tmpfile
397 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
398 * results in a lot of lseek()s to regular files and lot of small
401 sfset(sfstdout, SF_SHARE, 0);
404 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
406 PerlIO_importFILE(FILE *stdio, const char *mode)
408 const int fd = fileno(stdio);
409 if (!mode || !*mode) {
412 return PerlIO_fdopen(fd, mode);
416 PerlIO_findFILE(PerlIO *pio)
418 const int fd = PerlIO_fileno(pio);
419 FILE * const f = fdopen(fd, "r+");
421 if (!f && errno == EINVAL)
423 if (!f && errno == EINVAL)
430 /*======================================================================================*/
432 * Implement all the PerlIO interface ourselves.
438 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
445 #include <sys/mman.h>
449 PerlIO_debug(const char *fmt, ...)
454 if (!PL_perlio_debug_fd && !PL_tainting && PL_uid == PL_euid && PL_gid == PL_egid) {
455 const char *s = PerlEnv_getenv("PERLIO_DEBUG");
457 PL_perlio_debug_fd = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
459 PL_perlio_debug_fd = -1;
461 if (PL_perlio_debug_fd > 0) {
463 const char *s = CopFILE(PL_curcop);
466 /* Use fixed buffer as sv_catpvf etc. needs SVs */
470 len = sprintf(buffer, "%.40s:%" IVdf " ", s, (IV) CopLINE(PL_curcop));
471 vsprintf(buffer+len, fmt, ap);
472 PerlLIO_write(PL_perlio_debug_fd, buffer, strlen(buffer));
474 SV *sv = newSVpvn("", 0);
477 Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s,
478 (IV) CopLINE(PL_curcop));
479 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
482 PerlLIO_write(PL_perlio_debug_fd, s, len);
489 /*--------------------------------------------------------------------------------------*/
492 * Inner level routines
496 * Table of pointers to the PerlIO structs (malloc'ed)
498 #define PERLIO_TABLE_SIZE 64
501 PerlIO_allocate(pTHX)
504 * Find a free slot in the table, allocating new table as necessary
509 while ((f = *last)) {
511 last = (PerlIO **) (f);
512 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
518 Newz('I',f,PERLIO_TABLE_SIZE,PerlIO);
526 #undef PerlIO_fdupopen
528 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
530 if (PerlIOValid(f)) {
531 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
532 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
534 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
536 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
540 SETERRNO(EBADF, SS_IVCHAN);
546 PerlIO_cleantable(pTHX_ PerlIO **tablep)
548 PerlIO *table = *tablep;
551 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
552 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
553 PerlIO *f = table + i;
565 PerlIO_list_alloc(pTHX)
568 Newz('L', list, 1, PerlIO_list_t);
574 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
577 if (--list->refcnt == 0) {
580 for (i = 0; i < list->cur; i++) {
581 if (list->array[i].arg)
582 SvREFCNT_dec(list->array[i].arg);
584 Safefree(list->array);
592 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
595 if (list->cur >= list->len) {
598 Renew(list->array, list->len, PerlIO_pair_t);
600 New('l', list->array, list->len, PerlIO_pair_t);
602 p = &(list->array[list->cur++]);
604 if ((p->arg = arg)) {
605 (void)SvREFCNT_inc(arg);
610 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
612 PerlIO_list_t *list = (PerlIO_list_t *) NULL;
615 list = PerlIO_list_alloc(aTHX);
616 for (i=0; i < proto->cur; i++) {
618 if (proto->array[i].arg)
619 arg = PerlIO_sv_dup(aTHX_ proto->array[i].arg,param);
620 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
627 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
630 PerlIO **table = &proto->Iperlio;
633 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
634 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
635 PerlIO_allocate(aTHX); /* root slot is never used */
636 PerlIO_debug("Clone %p from %p\n",aTHX,proto);
637 while ((f = *table)) {
639 table = (PerlIO **) (f++);
640 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
642 (void) fp_dup(f, 0, param);
651 PerlIO_destruct(pTHX)
653 PerlIO **table = &PL_perlio;
656 PerlIO_debug("Destruct %p\n",aTHX);
658 while ((f = *table)) {
660 table = (PerlIO **) (f++);
661 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
665 if (l->tab->kind & PERLIO_K_DESTRUCT) {
666 PerlIO_debug("Destruct popping %s\n", l->tab->name);
680 PerlIO_pop(pTHX_ PerlIO *f)
684 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
685 if (l->tab->Popped) {
687 * If popped returns non-zero do not free its layer structure
688 * it has either done so itself, or it is shared and still in
691 if ((*l->tab->Popped) (aTHX_ f) != 0)
699 /* Return as an array the stack of layers on a filehandle. Note that
700 * the stack is returned top-first in the array, and there are three
701 * times as many array elements as there are layers in the stack: the
702 * first element of a layer triplet is the name, the second one is the
703 * arguments, and the third one is the flags. */
706 PerlIO_get_layers(pTHX_ PerlIO *f)
710 if (PerlIOValid(f)) {
711 PerlIOl *l = PerlIOBase(f);
714 SV *name = l->tab && l->tab->name ?
715 newSVpv(l->tab->name, 0) : &PL_sv_undef;
716 SV *arg = l->tab && l->tab->Getarg ?
717 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
720 av_push(av, newSViv((IV)l->flags));
728 /*--------------------------------------------------------------------------------------*/
730 * XS Interface for perl code
734 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
738 if ((SSize_t) len <= 0)
740 for (i = 0; i < PL_known_layers->cur; i++) {
741 PerlIO_funcs *f = PL_known_layers->array[i].funcs;
742 if (memEQ(f->name, name, len) && f->name[len] == 0) {
743 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
747 if (load && PL_subname && PL_def_layerlist
748 && PL_def_layerlist->cur >= 2) {
749 if (PL_in_load_module) {
750 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
753 SV *pkgsv = newSVpvn("PerlIO", 6);
754 SV *layer = newSVpvn(name, len);
755 CV *cv = get_cv("PerlIO::Layer::NoWarnings", FALSE);
757 SAVEINT(PL_in_load_module);
759 SAVESPTR(PL_warnhook);
760 PL_warnhook = (SV *) cv;
764 * The two SVs are magically freed by load_module
766 Perl_load_module(aTHX_ 0, pkgsv, Nullsv, layer, Nullsv);
769 return PerlIO_find_layer(aTHX_ name, len, 0);
772 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
776 #ifdef USE_ATTRIBUTES_FOR_PERLIO
779 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
782 IO *io = GvIOn((GV *) SvRV(sv));
783 PerlIO *ifp = IoIFP(io);
784 PerlIO *ofp = IoOFP(io);
785 Perl_warn(aTHX_ "set %" SVf " %p %p %p", sv, io, ifp, ofp);
791 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
794 IO *io = GvIOn((GV *) SvRV(sv));
795 PerlIO *ifp = IoIFP(io);
796 PerlIO *ofp = IoOFP(io);
797 Perl_warn(aTHX_ "get %" SVf " %p %p %p", sv, io, ifp, ofp);
803 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
805 Perl_warn(aTHX_ "clear %" SVf, sv);
810 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
812 Perl_warn(aTHX_ "free %" SVf, sv);
816 MGVTBL perlio_vtab = {
824 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
827 SV *sv = SvRV(ST(1));
832 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
834 mg = mg_find(sv, PERL_MAGIC_ext);
835 mg->mg_virtual = &perlio_vtab;
837 Perl_warn(aTHX_ "attrib %" SVf, sv);
838 for (i = 2; i < items; i++) {
840 const char *name = SvPV(ST(i), len);
841 SV *layer = PerlIO_find_layer(aTHX_ name, len, 1);
843 av_push(av, SvREFCNT_inc(layer));
854 #endif /* USE_ATTIBUTES_FOR_PERLIO */
857 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
859 HV *stash = gv_stashpv("PerlIO::Layer", TRUE);
860 SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
864 XS(XS_PerlIO__Layer__NoWarnings)
866 /* This is used as a %SIG{__WARN__} handler to supress warnings
867 during loading of layers.
871 PerlIO_debug("warning:%s\n",SvPV_nolen(ST(0)));
875 XS(XS_PerlIO__Layer__find)
879 Perl_croak(aTHX_ "Usage class->find(name[,load])");
882 const char *name = SvPV(ST(1), len);
883 const bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
884 PerlIO_funcs *layer = PerlIO_find_layer(aTHX_ name, len, load);
886 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
893 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
895 if (!PL_known_layers)
896 PL_known_layers = PerlIO_list_alloc(aTHX);
897 PerlIO_list_push(aTHX_ PL_known_layers, tab, Nullsv);
898 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
902 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
905 const char *s = names;
907 while (isSPACE(*s) || *s == ':')
912 const char *as = Nullch;
914 if (!isIDFIRST(*s)) {
916 * Message is consistent with how attribute lists are
917 * passed. Even though this means "foo : : bar" is
918 * seen as an invalid separator character.
920 const char q = ((*s == '\'') ? '"' : '\'');
921 if (ckWARN(WARN_LAYER))
922 Perl_warner(aTHX_ packWARN(WARN_LAYER),
923 "Invalid separator character %c%c%c in PerlIO layer specification %s",
925 SETERRNO(EINVAL, LIB_INVARG);
930 } while (isALNUM(*e));
946 * It's a nul terminated string, not allowed
947 * to \ the terminating null. Anything other
948 * character is passed over.
958 if (ckWARN(WARN_LAYER))
959 Perl_warner(aTHX_ packWARN(WARN_LAYER),
960 "Argument list not closed for PerlIO layer \"%.*s\"",
972 const bool warn_layer = ckWARN(WARN_LAYER);
973 PerlIO_funcs *layer =
974 PerlIO_find_layer(aTHX_ s, llen, 1);
976 PerlIO_list_push(aTHX_ av, layer,
983 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
996 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
998 PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
999 #ifdef PERLIO_USING_CRLF
1002 if (PerlIO_stdio.Set_ptrcnt)
1003 tab = &PerlIO_stdio;
1005 PerlIO_debug("Pushing %s\n", tab->name);
1006 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1011 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1013 return av->array[n].arg;
1017 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1019 if (n >= 0 && n < av->cur) {
1020 PerlIO_debug("Layer %" IVdf " is %s\n", n,
1021 av->array[n].funcs->name);
1022 return av->array[n].funcs;
1025 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1030 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1035 if (PerlIOValid(f)) {
1037 PerlIO_pop(aTHX_ f);
1043 PERLIO_FUNCS_DECL(PerlIO_remove) = {
1044 sizeof(PerlIO_funcs),
1047 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1067 NULL, /* get_base */
1068 NULL, /* get_bufsiz */
1071 NULL, /* set_ptrcnt */
1075 PerlIO_default_layers(pTHX)
1077 if (!PL_def_layerlist) {
1078 const char *s = (PL_tainting) ? Nullch : PerlEnv_getenv("PERLIO");
1079 PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1080 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1081 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1083 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1085 osLayer = &PerlIO_win32;
1088 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1089 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1090 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1091 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1093 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_mmap));
1095 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1096 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1097 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1098 PerlIO_list_push(aTHX_ PL_def_layerlist,
1099 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1102 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1105 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1108 if (PL_def_layerlist->cur < 2) {
1109 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1111 return PL_def_layerlist;
1115 Perl_boot_core_PerlIO(pTHX)
1117 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1118 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1121 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1122 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1126 PerlIO_default_layer(pTHX_ I32 n)
1128 PerlIO_list_t *av = PerlIO_default_layers(aTHX);
1131 return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1134 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1135 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1138 PerlIO_stdstreams(pTHX)
1141 PerlIO_allocate(aTHX);
1142 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1143 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1144 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1149 PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1151 if (tab->fsize != sizeof(PerlIO_funcs)) {
1153 Perl_croak(aTHX_ "Layer does not match this perl");
1157 if (tab->size < sizeof(PerlIOl)) {
1160 /* Real layer with a data area */
1161 Newc('L',l,tab->size,char,PerlIOl);
1163 Zero(l, tab->size, char);
1165 l->tab = (PerlIO_funcs*) tab;
1167 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1168 (mode) ? mode : "(Null)", (void*)arg);
1169 if (*l->tab->Pushed &&
1170 (*l->tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1171 PerlIO_pop(aTHX_ f);
1177 /* Pseudo-layer where push does its own stack adjust */
1178 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1179 (mode) ? mode : "(Null)", (void*)arg);
1181 (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1189 PerlIOBase_binmode(pTHX_ PerlIO *f)
1191 if (PerlIOValid(f)) {
1192 /* Is layer suitable for raw stream ? */
1193 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1194 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1195 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1198 /* Not suitable - pop it */
1199 PerlIO_pop(aTHX_ f);
1207 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1213 if (PerlIOValid(f)) {
1218 * Strip all layers that are not suitable for a raw stream
1221 while (t && (l = *t)) {
1222 if (l->tab->Binmode) {
1223 /* Has a handler - normal case */
1224 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1226 /* Layer still there - move down a layer */
1235 /* No handler - pop it */
1236 PerlIO_pop(aTHX_ t);
1239 if (PerlIOValid(f)) {
1240 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1248 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1249 PerlIO_list_t *layers, IV n, IV max)
1253 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1255 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1266 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1270 PerlIO_list_t *layers = PerlIO_list_alloc(aTHX);
1271 code = PerlIO_parse_layers(aTHX_ layers, names);
1273 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1275 PerlIO_list_free(aTHX_ layers);
1281 /*--------------------------------------------------------------------------------------*/
1283 * Given the abstraction above the public API functions
1287 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1289 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n",
1290 (void*)f, PerlIOBase(f)->tab->name, iotype, mode,
1291 (names) ? names : "(Null)");
1293 /* Do not flush etc. if (e.g.) switching encodings.
1294 if a pushed layer knows it needs to flush lower layers
1295 (for example :unix which is never going to call them)
1296 it can do the flush when it is pushed.
1298 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1301 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1302 #ifdef PERLIO_USING_CRLF
1303 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1304 O_BINARY so we can look for it in mode.
1306 if (!(mode & O_BINARY)) {
1308 /* FIXME?: Looking down the layer stack seems wrong,
1309 but is a way of reaching past (say) an encoding layer
1310 to flip CRLF-ness of the layer(s) below
1313 /* Perhaps we should turn on bottom-most aware layer
1314 e.g. Ilya's idea that UNIX TTY could serve
1316 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1317 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1318 /* Not in text mode - flush any pending stuff and flip it */
1320 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1322 /* Only need to turn it on in one layer so we are done */
1327 /* Not finding a CRLF aware layer presumably means we are binary
1328 which is not what was requested - so we failed
1329 We _could_ push :crlf layer but so could caller
1334 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1335 So code that used to be here is now in PerlIORaw_pushed().
1337 return PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), Nullch, Nullsv) ? TRUE : FALSE;
1342 PerlIO__close(pTHX_ PerlIO *f)
1344 if (PerlIOValid(f)) {
1345 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1346 if (tab && tab->Close)
1347 return (*tab->Close)(aTHX_ f);
1349 return PerlIOBase_close(aTHX_ f);
1352 SETERRNO(EBADF, SS_IVCHAN);
1358 Perl_PerlIO_close(pTHX_ PerlIO *f)
1360 const int code = PerlIO__close(aTHX_ f);
1361 while (PerlIOValid(f)) {
1362 PerlIO_pop(aTHX_ f);
1368 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1370 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1374 PerlIO_context_layers(pTHX_ const char *mode)
1376 const char *type = NULL;
1378 * Need to supply default layer info from open.pm
1381 SV *layers = PL_curcop->cop_io;
1384 type = SvPV(layers, len);
1385 if (type && mode[0] != 'r') {
1387 * Skip to write part
1389 const char *s = strchr(type, 0);
1390 if (s && (STRLEN)(s - type) < len) {
1399 static PerlIO_funcs *
1400 PerlIO_layer_from_ref(pTHX_ SV *sv)
1403 * For any scalar type load the handler which is bundled with perl
1405 if (SvTYPE(sv) < SVt_PVAV)
1406 return PerlIO_find_layer(aTHX_ "scalar", 6, 1);
1409 * For other types allow if layer is known but don't try and load it
1411 switch (SvTYPE(sv)) {
1413 return PerlIO_find_layer(aTHX_ "Array", 5, 0);
1415 return PerlIO_find_layer(aTHX_ "Hash", 4, 0);
1417 return PerlIO_find_layer(aTHX_ "Code", 4, 0);
1419 return PerlIO_find_layer(aTHX_ "Glob", 4, 0);
1425 PerlIO_resolve_layers(pTHX_ const char *layers,
1426 const char *mode, int narg, SV **args)
1428 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1431 PerlIO_stdstreams(aTHX);
1435 * If it is a reference but not an object see if we have a handler
1438 if (SvROK(arg) && !sv_isobject(arg)) {
1439 PerlIO_funcs *handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1441 def = PerlIO_list_alloc(aTHX);
1442 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1446 * Don't fail if handler cannot be found :via(...) etc. may do
1447 * something sensible else we will just stringfy and open
1453 layers = PerlIO_context_layers(aTHX_ mode);
1454 if (layers && *layers) {
1458 av = PerlIO_list_alloc(aTHX);
1459 for (i = 0; i < def->cur; i++) {
1460 PerlIO_list_push(aTHX_ av, def->array[i].funcs,
1467 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1471 PerlIO_list_free(aTHX_ av);
1472 return (PerlIO_list_t *) NULL;
1483 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1484 int imode, int perm, PerlIO *f, int narg, SV **args)
1486 if (!f && narg == 1 && *args == &PL_sv_undef) {
1487 if ((f = PerlIO_tmpfile())) {
1489 layers = PerlIO_context_layers(aTHX_ mode);
1490 if (layers && *layers)
1491 PerlIO_apply_layers(aTHX_ f, mode, layers);
1495 PerlIO_list_t *layera;
1497 PerlIO_funcs *tab = NULL;
1498 if (PerlIOValid(f)) {
1500 * This is "reopen" - it is not tested as perl does not use it
1504 layera = PerlIO_list_alloc(aTHX);
1506 SV *arg = (l->tab->Getarg)
1507 ? (*l->tab->Getarg) (aTHX_ &l, NULL, 0)
1509 PerlIO_list_push(aTHX_ layera, l->tab, arg);
1510 l = *PerlIONext(&l);
1514 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1520 * Start at "top" of layer stack
1522 n = layera->cur - 1;
1524 PerlIO_funcs *t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1533 * Found that layer 'n' can do opens - call it
1535 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1536 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1538 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1539 tab->name, layers, mode, fd, imode, perm,
1540 (void*)f, narg, (void*)args);
1542 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1545 SETERRNO(EINVAL, LIB_INVARG);
1549 if (n + 1 < layera->cur) {
1551 * More layers above the one that we used to open -
1554 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1555 /* If pushing layers fails close the file */
1562 PerlIO_list_free(aTHX_ layera);
1569 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1571 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1575 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1577 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1581 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1583 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1587 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1589 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1593 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1595 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1599 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1603 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1605 if (tab && tab->Flush)
1606 return (*tab->Flush) (aTHX_ f);
1608 return 0; /* If no Flush defined, silently succeed. */
1611 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1612 SETERRNO(EBADF, SS_IVCHAN);
1618 * Is it good API design to do flush-all on NULL, a potentially
1619 * errorneous input? Maybe some magical value (PerlIO*
1620 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1621 * things on fflush(NULL), but should we be bound by their design
1624 PerlIO **table = &PL_perlio;
1626 while ((f = *table)) {
1628 table = (PerlIO **) (f++);
1629 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1630 if (*f && PerlIO_flush(f) != 0)
1640 PerlIOBase_flush_linebuf(pTHX)
1642 PerlIO **table = &PL_perlio;
1644 while ((f = *table)) {
1646 table = (PerlIO **) (f++);
1647 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1650 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1651 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1659 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1661 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1665 PerlIO_isutf8(PerlIO *f)
1668 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1670 SETERRNO(EBADF, SS_IVCHAN);
1676 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1678 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1682 Perl_PerlIO_error(pTHX_ PerlIO *f)
1684 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1688 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1690 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1694 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1696 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1700 PerlIO_has_base(PerlIO *f)
1702 if (PerlIOValid(f)) {
1703 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1706 return (tab->Get_base != NULL);
1707 SETERRNO(EINVAL, LIB_INVARG);
1710 SETERRNO(EBADF, SS_IVCHAN);
1716 PerlIO_fast_gets(PerlIO *f)
1718 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1719 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1722 return (tab->Set_ptrcnt != NULL);
1723 SETERRNO(EINVAL, LIB_INVARG);
1726 SETERRNO(EBADF, SS_IVCHAN);
1732 PerlIO_has_cntptr(PerlIO *f)
1734 if (PerlIOValid(f)) {
1735 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1738 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1739 SETERRNO(EINVAL, LIB_INVARG);
1742 SETERRNO(EBADF, SS_IVCHAN);
1748 PerlIO_canset_cnt(PerlIO *f)
1750 if (PerlIOValid(f)) {
1751 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1754 return (tab->Set_ptrcnt != NULL);
1755 SETERRNO(EINVAL, LIB_INVARG);
1758 SETERRNO(EBADF, SS_IVCHAN);
1764 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1766 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1770 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1772 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1776 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1778 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1782 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1784 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1788 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1790 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1794 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1796 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1800 /*--------------------------------------------------------------------------------------*/
1802 * utf8 and raw dummy layers
1806 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1810 if (PerlIOValid(f)) {
1811 if (tab->kind & PERLIO_K_UTF8)
1812 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1814 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1820 PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1821 sizeof(PerlIO_funcs),
1824 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1844 NULL, /* get_base */
1845 NULL, /* get_bufsiz */
1848 NULL, /* set_ptrcnt */
1851 PERLIO_FUNCS_DECL(PerlIO_byte) = {
1852 sizeof(PerlIO_funcs),
1875 NULL, /* get_base */
1876 NULL, /* get_bufsiz */
1879 NULL, /* set_ptrcnt */
1883 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1884 IV n, const char *mode, int fd, int imode, int perm,
1885 PerlIO *old, int narg, SV **args)
1887 PerlIO_funcs *tab = PerlIO_default_btm();
1889 if (tab && tab->Open)
1890 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1892 SETERRNO(EINVAL, LIB_INVARG);
1896 PERLIO_FUNCS_DECL(PerlIO_raw) = {
1897 sizeof(PerlIO_funcs),
1920 NULL, /* get_base */
1921 NULL, /* get_bufsiz */
1924 NULL, /* set_ptrcnt */
1926 /*--------------------------------------------------------------------------------------*/
1927 /*--------------------------------------------------------------------------------------*/
1929 * "Methods" of the "base class"
1933 PerlIOBase_fileno(pTHX_ PerlIO *f)
1935 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1939 PerlIO_modestr(PerlIO * f, char *buf)
1942 if (PerlIOValid(f)) {
1943 const IV flags = PerlIOBase(f)->flags;
1944 if (flags & PERLIO_F_APPEND) {
1946 if (flags & PERLIO_F_CANREAD) {
1950 else if (flags & PERLIO_F_CANREAD) {
1952 if (flags & PERLIO_F_CANWRITE)
1955 else if (flags & PERLIO_F_CANWRITE) {
1957 if (flags & PERLIO_F_CANREAD) {
1961 #ifdef PERLIO_USING_CRLF
1962 if (!(flags & PERLIO_F_CRLF))
1972 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1974 PerlIOl * const l = PerlIOBase(f);
1977 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
1978 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
1979 if (tab->Set_ptrcnt != NULL)
1980 l->flags |= PERLIO_F_FASTGETS;
1982 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
1986 l->flags |= PERLIO_F_CANREAD;
1989 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
1992 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
1995 SETERRNO(EINVAL, LIB_INVARG);
2001 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2004 l->flags &= ~PERLIO_F_CRLF;
2007 l->flags |= PERLIO_F_CRLF;
2010 SETERRNO(EINVAL, LIB_INVARG);
2017 l->flags |= l->next->flags &
2018 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2023 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2024 f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2025 l->flags, PerlIO_modestr(f, temp));
2031 PerlIOBase_popped(pTHX_ PerlIO *f)
2038 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2041 * Save the position as current head considers it
2043 const Off_t old = PerlIO_tell(f);
2044 PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", Nullsv);
2045 PerlIOSelf(f, PerlIOBuf)->posn = old;
2046 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
2050 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2052 STDCHAR *buf = (STDCHAR *) vbuf;
2054 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2055 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2056 SETERRNO(EBADF, SS_IVCHAN);
2060 SSize_t avail = PerlIO_get_cnt(f);
2063 take = ((SSize_t)count < avail) ? count : avail;
2065 STDCHAR *ptr = PerlIO_get_ptr(f);
2066 Copy(ptr, buf, take, STDCHAR);
2067 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2071 if (count > 0 && avail <= 0) {
2072 if (PerlIO_fill(f) != 0)
2076 return (buf - (STDCHAR *) vbuf);
2082 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2089 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2096 PerlIOBase_close(pTHX_ PerlIO *f)
2099 if (PerlIOValid(f)) {
2100 PerlIO *n = PerlIONext(f);
2101 code = PerlIO_flush(f);
2102 PerlIOBase(f)->flags &=
2103 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2104 while (PerlIOValid(n)) {
2105 const PerlIO_funcs * const tab = PerlIOBase(n)->tab;
2106 if (tab && tab->Close) {
2107 if ((*tab->Close)(aTHX_ n) != 0)
2112 PerlIOBase(n)->flags &=
2113 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2119 SETERRNO(EBADF, SS_IVCHAN);
2125 PerlIOBase_eof(pTHX_ PerlIO *f)
2127 if (PerlIOValid(f)) {
2128 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2134 PerlIOBase_error(pTHX_ PerlIO *f)
2136 if (PerlIOValid(f)) {
2137 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2143 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2145 if (PerlIOValid(f)) {
2146 PerlIO *n = PerlIONext(f);
2147 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2154 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2156 if (PerlIOValid(f)) {
2157 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2162 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2168 return sv_dup(arg, param);
2171 return newSVsv(arg);
2174 return newSVsv(arg);
2179 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2181 PerlIO *nexto = PerlIONext(o);
2182 if (PerlIOValid(nexto)) {
2183 const PerlIO_funcs * const tab = PerlIOBase(nexto)->tab;
2184 if (tab && tab->Dup)
2185 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2187 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2190 PerlIO_funcs *self = PerlIOBase(o)->tab;
2193 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2194 self->name, (void*)f, (void*)o, (void*)param);
2196 arg = (*self->Getarg)(aTHX_ o, param, flags);
2200 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2209 perl_mutex PerlIO_mutex;
2212 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2217 /* Place holder for stdstreams call ??? */
2219 MUTEX_INIT(&PerlIO_mutex);
2224 PerlIOUnix_refcnt_inc(int fd)
2227 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2229 MUTEX_LOCK(&PerlIO_mutex);
2231 PL_perlio_fd_refcnt[fd]++;
2232 PerlIO_debug("fd %d refcnt=%d\n",fd,PL_perlio_fd_refcnt[fd]);
2234 MUTEX_UNLOCK(&PerlIO_mutex);
2240 PerlIOUnix_refcnt_dec(int fd)
2244 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2246 MUTEX_LOCK(&PerlIO_mutex);
2248 cnt = --PL_perlio_fd_refcnt[fd];
2249 PerlIO_debug("fd %d refcnt=%d\n",fd,cnt);
2251 MUTEX_UNLOCK(&PerlIO_mutex);
2258 PerlIO_cleanup(pTHX)
2262 PerlIO_debug("Cleanup layers for %p\n",aTHX);
2264 PerlIO_debug("Cleanup layers\n");
2266 /* Raise STDIN..STDERR refcount so we don't close them */
2267 for (i=0; i < 3; i++)
2268 PerlIOUnix_refcnt_inc(i);
2269 PerlIO_cleantable(aTHX_ &PL_perlio);
2270 /* Restore STDIN..STDERR refcount */
2271 for (i=0; i < 3; i++)
2272 PerlIOUnix_refcnt_dec(i);
2274 if (PL_known_layers) {
2275 PerlIO_list_free(aTHX_ PL_known_layers);
2276 PL_known_layers = NULL;
2278 if (PL_def_layerlist) {
2279 PerlIO_list_free(aTHX_ PL_def_layerlist);
2280 PL_def_layerlist = NULL;
2286 /*--------------------------------------------------------------------------------------*/
2288 * Bottom-most level for UNIX-like case
2292 struct _PerlIO base; /* The generic part */
2293 int fd; /* UNIX like file descriptor */
2294 int oflags; /* open/fcntl flags */
2298 PerlIOUnix_oflags(const char *mode)
2301 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2306 if (*++mode == '+') {
2313 oflags = O_CREAT | O_TRUNC;
2314 if (*++mode == '+') {
2323 oflags = O_CREAT | O_APPEND;
2324 if (*++mode == '+') {
2337 else if (*mode == 't') {
2339 oflags &= ~O_BINARY;
2343 * Always open in binary mode
2346 if (*mode || oflags == -1) {
2347 SETERRNO(EINVAL, LIB_INVARG);
2354 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2356 return PerlIOSelf(f, PerlIOUnix)->fd;
2360 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2362 PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2365 if (PerlLIO_fstat(fd, &st) == 0) {
2366 if (!S_ISREG(st.st_mode)) {
2367 PerlIO_debug("%d is not regular file\n",fd);
2368 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2371 PerlIO_debug("%d _is_ a regular file\n",fd);
2377 PerlIOUnix_refcnt_inc(fd);
2381 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2383 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2384 if (*PerlIONext(f)) {
2385 /* We never call down so do any pending stuff now */
2386 PerlIO_flush(PerlIONext(f));
2388 * XXX could (or should) we retrieve the oflags from the open file
2389 * handle rather than believing the "mode" we are passed in? XXX
2390 * Should the value on NULL mode be 0 or -1?
2392 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2393 mode ? PerlIOUnix_oflags(mode) : -1);
2395 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2401 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2403 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2405 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2407 SETERRNO(ESPIPE, LIB_INVARG);
2409 SETERRNO(EINVAL, LIB_INVARG);
2413 new_loc = PerlLIO_lseek(fd, offset, whence);
2414 if (new_loc == (Off_t) - 1)
2418 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2423 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2424 IV n, const char *mode, int fd, int imode,
2425 int perm, PerlIO *f, int narg, SV **args)
2427 if (PerlIOValid(f)) {
2428 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2429 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2432 if (*mode == IoTYPE_NUMERIC)
2435 imode = PerlIOUnix_oflags(mode);
2439 const char *path = SvPV_nolen(*args);
2440 fd = PerlLIO_open3(path, imode, perm);
2444 if (*mode == IoTYPE_IMPLICIT)
2447 f = PerlIO_allocate(aTHX);
2449 if (!PerlIOValid(f)) {
2450 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2454 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2455 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2456 if (*mode == IoTYPE_APPEND)
2457 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2463 * FIXME: pop layers ???
2471 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2473 PerlIOUnix *os = PerlIOSelf(o, PerlIOUnix);
2475 if (flags & PERLIO_DUP_FD) {
2476 fd = PerlLIO_dup(fd);
2478 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2479 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2481 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2482 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2491 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2493 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2494 #ifdef PERLIO_STD_SPECIAL
2496 return PERLIO_STD_IN(fd, vbuf, count);
2498 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2499 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2503 SSize_t len = PerlLIO_read(fd, vbuf, count);
2504 if (len >= 0 || errno != EINTR) {
2506 if (errno != EAGAIN) {
2507 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2510 else if (len == 0 && count != 0) {
2511 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2521 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2523 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2524 #ifdef PERLIO_STD_SPECIAL
2525 if (fd == 1 || fd == 2)
2526 return PERLIO_STD_OUT(fd, vbuf, count);
2529 const SSize_t len = PerlLIO_write(fd, vbuf, count);
2530 if (len >= 0 || errno != EINTR) {
2532 if (errno != EAGAIN) {
2533 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2543 PerlIOUnix_tell(pTHX_ PerlIO *f)
2545 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2550 PerlIOUnix_close(pTHX_ PerlIO *f)
2552 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2554 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2555 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2556 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2561 SETERRNO(EBADF,SS_IVCHAN);
2564 while (PerlLIO_close(fd) != 0) {
2565 if (errno != EINTR) {
2572 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2577 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2578 sizeof(PerlIO_funcs),
2585 PerlIOBase_binmode, /* binmode */
2595 PerlIOBase_noop_ok, /* flush */
2596 PerlIOBase_noop_fail, /* fill */
2599 PerlIOBase_clearerr,
2600 PerlIOBase_setlinebuf,
2601 NULL, /* get_base */
2602 NULL, /* get_bufsiz */
2605 NULL, /* set_ptrcnt */
2608 /*--------------------------------------------------------------------------------------*/
2613 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2614 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2615 broken by the last second glibc 2.3 fix
2617 #define STDIO_BUFFER_WRITABLE
2622 struct _PerlIO base;
2623 FILE *stdio; /* The stream */
2627 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2630 if (PerlIOValid(f) && (s = PerlIOSelf(f, PerlIOStdio)->stdio)) {
2631 return PerlSIO_fileno(s);
2638 PerlIOStdio_mode(const char *mode, char *tmode)
2640 char * const ret = tmode;
2646 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2654 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2657 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2658 PerlIO_funcs *toptab = PerlIOBase(n)->tab;
2659 if (toptab == tab) {
2660 /* Top is already stdio - pop self (duplicate) and use original */
2661 PerlIO_pop(aTHX_ f);
2664 const int fd = PerlIO_fileno(n);
2667 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2668 mode = PerlIOStdio_mode(mode, tmode)))) {
2669 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2670 /* We never call down so do any pending stuff now */
2671 PerlIO_flush(PerlIONext(f));
2678 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2683 PerlIO_importFILE(FILE *stdio, const char *mode)
2689 if (!mode || !*mode) {
2690 /* We need to probe to see how we can open the stream
2691 so start with read/write and then try write and read
2692 we dup() so that we can fclose without loosing the fd.
2694 Note that the errno value set by a failing fdopen
2695 varies between stdio implementations.
2697 const int fd = PerlLIO_dup(fileno(stdio));
2698 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2700 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2703 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2706 /* Don't seem to be able to open */
2712 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, Nullsv))) {
2713 s = PerlIOSelf(f, PerlIOStdio);
2721 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2722 IV n, const char *mode, int fd, int imode,
2723 int perm, PerlIO *f, int narg, SV **args)
2726 if (PerlIOValid(f)) {
2727 const char *path = SvPV_nolen(*args);
2728 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2730 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2731 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2736 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2741 const char *path = SvPV_nolen(*args);
2742 if (*mode == IoTYPE_NUMERIC) {
2744 fd = PerlLIO_open3(path, imode, perm);
2748 bool appended = FALSE;
2750 /* Cygwin wants its 'b' early. */
2752 mode = PerlIOStdio_mode(mode, tmode);
2754 stdio = PerlSIO_fopen(path, mode);
2758 f = PerlIO_allocate(aTHX);
2761 mode = PerlIOStdio_mode(mode, tmode);
2762 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2764 s = PerlIOSelf(f, PerlIOStdio);
2766 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2778 if (*mode == IoTYPE_IMPLICIT) {
2785 stdio = PerlSIO_stdin;
2788 stdio = PerlSIO_stdout;
2791 stdio = PerlSIO_stderr;
2796 stdio = PerlSIO_fdopen(fd, mode =
2797 PerlIOStdio_mode(mode, tmode));
2801 f = PerlIO_allocate(aTHX);
2803 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2804 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2806 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2816 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2818 /* This assumes no layers underneath - which is what
2819 happens, but is not how I remember it. NI-S 2001/10/16
2821 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2822 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2823 const int fd = fileno(stdio);
2825 if (flags & PERLIO_DUP_FD) {
2826 const int dfd = PerlLIO_dup(fileno(stdio));
2828 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2832 /* FIXME: To avoid messy error recovery if dup fails
2833 re-use the existing stdio as though flag was not set
2837 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2839 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2840 PerlIOUnix_refcnt_inc(fileno(stdio));
2846 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
2848 /* XXX this could use PerlIO_canset_fileno() and
2849 * PerlIO_set_fileno() support from Configure
2851 # if defined(__UCLIBC__)
2852 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
2855 # elif defined(__GLIBC__)
2856 /* There may be a better way for GLIBC:
2857 - libio.h defines a flag to not close() on cleanup
2861 # elif defined(__sun__)
2863 /* On solaris, if _LP64 is defined, the FILE structure is this:
2869 * It turns out that the fd is stored in the top 32 bits of
2870 * file->__pad[4]. The lower 32 bits contain flags. file->pad[5] appears
2871 * to contain a pointer or offset into another structure. All the
2872 * remaining fields are zero.
2874 * We set the top bits to -1 (0xFFFFFFFF).
2876 f->__pad[4] |= 0xffffffff00000000L;
2877 assert(fileno(f) == 0xffffffff);
2878 # else /* !defined(_LP64) */
2879 /* _file is just a unsigned char :-(
2880 Not clear why we dup() rather than using -1
2881 even if that would be treated as 0xFF - so will
2884 f->_file = PerlLIO_dup(fileno(f));
2885 # endif /* defined(_LP64) */
2887 # elif defined(__hpux)
2891 /* Next one ->_file seems to be a reasonable fallback, i.e. if
2892 your platform does not have special entry try this one.
2893 [For OSF only have confirmation for Tru64 (alpha)
2894 but assume other OSFs will be similar.]
2896 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
2899 # elif defined(__FreeBSD__)
2900 /* There may be a better way on FreeBSD:
2901 - we could insert a dummy func in the _close function entry
2902 f->_close = (int (*)(void *)) dummy_close;
2906 # elif defined(__OpenBSD__)
2907 /* There may be a better way on OpenBSD:
2908 - we could insert a dummy func in the _close function entry
2909 f->_close = (int (*)(void *)) dummy_close;
2913 # elif defined(__EMX__)
2914 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
2917 # elif defined(__CYGWIN__)
2918 /* There may be a better way on CYGWIN:
2919 - we could insert a dummy func in the _close function entry
2920 f->_close = (int (*)(void *)) dummy_close;
2924 # elif defined(WIN32)
2925 # if defined(__BORLANDC__)
2926 f->fd = PerlLIO_dup(fileno(f));
2927 # elif defined(UNDER_CE)
2928 /* WIN_CE does not have access to FILE internals, it hardly has FILE
2937 /* Sarathy's code did this - we fall back to a dup/dup2 hack
2938 (which isn't thread safe) instead
2940 # error "Don't know how to set FILE.fileno on your platform"
2947 PerlIOStdio_close(pTHX_ PerlIO *f)
2949 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
2955 const int fd = fileno(stdio);
2961 #ifdef SOCKS5_VERSION_NAME
2962 /* Socks lib overrides close() but stdio isn't linked to
2963 that library (though we are) - so we must call close()
2964 on sockets on stdio's behalf.
2967 Sock_size_t optlen = sizeof(int);
2968 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0) {
2973 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2974 /* File descriptor still in use */
2979 /* For STD* handles don't close the stdio at all
2980 this is because we have shared the FILE * too
2982 if (stdio == stdin) {
2983 /* Some stdios are buggy fflush-ing inputs */
2986 else if (stdio == stdout || stdio == stderr) {
2987 return PerlIO_flush(f);
2989 /* Tricky - must fclose(stdio) to free memory but not close(fd)
2990 Use Sarathy's trick from maint-5.6 to invalidate the
2991 fileno slot of the FILE *
2993 result = PerlIO_flush(f);
2995 if (!(invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio))) {
2996 dupfd = PerlLIO_dup(fd);
2999 result = PerlSIO_fclose(stdio);
3000 /* We treat error from stdio as success if we invalidated
3001 errno may NOT be expected EBADF
3003 if (invalidate && result != 0) {
3008 /* in SOCKS case let close() determine return value */
3012 PerlLIO_dup2(dupfd,fd);
3013 PerlLIO_close(dupfd);
3020 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3022 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3026 STDCHAR *buf = (STDCHAR *) vbuf;
3028 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3029 * stdio does not do that for fread()
3031 const int ch = PerlSIO_fgetc(s);
3038 got = PerlSIO_fread(vbuf, 1, count, s);
3039 if (got == 0 && PerlSIO_ferror(s))
3041 if (got >= 0 || errno != EINTR)
3044 SETERRNO(0,0); /* just in case */
3050 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3053 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3055 #ifdef STDIO_BUFFER_WRITABLE
3056 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3057 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3058 STDCHAR *base = PerlIO_get_base(f);
3059 SSize_t cnt = PerlIO_get_cnt(f);
3060 STDCHAR *ptr = PerlIO_get_ptr(f);
3061 SSize_t avail = ptr - base;
3063 if (avail > count) {
3067 Move(buf-avail,ptr,avail,STDCHAR);
3070 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3071 if (PerlSIO_feof(s) && unread >= 0)
3072 PerlSIO_clearerr(s);
3077 if (PerlIO_has_cntptr(f)) {
3078 /* We can get pointer to buffer but not its base
3079 Do ungetc() but check chars are ending up in the
3082 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3083 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3085 const int ch = *--buf & 0xFF;
3086 if (ungetc(ch,s) != ch) {
3087 /* ungetc did not work */
3090 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3091 /* Did not change pointer as expected */
3092 fgetc(s); /* get char back again */
3102 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3108 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3112 got = PerlSIO_fwrite(vbuf, 1, count,
3113 PerlIOSelf(f, PerlIOStdio)->stdio);
3114 if (got >= 0 || errno != EINTR)
3117 SETERRNO(0,0); /* just in case */
3123 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3125 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3126 return PerlSIO_fseek(stdio, offset, whence);
3130 PerlIOStdio_tell(pTHX_ PerlIO *f)
3132 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3133 return PerlSIO_ftell(stdio);
3137 PerlIOStdio_flush(pTHX_ PerlIO *f)
3139 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3140 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3141 return PerlSIO_fflush(stdio);
3146 * FIXME: This discards ungetc() and pre-read stuff which is not
3147 * right if this is just a "sync" from a layer above Suspect right
3148 * design is to do _this_ but not have layer above flush this
3149 * layer read-to-read
3152 * Not writeable - sync by attempting a seek
3155 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3163 PerlIOStdio_eof(pTHX_ PerlIO *f)
3165 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3169 PerlIOStdio_error(pTHX_ PerlIO *f)
3171 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3175 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3177 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3181 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3183 #ifdef HAS_SETLINEBUF
3184 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3186 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, Nullch, _IOLBF, 0);
3192 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3194 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3195 return (STDCHAR*)PerlSIO_get_base(stdio);
3199 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3201 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3202 return PerlSIO_get_bufsiz(stdio);
3206 #ifdef USE_STDIO_PTR
3208 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3210 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3211 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3215 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3217 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3218 return PerlSIO_get_cnt(stdio);
3222 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3224 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3226 #ifdef STDIO_PTR_LVALUE
3227 PerlSIO_set_ptr(stdio, (void*)ptr); /* LHS STDCHAR* cast non-portable */
3228 #ifdef STDIO_PTR_LVAL_SETS_CNT
3229 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3230 assert(PerlSIO_get_cnt(stdio) == (cnt));
3233 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3235 * Setting ptr _does_ change cnt - we are done
3239 #else /* STDIO_PTR_LVALUE */
3241 #endif /* STDIO_PTR_LVALUE */
3244 * Now (or only) set cnt
3246 #ifdef STDIO_CNT_LVALUE
3247 PerlSIO_set_cnt(stdio, cnt);
3248 #else /* STDIO_CNT_LVALUE */
3249 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3250 PerlSIO_set_ptr(stdio,
3251 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3253 #else /* STDIO_PTR_LVAL_SETS_CNT */
3255 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3256 #endif /* STDIO_CNT_LVALUE */
3263 PerlIOStdio_fill(pTHX_ PerlIO *f)
3265 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3268 * fflush()ing read-only streams can cause trouble on some stdio-s
3270 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3271 if (PerlSIO_fflush(stdio) != 0)
3274 c = PerlSIO_fgetc(stdio);
3278 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3280 #ifdef STDIO_BUFFER_WRITABLE
3281 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3282 /* Fake ungetc() to the real buffer in case system's ungetc
3285 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3286 SSize_t cnt = PerlSIO_get_cnt(stdio);
3287 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3288 if (ptr == base+1) {
3289 *--ptr = (STDCHAR) c;
3290 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3291 if (PerlSIO_feof(stdio))
3292 PerlSIO_clearerr(stdio);
3298 if (PerlIO_has_cntptr(f)) {
3300 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3307 /* An ungetc()d char is handled separately from the regular
3308 * buffer, so we stuff it in the buffer ourselves.
3309 * Should never get called as should hit code above
3311 *(--((*stdio)->_ptr)) = (unsigned char) c;
3314 /* If buffer snoop scheme above fails fall back to
3317 if (PerlSIO_ungetc(c, stdio) != c)
3325 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3326 sizeof(PerlIO_funcs),
3328 sizeof(PerlIOStdio),
3329 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3333 PerlIOBase_binmode, /* binmode */
3347 PerlIOStdio_clearerr,
3348 PerlIOStdio_setlinebuf,
3350 PerlIOStdio_get_base,
3351 PerlIOStdio_get_bufsiz,
3356 #ifdef USE_STDIO_PTR
3357 PerlIOStdio_get_ptr,
3358 PerlIOStdio_get_cnt,
3359 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3360 PerlIOStdio_set_ptrcnt,
3363 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3368 #endif /* USE_STDIO_PTR */
3371 /* Note that calls to PerlIO_exportFILE() are reversed using
3372 * PerlIO_releaseFILE(), not importFILE. */
3374 PerlIO_exportFILE(PerlIO * f, const char *mode)
3378 if (PerlIOValid(f)) {
3381 if (!mode || !*mode) {
3382 mode = PerlIO_modestr(f, buf);
3384 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3388 /* De-link any lower layers so new :stdio sticks */
3390 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, Nullsv))) {
3391 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3393 /* Link previous lower layers under new one */
3397 /* restore layers list */
3407 PerlIO_findFILE(PerlIO *f)
3411 if (l->tab == &PerlIO_stdio) {
3412 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3415 l = *PerlIONext(&l);
3417 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3418 return PerlIO_exportFILE(f, Nullch);
3421 /* Use this to reverse PerlIO_exportFILE calls. */
3423 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3428 if (l->tab == &PerlIO_stdio) {
3429 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3430 if (s->stdio == f) {
3432 PerlIO_pop(aTHX_ p);
3441 /*--------------------------------------------------------------------------------------*/
3443 * perlio buffer layer
3447 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3449 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3450 const int fd = PerlIO_fileno(f);
3451 if (fd >= 0 && PerlLIO_isatty(fd)) {
3452 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3454 if (*PerlIONext(f)) {
3455 const Off_t posn = PerlIO_tell(PerlIONext(f));
3456 if (posn != (Off_t) - 1) {
3460 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3464 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3465 IV n, const char *mode, int fd, int imode, int perm,
3466 PerlIO *f, int narg, SV **args)
3468 if (PerlIOValid(f)) {
3469 PerlIO *next = PerlIONext(f);
3471 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3472 if (tab && tab->Open)
3474 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3476 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3481 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3483 if (*mode == IoTYPE_IMPLICIT) {
3489 if (tab && tab->Open)
3490 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3493 SETERRNO(EINVAL, LIB_INVARG);
3495 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3497 * if push fails during open, open fails. close will pop us.
3502 fd = PerlIO_fileno(f);
3503 if (init && fd == 2) {
3505 * Initial stderr is unbuffered
3507 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3509 #ifdef PERLIO_USING_CRLF
3510 # ifdef PERLIO_IS_BINMODE_FD
3511 if (PERLIO_IS_BINMODE_FD(fd))
3512 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, Nullch);
3516 * do something about failing setmode()? --jhi
3518 PerlLIO_setmode(fd, O_BINARY);
3527 * This "flush" is akin to sfio's sync in that it handles files in either
3528 * read or write state
3531 PerlIOBuf_flush(pTHX_ PerlIO *f)
3533 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3535 PerlIO *n = PerlIONext(f);
3536 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3538 * write() the buffer
3540 const STDCHAR *buf = b->buf;
3541 const STDCHAR *p = buf;
3542 while (p < b->ptr) {
3543 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3547 else if (count < 0 || PerlIO_error(n)) {
3548 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3553 b->posn += (p - buf);
3555 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3556 STDCHAR *buf = PerlIO_get_base(f);
3558 * Note position change
3560 b->posn += (b->ptr - buf);
3561 if (b->ptr < b->end) {
3562 /* We did not consume all of it - try and seek downstream to
3563 our logical position
3565 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3566 /* Reload n as some layers may pop themselves on seek */
3567 b->posn = PerlIO_tell(n = PerlIONext(f));
3570 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3571 data is lost for good - so return saying "ok" having undone
3574 b->posn -= (b->ptr - buf);
3579 b->ptr = b->end = b->buf;
3580 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3581 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3582 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3588 PerlIOBuf_fill(pTHX_ PerlIO *f)
3590 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3591 PerlIO *n = PerlIONext(f);
3594 * Down-stream flush is defined not to loose read data so is harmless.
3595 * we would not normally be fill'ing if there was data left in anycase.
3597 if (PerlIO_flush(f) != 0)
3599 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3600 PerlIOBase_flush_linebuf(aTHX);
3603 PerlIO_get_base(f); /* allocate via vtable */
3605 b->ptr = b->end = b->buf;
3607 if (!PerlIOValid(n)) {
3608 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3612 if (PerlIO_fast_gets(n)) {
3614 * Layer below is also buffered. We do _NOT_ want to call its
3615 * ->Read() because that will loop till it gets what we asked for
3616 * which may hang on a pipe etc. Instead take anything it has to
3617 * hand, or ask it to fill _once_.
3619 avail = PerlIO_get_cnt(n);
3621 avail = PerlIO_fill(n);
3623 avail = PerlIO_get_cnt(n);
3625 if (!PerlIO_error(n) && PerlIO_eof(n))
3630 STDCHAR *ptr = PerlIO_get_ptr(n);
3631 SSize_t cnt = avail;
3632 if (avail > (SSize_t)b->bufsiz)
3634 Copy(ptr, b->buf, avail, STDCHAR);
3635 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3639 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3643 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3645 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3648 b->end = b->buf + avail;
3649 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3654 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3656 if (PerlIOValid(f)) {
3657 const PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3660 return PerlIOBase_read(aTHX_ f, vbuf, count);
3666 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3668 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3669 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3672 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3677 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3679 * Buffer is already a read buffer, we can overwrite any chars
3680 * which have been read back to buffer start
3682 avail = (b->ptr - b->buf);
3686 * Buffer is idle, set it up so whole buffer is available for
3690 b->end = b->buf + avail;
3692 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3694 * Buffer extends _back_ from where we are now
3696 b->posn -= b->bufsiz;
3698 if (avail > (SSize_t) count) {
3700 * If we have space for more than count, just move count
3708 * In simple stdio-like ungetc() case chars will be already
3711 if (buf != b->ptr) {
3712 Copy(buf, b->ptr, avail, STDCHAR);
3716 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3720 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3726 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3728 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3729 const STDCHAR *buf = (const STDCHAR *) vbuf;
3730 const STDCHAR *flushptr = buf;
3734 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3736 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3737 if (PerlIO_flush(f) != 0) {
3741 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3742 flushptr = buf + count;
3743 while (flushptr > buf && *(flushptr - 1) != '\n')
3747 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3748 if ((SSize_t) count < avail)
3750 if (flushptr > buf && flushptr <= buf + avail)
3751 avail = flushptr - buf;
3752 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3754 Copy(buf, b->ptr, avail, STDCHAR);
3759 if (buf == flushptr)
3762 if (b->ptr >= (b->buf + b->bufsiz))
3765 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3771 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3774 if ((code = PerlIO_flush(f)) == 0) {
3775 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3776 code = PerlIO_seek(PerlIONext(f), offset, whence);
3778 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3779 b->posn = PerlIO_tell(PerlIONext(f));
3786 PerlIOBuf_tell(pTHX_ PerlIO *f)
3788 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3790 * b->posn is file position where b->buf was read, or will be written
3792 Off_t posn = b->posn;
3793 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3794 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3796 /* As O_APPEND files are normally shared in some sense it is better
3801 /* when file is NOT shared then this is sufficient */
3802 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3804 posn = b->posn = PerlIO_tell(PerlIONext(f));
3808 * If buffer is valid adjust position by amount in buffer
3810 posn += (b->ptr - b->buf);
3816 PerlIOBuf_popped(pTHX_ PerlIO *f)
3818 const IV code = PerlIOBase_popped(aTHX_ f);
3819 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3820 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3824 b->ptr = b->end = b->buf;
3825 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3830 PerlIOBuf_close(pTHX_ PerlIO *f)
3832 const IV code = PerlIOBase_close(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_get_ptr(pTHX_ PerlIO *f)
3846 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3853 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
3855 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3858 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
3859 return (b->end - b->ptr);
3864 PerlIOBuf_get_base(pTHX_ PerlIO *f)
3866 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3870 b->buf = Newz('B',b->buf,b->bufsiz, STDCHAR);
3872 b->buf = (STDCHAR *) & b->oneword;
3873 b->bufsiz = sizeof(b->oneword);
3882 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
3884 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3887 return (b->end - b->buf);
3891 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3893 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3897 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
3898 assert(PerlIO_get_cnt(f) == cnt);
3899 assert(b->ptr >= b->buf);
3901 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3905 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3907 return PerlIOBase_dup(aTHX_ f, o, param, flags);
3912 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
3913 sizeof(PerlIO_funcs),
3916 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3920 PerlIOBase_binmode, /* binmode */
3934 PerlIOBase_clearerr,
3935 PerlIOBase_setlinebuf,
3940 PerlIOBuf_set_ptrcnt,
3943 /*--------------------------------------------------------------------------------------*/
3945 * Temp layer to hold unread chars when cannot do it any other way
3949 PerlIOPending_fill(pTHX_ PerlIO *f)
3952 * Should never happen
3959 PerlIOPending_close(pTHX_ PerlIO *f)
3962 * A tad tricky - flush pops us, then we close new top
3965 return PerlIO_close(f);
3969 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3972 * A tad tricky - flush pops us, then we seek new top
3975 return PerlIO_seek(f, offset, whence);
3980 PerlIOPending_flush(pTHX_ PerlIO *f)
3982 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3983 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3987 PerlIO_pop(aTHX_ f);
3992 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3998 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4003 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4005 const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4006 PerlIOl *l = PerlIOBase(f);
4008 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4009 * etc. get muddled when it changes mid-string when we auto-pop.
4011 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4012 (PerlIOBase(PerlIONext(f))->
4013 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4018 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4020 SSize_t avail = PerlIO_get_cnt(f);
4022 if ((SSize_t)count < avail)
4025 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4026 if (got >= 0 && got < (SSize_t)count) {
4027 const SSize_t more =
4028 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4029 if (more >= 0 || got == 0)
4035 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4036 sizeof(PerlIO_funcs),
4039 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4040 PerlIOPending_pushed,
4043 PerlIOBase_binmode, /* binmode */
4052 PerlIOPending_close,
4053 PerlIOPending_flush,
4057 PerlIOBase_clearerr,
4058 PerlIOBase_setlinebuf,
4063 PerlIOPending_set_ptrcnt,
4068 /*--------------------------------------------------------------------------------------*/
4070 * crlf - translation On read translate CR,LF to "\n" we do this by
4071 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4072 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4076 PerlIOBuf base; /* PerlIOBuf stuff */
4077 STDCHAR *nl; /* Position of crlf we "lied" about in the
4082 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4085 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4086 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4088 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4089 f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4090 PerlIOBase(f)->flags);
4093 /* Enable the first CRLF capable layer you can find, but if none
4094 * found, the one we just pushed is fine. This results in at
4095 * any given moment at most one CRLF-capable layer being enabled
4096 * in the whole layer stack. */
4097 PerlIO *g = PerlIONext(f);
4099 PerlIOl *b = PerlIOBase(g);
4100 if (b && b->tab == &PerlIO_crlf) {
4101 if (!(b->flags & PERLIO_F_CRLF))
4102 b->flags |= PERLIO_F_CRLF;
4103 PerlIO_pop(aTHX_ f);
4114 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4116 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4121 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4122 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4124 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4125 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4127 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4132 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4133 b->end = b->ptr = b->buf + b->bufsiz;
4134 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4135 b->posn -= b->bufsiz;
4137 while (count > 0 && b->ptr > b->buf) {
4140 if (b->ptr - 2 >= b->buf) {
4163 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4165 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4168 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4169 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4170 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4171 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4173 while (nl < b->end && *nl != 0xd)
4175 if (nl < b->end && *nl == 0xd) {
4177 if (nl + 1 < b->end) {
4184 * Not CR,LF but just CR
4192 * Blast - found CR as last char in buffer
4197 * They may not care, defer work as long as
4201 return (nl - b->ptr);
4205 b->ptr++; /* say we have read it as far as
4206 * flush() is concerned */
4207 b->buf++; /* Leave space in front of buffer */
4208 /* Note as we have moved buf up flush's
4210 will naturally make posn point at CR
4212 b->bufsiz--; /* Buffer is thus smaller */
4213 code = PerlIO_fill(f); /* Fetch some more */
4214 b->bufsiz++; /* Restore size for next time */
4215 b->buf--; /* Point at space */
4216 b->ptr = nl = b->buf; /* Which is what we hand
4218 *nl = 0xd; /* Fill in the CR */
4220 goto test; /* fill() call worked */
4222 * CR at EOF - just fall through
4224 /* Should we clear EOF though ??? */
4229 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4235 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4237 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4238 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4244 if (ptr == b->end && *c->nl == 0xd) {
4245 /* Defered CR at end of buffer case - we lied about count */
4257 * Test code - delete when it works ...
4259 IV flags = PerlIOBase(f)->flags;
4260 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4261 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4262 /* Defered CR at end of buffer case - we lied about count */
4268 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4269 " nl=%p e=%p for %d", ptr, chk, flags, c->nl,
4277 * They have taken what we lied about
4285 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4289 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4291 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4292 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4294 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4295 const STDCHAR *buf = (const STDCHAR *) vbuf;
4296 const STDCHAR *ebuf = buf + count;
4299 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4301 while (buf < ebuf) {
4302 STDCHAR *eptr = b->buf + b->bufsiz;
4303 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4304 while (buf < ebuf && b->ptr < eptr) {
4306 if ((b->ptr + 2) > eptr) {
4314 *(b->ptr)++ = 0xd; /* CR */
4315 *(b->ptr)++ = 0xa; /* LF */
4317 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4327 if (b->ptr >= eptr) {
4333 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4335 return (buf - (STDCHAR *) vbuf);
4340 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4342 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4347 return PerlIOBuf_flush(aTHX_ f);
4351 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4353 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4354 /* In text mode - flush any pending stuff and flip it */
4355 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4356 #ifndef PERLIO_USING_CRLF
4357 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4358 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4359 PerlIO_pop(aTHX_ f);
4366 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4367 sizeof(PerlIO_funcs),
4370 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4372 PerlIOBuf_popped, /* popped */
4374 PerlIOCrlf_binmode, /* binmode */
4378 PerlIOBuf_read, /* generic read works with ptr/cnt lies */
4379 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4380 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4388 PerlIOBase_clearerr,
4389 PerlIOBase_setlinebuf,
4394 PerlIOCrlf_set_ptrcnt,
4398 /*--------------------------------------------------------------------------------------*/
4400 * mmap as "buffer" layer
4404 PerlIOBuf base; /* PerlIOBuf stuff */
4405 Mmap_t mptr; /* Mapped address */
4406 Size_t len; /* mapped length */
4407 STDCHAR *bbuf; /* malloced buffer if map fails */
4411 PerlIOMmap_map(pTHX_ PerlIO *f)
4414 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4415 const IV flags = PerlIOBase(f)->flags;
4419 if (flags & PERLIO_F_CANREAD) {
4420 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4421 const int fd = PerlIO_fileno(f);
4423 code = Fstat(fd, &st);
4424 if (code == 0 && S_ISREG(st.st_mode)) {
4425 SSize_t len = st.st_size - b->posn;
4428 if (PL_mmap_page_size <= 0)
4429 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4433 * This is a hack - should never happen - open should
4436 b->posn = PerlIO_tell(PerlIONext(f));
4438 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4439 len = st.st_size - posn;
4440 m->mptr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4441 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4442 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4443 madvise(m->mptr, len, MADV_SEQUENTIAL);
4445 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4446 madvise(m->mptr, len, MADV_WILLNEED);
4448 PerlIOBase(f)->flags =
4449 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4450 b->end = ((STDCHAR *) m->mptr) + len;
4451 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4460 PerlIOBase(f)->flags =
4461 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4463 b->ptr = b->end = b->ptr;
4472 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4474 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4475 PerlIOBuf *b = &m->base;
4479 code = munmap(m->mptr, m->len);
4483 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4486 b->ptr = b->end = b->buf;
4487 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4493 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4495 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4496 PerlIOBuf *b = &m->base;
4497 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4499 * Already have a readbuffer in progress
4505 * We have a write buffer or flushed PerlIOBuf read buffer
4507 m->bbuf = b->buf; /* save it in case we need it again */
4508 b->buf = NULL; /* Clear to trigger below */
4511 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4514 * Map did not work - recover PerlIOBuf buffer if we have one
4519 b->ptr = b->end = b->buf;
4522 return PerlIOBuf_get_base(aTHX_ f);
4526 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4528 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4529 PerlIOBuf *b = &m->base;
4530 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4532 if (b->ptr && (b->ptr - count) >= b->buf
4533 && memEQ(b->ptr - count, vbuf, count)) {
4535 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4540 * Loose the unwritable mapped buffer
4544 * If flush took the "buffer" see if we have one from before
4546 if (!b->buf && m->bbuf)
4549 PerlIOBuf_get_base(aTHX_ f);
4553 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4557 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4559 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4560 PerlIOBuf * const b = &m->base;
4562 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4564 * No, or wrong sort of, buffer
4567 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4571 * If unmap took the "buffer" see if we have one from before
4573 if (!b->buf && m->bbuf)
4576 PerlIOBuf_get_base(aTHX_ f);
4580 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4584 PerlIOMmap_flush(pTHX_ PerlIO *f)
4586 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4587 PerlIOBuf *b = &m->base;
4588 IV code = PerlIOBuf_flush(aTHX_ f);
4590 * Now we are "synced" at PerlIOBuf level
4597 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4602 * We seem to have a PerlIOBuf buffer which was not mapped
4603 * remember it in case we need one later
4612 PerlIOMmap_fill(pTHX_ PerlIO *f)
4614 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4615 IV code = PerlIO_flush(f);
4616 if (code == 0 && !b->buf) {
4617 code = PerlIOMmap_map(aTHX_ f);
4619 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4620 code = PerlIOBuf_fill(aTHX_ f);
4626 PerlIOMmap_close(pTHX_ PerlIO *f)
4628 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4629 PerlIOBuf *b = &m->base;
4630 IV code = PerlIO_flush(f);
4634 b->ptr = b->end = b->buf;
4636 if (PerlIOBuf_close(aTHX_ f) != 0)
4642 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4644 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4648 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4649 sizeof(PerlIO_funcs),
4652 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4656 PerlIOBase_binmode, /* binmode */
4670 PerlIOBase_clearerr,
4671 PerlIOBase_setlinebuf,
4672 PerlIOMmap_get_base,
4676 PerlIOBuf_set_ptrcnt,
4679 #endif /* HAS_MMAP */
4682 Perl_PerlIO_stdin(pTHX)
4685 PerlIO_stdstreams(aTHX);
4687 return &PL_perlio[1];
4691 Perl_PerlIO_stdout(pTHX)
4694 PerlIO_stdstreams(aTHX);
4696 return &PL_perlio[2];
4700 Perl_PerlIO_stderr(pTHX)
4703 PerlIO_stdstreams(aTHX);
4705 return &PL_perlio[3];
4708 /*--------------------------------------------------------------------------------------*/
4711 PerlIO_getname(PerlIO *f, char *buf)
4716 bool exported = FALSE;
4717 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4719 stdio = PerlIO_exportFILE(f,0);
4723 name = fgetname(stdio, buf);
4724 if (exported) PerlIO_releaseFILE(f,stdio);
4730 Perl_croak(aTHX_ "Don't know how to get file name");
4736 /*--------------------------------------------------------------------------------------*/
4738 * Functions which can be called on any kind of PerlIO implemented in
4742 #undef PerlIO_fdopen
4744 PerlIO_fdopen(int fd, const char *mode)
4747 return PerlIO_openn(aTHX_ Nullch, mode, fd, 0, 0, NULL, 0, NULL);
4752 PerlIO_open(const char *path, const char *mode)
4755 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4756 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, NULL, 1, &name);
4759 #undef Perlio_reopen
4761 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4764 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4765 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, f, 1, &name);
4770 PerlIO_getc(PerlIO *f)
4774 if ( 1 == PerlIO_read(f, buf, 1) ) {
4775 return (unsigned char) buf[0];
4780 #undef PerlIO_ungetc
4782 PerlIO_ungetc(PerlIO *f, int ch)
4787 if (PerlIO_unread(f, &buf, 1) == 1)
4795 PerlIO_putc(PerlIO *f, int ch)
4799 return PerlIO_write(f, &buf, 1);
4804 PerlIO_puts(PerlIO *f, const char *s)
4807 STRLEN len = strlen(s);
4808 return PerlIO_write(f, s, len);
4811 #undef PerlIO_rewind
4813 PerlIO_rewind(PerlIO *f)
4816 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4820 #undef PerlIO_vprintf
4822 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4825 SV *sv = newSVpvn("", 0);
4831 Perl_va_copy(ap, apc);
4832 sv_vcatpvf(sv, fmt, &apc);
4834 sv_vcatpvf(sv, fmt, &ap);
4837 wrote = PerlIO_write(f, s, len);
4842 #undef PerlIO_printf
4844 PerlIO_printf(PerlIO *f, const char *fmt, ...)
4849 result = PerlIO_vprintf(f, fmt, ap);
4854 #undef PerlIO_stdoutf
4856 PerlIO_stdoutf(const char *fmt, ...)
4862 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
4867 #undef PerlIO_tmpfile
4869 PerlIO_tmpfile(void)
4874 const int fd = win32_tmpfd();
4876 f = PerlIO_fdopen(fd, "w+b");
4878 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
4879 SV *sv = newSVpv("/tmp/PerlIO_XXXXXX", 0);
4881 * I have no idea how portable mkstemp() is ... NI-S
4883 const int fd = mkstemp(SvPVX(sv));
4885 f = PerlIO_fdopen(fd, "w+");
4887 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
4888 PerlLIO_unlink(SvPVX(sv));
4891 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
4892 FILE *stdio = PerlSIO_tmpfile();
4895 if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)),
4896 PERLIO_FUNCS_CAST(&PerlIO_stdio),
4898 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
4904 # endif /* else HAS_MKSTEMP */
4905 #endif /* else WIN32 */
4912 #endif /* USE_SFIO */
4913 #endif /* PERLIO_IS_STDIO */
4915 /*======================================================================================*/
4917 * Now some functions in terms of above which may be needed even if we are
4918 * not in true PerlIO mode
4922 #undef PerlIO_setpos
4924 PerlIO_setpos(PerlIO *f, SV *pos)
4929 Off_t *posn = (Off_t *) SvPV(pos, len);