3 * Copyright (c) 1996-2006, Nick Ing-Simmons
4 * Copyright (c) 2006, 2007, 2008 Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public License
7 * or the Artistic License, as specified in the README file.
11 * Hour after hour for nearly three weary days he had jogged up and down,
12 * over passes, and through long dales, and across many streams.
14 * [pp.791-792 of _The Lord of the Rings_, V/iii: "The Muster of Rohan"]
17 /* This file contains the functions needed to implement PerlIO, which
18 * is Perl's private replacement for the C stdio library. This is used
19 * by default unless you compile with -Uuseperlio or run with
20 * PERLIO=:stdio (but don't do this unless you know what you're doing)
24 * If we have ActivePerl-like PERL_IMPLICIT_SYS then we need a dTHX to get
25 * at the dispatch tables, even when we do not need it for other reasons.
26 * Invent a dSYS macro to abstract this out
28 #ifdef PERL_IMPLICIT_SYS
38 # ifndef USE_CROSS_COMPILE
45 #define PERLIO_NOT_STDIO 0
46 #if !defined(PERLIO_IS_STDIO) && !defined(USE_SFIO)
52 * This file provides those parts of PerlIO abstraction
53 * which are not #defined in perlio.h.
54 * Which these are depends on various Configure #ifdef's
58 #define PERL_IN_PERLIO_C
61 #ifdef PERL_IMPLICIT_CONTEXT
69 /* Missing proto on LynxOS */
73 /* Call the callback or PerlIOBase, and return failure. */
74 #define Perl_PerlIO_or_Base(f, callback, base, failure, args) \
75 if (PerlIOValid(f)) { \
76 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
77 if (tab && tab->callback) \
78 return (*tab->callback) args; \
80 return PerlIOBase_ ## base args; \
83 SETERRNO(EBADF, SS_IVCHAN); \
86 /* Call the callback or fail, and return failure. */
87 #define Perl_PerlIO_or_fail(f, callback, failure, args) \
88 if (PerlIOValid(f)) { \
89 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
90 if (tab && tab->callback) \
91 return (*tab->callback) args; \
92 SETERRNO(EINVAL, LIB_INVARG); \
95 SETERRNO(EBADF, SS_IVCHAN); \
98 /* Call the callback or PerlIOBase, and be void. */
99 #define Perl_PerlIO_or_Base_void(f, callback, base, args) \
100 if (PerlIOValid(f)) { \
101 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
102 if (tab && tab->callback) \
103 (*tab->callback) args; \
105 PerlIOBase_ ## base args; \
108 SETERRNO(EBADF, SS_IVCHAN)
110 /* Call the callback or fail, and be void. */
111 #define Perl_PerlIO_or_fail_void(f, callback, args) \
112 if (PerlIOValid(f)) { \
113 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
114 if (tab && tab->callback) \
115 (*tab->callback) args; \
117 SETERRNO(EINVAL, LIB_INVARG); \
120 SETERRNO(EBADF, SS_IVCHAN)
122 #if defined(__osf__) && _XOPEN_SOURCE < 500
123 extern int fseeko(FILE *, off_t, int);
124 extern off_t ftello(FILE *);
129 EXTERN_C int perlsio_binmode(FILE *fp, int iotype, int mode);
132 perlsio_binmode(FILE *fp, int iotype, int mode)
135 * This used to be contents of do_binmode in doio.c
138 # if defined(atarist) || defined(__MINT__)
139 PERL_UNUSED_ARG(iotype);
142 ((FILE *) fp)->_flag |= _IOBIN;
144 ((FILE *) fp)->_flag &= ~_IOBIN;
150 PERL_UNUSED_ARG(iotype);
152 if (PerlLIO_setmode(fp, mode) != -1) {
154 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
156 # if defined(WIN32) && defined(__BORLANDC__)
158 * The translation mode of the stream is maintained independent
160 * the translation mode of the fd in the Borland RTL (heavy
161 * digging through their runtime sources reveal). User has to
163 * the mode explicitly for the stream (though they don't
165 * this anywhere). GSAR 97-5-24
171 fp->flags &= ~_F_BIN;
179 # if defined(USEMYBINMODE)
181 # if defined(__CYGWIN__)
182 PERL_UNUSED_ARG(iotype);
184 if (my_binmode(fp, iotype, mode) != FALSE)
190 PERL_UNUSED_ARG(iotype);
191 PERL_UNUSED_ARG(mode);
199 #define O_ACCMODE 3 /* Assume traditional implementation */
203 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
205 const int result = rawmode & O_ACCMODE;
210 ptype = IoTYPE_RDONLY;
213 ptype = IoTYPE_WRONLY;
221 *writing = (result != O_RDONLY);
223 if (result == O_RDONLY) {
227 else if (rawmode & O_APPEND) {
229 if (result != O_WRONLY)
234 if (result == O_WRONLY)
241 if (rawmode & O_BINARY)
247 #ifndef PERLIO_LAYERS
249 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
251 if (!names || !*names
252 || strEQ(names, ":crlf")
253 || strEQ(names, ":raw")
254 || strEQ(names, ":bytes")
258 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
266 PerlIO_destruct(pTHX)
271 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
274 PERL_UNUSED_ARG(iotype);
275 PERL_UNUSED_ARG(mode);
276 PERL_UNUSED_ARG(names);
279 return perlsio_binmode(fp, iotype, mode);
284 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
286 #if defined(PERL_MICRO) || defined(__SYMBIAN32__)
289 #ifdef PERL_IMPLICIT_SYS
290 return PerlSIO_fdupopen(f);
293 return win32_fdupopen(f);
296 const int fd = PerlLIO_dup(PerlIO_fileno(f));
300 const int omode = djgpp_get_stream_mode(f);
302 const int omode = fcntl(fd, F_GETFL);
304 PerlIO_intmode2str(omode,mode,NULL);
305 /* the r+ is a hack */
306 return PerlIO_fdopen(fd, mode);
311 SETERRNO(EBADF, SS_IVCHAN);
321 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
325 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
326 int imode, int perm, PerlIO *old, int narg, SV **args)
330 Perl_croak(aTHX_ "More than one argument to open");
332 if (*args == &PL_sv_undef)
333 return PerlIO_tmpfile();
335 const char *name = SvPV_nolen_const(*args);
336 if (*mode == IoTYPE_NUMERIC) {
337 fd = PerlLIO_open3(name, imode, perm);
339 return PerlIO_fdopen(fd, mode + 1);
342 return PerlIO_reopen(name, mode, old);
345 return PerlIO_open(name, mode);
350 return PerlIO_fdopen(fd, (char *) mode);
355 XS(XS_PerlIO__Layer__find)
359 Perl_croak(aTHX_ "Usage class->find(name[,load])");
361 const char * const name = SvPV_nolen_const(ST(1));
362 ST(0) = (strEQ(name, "crlf")
363 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
370 Perl_boot_core_PerlIO(pTHX)
372 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
378 #ifdef PERLIO_IS_STDIO
385 * Does nothing (yet) except force this file to be included in perl
386 * binary. That allows this file to force inclusion of other functions
387 * that may be required by loadable extensions e.g. for
388 * FileHandle::tmpfile
392 #undef PerlIO_tmpfile
399 #else /* PERLIO_IS_STDIO */
407 * This section is just to make sure these functions get pulled in from
411 #undef PerlIO_tmpfile
423 * Force this file to be included in perl binary. Which allows this
424 * file to force inclusion of other functions that may be required by
425 * loadable extensions e.g. for FileHandle::tmpfile
429 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
430 * results in a lot of lseek()s to regular files and lot of small
433 sfset(sfstdout, SF_SHARE, 0);
436 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
438 PerlIO_importFILE(FILE *stdio, const char *mode)
440 const int fd = fileno(stdio);
441 if (!mode || !*mode) {
444 return PerlIO_fdopen(fd, mode);
448 PerlIO_findFILE(PerlIO *pio)
450 const int fd = PerlIO_fileno(pio);
451 FILE * const f = fdopen(fd, "r+");
453 if (!f && errno == EINVAL)
455 if (!f && errno == EINVAL)
462 /*======================================================================================*/
464 * Implement all the PerlIO interface ourselves.
470 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
477 #include <sys/mman.h>
481 PerlIO_debug(const char *fmt, ...)
486 if (!PL_perlio_debug_fd) {
487 if (!PL_tainting && PL_uid == PL_euid && PL_gid == PL_egid) {
488 const char * const s = PerlEnv_getenv("PERLIO_DEBUG");
491 = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
493 PL_perlio_debug_fd = -1;
495 /* tainting or set*id, so ignore the environment, and ensure we
496 skip these tests next time through. */
497 PL_perlio_debug_fd = -1;
500 if (PL_perlio_debug_fd > 0) {
503 const char * const s = CopFILE(PL_curcop);
504 /* Use fixed buffer as sv_catpvf etc. needs SVs */
506 const STRLEN len1 = my_snprintf(buffer, sizeof(buffer), "%.40s:%" IVdf " ", s ? s : "(none)", (IV) CopLINE(PL_curcop));
507 const STRLEN len2 = my_vsnprintf(buffer + len1, sizeof(buffer) - len1, fmt, ap);
508 PerlLIO_write(PL_perlio_debug_fd, buffer, len1 + len2);
510 const char *s = CopFILE(PL_curcop);
512 SV * const sv = Perl_newSVpvf(aTHX_ "%s:%" IVdf " ", s ? s : "(none)",
513 (IV) CopLINE(PL_curcop));
514 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
516 s = SvPV_const(sv, len);
517 PerlLIO_write(PL_perlio_debug_fd, s, len);
524 /*--------------------------------------------------------------------------------------*/
527 * Inner level routines
531 * Table of pointers to the PerlIO structs (malloc'ed)
533 #define PERLIO_TABLE_SIZE 64
536 PerlIO_allocate(pTHX)
540 * Find a free slot in the table, allocating new table as necessary
545 while ((f = *last)) {
547 last = (PerlIO **) (f);
548 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
554 Newxz(f,PERLIO_TABLE_SIZE,PerlIO);
562 #undef PerlIO_fdupopen
564 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
566 if (PerlIOValid(f)) {
567 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
568 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
570 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
572 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
576 SETERRNO(EBADF, SS_IVCHAN);
582 PerlIO_cleantable(pTHX_ PerlIO **tablep)
584 PerlIO * const table = *tablep;
587 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
588 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
589 PerlIO * const f = table + i;
601 PerlIO_list_alloc(pTHX)
605 Newxz(list, 1, PerlIO_list_t);
611 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
614 if (--list->refcnt == 0) {
617 for (i = 0; i < list->cur; i++) {
618 if (list->array[i].arg)
619 SvREFCNT_dec(list->array[i].arg);
621 Safefree(list->array);
629 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
635 if (list->cur >= list->len) {
638 Renew(list->array, list->len, PerlIO_pair_t);
640 Newx(list->array, list->len, PerlIO_pair_t);
642 p = &(list->array[list->cur++]);
644 if ((p->arg = arg)) {
645 SvREFCNT_inc_simple_void_NN(arg);
650 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
652 PerlIO_list_t *list = NULL;
655 list = PerlIO_list_alloc(aTHX);
656 for (i=0; i < proto->cur; i++) {
657 SV *arg = proto->array[i].arg;
660 arg = sv_dup(arg, param);
662 PERL_UNUSED_ARG(param);
664 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
671 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
674 PerlIO **table = &proto->Iperlio;
677 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
678 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
679 PerlIO_allocate(aTHX); /* root slot is never used */
680 PerlIO_debug("Clone %p from %p\n",(void*)aTHX,(void*)proto);
681 while ((f = *table)) {
683 table = (PerlIO **) (f++);
684 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
686 (void) fp_dup(f, 0, param);
693 PERL_UNUSED_ARG(proto);
694 PERL_UNUSED_ARG(param);
699 PerlIO_destruct(pTHX)
702 PerlIO **table = &PL_perlio;
705 PerlIO_debug("Destruct %p\n",(void*)aTHX);
707 while ((f = *table)) {
709 table = (PerlIO **) (f++);
710 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
714 if (l->tab->kind & PERLIO_K_DESTRUCT) {
715 PerlIO_debug("Destruct popping %s\n", l->tab->name);
729 PerlIO_pop(pTHX_ PerlIO *f)
731 const PerlIOl *l = *f;
733 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
734 if (l->tab->Popped) {
736 * If popped returns non-zero do not free its layer structure
737 * it has either done so itself, or it is shared and still in
740 if ((*l->tab->Popped) (aTHX_ f) != 0)
748 /* Return as an array the stack of layers on a filehandle. Note that
749 * the stack is returned top-first in the array, and there are three
750 * times as many array elements as there are layers in the stack: the
751 * first element of a layer triplet is the name, the second one is the
752 * arguments, and the third one is the flags. */
755 PerlIO_get_layers(pTHX_ PerlIO *f)
758 AV * const av = newAV();
760 if (PerlIOValid(f)) {
761 PerlIOl *l = PerlIOBase(f);
764 /* There is some collusion in the implementation of
765 XS_PerlIO_get_layers - it knows that name and flags are
766 generated as fresh SVs here, and takes advantage of that to
767 "copy" them by taking a reference. If it changes here, it needs
768 to change there too. */
769 SV * const name = l->tab && l->tab->name ?
770 newSVpv(l->tab->name, 0) : &PL_sv_undef;
771 SV * const arg = l->tab && l->tab->Getarg ?
772 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
775 av_push(av, newSViv((IV)l->flags));
783 /*--------------------------------------------------------------------------------------*/
785 * XS Interface for perl code
789 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
793 if ((SSize_t) len <= 0)
795 for (i = 0; i < PL_known_layers->cur; i++) {
796 PerlIO_funcs * const f = PL_known_layers->array[i].funcs;
797 if (memEQ(f->name, name, len) && f->name[len] == 0) {
798 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
802 if (load && PL_subname && PL_def_layerlist
803 && PL_def_layerlist->cur >= 2) {
804 if (PL_in_load_module) {
805 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
808 SV * const pkgsv = newSVpvs("PerlIO");
809 SV * const layer = newSVpvn(name, len);
810 CV * const cv = Perl_get_cvn_flags(aTHX_ STR_WITH_LEN("PerlIO::Layer::NoWarnings"), 0);
812 SAVEINT(PL_in_load_module);
814 SAVEGENERICSV(PL_warnhook);
815 PL_warnhook = MUTABLE_SV((SvREFCNT_inc_simple_NN(cv)));
819 * The two SVs are magically freed by load_module
821 Perl_load_module(aTHX_ 0, pkgsv, NULL, layer, NULL);
824 return PerlIO_find_layer(aTHX_ name, len, 0);
827 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
831 #ifdef USE_ATTRIBUTES_FOR_PERLIO
834 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
837 IO * const io = GvIOn(MUTABLE_GV(SvRV(sv)));
838 PerlIO * const ifp = IoIFP(io);
839 PerlIO * const ofp = IoOFP(io);
840 Perl_warn(aTHX_ "set %" SVf " %p %p %p",
841 SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
847 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
850 IO * const io = GvIOn(MUTABLE_GV(SvRV(sv)));
851 PerlIO * const ifp = IoIFP(io);
852 PerlIO * const ofp = IoOFP(io);
853 Perl_warn(aTHX_ "get %" SVf " %p %p %p",
854 SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
860 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
862 Perl_warn(aTHX_ "clear %" SVf, SVfARG(sv));
867 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
869 Perl_warn(aTHX_ "free %" SVf, SVfARG(sv));
873 MGVTBL perlio_vtab = {
881 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
884 SV * const sv = SvRV(ST(1));
885 AV * const av = newAV();
889 sv_magic(sv, MUTABLE_SV(av), PERL_MAGIC_ext, NULL, 0);
891 mg = mg_find(sv, PERL_MAGIC_ext);
892 mg->mg_virtual = &perlio_vtab;
894 Perl_warn(aTHX_ "attrib %" SVf, SVfARG(sv));
895 for (i = 2; i < items; i++) {
897 const char * const name = SvPV_const(ST(i), len);
898 SV * const layer = PerlIO_find_layer(aTHX_ name, len, 1);
900 av_push(av, SvREFCNT_inc_simple_NN(layer));
911 #endif /* USE_ATTIBUTES_FOR_PERLIO */
914 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
916 HV * const stash = gv_stashpvs("PerlIO::Layer", GV_ADD);
917 SV * const sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
921 XS(XS_PerlIO__Layer__NoWarnings)
923 /* This is used as a %SIG{__WARN__} handler to supress warnings
924 during loading of layers.
930 PerlIO_debug("warning:%s\n",SvPV_nolen_const(ST(0)));
934 XS(XS_PerlIO__Layer__find)
940 Perl_croak(aTHX_ "Usage class->find(name[,load])");
943 const char * const name = SvPV_const(ST(1), len);
944 const bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
945 PerlIO_funcs * const layer = PerlIO_find_layer(aTHX_ name, len, load);
947 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
954 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
957 if (!PL_known_layers)
958 PL_known_layers = PerlIO_list_alloc(aTHX);
959 PerlIO_list_push(aTHX_ PL_known_layers, tab, NULL);
960 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
964 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
968 const char *s = names;
970 while (isSPACE(*s) || *s == ':')
975 const char *as = NULL;
977 if (!isIDFIRST(*s)) {
979 * Message is consistent with how attribute lists are
980 * passed. Even though this means "foo : : bar" is
981 * seen as an invalid separator character.
983 const char q = ((*s == '\'') ? '"' : '\'');
984 if (ckWARN(WARN_LAYER))
985 Perl_warner(aTHX_ packWARN(WARN_LAYER),
986 "Invalid separator character %c%c%c in PerlIO layer specification %s",
988 SETERRNO(EINVAL, LIB_INVARG);
993 } while (isALNUM(*e));
1002 alen = (e - 1) - as;
1009 * It's a nul terminated string, not allowed
1010 * to \ the terminating null. Anything other
1011 * character is passed over.
1021 if (ckWARN(WARN_LAYER))
1022 Perl_warner(aTHX_ packWARN(WARN_LAYER),
1023 "Argument list not closed for PerlIO layer \"%.*s\"",
1035 PerlIO_funcs * const layer =
1036 PerlIO_find_layer(aTHX_ s, llen, 1);
1040 arg = newSVpvn(as, alen);
1041 PerlIO_list_push(aTHX_ av, layer,
1042 (arg) ? arg : &PL_sv_undef);
1047 if (ckWARN(WARN_LAYER))
1048 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
1061 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
1064 PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
1065 #ifdef PERLIO_USING_CRLF
1068 if (PerlIO_stdio.Set_ptrcnt)
1069 tab = &PerlIO_stdio;
1071 PerlIO_debug("Pushing %s\n", tab->name);
1072 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1077 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1079 return av->array[n].arg;
1083 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1085 if (n >= 0 && n < av->cur) {
1086 PerlIO_debug("Layer %" IVdf " is %s\n", n,
1087 av->array[n].funcs->name);
1088 return av->array[n].funcs;
1091 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1096 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1098 PERL_UNUSED_ARG(mode);
1099 PERL_UNUSED_ARG(arg);
1100 PERL_UNUSED_ARG(tab);
1101 if (PerlIOValid(f)) {
1103 PerlIO_pop(aTHX_ f);
1109 PERLIO_FUNCS_DECL(PerlIO_remove) = {
1110 sizeof(PerlIO_funcs),
1113 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1133 NULL, /* get_base */
1134 NULL, /* get_bufsiz */
1137 NULL, /* set_ptrcnt */
1141 PerlIO_default_layers(pTHX)
1144 if (!PL_def_layerlist) {
1145 const char * const s = (PL_tainting) ? NULL : PerlEnv_getenv("PERLIO");
1146 PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1147 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1148 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1150 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1152 osLayer = &PerlIO_win32;
1155 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1156 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1157 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1158 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1160 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_mmap));
1162 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1163 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1164 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1165 PerlIO_list_push(aTHX_ PL_def_layerlist,
1166 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1169 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1172 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1175 if (PL_def_layerlist->cur < 2) {
1176 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1178 return PL_def_layerlist;
1182 Perl_boot_core_PerlIO(pTHX)
1184 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1185 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1188 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1189 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1193 PerlIO_default_layer(pTHX_ I32 n)
1196 PerlIO_list_t * const av = PerlIO_default_layers(aTHX);
1199 return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1202 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1203 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1206 PerlIO_stdstreams(pTHX)
1210 PerlIO_allocate(aTHX);
1211 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1212 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1213 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1218 PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1220 if (tab->fsize != sizeof(PerlIO_funcs)) {
1222 Perl_croak(aTHX_ "Layer does not match this perl");
1226 if (tab->size < sizeof(PerlIOl)) {
1229 /* Real layer with a data area */
1232 Newxz(temp, tab->size, char);
1236 l->tab = (PerlIO_funcs*) tab;
1238 PerlIO_debug("PerlIO_push f=%p %s %s %p\n",
1239 (void*)f, tab->name,
1240 (mode) ? mode : "(Null)", (void*)arg);
1241 if (*l->tab->Pushed &&
1243 (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1244 PerlIO_pop(aTHX_ f);
1253 /* Pseudo-layer where push does its own stack adjust */
1254 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1255 (mode) ? mode : "(Null)", (void*)arg);
1257 (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1265 PerlIOBase_binmode(pTHX_ PerlIO *f)
1267 if (PerlIOValid(f)) {
1268 /* Is layer suitable for raw stream ? */
1269 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1270 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1271 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1274 /* Not suitable - pop it */
1275 PerlIO_pop(aTHX_ f);
1283 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1285 PERL_UNUSED_ARG(mode);
1286 PERL_UNUSED_ARG(arg);
1287 PERL_UNUSED_ARG(tab);
1289 if (PerlIOValid(f)) {
1294 * Strip all layers that are not suitable for a raw stream
1297 while (t && (l = *t)) {
1298 if (l->tab->Binmode) {
1299 /* Has a handler - normal case */
1300 if ((*l->tab->Binmode)(aTHX_ t) == 0) {
1302 /* Layer still there - move down a layer */
1311 /* No handler - pop it */
1312 PerlIO_pop(aTHX_ t);
1315 if (PerlIOValid(f)) {
1316 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1324 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1325 PerlIO_list_t *layers, IV n, IV max)
1329 PerlIO_funcs * const tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1331 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1342 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1346 PerlIO_list_t * const layers = PerlIO_list_alloc(aTHX);
1347 code = PerlIO_parse_layers(aTHX_ layers, names);
1349 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1351 PerlIO_list_free(aTHX_ layers);
1357 /*--------------------------------------------------------------------------------------*/
1359 * Given the abstraction above the public API functions
1363 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1365 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n", (void*)f,
1366 (PerlIOBase(f)) ? PerlIOBase(f)->tab->name : "(Null)",
1367 iotype, mode, (names) ? names : "(Null)");
1370 /* Do not flush etc. if (e.g.) switching encodings.
1371 if a pushed layer knows it needs to flush lower layers
1372 (for example :unix which is never going to call them)
1373 it can do the flush when it is pushed.
1375 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1378 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1379 #ifdef PERLIO_USING_CRLF
1380 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1381 O_BINARY so we can look for it in mode.
1383 if (!(mode & O_BINARY)) {
1385 /* FIXME?: Looking down the layer stack seems wrong,
1386 but is a way of reaching past (say) an encoding layer
1387 to flip CRLF-ness of the layer(s) below
1390 /* Perhaps we should turn on bottom-most aware layer
1391 e.g. Ilya's idea that UNIX TTY could serve
1393 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1394 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1395 /* Not in text mode - flush any pending stuff and flip it */
1397 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1399 /* Only need to turn it on in one layer so we are done */
1404 /* Not finding a CRLF aware layer presumably means we are binary
1405 which is not what was requested - so we failed
1406 We _could_ push :crlf layer but so could caller
1411 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1412 So code that used to be here is now in PerlIORaw_pushed().
1414 return PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), NULL, NULL) ? TRUE : FALSE;
1419 PerlIO__close(pTHX_ PerlIO *f)
1421 if (PerlIOValid(f)) {
1422 PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1423 if (tab && tab->Close)
1424 return (*tab->Close)(aTHX_ f);
1426 return PerlIOBase_close(aTHX_ f);
1429 SETERRNO(EBADF, SS_IVCHAN);
1435 Perl_PerlIO_close(pTHX_ PerlIO *f)
1437 const int code = PerlIO__close(aTHX_ f);
1438 while (PerlIOValid(f)) {
1439 PerlIO_pop(aTHX_ f);
1445 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1448 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1452 static PerlIO_funcs *
1453 PerlIO_layer_from_ref(pTHX_ SV *sv)
1457 * For any scalar type load the handler which is bundled with perl
1459 if (SvTYPE(sv) < SVt_PVAV) {
1460 PerlIO_funcs *f = PerlIO_find_layer(aTHX_ STR_WITH_LEN("scalar"), 1);
1461 /* This isn't supposed to happen, since PerlIO::scalar is core,
1462 * but could happen anyway in smaller installs or with PAR */
1463 if (!f && ckWARN(WARN_LAYER))
1464 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"scalar\"");
1469 * For other types allow if layer is known but don't try and load it
1471 switch (SvTYPE(sv)) {
1473 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Array"), 0);
1475 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Hash"), 0);
1477 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Code"), 0);
1479 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Glob"), 0);
1486 PerlIO_resolve_layers(pTHX_ const char *layers,
1487 const char *mode, int narg, SV **args)
1490 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1493 PerlIO_stdstreams(aTHX);
1495 SV * const arg = *args;
1497 * If it is a reference but not an object see if we have a handler
1500 if (SvROK(arg) && !sv_isobject(arg)) {
1501 PerlIO_funcs * const handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1503 def = PerlIO_list_alloc(aTHX);
1504 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1508 * Don't fail if handler cannot be found :via(...) etc. may do
1509 * something sensible else we will just stringfy and open
1514 if (!layers || !*layers)
1515 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1516 if (layers && *layers) {
1519 av = PerlIO_clone_list(aTHX_ def, NULL);
1524 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1528 PerlIO_list_free(aTHX_ av);
1540 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1541 int imode, int perm, PerlIO *f, int narg, SV **args)
1544 if (!f && narg == 1 && *args == &PL_sv_undef) {
1545 if ((f = PerlIO_tmpfile())) {
1546 if (!layers || !*layers)
1547 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1548 if (layers && *layers)
1549 PerlIO_apply_layers(aTHX_ f, mode, layers);
1553 PerlIO_list_t *layera;
1555 PerlIO_funcs *tab = NULL;
1556 if (PerlIOValid(f)) {
1558 * This is "reopen" - it is not tested as perl does not use it
1562 layera = PerlIO_list_alloc(aTHX);
1566 arg = (*l->tab->Getarg) (aTHX_ &l, NULL, 0);
1567 PerlIO_list_push(aTHX_ layera, l->tab,
1568 (arg) ? arg : &PL_sv_undef);
1571 l = *PerlIONext(&l);
1575 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1581 * Start at "top" of layer stack
1583 n = layera->cur - 1;
1585 PerlIO_funcs * const t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1594 * Found that layer 'n' can do opens - call it
1596 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1597 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1599 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1600 tab->name, layers ? layers : "(Null)", mode, fd,
1601 imode, perm, (void*)f, narg, (void*)args);
1603 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1606 SETERRNO(EINVAL, LIB_INVARG);
1610 if (n + 1 < layera->cur) {
1612 * More layers above the one that we used to open -
1615 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1616 /* If pushing layers fails close the file */
1623 PerlIO_list_free(aTHX_ layera);
1630 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1632 PERL_ARGS_ASSERT_PERLIO_READ;
1634 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1638 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1640 PERL_ARGS_ASSERT_PERLIO_UNREAD;
1642 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1646 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1648 PERL_ARGS_ASSERT_PERLIO_WRITE;
1650 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1654 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1656 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1660 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1662 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1666 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1671 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1673 if (tab && tab->Flush)
1674 return (*tab->Flush) (aTHX_ f);
1676 return 0; /* If no Flush defined, silently succeed. */
1679 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1680 SETERRNO(EBADF, SS_IVCHAN);
1686 * Is it good API design to do flush-all on NULL, a potentially
1687 * errorneous input? Maybe some magical value (PerlIO*
1688 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1689 * things on fflush(NULL), but should we be bound by their design
1692 PerlIO **table = &PL_perlio;
1694 while ((f = *table)) {
1696 table = (PerlIO **) (f++);
1697 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1698 if (*f && PerlIO_flush(f) != 0)
1708 PerlIOBase_flush_linebuf(pTHX)
1711 PerlIO **table = &PL_perlio;
1713 while ((f = *table)) {
1715 table = (PerlIO **) (f++);
1716 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1719 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1720 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1728 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1730 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1734 PerlIO_isutf8(PerlIO *f)
1737 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1739 SETERRNO(EBADF, SS_IVCHAN);
1745 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1747 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1751 Perl_PerlIO_error(pTHX_ PerlIO *f)
1753 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1757 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1759 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1763 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1765 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1769 PerlIO_has_base(PerlIO *f)
1771 if (PerlIOValid(f)) {
1772 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1775 return (tab->Get_base != NULL);
1776 SETERRNO(EINVAL, LIB_INVARG);
1779 SETERRNO(EBADF, SS_IVCHAN);
1785 PerlIO_fast_gets(PerlIO *f)
1787 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1788 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1791 return (tab->Set_ptrcnt != NULL);
1792 SETERRNO(EINVAL, LIB_INVARG);
1795 SETERRNO(EBADF, SS_IVCHAN);
1801 PerlIO_has_cntptr(PerlIO *f)
1803 if (PerlIOValid(f)) {
1804 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1807 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1808 SETERRNO(EINVAL, LIB_INVARG);
1811 SETERRNO(EBADF, SS_IVCHAN);
1817 PerlIO_canset_cnt(PerlIO *f)
1819 if (PerlIOValid(f)) {
1820 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1823 return (tab->Set_ptrcnt != NULL);
1824 SETERRNO(EINVAL, LIB_INVARG);
1827 SETERRNO(EBADF, SS_IVCHAN);
1833 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1835 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1839 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1841 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1845 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1847 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1851 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1853 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1857 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1859 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1863 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1865 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1869 /*--------------------------------------------------------------------------------------*/
1871 * utf8 and raw dummy layers
1875 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1877 PERL_UNUSED_CONTEXT;
1878 PERL_UNUSED_ARG(mode);
1879 PERL_UNUSED_ARG(arg);
1880 if (PerlIOValid(f)) {
1881 if (tab->kind & PERLIO_K_UTF8)
1882 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1884 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1890 PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1891 sizeof(PerlIO_funcs),
1894 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1914 NULL, /* get_base */
1915 NULL, /* get_bufsiz */
1918 NULL, /* set_ptrcnt */
1921 PERLIO_FUNCS_DECL(PerlIO_byte) = {
1922 sizeof(PerlIO_funcs),
1945 NULL, /* get_base */
1946 NULL, /* get_bufsiz */
1949 NULL, /* set_ptrcnt */
1953 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1954 IV n, const char *mode, int fd, int imode, int perm,
1955 PerlIO *old, int narg, SV **args)
1957 PerlIO_funcs * const tab = PerlIO_default_btm();
1958 PERL_UNUSED_ARG(self);
1959 if (tab && tab->Open)
1960 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1962 SETERRNO(EINVAL, LIB_INVARG);
1966 PERLIO_FUNCS_DECL(PerlIO_raw) = {
1967 sizeof(PerlIO_funcs),
1990 NULL, /* get_base */
1991 NULL, /* get_bufsiz */
1994 NULL, /* set_ptrcnt */
1996 /*--------------------------------------------------------------------------------------*/
1997 /*--------------------------------------------------------------------------------------*/
1999 * "Methods" of the "base class"
2003 PerlIOBase_fileno(pTHX_ PerlIO *f)
2005 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
2009 PerlIO_modestr(PerlIO * f, char *buf)
2012 if (PerlIOValid(f)) {
2013 const IV flags = PerlIOBase(f)->flags;
2014 if (flags & PERLIO_F_APPEND) {
2016 if (flags & PERLIO_F_CANREAD) {
2020 else if (flags & PERLIO_F_CANREAD) {
2022 if (flags & PERLIO_F_CANWRITE)
2025 else if (flags & PERLIO_F_CANWRITE) {
2027 if (flags & PERLIO_F_CANREAD) {
2031 #ifdef PERLIO_USING_CRLF
2032 if (!(flags & PERLIO_F_CRLF))
2042 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2044 PerlIOl * const l = PerlIOBase(f);
2045 PERL_UNUSED_CONTEXT;
2046 PERL_UNUSED_ARG(arg);
2048 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
2049 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
2050 if (tab->Set_ptrcnt != NULL)
2051 l->flags |= PERLIO_F_FASTGETS;
2053 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
2057 l->flags |= PERLIO_F_CANREAD;
2060 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
2063 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
2066 SETERRNO(EINVAL, LIB_INVARG);
2072 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2075 l->flags &= ~PERLIO_F_CRLF;
2078 l->flags |= PERLIO_F_CRLF;
2081 SETERRNO(EINVAL, LIB_INVARG);
2088 l->flags |= l->next->flags &
2089 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2094 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2095 (void*)f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2096 l->flags, PerlIO_modestr(f, temp));
2102 PerlIOBase_popped(pTHX_ PerlIO *f)
2104 PERL_UNUSED_CONTEXT;
2110 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2113 * Save the position as current head considers it
2115 const Off_t old = PerlIO_tell(f);
2116 PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", NULL);
2117 PerlIOSelf(f, PerlIOBuf)->posn = old;
2118 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
2122 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2124 STDCHAR *buf = (STDCHAR *) vbuf;
2126 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2127 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2128 SETERRNO(EBADF, SS_IVCHAN);
2134 SSize_t avail = PerlIO_get_cnt(f);
2137 take = ((SSize_t)count < avail) ? (SSize_t)count : avail;
2139 STDCHAR *ptr = PerlIO_get_ptr(f);
2140 Copy(ptr, buf, take, STDCHAR);
2141 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2144 if (avail == 0) /* set_ptrcnt could have reset avail */
2147 if (count > 0 && avail <= 0) {
2148 if (PerlIO_fill(f) != 0)
2153 return (buf - (STDCHAR *) vbuf);
2159 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2161 PERL_UNUSED_CONTEXT;
2167 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2169 PERL_UNUSED_CONTEXT;
2175 PerlIOBase_close(pTHX_ PerlIO *f)
2178 if (PerlIOValid(f)) {
2179 PerlIO *n = PerlIONext(f);
2180 code = PerlIO_flush(f);
2181 PerlIOBase(f)->flags &=
2182 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2183 while (PerlIOValid(n)) {
2184 const PerlIO_funcs * const tab = PerlIOBase(n)->tab;
2185 if (tab && tab->Close) {
2186 if ((*tab->Close)(aTHX_ n) != 0)
2191 PerlIOBase(n)->flags &=
2192 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2198 SETERRNO(EBADF, SS_IVCHAN);
2204 PerlIOBase_eof(pTHX_ PerlIO *f)
2206 PERL_UNUSED_CONTEXT;
2207 if (PerlIOValid(f)) {
2208 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2214 PerlIOBase_error(pTHX_ PerlIO *f)
2216 PERL_UNUSED_CONTEXT;
2217 if (PerlIOValid(f)) {
2218 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2224 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2226 if (PerlIOValid(f)) {
2227 PerlIO * const n = PerlIONext(f);
2228 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2235 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2237 PERL_UNUSED_CONTEXT;
2238 if (PerlIOValid(f)) {
2239 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2244 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2250 arg = sv_dup(arg, param);
2251 SvREFCNT_inc_simple_void_NN(arg);
2255 return newSVsv(arg);
2258 PERL_UNUSED_ARG(param);
2259 return newSVsv(arg);
2264 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2266 PerlIO * const nexto = PerlIONext(o);
2267 if (PerlIOValid(nexto)) {
2268 const PerlIO_funcs * const tab = PerlIOBase(nexto)->tab;
2269 if (tab && tab->Dup)
2270 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2272 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2275 PerlIO_funcs * const self = PerlIOBase(o)->tab;
2278 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2279 self->name, (void*)f, (void*)o, (void*)param);
2281 arg = (*self->Getarg)(aTHX_ o, param, flags);
2282 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2283 if (PerlIOBase(o)->flags & PERLIO_F_UTF8)
2284 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
2291 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2293 /* Must be called with PL_perlio_mutex locked. */
2295 S_more_refcounted_fds(pTHX_ const int new_fd) {
2297 const int old_max = PL_perlio_fd_refcnt_size;
2298 const int new_max = 16 + (new_fd & ~15);
2301 PerlIO_debug("More fds - old=%d, need %d, new=%d\n",
2302 old_max, new_fd, new_max);
2304 if (new_fd < old_max) {
2308 assert (new_max > new_fd);
2310 /* Use plain realloc() since we need this memory to be really
2311 * global and visible to all the interpreters and/or threads. */
2312 new_array = (int*) realloc(PL_perlio_fd_refcnt, new_max * sizeof(int));
2316 MUTEX_UNLOCK(&PL_perlio_mutex);
2318 /* Can't use PerlIO to write as it allocates memory */
2319 PerlLIO_write(PerlIO_fileno(Perl_error_log),
2320 PL_no_mem, strlen(PL_no_mem));
2324 PL_perlio_fd_refcnt_size = new_max;
2325 PL_perlio_fd_refcnt = new_array;
2327 PerlIO_debug("Zeroing %p, %d\n",
2328 (void*)(new_array + old_max),
2331 Zero(new_array + old_max, new_max - old_max, int);
2338 /* MUTEX_INIT(&PL_perlio_mutex) is done in PERL_SYS_INIT3(). */
2339 PERL_UNUSED_CONTEXT;
2343 PerlIOUnix_refcnt_inc(int fd)
2350 MUTEX_LOCK(&PL_perlio_mutex);
2352 if (fd >= PL_perlio_fd_refcnt_size)
2353 S_more_refcounted_fds(aTHX_ fd);
2355 PL_perlio_fd_refcnt[fd]++;
2356 if (PL_perlio_fd_refcnt[fd] <= 0) {
2357 Perl_croak(aTHX_ "refcnt_inc: fd %d: %d <= 0\n",
2358 fd, PL_perlio_fd_refcnt[fd]);
2360 PerlIO_debug("refcnt_inc: fd %d refcnt=%d\n",
2361 fd, PL_perlio_fd_refcnt[fd]);
2364 MUTEX_UNLOCK(&PL_perlio_mutex);
2367 Perl_croak(aTHX_ "refcnt_inc: fd %d < 0\n", fd);
2372 PerlIOUnix_refcnt_dec(int fd)
2379 MUTEX_LOCK(&PL_perlio_mutex);
2381 if (fd >= PL_perlio_fd_refcnt_size) {
2382 Perl_croak(aTHX_ "refcnt_dec: fd %d >= refcnt_size %d\n",
2383 fd, PL_perlio_fd_refcnt_size);
2385 if (PL_perlio_fd_refcnt[fd] <= 0) {
2386 Perl_croak(aTHX_ "refcnt_dec: fd %d: %d <= 0\n",
2387 fd, PL_perlio_fd_refcnt[fd]);
2389 cnt = --PL_perlio_fd_refcnt[fd];
2390 PerlIO_debug("refcnt_dec: fd %d refcnt=%d\n", fd, cnt);
2392 MUTEX_UNLOCK(&PL_perlio_mutex);
2395 Perl_croak(aTHX_ "refcnt_dec: fd %d < 0\n", fd);
2401 PerlIO_cleanup(pTHX)
2406 PerlIO_debug("Cleanup layers for %p\n",(void*)aTHX);
2408 PerlIO_debug("Cleanup layers\n");
2411 /* Raise STDIN..STDERR refcount so we don't close them */
2412 for (i=0; i < 3; i++)
2413 PerlIOUnix_refcnt_inc(i);
2414 PerlIO_cleantable(aTHX_ &PL_perlio);
2415 /* Restore STDIN..STDERR refcount */
2416 for (i=0; i < 3; i++)
2417 PerlIOUnix_refcnt_dec(i);
2419 if (PL_known_layers) {
2420 PerlIO_list_free(aTHX_ PL_known_layers);
2421 PL_known_layers = NULL;
2423 if (PL_def_layerlist) {
2424 PerlIO_list_free(aTHX_ PL_def_layerlist);
2425 PL_def_layerlist = NULL;
2429 void PerlIO_teardown(void) /* Call only from PERL_SYS_TERM(). */
2433 /* XXX we can't rely on an interpreter being present at this late stage,
2434 XXX so we can't use a function like PerlLIO_write that relies on one
2435 being present (at least in win32) :-(.
2440 /* By now all filehandles should have been closed, so any
2441 * stray (non-STD-)filehandles indicate *possible* (PerlIO)
2443 #define PERLIO_TEARDOWN_MESSAGE_BUF_SIZE 64
2444 #define PERLIO_TEARDOWN_MESSAGE_FD 2
2445 char buf[PERLIO_TEARDOWN_MESSAGE_BUF_SIZE];
2447 for (i = 3; i < PL_perlio_fd_refcnt_size; i++) {
2448 if (PL_perlio_fd_refcnt[i]) {
2450 my_snprintf(buf, sizeof(buf),
2451 "PerlIO_teardown: fd %d refcnt=%d\n",
2452 i, PL_perlio_fd_refcnt[i]);
2453 PerlLIO_write(PERLIO_TEARDOWN_MESSAGE_FD, buf, len);
2459 /* Not bothering with PL_perlio_mutex since by now
2460 * all the interpreters are gone. */
2461 if (PL_perlio_fd_refcnt_size /* Assuming initial size of zero. */
2462 && PL_perlio_fd_refcnt) {
2463 free(PL_perlio_fd_refcnt); /* To match realloc() in S_more_refcounted_fds(). */
2464 PL_perlio_fd_refcnt = NULL;
2465 PL_perlio_fd_refcnt_size = 0;
2469 /*--------------------------------------------------------------------------------------*/
2471 * Bottom-most level for UNIX-like case
2475 struct _PerlIO base; /* The generic part */
2476 int fd; /* UNIX like file descriptor */
2477 int oflags; /* open/fcntl flags */
2481 PerlIOUnix_oflags(const char *mode)
2484 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2489 if (*++mode == '+') {
2496 oflags = O_CREAT | O_TRUNC;
2497 if (*++mode == '+') {
2506 oflags = O_CREAT | O_APPEND;
2507 if (*++mode == '+') {
2520 else if (*mode == 't') {
2522 oflags &= ~O_BINARY;
2526 * Always open in binary mode
2529 if (*mode || oflags == -1) {
2530 SETERRNO(EINVAL, LIB_INVARG);
2537 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2539 PERL_UNUSED_CONTEXT;
2540 return PerlIOSelf(f, PerlIOUnix)->fd;
2544 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2546 PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2549 if (PerlLIO_fstat(fd, &st) == 0) {
2550 if (!S_ISREG(st.st_mode)) {
2551 PerlIO_debug("%d is not regular file\n",fd);
2552 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2555 PerlIO_debug("%d _is_ a regular file\n",fd);
2561 PerlIOUnix_refcnt_inc(fd);
2562 PERL_UNUSED_CONTEXT;
2566 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2568 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2569 if (*PerlIONext(f)) {
2570 /* We never call down so do any pending stuff now */
2571 PerlIO_flush(PerlIONext(f));
2573 * XXX could (or should) we retrieve the oflags from the open file
2574 * handle rather than believing the "mode" we are passed in? XXX
2575 * Should the value on NULL mode be 0 or -1?
2577 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2578 mode ? PerlIOUnix_oflags(mode) : -1);
2580 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2586 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2588 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2590 PERL_UNUSED_CONTEXT;
2591 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2593 SETERRNO(ESPIPE, LIB_INVARG);
2595 SETERRNO(EINVAL, LIB_INVARG);
2599 new_loc = PerlLIO_lseek(fd, offset, whence);
2600 if (new_loc == (Off_t) - 1)
2602 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2607 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2608 IV n, const char *mode, int fd, int imode,
2609 int perm, PerlIO *f, int narg, SV **args)
2611 if (PerlIOValid(f)) {
2612 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2613 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2616 if (*mode == IoTYPE_NUMERIC)
2619 imode = PerlIOUnix_oflags(mode);
2623 const char *path = SvPV_nolen_const(*args);
2624 fd = PerlLIO_open3(path, imode, perm);
2628 if (*mode == IoTYPE_IMPLICIT)
2631 f = PerlIO_allocate(aTHX);
2633 if (!PerlIOValid(f)) {
2634 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2638 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2639 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2640 if (*mode == IoTYPE_APPEND)
2641 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2648 * FIXME: pop layers ???
2656 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2658 const PerlIOUnix * const os = PerlIOSelf(o, PerlIOUnix);
2660 if (flags & PERLIO_DUP_FD) {
2661 fd = PerlLIO_dup(fd);
2664 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2666 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2667 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2676 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2679 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2680 #ifdef PERLIO_STD_SPECIAL
2682 return PERLIO_STD_IN(fd, vbuf, count);
2684 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2685 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2689 const SSize_t len = PerlLIO_read(fd, vbuf, count);
2690 if (len >= 0 || errno != EINTR) {
2692 if (errno != EAGAIN) {
2693 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2696 else if (len == 0 && count != 0) {
2697 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2708 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2711 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2712 #ifdef PERLIO_STD_SPECIAL
2713 if (fd == 1 || fd == 2)
2714 return PERLIO_STD_OUT(fd, vbuf, count);
2717 const SSize_t len = PerlLIO_write(fd, vbuf, count);
2718 if (len >= 0 || errno != EINTR) {
2720 if (errno != EAGAIN) {
2721 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2732 PerlIOUnix_tell(pTHX_ PerlIO *f)
2734 PERL_UNUSED_CONTEXT;
2736 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2741 PerlIOUnix_close(pTHX_ PerlIO *f)
2744 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2746 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2747 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2748 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2753 SETERRNO(EBADF,SS_IVCHAN);
2756 while (PerlLIO_close(fd) != 0) {
2757 if (errno != EINTR) {
2764 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2769 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2770 sizeof(PerlIO_funcs),
2777 PerlIOBase_binmode, /* binmode */
2787 PerlIOBase_noop_ok, /* flush */
2788 PerlIOBase_noop_fail, /* fill */
2791 PerlIOBase_clearerr,
2792 PerlIOBase_setlinebuf,
2793 NULL, /* get_base */
2794 NULL, /* get_bufsiz */
2797 NULL, /* set_ptrcnt */
2800 /*--------------------------------------------------------------------------------------*/
2805 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2806 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2807 broken by the last second glibc 2.3 fix
2809 #define STDIO_BUFFER_WRITABLE
2814 struct _PerlIO base;
2815 FILE *stdio; /* The stream */
2819 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2821 PERL_UNUSED_CONTEXT;
2823 if (PerlIOValid(f)) {
2824 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
2826 return PerlSIO_fileno(s);
2833 PerlIOStdio_mode(const char *mode, char *tmode)
2835 char * const ret = tmode;
2841 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2849 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2852 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2853 PerlIO_funcs * const toptab = PerlIOBase(n)->tab;
2854 if (toptab == tab) {
2855 /* Top is already stdio - pop self (duplicate) and use original */
2856 PerlIO_pop(aTHX_ f);
2859 const int fd = PerlIO_fileno(n);
2862 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2863 mode = PerlIOStdio_mode(mode, tmode)))) {
2864 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2865 /* We never call down so do any pending stuff now */
2866 PerlIO_flush(PerlIONext(f));
2873 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2878 PerlIO_importFILE(FILE *stdio, const char *mode)
2884 if (!mode || !*mode) {
2885 /* We need to probe to see how we can open the stream
2886 so start with read/write and then try write and read
2887 we dup() so that we can fclose without loosing the fd.
2889 Note that the errno value set by a failing fdopen
2890 varies between stdio implementations.
2892 const int fd = PerlLIO_dup(fileno(stdio));
2893 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2895 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2898 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2901 /* Don't seem to be able to open */
2907 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, NULL))) {
2908 s = PerlIOSelf(f, PerlIOStdio);
2910 PerlIOUnix_refcnt_inc(fileno(stdio));
2917 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2918 IV n, const char *mode, int fd, int imode,
2919 int perm, PerlIO *f, int narg, SV **args)
2922 if (PerlIOValid(f)) {
2923 const char * const path = SvPV_nolen_const(*args);
2924 PerlIOStdio * const s = PerlIOSelf(f, PerlIOStdio);
2926 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2927 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2932 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2937 const char * const path = SvPV_nolen_const(*args);
2938 if (*mode == IoTYPE_NUMERIC) {
2940 fd = PerlLIO_open3(path, imode, perm);
2944 bool appended = FALSE;
2946 /* Cygwin wants its 'b' early. */
2948 mode = PerlIOStdio_mode(mode, tmode);
2950 stdio = PerlSIO_fopen(path, mode);
2953 f = PerlIO_allocate(aTHX);
2956 mode = PerlIOStdio_mode(mode, tmode);
2957 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2959 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2960 PerlIOUnix_refcnt_inc(fileno(stdio));
2962 PerlSIO_fclose(stdio);
2974 if (*mode == IoTYPE_IMPLICIT) {
2981 stdio = PerlSIO_stdin;
2984 stdio = PerlSIO_stdout;
2987 stdio = PerlSIO_stderr;
2992 stdio = PerlSIO_fdopen(fd, mode =
2993 PerlIOStdio_mode(mode, tmode));
2997 f = PerlIO_allocate(aTHX);
2999 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
3000 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
3001 PerlIOUnix_refcnt_inc(fileno(stdio));
3011 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3013 /* This assumes no layers underneath - which is what
3014 happens, but is not how I remember it. NI-S 2001/10/16
3016 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
3017 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
3018 const int fd = fileno(stdio);
3020 if (flags & PERLIO_DUP_FD) {
3021 const int dfd = PerlLIO_dup(fileno(stdio));
3023 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
3028 /* FIXME: To avoid messy error recovery if dup fails
3029 re-use the existing stdio as though flag was not set
3033 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
3035 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
3036 PerlIOUnix_refcnt_inc(fileno(stdio));
3042 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
3044 PERL_UNUSED_CONTEXT;
3046 /* XXX this could use PerlIO_canset_fileno() and
3047 * PerlIO_set_fileno() support from Configure
3049 # if defined(__UCLIBC__)
3050 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
3053 # elif defined(__GLIBC__)
3054 /* There may be a better way for GLIBC:
3055 - libio.h defines a flag to not close() on cleanup
3059 # elif defined(__sun__)
3062 # elif defined(__hpux)
3066 /* Next one ->_file seems to be a reasonable fallback, i.e. if
3067 your platform does not have special entry try this one.
3068 [For OSF only have confirmation for Tru64 (alpha)
3069 but assume other OSFs will be similar.]
3071 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
3074 # elif defined(__FreeBSD__)
3075 /* There may be a better way on FreeBSD:
3076 - we could insert a dummy func in the _close function entry
3077 f->_close = (int (*)(void *)) dummy_close;
3081 # elif defined(__OpenBSD__)
3082 /* There may be a better way on OpenBSD:
3083 - we could insert a dummy func in the _close function entry
3084 f->_close = (int (*)(void *)) dummy_close;
3088 # elif defined(__EMX__)
3089 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
3092 # elif defined(__CYGWIN__)
3093 /* There may be a better way on CYGWIN:
3094 - we could insert a dummy func in the _close function entry
3095 f->_close = (int (*)(void *)) dummy_close;
3099 # elif defined(WIN32)
3100 # if defined(__BORLANDC__)
3101 f->fd = PerlLIO_dup(fileno(f));
3102 # elif defined(UNDER_CE)
3103 /* WIN_CE does not have access to FILE internals, it hardly has FILE
3112 /* Sarathy's code did this - we fall back to a dup/dup2 hack
3113 (which isn't thread safe) instead
3115 # error "Don't know how to set FILE.fileno on your platform"
3123 PerlIOStdio_close(pTHX_ PerlIO *f)
3125 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3131 const int fd = fileno(stdio);
3139 #ifdef SOCKS5_VERSION_NAME
3140 /* Socks lib overrides close() but stdio isn't linked to
3141 that library (though we are) - so we must call close()
3142 on sockets on stdio's behalf.
3145 Sock_size_t optlen = sizeof(int);
3146 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0)
3149 /* Test for -1, as *BSD stdio (at least) on fclose sets the FILE* such
3150 that a subsequent fileno() on it returns -1. Don't want to croak()
3151 from within PerlIOUnix_refcnt_dec() if some buggy caller code is
3152 trying to close an already closed handle which somehow it still has
3153 a reference to. (via.xs, I'm looking at you). */
3154 if (fd != -1 && PerlIOUnix_refcnt_dec(fd) > 0) {
3155 /* File descriptor still in use */
3159 /* For STD* handles, don't close stdio, since we shared the FILE *, too. */
3160 if (stdio == stdin) /* Some stdios are buggy fflush-ing inputs */
3162 if (stdio == stdout || stdio == stderr)
3163 return PerlIO_flush(f);
3164 /* Tricky - must fclose(stdio) to free memory but not close(fd)
3165 Use Sarathy's trick from maint-5.6 to invalidate the
3166 fileno slot of the FILE *
3168 result = PerlIO_flush(f);
3170 invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio);
3173 MUTEX_LOCK(&PL_perlio_mutex);
3174 /* Right. We need a mutex here because for a brief while we
3175 will have the situation that fd is actually closed. Hence if
3176 a second thread were to get into this block, its dup() would
3177 likely return our fd as its dupfd. (after all, it is closed)
3178 Then if we get to the dup2() first, we blat the fd back
3179 (messing up its temporary as a side effect) only for it to
3180 then close its dupfd (== our fd) in its close(dupfd) */
3182 /* There is, of course, a race condition, that any other thread
3183 trying to input/output/whatever on this fd will be stuffed
3184 for the duration of this little manoeuvrer. Perhaps we
3185 should hold an IO mutex for the duration of every IO
3186 operation if we know that invalidate doesn't work on this
3187 platform, but that would suck, and could kill performance.
3189 Except that correctness trumps speed.
3190 Advice from klortho #11912. */
3192 dupfd = PerlLIO_dup(fd);
3195 MUTEX_UNLOCK(&PL_perlio_mutex);
3196 /* Oh cXap. This isn't going to go well. Not sure if we can
3197 recover from here, or if closing this particular FILE *
3198 is a good idea now. */
3203 result = PerlSIO_fclose(stdio);
3204 /* We treat error from stdio as success if we invalidated
3205 errno may NOT be expected EBADF
3207 if (invalidate && result != 0) {
3211 #ifdef SOCKS5_VERSION_NAME
3212 /* in SOCKS' case, let close() determine return value */
3216 PerlLIO_dup2(dupfd,fd);
3217 PerlLIO_close(dupfd);
3219 MUTEX_UNLOCK(&PL_perlio_mutex);
3227 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3230 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3234 STDCHAR *buf = (STDCHAR *) vbuf;
3236 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3237 * stdio does not do that for fread()
3239 const int ch = PerlSIO_fgetc(s);
3246 got = PerlSIO_fread(vbuf, 1, count, s);
3247 if (got == 0 && PerlSIO_ferror(s))
3249 if (got >= 0 || errno != EINTR)
3252 SETERRNO(0,0); /* just in case */
3258 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3261 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3263 #ifdef STDIO_BUFFER_WRITABLE
3264 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3265 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3266 STDCHAR *base = PerlIO_get_base(f);
3267 SSize_t cnt = PerlIO_get_cnt(f);
3268 STDCHAR *ptr = PerlIO_get_ptr(f);
3269 SSize_t avail = ptr - base;
3271 if (avail > count) {
3275 Move(buf-avail,ptr,avail,STDCHAR);
3278 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3279 if (PerlSIO_feof(s) && unread >= 0)
3280 PerlSIO_clearerr(s);
3285 if (PerlIO_has_cntptr(f)) {
3286 /* We can get pointer to buffer but not its base
3287 Do ungetc() but check chars are ending up in the
3290 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3291 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3293 const int ch = *--buf & 0xFF;
3294 if (ungetc(ch,s) != ch) {
3295 /* ungetc did not work */
3298 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3299 /* Did not change pointer as expected */
3300 fgetc(s); /* get char back again */
3310 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3316 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3321 got = PerlSIO_fwrite(vbuf, 1, count,
3322 PerlIOSelf(f, PerlIOStdio)->stdio);
3323 if (got >= 0 || errno != EINTR)
3326 SETERRNO(0,0); /* just in case */
3332 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3334 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3335 PERL_UNUSED_CONTEXT;
3337 return PerlSIO_fseek(stdio, offset, whence);
3341 PerlIOStdio_tell(pTHX_ PerlIO *f)
3343 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3344 PERL_UNUSED_CONTEXT;
3346 return PerlSIO_ftell(stdio);
3350 PerlIOStdio_flush(pTHX_ PerlIO *f)
3352 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3353 PERL_UNUSED_CONTEXT;
3355 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3356 return PerlSIO_fflush(stdio);
3362 * FIXME: This discards ungetc() and pre-read stuff which is not
3363 * right if this is just a "sync" from a layer above Suspect right
3364 * design is to do _this_ but not have layer above flush this
3365 * layer read-to-read
3368 * Not writeable - sync by attempting a seek
3370 const int err = errno;
3371 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3379 PerlIOStdio_eof(pTHX_ PerlIO *f)
3381 PERL_UNUSED_CONTEXT;
3383 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3387 PerlIOStdio_error(pTHX_ PerlIO *f)
3389 PERL_UNUSED_CONTEXT;
3391 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3395 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3397 PERL_UNUSED_CONTEXT;
3399 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3403 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3405 PERL_UNUSED_CONTEXT;
3407 #ifdef HAS_SETLINEBUF
3408 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3410 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, NULL, _IOLBF, 0);
3416 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3418 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3419 return (STDCHAR*)PerlSIO_get_base(stdio);
3423 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3425 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3426 return PerlSIO_get_bufsiz(stdio);
3430 #ifdef USE_STDIO_PTR
3432 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3434 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3435 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3439 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3441 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3442 return PerlSIO_get_cnt(stdio);
3446 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3448 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3450 #ifdef STDIO_PTR_LVALUE
3451 PerlSIO_set_ptr(stdio, ptr); /* LHS STDCHAR* cast non-portable */
3452 #ifdef STDIO_PTR_LVAL_SETS_CNT
3453 assert(PerlSIO_get_cnt(stdio) == (cnt));
3455 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3457 * Setting ptr _does_ change cnt - we are done
3461 #else /* STDIO_PTR_LVALUE */
3463 #endif /* STDIO_PTR_LVALUE */
3466 * Now (or only) set cnt
3468 #ifdef STDIO_CNT_LVALUE
3469 PerlSIO_set_cnt(stdio, cnt);
3470 #else /* STDIO_CNT_LVALUE */
3471 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3472 PerlSIO_set_ptr(stdio,
3473 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3475 #else /* STDIO_PTR_LVAL_SETS_CNT */
3477 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3478 #endif /* STDIO_CNT_LVALUE */
3485 PerlIOStdio_fill(pTHX_ PerlIO *f)
3487 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3489 PERL_UNUSED_CONTEXT;
3492 * fflush()ing read-only streams can cause trouble on some stdio-s
3494 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3495 if (PerlSIO_fflush(stdio) != 0)
3499 c = PerlSIO_fgetc(stdio);
3502 if (! PerlSIO_ferror(stdio) || errno != EINTR)
3508 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3510 #ifdef STDIO_BUFFER_WRITABLE
3511 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3512 /* Fake ungetc() to the real buffer in case system's ungetc
3515 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3516 SSize_t cnt = PerlSIO_get_cnt(stdio);
3517 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3518 if (ptr == base+1) {
3519 *--ptr = (STDCHAR) c;
3520 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3521 if (PerlSIO_feof(stdio))
3522 PerlSIO_clearerr(stdio);
3528 if (PerlIO_has_cntptr(f)) {
3530 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3537 /* An ungetc()d char is handled separately from the regular
3538 * buffer, so we stuff it in the buffer ourselves.
3539 * Should never get called as should hit code above
3541 *(--((*stdio)->_ptr)) = (unsigned char) c;
3544 /* If buffer snoop scheme above fails fall back to
3547 if (PerlSIO_ungetc(c, stdio) != c)
3555 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3556 sizeof(PerlIO_funcs),
3558 sizeof(PerlIOStdio),
3559 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3563 PerlIOBase_binmode, /* binmode */
3577 PerlIOStdio_clearerr,
3578 PerlIOStdio_setlinebuf,
3580 PerlIOStdio_get_base,
3581 PerlIOStdio_get_bufsiz,
3586 #ifdef USE_STDIO_PTR
3587 PerlIOStdio_get_ptr,
3588 PerlIOStdio_get_cnt,
3589 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3590 PerlIOStdio_set_ptrcnt,
3593 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3598 #endif /* USE_STDIO_PTR */
3601 /* Note that calls to PerlIO_exportFILE() are reversed using
3602 * PerlIO_releaseFILE(), not importFILE. */
3604 PerlIO_exportFILE(PerlIO * f, const char *mode)
3608 if (PerlIOValid(f)) {
3611 if (!mode || !*mode) {
3612 mode = PerlIO_modestr(f, buf);
3614 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3618 /* De-link any lower layers so new :stdio sticks */
3620 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, NULL))) {
3621 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3623 PerlIOUnix_refcnt_inc(fileno(stdio));
3624 /* Link previous lower layers under new one */
3628 /* restore layers list */
3638 PerlIO_findFILE(PerlIO *f)
3643 if (l->tab == &PerlIO_stdio) {
3644 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3647 l = *PerlIONext(&l);
3649 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3650 /* However, we're not really exporting a FILE * to someone else (who
3651 becomes responsible for closing it, or calling PerlIO_releaseFILE())
3652 So we need to undo its refernce count increase on the underlying file
3653 descriptor. We have to do this, because if the loop above returns you
3654 the FILE *, then *it* didn't increase any reference count. So there's
3655 only one way to be consistent. */
3656 stdio = PerlIO_exportFILE(f, NULL);
3658 const int fd = fileno(stdio);
3660 PerlIOUnix_refcnt_dec(fd);
3665 /* Use this to reverse PerlIO_exportFILE calls. */
3667 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3672 if (l->tab == &PerlIO_stdio) {
3673 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3674 if (s->stdio == f) {
3676 const int fd = fileno(f);
3678 PerlIOUnix_refcnt_dec(fd);
3679 PerlIO_pop(aTHX_ p);
3688 /*--------------------------------------------------------------------------------------*/
3690 * perlio buffer layer
3694 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3696 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3697 const int fd = PerlIO_fileno(f);
3698 if (fd >= 0 && PerlLIO_isatty(fd)) {
3699 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3701 if (*PerlIONext(f)) {
3702 const Off_t posn = PerlIO_tell(PerlIONext(f));
3703 if (posn != (Off_t) - 1) {
3707 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3711 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3712 IV n, const char *mode, int fd, int imode, int perm,
3713 PerlIO *f, int narg, SV **args)
3715 if (PerlIOValid(f)) {
3716 PerlIO *next = PerlIONext(f);
3718 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3719 if (tab && tab->Open)
3721 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3723 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3728 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3730 if (*mode == IoTYPE_IMPLICIT) {
3736 if (tab && tab->Open)
3737 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3740 SETERRNO(EINVAL, LIB_INVARG);
3742 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3744 * if push fails during open, open fails. close will pop us.
3749 fd = PerlIO_fileno(f);
3750 if (init && fd == 2) {
3752 * Initial stderr is unbuffered
3754 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3756 #ifdef PERLIO_USING_CRLF
3757 # ifdef PERLIO_IS_BINMODE_FD
3758 if (PERLIO_IS_BINMODE_FD(fd))
3759 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, NULL);
3763 * do something about failing setmode()? --jhi
3765 PerlLIO_setmode(fd, O_BINARY);
3774 * This "flush" is akin to sfio's sync in that it handles files in either
3775 * read or write state. For write state, we put the postponed data through
3776 * the next layers. For read state, we seek() the next layers to the
3777 * offset given by current position in the buffer, and discard the buffer
3778 * state (XXXX supposed to be for seek()able buffers only, but now it is done
3779 * in any case?). Then the pass the stick further in chain.
3782 PerlIOBuf_flush(pTHX_ PerlIO *f)
3784 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3786 PerlIO *n = PerlIONext(f);
3787 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3789 * write() the buffer
3791 const STDCHAR *buf = b->buf;
3792 const STDCHAR *p = buf;
3793 while (p < b->ptr) {
3794 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3798 else if (count < 0 || PerlIO_error(n)) {
3799 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3804 b->posn += (p - buf);
3806 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3807 STDCHAR *buf = PerlIO_get_base(f);
3809 * Note position change
3811 b->posn += (b->ptr - buf);
3812 if (b->ptr < b->end) {
3813 /* We did not consume all of it - try and seek downstream to
3814 our logical position
3816 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3817 /* Reload n as some layers may pop themselves on seek */
3818 b->posn = PerlIO_tell(n = PerlIONext(f));
3821 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3822 data is lost for good - so return saying "ok" having undone
3825 b->posn -= (b->ptr - buf);
3830 b->ptr = b->end = b->buf;
3831 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3832 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3833 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3838 /* This discards the content of the buffer after b->ptr, and rereads
3839 * the buffer from the position off in the layer downstream; here off
3840 * is at offset corresponding to b->ptr - b->buf.
3843 PerlIOBuf_fill(pTHX_ PerlIO *f)
3845 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3846 PerlIO *n = PerlIONext(f);
3849 * Down-stream flush is defined not to loose read data so is harmless.
3850 * we would not normally be fill'ing if there was data left in anycase.
3852 if (PerlIO_flush(f) != 0) /* XXXX Check that its seek() succeeded?! */
3854 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3855 PerlIOBase_flush_linebuf(aTHX);
3858 PerlIO_get_base(f); /* allocate via vtable */
3860 assert(b->buf); /* The b->buf does get allocated via the vtable system. */
3862 b->ptr = b->end = b->buf;
3864 if (!PerlIOValid(n)) {
3865 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3869 if (PerlIO_fast_gets(n)) {
3871 * Layer below is also buffered. We do _NOT_ want to call its
3872 * ->Read() because that will loop till it gets what we asked for
3873 * which may hang on a pipe etc. Instead take anything it has to
3874 * hand, or ask it to fill _once_.
3876 avail = PerlIO_get_cnt(n);
3878 avail = PerlIO_fill(n);
3880 avail = PerlIO_get_cnt(n);
3882 if (!PerlIO_error(n) && PerlIO_eof(n))
3887 STDCHAR *ptr = PerlIO_get_ptr(n);
3888 const SSize_t cnt = avail;
3889 if (avail > (SSize_t)b->bufsiz)
3891 Copy(ptr, b->buf, avail, STDCHAR);
3892 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3896 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3900 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3902 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3905 b->end = b->buf + avail;
3906 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3911 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3913 if (PerlIOValid(f)) {
3914 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3917 return PerlIOBase_read(aTHX_ f, vbuf, count);
3923 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3925 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3926 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3929 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3934 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3936 * Buffer is already a read buffer, we can overwrite any chars
3937 * which have been read back to buffer start
3939 avail = (b->ptr - b->buf);
3943 * Buffer is idle, set it up so whole buffer is available for
3947 b->end = b->buf + avail;
3949 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3951 * Buffer extends _back_ from where we are now
3953 b->posn -= b->bufsiz;
3955 if (avail > (SSize_t) count) {
3957 * If we have space for more than count, just move count
3965 * In simple stdio-like ungetc() case chars will be already
3968 if (buf != b->ptr) {
3969 Copy(buf, b->ptr, avail, STDCHAR);
3973 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3977 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3983 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3985 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3986 const STDCHAR *buf = (const STDCHAR *) vbuf;
3987 const STDCHAR *flushptr = buf;
3991 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3993 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3994 if (PerlIO_flush(f) != 0) {
3998 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3999 flushptr = buf + count;
4000 while (flushptr > buf && *(flushptr - 1) != '\n')
4004 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
4005 if ((SSize_t) count < avail)
4007 if (flushptr > buf && flushptr <= buf + avail)
4008 avail = flushptr - buf;
4009 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4011 Copy(buf, b->ptr, avail, STDCHAR);
4016 if (buf == flushptr)
4019 if (b->ptr >= (b->buf + b->bufsiz))
4022 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4028 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4031 if ((code = PerlIO_flush(f)) == 0) {
4032 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4033 code = PerlIO_seek(PerlIONext(f), offset, whence);
4035 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4036 b->posn = PerlIO_tell(PerlIONext(f));
4043 PerlIOBuf_tell(pTHX_ PerlIO *f)
4045 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4047 * b->posn is file position where b->buf was read, or will be written
4049 Off_t posn = b->posn;
4050 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
4051 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4053 /* As O_APPEND files are normally shared in some sense it is better
4058 /* when file is NOT shared then this is sufficient */
4059 PerlIO_seek(PerlIONext(f),0, SEEK_END);
4061 posn = b->posn = PerlIO_tell(PerlIONext(f));
4065 * If buffer is valid adjust position by amount in buffer
4067 posn += (b->ptr - b->buf);
4073 PerlIOBuf_popped(pTHX_ PerlIO *f)
4075 const IV code = PerlIOBase_popped(aTHX_ f);
4076 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4077 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4080 b->ptr = b->end = b->buf = NULL;
4081 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4086 PerlIOBuf_close(pTHX_ PerlIO *f)
4088 const IV code = PerlIOBase_close(aTHX_ f);
4089 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4090 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4093 b->ptr = b->end = b->buf = NULL;
4094 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4099 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
4101 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4108 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
4110 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4113 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
4114 return (b->end - b->ptr);
4119 PerlIOBuf_get_base(pTHX_ PerlIO *f)
4121 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4122 PERL_UNUSED_CONTEXT;
4127 b->buf = Newxz(b->buf,b->bufsiz, STDCHAR);
4129 b->buf = (STDCHAR *) & b->oneword;
4130 b->bufsiz = sizeof(b->oneword);
4132 b->end = b->ptr = b->buf;
4138 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
4140 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4143 return (b->end - b->buf);
4147 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4149 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4151 PERL_UNUSED_ARG(cnt);
4156 assert(PerlIO_get_cnt(f) == cnt);
4157 assert(b->ptr >= b->buf);
4158 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4162 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4164 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4169 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
4170 sizeof(PerlIO_funcs),
4173 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4177 PerlIOBase_binmode, /* binmode */
4191 PerlIOBase_clearerr,
4192 PerlIOBase_setlinebuf,
4197 PerlIOBuf_set_ptrcnt,
4200 /*--------------------------------------------------------------------------------------*/
4202 * Temp layer to hold unread chars when cannot do it any other way
4206 PerlIOPending_fill(pTHX_ PerlIO *f)
4209 * Should never happen
4216 PerlIOPending_close(pTHX_ PerlIO *f)
4219 * A tad tricky - flush pops us, then we close new top
4222 return PerlIO_close(f);
4226 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4229 * A tad tricky - flush pops us, then we seek new top
4232 return PerlIO_seek(f, offset, whence);
4237 PerlIOPending_flush(pTHX_ PerlIO *f)
4239 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4240 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4244 PerlIO_pop(aTHX_ f);
4249 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4255 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4260 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4262 const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4263 PerlIOl * const l = PerlIOBase(f);
4265 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4266 * etc. get muddled when it changes mid-string when we auto-pop.
4268 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4269 (PerlIOBase(PerlIONext(f))->
4270 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4275 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4277 SSize_t avail = PerlIO_get_cnt(f);
4279 if ((SSize_t)count < avail)
4282 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4283 if (got >= 0 && got < (SSize_t)count) {
4284 const SSize_t more =
4285 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4286 if (more >= 0 || got == 0)
4292 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4293 sizeof(PerlIO_funcs),
4296 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4297 PerlIOPending_pushed,
4300 PerlIOBase_binmode, /* binmode */
4309 PerlIOPending_close,
4310 PerlIOPending_flush,
4314 PerlIOBase_clearerr,
4315 PerlIOBase_setlinebuf,
4320 PerlIOPending_set_ptrcnt,
4325 /*--------------------------------------------------------------------------------------*/
4327 * crlf - translation On read translate CR,LF to "\n" we do this by
4328 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4329 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4331 * c->nl points on the first byte of CR LF pair when it is temporarily
4332 * replaced by LF, or to the last CR of the buffer. In the former case
4333 * the caller thinks that the buffer ends at c->nl + 1, in the latter
4334 * that it ends at c->nl; these two cases can be distinguished by
4335 * *c->nl. c->nl is set during _getcnt() call, and unset during
4336 * _unread() and _flush() calls.
4337 * It only matters for read operations.
4341 PerlIOBuf base; /* PerlIOBuf stuff */
4342 STDCHAR *nl; /* Position of crlf we "lied" about in the
4346 /* Inherit the PERLIO_F_UTF8 flag from previous layer.
4347 * Otherwise the :crlf layer would always revert back to
4351 S_inherit_utf8_flag(PerlIO *f)
4353 PerlIO *g = PerlIONext(f);
4354 if (PerlIOValid(g)) {
4355 if (PerlIOBase(g)->flags & PERLIO_F_UTF8) {
4356 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
4362 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4365 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4366 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4368 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4369 (void*)f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4370 PerlIOBase(f)->flags);
4373 /* Enable the first CRLF capable layer you can find, but if none
4374 * found, the one we just pushed is fine. This results in at
4375 * any given moment at most one CRLF-capable layer being enabled
4376 * in the whole layer stack. */
4377 PerlIO *g = PerlIONext(f);
4378 while (PerlIOValid(g)) {
4379 PerlIOl *b = PerlIOBase(g);
4380 if (b && b->tab == &PerlIO_crlf) {
4381 if (!(b->flags & PERLIO_F_CRLF))
4382 b->flags |= PERLIO_F_CRLF;
4383 S_inherit_utf8_flag(g);
4384 PerlIO_pop(aTHX_ f);
4390 S_inherit_utf8_flag(f);
4396 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4398 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4399 if (c->nl) { /* XXXX Shouldn't it be done only if b->ptr > c->nl? */
4403 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4404 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4406 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4407 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4409 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4414 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4415 b->end = b->ptr = b->buf + b->bufsiz;
4416 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4417 b->posn -= b->bufsiz;
4419 while (count > 0 && b->ptr > b->buf) {
4420 const int ch = *--buf;
4422 if (b->ptr - 2 >= b->buf) {
4429 /* If b->ptr - 1 == b->buf, we are undoing reading 0xa */
4430 *--(b->ptr) = 0xa; /* Works even if 0xa == '\r' */
4446 /* XXXX This code assumes that buffer size >=2, but does not check it... */
4448 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4450 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4453 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4454 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4455 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4456 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4458 while (nl < b->end && *nl != 0xd)
4460 if (nl < b->end && *nl == 0xd) {
4462 if (nl + 1 < b->end) {
4469 * Not CR,LF but just CR
4477 * Blast - found CR as last char in buffer
4482 * They may not care, defer work as long as
4486 return (nl - b->ptr);
4490 b->ptr++; /* say we have read it as far as
4491 * flush() is concerned */
4492 b->buf++; /* Leave space in front of buffer */
4493 /* Note as we have moved buf up flush's
4495 will naturally make posn point at CR
4497 b->bufsiz--; /* Buffer is thus smaller */
4498 code = PerlIO_fill(f); /* Fetch some more */
4499 b->bufsiz++; /* Restore size for next time */
4500 b->buf--; /* Point at space */
4501 b->ptr = nl = b->buf; /* Which is what we hand
4503 *nl = 0xd; /* Fill in the CR */
4505 goto test; /* fill() call worked */
4507 * CR at EOF - just fall through
4509 /* Should we clear EOF though ??? */
4514 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4520 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4522 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4523 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4529 if (ptr == b->end && *c->nl == 0xd) {
4530 /* Defered CR at end of buffer case - we lied about count */
4543 * Test code - delete when it works ...
4545 IV flags = PerlIOBase(f)->flags;
4546 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4547 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4548 /* Defered CR at end of buffer case - we lied about count */
4554 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4555 " nl=%p e=%p for %d", (void*)ptr, (void*)chk,
4556 flags, c->nl, b->end, cnt);
4563 * They have taken what we lied about
4571 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4575 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4577 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4578 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4580 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4581 const STDCHAR *buf = (const STDCHAR *) vbuf;
4582 const STDCHAR * const ebuf = buf + count;
4585 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4587 while (buf < ebuf) {
4588 const STDCHAR * const eptr = b->buf + b->bufsiz;
4589 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4590 while (buf < ebuf && b->ptr < eptr) {
4592 if ((b->ptr + 2) > eptr) {
4600 *(b->ptr)++ = 0xd; /* CR */
4601 *(b->ptr)++ = 0xa; /* LF */
4603 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4610 *(b->ptr)++ = *buf++;
4612 if (b->ptr >= eptr) {
4618 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4620 return (buf - (STDCHAR *) vbuf);
4625 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4627 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4632 return PerlIOBuf_flush(aTHX_ f);
4636 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4638 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4639 /* In text mode - flush any pending stuff and flip it */
4640 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4641 #ifndef PERLIO_USING_CRLF
4642 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4643 PerlIO_pop(aTHX_ f);
4649 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4650 sizeof(PerlIO_funcs),
4653 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4655 PerlIOBuf_popped, /* popped */
4657 PerlIOCrlf_binmode, /* binmode */
4661 PerlIOBuf_read, /* generic read works with ptr/cnt lies */
4662 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4663 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4671 PerlIOBase_clearerr,
4672 PerlIOBase_setlinebuf,
4677 PerlIOCrlf_set_ptrcnt,
4681 /*--------------------------------------------------------------------------------------*/
4683 * mmap as "buffer" layer
4687 PerlIOBuf base; /* PerlIOBuf stuff */
4688 Mmap_t mptr; /* Mapped address */
4689 Size_t len; /* mapped length */
4690 STDCHAR *bbuf; /* malloced buffer if map fails */
4694 PerlIOMmap_map(pTHX_ PerlIO *f)
4697 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4698 const IV flags = PerlIOBase(f)->flags;
4702 if (flags & PERLIO_F_CANREAD) {
4703 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4704 const int fd = PerlIO_fileno(f);
4706 code = Fstat(fd, &st);
4707 if (code == 0 && S_ISREG(st.st_mode)) {
4708 SSize_t len = st.st_size - b->posn;
4711 if (PL_mmap_page_size <= 0)
4712 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4716 * This is a hack - should never happen - open should
4719 b->posn = PerlIO_tell(PerlIONext(f));
4721 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4722 len = st.st_size - posn;
4723 m->mptr = (Mmap_t)mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4724 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4725 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4726 madvise(m->mptr, len, MADV_SEQUENTIAL);
4728 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4729 madvise(m->mptr, len, MADV_WILLNEED);
4731 PerlIOBase(f)->flags =
4732 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4733 b->end = ((STDCHAR *) m->mptr) + len;
4734 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4743 PerlIOBase(f)->flags =
4744 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4746 b->ptr = b->end = b->ptr;
4755 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4757 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4760 PerlIOBuf * const b = &m->base;
4762 /* The munmap address argument is tricky: depending on the
4763 * standard it is either "void *" or "caddr_t" (which is
4764 * usually "char *" (signed or unsigned). If we cast it
4765 * to "void *", those that have it caddr_t and an uptight
4766 * C++ compiler, will freak out. But casting it as char*
4767 * should work. Maybe. (Using Mmap_t figured out by
4768 * Configure doesn't always work, apparently.) */
4769 code = munmap((char*)m->mptr, m->len);
4773 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4776 b->ptr = b->end = b->buf;
4777 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4783 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4785 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4786 PerlIOBuf * const b = &m->base;
4787 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4789 * Already have a readbuffer in progress
4795 * We have a write buffer or flushed PerlIOBuf read buffer
4797 m->bbuf = b->buf; /* save it in case we need it again */
4798 b->buf = NULL; /* Clear to trigger below */
4801 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4804 * Map did not work - recover PerlIOBuf buffer if we have one
4809 b->ptr = b->end = b->buf;
4812 return PerlIOBuf_get_base(aTHX_ f);
4816 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4818 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4819 PerlIOBuf * const b = &m->base;
4820 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4822 if (b->ptr && (b->ptr - count) >= b->buf
4823 && memEQ(b->ptr - count, vbuf, count)) {
4825 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4830 * Loose the unwritable mapped buffer
4834 * If flush took the "buffer" see if we have one from before
4836 if (!b->buf && m->bbuf)
4839 PerlIOBuf_get_base(aTHX_ f);
4843 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4847 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4849 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4850 PerlIOBuf * const b = &m->base;
4852 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4854 * No, or wrong sort of, buffer
4857 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4861 * If unmap took the "buffer" see if we have one from before
4863 if (!b->buf && m->bbuf)
4866 PerlIOBuf_get_base(aTHX_ f);
4870 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4874 PerlIOMmap_flush(pTHX_ PerlIO *f)
4876 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4877 PerlIOBuf * const b = &m->base;
4878 IV code = PerlIOBuf_flush(aTHX_ f);
4880 * Now we are "synced" at PerlIOBuf level
4887 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4892 * We seem to have a PerlIOBuf buffer which was not mapped
4893 * remember it in case we need one later
4902 PerlIOMmap_fill(pTHX_ PerlIO *f)
4904 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4905 IV code = PerlIO_flush(f);
4906 if (code == 0 && !b->buf) {
4907 code = PerlIOMmap_map(aTHX_ f);
4909 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4910 code = PerlIOBuf_fill(aTHX_ f);
4916 PerlIOMmap_close(pTHX_ PerlIO *f)
4918 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4919 PerlIOBuf * const b = &m->base;
4920 IV code = PerlIO_flush(f);
4924 b->ptr = b->end = b->buf;
4926 if (PerlIOBuf_close(aTHX_ f) != 0)
4932 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4934 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4938 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4939 sizeof(PerlIO_funcs),
4942 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4946 PerlIOBase_binmode, /* binmode */
4960 PerlIOBase_clearerr,
4961 PerlIOBase_setlinebuf,
4962 PerlIOMmap_get_base,
4966 PerlIOBuf_set_ptrcnt,
4969 #endif /* HAS_MMAP */
4972 Perl_PerlIO_stdin(pTHX)
4976 PerlIO_stdstreams(aTHX);
4978 return &PL_perlio[1];
4982 Perl_PerlIO_stdout(pTHX)
4986 PerlIO_stdstreams(aTHX);
4988 return &PL_perlio[2];
4992 Perl_PerlIO_stderr(pTHX)
4996 PerlIO_stdstreams(aTHX);
4998 return &PL_perlio[3];
5001 /*--------------------------------------------------------------------------------------*/
5004 PerlIO_getname(PerlIO *f, char *buf)
5009 bool exported = FALSE;
5010 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
5012 stdio = PerlIO_exportFILE(f,0);
5016 name = fgetname(stdio, buf);
5017 if (exported) PerlIO_releaseFILE(f,stdio);
5022 PERL_UNUSED_ARG(buf);
5023 Perl_croak(aTHX_ "Don't know how to get file name");
5029 /*--------------------------------------------------------------------------------------*/
5031 * Functions which can be called on any kind of PerlIO implemented in
5035 #undef PerlIO_fdopen
5037 PerlIO_fdopen(int fd, const char *mode)
5040 return PerlIO_openn(aTHX_ NULL, mode, fd, 0, 0, NULL, 0, NULL);
5045 PerlIO_open(const char *path, const char *mode)
5048 SV *name = sv_2mortal(newSVpv(path, 0));
5049 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, NULL, 1, &name);
5052 #undef Perlio_reopen
5054 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
5057 SV *name = sv_2mortal(newSVpv(path,0));
5058 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, f, 1, &name);
5063 PerlIO_getc(PerlIO *f)
5067 if ( 1 == PerlIO_read(f, buf, 1) ) {
5068 return (unsigned char) buf[0];
5073 #undef PerlIO_ungetc
5075 PerlIO_ungetc(PerlIO *f, int ch)
5080 if (PerlIO_unread(f, &buf, 1) == 1)
5088 PerlIO_putc(PerlIO *f, int ch)
5092 return PerlIO_write(f, &buf, 1);
5097 PerlIO_puts(PerlIO *f, const char *s)
5100 return PerlIO_write(f, s, strlen(s));
5103 #undef PerlIO_rewind
5105 PerlIO_rewind(PerlIO *f)
5108 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
5112 #undef PerlIO_vprintf
5114 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
5123 Perl_va_copy(ap, apc);
5124 sv = vnewSVpvf(fmt, &apc);
5126 sv = vnewSVpvf(fmt, &ap);
5128 s = SvPV_const(sv, len);
5129 wrote = PerlIO_write(f, s, len);
5134 #undef PerlIO_printf
5136 PerlIO_printf(PerlIO *f, const char *fmt, ...)
5141 result = PerlIO_vprintf(f, fmt, ap);
5146 #undef PerlIO_stdoutf
5148 PerlIO_stdoutf(const char *fmt, ...)
5154 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
5159 #undef PerlIO_tmpfile
5161 PerlIO_tmpfile(void)
5166 const int fd = win32_tmpfd();
5168 f = PerlIO_fdopen(fd, "w+b");
5170 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
5171 SV * const sv = newSVpvs("/tmp/PerlIO_XXXXXX");
5173 * I have no idea how portable mkstemp() is ... NI-S
5175 const int fd = mkstemp(SvPVX(sv));
5177 f = PerlIO_fdopen(fd, "w+");
5179 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
5180 PerlLIO_unlink(SvPVX_const(sv));
5183 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
5184 FILE * const stdio = PerlSIO_tmpfile();
5187 f = PerlIO_fdopen(fileno(stdio), "w+");
5189 # endif /* else HAS_MKSTEMP */
5190 #endif /* else WIN32 */
5197 #endif /* USE_SFIO */
5198 #endif /* PERLIO_IS_STDIO */
5200 /*======================================================================================*/
5202 * Now some functions in terms of above which may be needed even if we are
5203 * not in true PerlIO mode
5206 Perl_PerlIO_context_layers(pTHX_ const char *mode)
5209 const char *direction = NULL;
5212 * Need to supply default layer info from open.pm
5218 if (mode && mode[0] != 'r') {
5219 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_OUT)
5220 direction = "open>";
5222 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_IN)
5223 direction = "open<";
5228 layers = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
5229 0, direction, 5, 0, 0);
5232 return SvOK(layers) ? SvPV_nolen_const(layers) : NULL;
5237 #undef PerlIO_setpos
5239 PerlIO_setpos(PerlIO *f, SV *pos)
5244 const Off_t * const posn = (Off_t *) SvPV(pos, len);
5245 if (f && len == sizeof(Off_t))
5246 return PerlIO_seek(f, *posn, SEEK_SET);
5248 SETERRNO(EINVAL, SS_IVCHAN);
5252 #undef PerlIO_setpos
5254 PerlIO_setpos(PerlIO *f, SV *pos)
5259 Fpos_t * const fpos = (Fpos_t *) SvPV(pos, len);
5260 if (f && len == sizeof(Fpos_t)) {
5261 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5262 return fsetpos64(f, fpos);
5264 return fsetpos(f, fpos);
5268 SETERRNO(EINVAL, SS_IVCHAN);
5274 #undef PerlIO_getpos
5276 PerlIO_getpos(PerlIO *f, SV *pos)
5279 Off_t posn = PerlIO_tell(f);
5280 sv_setpvn(pos, (char *) &posn, sizeof(posn));
5281 return (posn == (Off_t) - 1) ? -1 : 0;
5284 #undef PerlIO_getpos
5286 PerlIO_getpos(PerlIO *f, SV *pos)
5291 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5292 code = fgetpos64(f, &fpos);
5294 code = fgetpos(f, &fpos);
5296 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
5301 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
5304 vprintf(char *pat, char *args)
5306 _doprnt(pat, args, stdout);
5307 return 0; /* wrong, but perl doesn't use the return
5312 vfprintf(FILE *fd, char *pat, char *args)
5314 _doprnt(pat, args, fd);
5315 return 0; /* wrong, but perl doesn't use the return
5321 #ifndef PerlIO_vsprintf
5323 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5326 const int val = my_vsnprintf(s, n > 0 ? n : 0, fmt, ap);
5327 PERL_UNUSED_CONTEXT;
5329 #ifndef PERL_MY_VSNPRINTF_GUARDED
5330 if (val < 0 || (n > 0 ? val >= n : 0)) {
5331 Perl_croak(aTHX_ "panic: my_vsnprintf overflow in PerlIO_vsprintf\n");
5338 #ifndef PerlIO_sprintf
5340 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5345 result = PerlIO_vsprintf(s, n, fmt, ap);
5353 * c-indentation-style: bsd
5355 * indent-tabs-mode: t
5358 * ex: set ts=8 sts=4 sw=4 noet: